Merge lp:~salgado/offspring/disable-subscription-for-private-projects into lp:~linaro-automation/offspring/private-builds

[Guilherme Salgado]

This branch disables the ability to subscribe to notifications of private projects as well as the sending of notifications about private projects

[lp:~salgado/offspring/disable-subscription-for-private-projects]

86. By Guilherme Salgado on 2011-11-09

Remove 4 unused methods (one from Project and 3 from ProjectGroup)

87. By Cody A.W. Somerville on 2011-11-11

Deprecate shell script configuration file offspring-builder.config for builder component and build archiver script - instead store that configuration in offspring.cfg and have offspring-builder-config script that will output shell environment variables to be set by components of Offspring still written in shell. Kudos to Michael Hudson and Guilherme Salgado from Linaro. N.B. Project build configuration in build configuration branches are still written in shell.

88. By Guilherme Salgado on 2011-11-18

Add the hwpack wrapper used by Linaro

89. By Guilherme Salgado on 2011-11-30

Add an anonymous object factory for queuemanager tests

90. By Guilherme Salgado on 2011-12-01

Add support for private objects to web.queuemanger, with a custom API for querying only the objects a given user is allowed to see and helper methods to check if a given object is visible to a given user

91. By Kevin McDermott on 2011-12-01

Merge database-testing [r=salgado] [f=891557]

This adds a test infrastructure for the "master" part of offspring, including
setting up the database tables needed and support for fixtures.

In addition, there new tests added for the master code, and the notifications
that are sent.

Also, the configuration mechanism has been replaced by a simple ConfigParser
implementation.

92. By Kevin McDermott on 2011-12-02

Merge add-path-independence [r=salgado] [f=897203]

This changes the default file used in Offspring, to use a file sourced from the
root of the offspring Python source files.

The path to the configuration file can still be explicitly set either through
the environment or explicitly on the command-line.

93. By Kevin McDermott on 2011-12-02

Merge slave-testing [r=jedimike] [f=898118]

This adds tests for the Offspring LexBuilderSlave functionality.

94. By Kevin McDermott on 2011-12-02

Merge fix-base-dir-in-config [r=salgado] [f=899220]

This fixes get_configuration() to only overwrite the base_dir in the
configuration object returned in the event that there's no base_dir already
set.

95. By Kevin McDermott on 2011-12-08

Merge slave-testing-server [r=salgado] [f=898118]

This adds tests for the LexbuilderSlaveServer.

96. By Kevin McDermott on 2011-12-08

Add coverage make targets for slave and master.

97. By Kevin McDermott on 2011-12-09

Missed config gets.

98. By Guilherme Salgado on 2011-12-09

Make project and build views return a 404 if the user is not allowed to see that private project/build

99. By Kevin McDermott on 2011-12-09

Merge passing-ssh-key-to-slave2 [r=bigkevmcd] [a=jamestunnicliff]

This adds support for passing an SSH key to the slave builder, to use when
checking out configurations.

100. By Kevin McDermott on 2011-12-12

Add test-web-coverage as a target.

101. By Guilherme Salgado on 2011-12-13

Add a new page (+acl) to edit the list of people who can see a given private project.

102. By Kevin McDermott on 2011-12-14

Don't import tests otherwise they run twice.

103. By Kevin McDermott on 2011-12-14

Merge error-in-queuemanager-views [r=salgado] [f=900337]

This adds tests for the LaunchpadProject form, and removes an error in the view
code for creating LaunchpadProjects.

104. By Guilherme Salgado on 2011-12-14

Change the builds() view to show private builds if the user is allowed to see them.

105. By Guilherme Salgado on 2011-12-15

Update the piston handlers to include private objects the user is allowed to see.

106. By Kevin McDermott on 2011-12-16

Merge add-queue-metrics [r=cody,schwuk] [f=902183]

This adds the core queue-metrics logic, calculating the average build time
either for a Project, or for all Projects, over a configurable period of time.

It also adds a new management command build_metrics which outputs some basic
metrics.

107. By Cody A.W. Somerville on 2012-01-09

Updated archive-builds script to include hwpacks generated by linaro-media-create in artifacts that are pruned (LP #819371).

108. By Kevin McDermott on 2012-01-11

Merge slave-testing-integration [r=Cody] [f=898118]

This adds test coverage for offspring.slave.slave.

109. By Guilherme Salgado on 2012-01-11

Update list views to include private objects the user is allowed to see or
redact information about the ones the user is not allowed to see.

The project list view hides the projects the user is not allowed to see
whereas the builder list redacts information about current builds when it's
for a project the user is not allowed to see

110. By Guilherme Salgado on 2012-01-11

Update the builder_details view to omit details of the current job if the user
has no rights to see it.

Also shows a small padlock icon next to private projects on both the list of
projects and the list of builds

111. By Kevin McDermott on 2012-01-12

Merge add-queue-wait-time [r=salgado] [f=902183]

This implements queue wait time metric to the gathered metrics.

112. By Kevin McDermott on 2012-01-12

Merge non-scheduled-builds [r=salgado] [f=902183]

This adds support for non-scheduled (automated) builds to the metrics
determination.

113. By Guilherme Salgado on 2012-01-12

Update the build failures sidebar to skip private builds the user is not allowed to see, and the queued-builds and build-farm sidebars to simply state it's a private build (without any other information) when the user is not allowed to see them

114. By Guilherme Salgado on 2012-01-12

Make sure Lexbuilders with no current_job are considered public

115. By Guilherme Salgado on 2012-01-13

Make sure we can't have a private project without an owner, as that could render them completely inaccessible

116. By Guilherme Salgado on 2012-01-13

Disable subscriptions and notifications to private projects by not showing the Subscribe link for private projects and refraining from sending any notification for builds of private projects.

117. By Guilherme Salgado on 2012-01-16

merge trunk

Unmerged revisions

117. By Guilherme Salgado on 2012-01-16

merge trunk

116. By Guilherme Salgado on 2012-01-13

Disable subscriptions and notifications to private projects by not showing the Subscribe link for private projects and refraining from sending any notification for builds of private projects.

115. By Guilherme Salgado on 2012-01-13

Make sure we can't have a private project without an owner, as that could render them completely inaccessible

114. By Guilherme Salgado on 2012-01-12

Make sure Lexbuilders with no current_job are considered public

113. By Guilherme Salgado on 2012-01-12

Update the build failures sidebar to skip private builds the user is not allowed to see, and the queued-builds and build-farm sidebars to simply state it's a private build (without any other information) when the user is not allowed to see them

112. By Kevin McDermott on 2012-01-12

Merge non-scheduled-builds [r=salgado] [f=902183]

This adds support for non-scheduled (automated) builds to the metrics
determination.

111. By Kevin McDermott on 2012-01-12

Merge add-queue-wait-time [r=salgado] [f=902183]

This implements queue wait time metric to the gathered metrics.

110. By Guilherme Salgado on 2012-01-11

Update the builder_details view to omit details of the current job if the user
has no rights to see it.

Also shows a small padlock icon next to private projects on both the list of
projects and the list of builds

109. By Guilherme Salgado on 2012-01-11

Update list views to include private objects the user is allowed to see or
redact information about the ones the user is not allowed to see.

The project list view hides the projects the user is not allowed to see
whereas the builder list redacts information about current builds when it's
for a project the user is not allowed to see

108. By Kevin McDermott on 2012-01-11

Merge slave-testing-integration [r=Cody] [f=898118]

This adds test coverage for offspring.slave.slave.

=== modified file 'lib/offspring/master/models.py'
--- lib/offspring/master/models.py	2011-09-23 14:01:26 +0000
+++ lib/offspring/master/models.py	2011-10-17 19:26:36 +0000
@@ -157,6 +157,7 @@
     title = Unicode()
     priority = Int(default=0)
     is_active = Bool(default=True)
+    is_private = Bool(default=False)
     launchpad_project_id = Unicode()
     launchpad_project = Reference(launchpad_project_id, "LaunchpadProject.name")
     suite = Unicode()

=== modified file 'lib/offspring/master/notifications.py'
--- lib/offspring/master/notifications.py	2010-11-29 08:27:24 +0000
+++ lib/offspring/master/notifications.py	2011-10-17 19:26:36 +0000
@@ -88,6 +88,9 @@
 def notify_buildresult(build_result):
     project = build_result.project
     builder = build_result.builder
+    if project.is_private:
+        # We don't support subscriptions for private projects.
+        return
     
     build_date, build_id = build_result.name.rsplit('-', 1)
     build_url = "%s/%s/%s/%s" % (offspring.config.web('build_results_uri'), project.name, build_date, build_id)

=== modified file 'lib/offspring/master/tests.py'
--- lib/offspring/master/tests.py	2011-09-08 19:12:29 +0000
+++ lib/offspring/master/tests.py	2011-10-17 19:26:36 +0000
@@ -5,7 +5,12 @@
 import unittest
 
 from offspring import config
+from offspring.master.models import (
+    Project,
+    ProjectNotificationSubscription,
+    )
 from offspring.master.notifications import (
+    notify_buildresult,
     notify_crash,
     notify_problem,
 )
@@ -20,6 +25,12 @@
         self.mails.append((sender, rcpt, msg))
 
 
+class FakeLexBuilder(object):
+    
+    def __init__(self, name):
+        self.name = name
+
+
 class Factory(object):
 
     def __init__(self):
@@ -29,6 +40,13 @@
         self.counter += 1
         return 'str%s' % self.counter
 
+    def makeProject(self, is_private=False):
+        name = self.getUniqueString()
+        project = Project(name=name)
+        project.title = name.decode('utf-8')
+        project.is_private = is_private
+        return project
+
 
 class TestCaseWithFactory(unittest.TestCase):
 
@@ -119,3 +137,24 @@
         from_header = mailer.mails[0][0]
         sender_real_name, sender_addr = email.utils.parseaddr(from_header)
         self.assertEqual(addr, sender_addr)
+
+
+class FakeBuildResult(object):
+
+    def __init__(self, project):
+        self.project = project
+        self.builder = None
+
+
+class TestNotifyBuildResult(TestCaseWithFactory):
+
+    def test_private_project(self):
+        # For simplicity, we don't support subscriptions for private projects,
+        # so no notifications are sent here even though there is a project
+        # subscription.
+        mailer = StubMailer()
+        project = self.factory.makeProject(is_private=True)
+        project.subscriptions = [ProjectNotificationSubscription()]
+        build = FakeBuildResult(project)
+        notify_buildresult(build)
+        self.assertEquals([], mailer.mails)

=== modified file 'lib/offspring/web/queuemanager/handlers.py'
--- lib/offspring/web/queuemanager/handlers.py	2011-10-13 23:23:41 +0000
+++ lib/offspring/web/queuemanager/handlers.py	2011-10-17 19:26:36 +0000
@@ -154,7 +154,6 @@
         return results
 
 
-# TODO: Must be made privacy-aware.
 class BuildRequestHandler(BaseHandler):
     allowed_methods = ('GET', 'POST', 'DELETE')
     model = BuildRequest
@@ -162,10 +161,10 @@
 
     def read(self, request, projectName=None, request_id=None):
         try:
+            requests = BuildRequest.all_objects.accessible_by_user(
+                request.user)
             if projectName is not None:
-                requests = BuildRequest.objects.filter(project__name=projectName)
-            else:
-                requests = BuildRequest.objects
+                requests = requests.filter(project__name=projectName)
         except:
             return rc.NOT_FOUND
         if request_id is not None:
@@ -177,12 +176,12 @@
     def delete(self, request, projectName=None, request_id=None):
         if request.user.has_perm("queuemanager.can_build"):
             try:
+                requests = BuildRequest.all_objects.accessible_by_user(
+                    request.user)
                 if projectName is not None:
-                    requests = BuildRequest.objects.filter(project__name=projectName)
-                else:
-                    requests = BuildRequest.objects
+                    requests = requests.filter(project__name=projectName)
             except:
-                return RC.NOT_FOUND
+                return rc.NOT_FOUND
             if request_id is not None:
                 try:
                     requests.get(pk=request_id).delete()
@@ -202,7 +201,8 @@
     def create(self, request, projectName):
         if request.user.has_perm("queuemanager.can_build"):
             try:
-                p = Project.objects.get(pk=projectName)
+                p = Project.all_objects.accessible_by_user(request.user).get(
+                    pk=projectName)
                 if request.POST.has_key('build_reason'):
                     request = BuildRequest.queue_build(p, request.user, reason=request.POST['build_reason'], scoreBonus=25)
                 else:

=== added file 'lib/offspring/web/queuemanager/tests/helpers.py'
--- lib/offspring/web/queuemanager/tests/helpers.py	1970-01-01 00:00:00 +0000
+++ lib/offspring/web/queuemanager/tests/helpers.py	2011-10-17 19:26:36 +0000
@@ -0,0 +1,14 @@
+from django.contrib.auth.models import (
+    Group,
+    Permission,
+    )
+
+
+def grant_permission_to_user(user, permission):
+    group = Group(name=user.username)
+    group.save()
+    group.permissions.add(Permission.objects.get(codename=permission))
+    group.save()
+    user.groups.add(group)
+    user.save()
+    return user

=== modified file 'lib/offspring/web/queuemanager/tests/test_handlers.py'
--- lib/offspring/web/queuemanager/tests/test_handlers.py	2011-10-13 23:16:02 +0000
+++ lib/offspring/web/queuemanager/tests/test_handlers.py	2011-10-17 19:26:36 +0000
@@ -6,13 +6,18 @@
 from django.test import TestCase
 from django.contrib.sessions.middleware import SessionMiddleware
 
+from piston.utils import rc
+
+from offspring.web.queuemanager.models import BuildRequest
 from offspring.web.queuemanager.handlers import (
     BuildManifestComparisonHandler,
     BuildManifestHandler,
+    BuildRequestHandler,
     BuildResultHandler,
     ReleaseHandler,
     )
 from offspring.web.queuemanager.tests.factory import factory
+from offspring.web.queuemanager.tests.helpers import grant_permission_to_user
 
 
 class BaseHandlerTestCase(TestCase):
@@ -97,6 +102,88 @@
         self.assertEqual(0, results.count())
 
 
+class BuildRequestHandlerTests(BaseHandlerTestCase):
+
+    def test_public_build_request_is_visible_to_anyone(self):
+        job = factory.makeBuildRequest(
+            project=factory.makeProject(is_private=False))
+        results = BuildRequestHandler().read(
+            self.request, projectName=job.project.name, request_id=job.id)
+        self.assertEqual(job, results)
+
+    def test_private_build_request_is_visible_to_owner(self):
+        job = factory.makeBuildRequest(
+            project=factory.makeProject(is_private=True))
+        self._login(job.project.owner)
+        results = BuildRequestHandler().read(
+            self.request, projectName=job.project.name, request_id=job.id)
+        self.assertEqual(job, results)
+
+    def test_private_build_request_is_not_visible_to_others(self):
+        job = factory.makeBuildRequest(
+            project=factory.makeProject(is_private=True))
+        self._login(factory.makeUser())
+        self.assertRaises(
+            BuildRequest.DoesNotExist,
+            BuildRequestHandler().read,
+            self.request, projectName=job.project.name, request_id=job.id)
+
+    def test_new_build_request_on_public_project(self):
+        project = factory.makeProject(is_private=False)
+        self.assertCreateReturnCode(
+            project, factory.makeUser(), rc.CREATED.status_code)
+
+    def test_owner_requests_new_build_on_private_project(self):
+        project = factory.makeProject(is_private=True)
+        self.assertCreateReturnCode(
+            project, project.owner, rc.CREATED.status_code)
+
+    def test_other_user_requests_new_build_on_private_project(self):
+        project = factory.makeProject(is_private=True)
+        self.assertCreateReturnCode(
+            project, factory.makeUser(), rc.BAD_REQUEST.status_code)
+
+    def test_delete_build_request_on_public_project(self):
+        job = factory.makeBuildRequest(
+            project=factory.makeProject(is_private=False))
+        self.assertDeleteReturnCode(
+            job, factory.makeUser(), rc.DELETED.status_code)
+
+    def test_owner_deletes_build_request_on_private_project(self):
+        job = factory.makeBuildRequest(
+            project=factory.makeProject(is_private=True))
+        self.assertDeleteReturnCode(
+            job, job.project.owner, rc.DELETED.status_code)
+
+    def test_other_user_deletes_build_request_on_private_project(self):
+        job = factory.makeBuildRequest(
+            project=factory.makeProject(is_private=True))
+        self.assertDeleteReturnCode(
+            job, factory.makeUser(), rc.NOT_FOUND.status_code)
+
+    def assertCreateReturnCode(self, project, user, return_code):
+        """Assert that BuildRequestHandler.create() returns the given code.
+
+        Also grant the given user the 'can_build' permission and logs it in.
+        """
+        grant_permission_to_user(user, 'can_build')
+        self._login(user)
+        result = BuildRequestHandler().create(
+            self.request, projectName=project.name)
+        self.assertEqual(return_code, result.status_code)
+
+    def assertDeleteReturnCode(self, job, user, return_code):
+        """Assert that BuildRequestHandler.delete() returns the given code.
+
+        Also grant the given user the 'can_build' permission and logs it in.
+        """
+        grant_permission_to_user(user, 'can_build')
+        self._login(user)
+        result = BuildRequestHandler().delete(
+            self.request, projectName=job.project.name, request_id=job.id)
+        self.assertEqual(return_code, result.status_code)
+
+
 class ReleaseHandlerTests(BaseHandlerTestCase):
 
     def test_public_project_release(self):

=== modified file 'lib/offspring/web/queuemanager/tests/test_views.py'
--- lib/offspring/web/queuemanager/tests/test_views.py	2011-10-10 21:15:48 +0000
+++ lib/offspring/web/queuemanager/tests/test_views.py	2011-10-17 19:26:36 +0000
@@ -1,9 +1,5 @@
 from django.core.urlresolvers import reverse
-from django.contrib.auth.models import (
-    AnonymousUser,
-    Group,
-    Permission,
-    )
+from django.contrib.auth.models import AnonymousUser
 from django.http import Http404
 from django.test import TestCase
 
@@ -13,6 +9,7 @@
     )
 from offspring.web.queuemanager.views import get_possibly_private_object
 from offspring.web.queuemanager.tests.factory import factory
+from offspring.web.queuemanager.tests.helpers import grant_permission_to_user
 
 
 class Test_get_possibly_private_object(TestCase):
@@ -309,14 +306,3 @@
 def make_user_and_login(client):
     user = factory.makeUser()
     return client.login(username=user.username, password=user.username)
-
-
-def grant_permission_to_user(user, permission):
-    group = Group(name=user.username)
-    group.save()
-    group.permissions.add(Permission.objects.get(codename=permission))
-    group.save()
-    user.groups.add(group)
-    user.save()
-    return user
-

=== modified file 'lib/offspring/web/templates/queuemanager/project_details.html'
--- lib/offspring/web/templates/queuemanager/project_details.html	2011-10-10 19:42:14 +0000
+++ lib/offspring/web/templates/queuemanager/project_details.html	2011-10-17 19:26:36 +0000
@@ -537,8 +537,16 @@
             contents:"${isSubscribed ? 'Unsubscribe' : 'Subscribe'} to Notifications",
             dynamicContents:true,
             icon: "/assets/images/mail--plus.png",
+{% if not user.is_authenticated %}
+            prompt: "You must login to manage your project build notification subscription",
+            disabled: true,
+{% else %} {% if project.is_private %}
+            prompt: "Build notification subscription disabled for private projects",
+            disabled: true,
+{% else %}
             prompt: "Manage project build notification subscription",
-            disabled: {% if user.is_authenticated %}false{% else %}true{% endif %},
+            disabled: false,
+{% endif %} {% endif %}
             click: function() {
                 toggle_subscription();
                 return false;