Merge lp:~salgado/offspring/sidebars into lp:~linaro-automation/offspring/private-builds

[Guilherme Salgado]

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

[James Tunnicliffe (dooferlad)]

Nice.

review: Approve

=== modified file 'lib/offspring/web/queuemanager/models.py'
--- lib/offspring/web/queuemanager/models.py	2011-10-19 14:51:51 +0000
+++ lib/offspring/web/queuemanager/models.py	2011-10-19 15:12:46 +0000
@@ -429,17 +429,18 @@
         else:
             return None
 
-    def recentBuildFailures(limit=5):
+    def recentBuildFailures(user, limit=5):
         #XXX: Should be method of custom model manager.
         threshold = datetime.now() - timedelta(weeks=2)
-        r = BuildResult.objects.select_related(
-            'project').filter(finished_at__gte = threshold).filter(
-            result = ProjectBuildStates.FAILED).order_by(
+        builds = BuildResult.all_objects.accessible_by_user(user)
+        query = models.Q(
+            finished_at__gte=threshold, result=ProjectBuildStates.FAILED)
+        builds = builds.select_related('project').filter(query).order_by(
             "finished_at").reverse()
         if limit is None:
-            return r
+            return builds
         else:
-            return r[:limit]
+            return builds[:limit]
     recentBuildFailures = staticmethod(recentBuildFailures)
 
 

=== modified file 'lib/offspring/web/queuemanager/templatetags/lexbuilder_sidebars.py'
--- lib/offspring/web/queuemanager/templatetags/lexbuilder_sidebars.py	2011-01-22 05:41:52 +0000
+++ lib/offspring/web/queuemanager/templatetags/lexbuilder_sidebars.py	2011-10-19 15:12:46 +0000
@@ -11,14 +11,31 @@
 
 register = template.Library()
 
-def show_sidebar_failedbuilds():
-    return { 'recent_failures' : BuildResult.recentBuildFailures() }
+def show_sidebar_failedbuilds(user):
+    return {'recent_failures': BuildResult.recentBuildFailures(user)}
 register.inclusion_tag('queuemanager/sidebars/failed_builds.html')(show_sidebar_failedbuilds)
 
-def show_sidebar_queuedbuilds():
-    return { 'pending_builds' : BuildRequest.objects.select_related('project', 'requestor').order_by("score").reverse()[:5] }
+def show_sidebar_queuedbuilds(user):
+    # Instead of filtering out the private builds the user is not allowed to
+    # see we state in the UI that there's a private build queued, but don't
+    # include any information about its project.
+    builds = BuildRequest.all_objects.select_related(
+        'project', 'requestor').order_by("score").reverse()[:5]
+    builds_to_show = {}
+    for build in builds:
+        builds_to_show[build] = build.is_visible_to(user)
+    return {'pending_builds': builds_to_show}
 register.inclusion_tag('queuemanager/sidebars/queued_builds.html')(show_sidebar_queuedbuilds)
 
-def show_sidebar_buildfarm():
-    return { 'lexbuilders' : Lexbuilder.objects.exclude(is_active=False).select_related('current_job__project').order_by("name") }
+def show_sidebar_buildfarm(user):
+    # Instead of filtering out the builders that are working on private
+    # projects the user is not allowed to see we state in the UI that it's
+    # working on a private project, without including any information about
+    # the project itself.
+    builders = Lexbuilder.all_objects.exclude(is_active=False).select_related(
+        'current_job__project').order_by("name")
+    builders_to_show = {}
+    for builder in builders:
+        builders_to_show[builder] = builder.is_visible_to(user)
+    return {'lexbuilders': builders_to_show}
 register.inclusion_tag('queuemanager/sidebars/build_farm.html')(show_sidebar_buildfarm)

=== modified file 'lib/offspring/web/queuemanager/tests/factory.py'
--- lib/offspring/web/queuemanager/tests/factory.py	2011-10-11 18:54:36 +0000
+++ lib/offspring/web/queuemanager/tests/factory.py	2011-10-19 15:12:46 +0000
@@ -67,14 +67,14 @@
         return group
 
     def makeBuildResult(self, project=None, name=None, result=None,
-                        builder=None):
+                        builder=None, finished_at=None):
         if name is None:
             name = self.getUniqueString()
         if project is None:
             project = self.makeProject()
             project.save()
         result = BuildResult(name=name, project=project, result=result,
-                             builder=builder)
+                             builder=builder, finished_at=finished_at)
         result.save()
         return result
 

=== modified file 'lib/offspring/web/queuemanager/tests/test_models.py'
--- lib/offspring/web/queuemanager/tests/test_models.py	2011-09-29 18:14:35 +0000
+++ lib/offspring/web/queuemanager/tests/test_models.py	2011-10-19 15:12:46 +0000
@@ -1,8 +1,10 @@
+from datetime import datetime
 from operator import attrgetter
 
 from django.contrib.auth.models import AnonymousUser
 from django.test import TestCase
 
+from offspring.enums import ProjectBuildStates
 from offspring.web.queuemanager.models import (
     BuildRequest,
     BuildResult,
@@ -204,6 +206,29 @@
     model = BuildResult
     factoryMethod = factory.makeBuildResult
 
+    def test_recentBuildFailures_public_project(self):
+        project = factory.makeProject(is_private=False)
+        build = self.makeFailedBuild(project)
+        self.assertEqual(
+            [build], list(build.recentBuildFailures(AnonymousUser())))
+
+    def test_recentBuildFailures_private_project_visible_to_user(self):
+        project = factory.makeProject(is_private=True)
+        build = self.makeFailedBuild(project)
+        self.assertEqual(
+            [build], list(build.recentBuildFailures(project.owner)))
+
+    def test_recentBuildFailures_private_project_invisible_to_user(self):
+        project = factory.makeProject(is_private=True)
+        build = self.makeFailedBuild(project)
+        self.assertEqual(
+            [], list(build.recentBuildFailures(factory.makeUser())))
+
+    def makeFailedBuild(self, project):
+        return factory.makeBuildResult(
+            project, result=ProjectBuildStates.FAILED,
+            finished_at=datetime.now())
+
 
 class BuildRequestTests(
         TestCase, ReleaseOrLexbuilderOrBuildResultOrBuildRequestTestsMixin):

=== modified file 'lib/offspring/web/queuemanager/tests/test_views.py'
--- lib/offspring/web/queuemanager/tests/test_views.py	2011-10-19 15:12:46 +0000
+++ lib/offspring/web/queuemanager/tests/test_views.py	2011-10-19 15:12:46 +0000
@@ -1,6 +1,12 @@
+from datetime import datetime
+
 from django.core.urlresolvers import reverse
 from django.contrib.auth.models import AnonymousUser
 from django.http import Http404
+from django.template import (
+    Context,
+    Template,
+    )
 from django.test import TestCase
 
 from offspring.enums import ProjectBuildStates
@@ -388,6 +394,93 @@
             msg_prefix=response.content)
 
 
+class FailedBuildsSidebarTests(TestCase):
+
+    template = Template(
+        "{% load lexbuilder_sidebars  %}"
+        "{% show_sidebar_failedbuilds user %}")
+
+    def test_public_builds(self):
+        build = self.makeBuildResult(is_private=False)
+        out = self.template.render(Context({'user': AnonymousUser()}))
+        self.assertTrue(build.name in out, out)
+
+    def test_private_builds_are_shown_if_user_has_rights(self):
+        build = self.makeBuildResult(is_private=True)
+        out = self.template.render(Context({'user': build.project.owner}))
+        self.assertTrue(build.name in out, out)
+
+    def test_private_builds_are_not_shown_if_user_has_no_rights(self):
+        build = self.makeBuildResult(is_private=True)
+        out = self.template.render(Context({'user': factory.makeUser()}))
+        self.assertTrue(build.name not in out, out)
+
+    def makeBuildResult(self, is_private):
+        project = factory.makeProject(is_private=is_private)
+        return factory.makeBuildResult(
+            project=project, result=ProjectBuildStates.FAILED,
+            finished_at=datetime.now())
+
+
+class QueuedBuildsSidebarTests(TestCase):
+
+    template = Template(
+        "{% load lexbuilder_sidebars  %}"
+        "{% show_sidebar_queuedbuilds user %}")
+
+    def test_public_builds(self):
+        build = self.makeBuildRequest(is_private=False)
+        out = self.template.render(Context({'user': AnonymousUser()}))
+        self.assertTrue(str(build) in out, out)
+
+    def test_private_builds_are_shown_if_user_has_rights(self):
+        build = self.makeBuildRequest(is_private=True)
+        out = self.template.render(Context({'user': build.project.owner}))
+        self.assertTrue(str(build) in out, out)
+
+    def test_private_builds_are_not_shown_if_user_has_no_rights(self):
+        build = self.makeBuildRequest(is_private=True)
+        out = self.template.render(Context({'user': factory.makeUser()}))
+        self.assertTrue(str(build) not in out, out)
+        self.assertTrue('Private build' in out, out)
+
+    def makeBuildRequest(self, is_private):
+        project = factory.makeProject(is_private=is_private)
+        return factory.makeBuildRequest(project=project)
+
+
+class BuildFarmSidebarTests(TestCase):
+
+    template = Template(
+        "{% load lexbuilder_sidebars  %}"
+        "{% show_sidebar_buildfarm user %}")
+
+    def test_public_builds(self):
+        builder = self.makeBuilderWithCurrentJob(is_private=False)
+        out = self.template.render(Context({'user': AnonymousUser()}))
+        self.assertTrue(builder.current_job.name in out, out)
+
+    def test_private_builds_are_shown_if_user_has_rights(self):
+        builder = self.makeBuilderWithCurrentJob(is_private=True)
+        out = self.template.render(
+            Context({'user': builder.current_job.project.owner}))
+        self.assertTrue(builder.current_job.name in out, out)
+
+    def test_private_builds_are_not_shown_if_user_has_no_rights(self):
+        builder = self.makeBuilderWithCurrentJob(is_private=True)
+        out = self.template.render(Context({'user': factory.makeUser()}))
+        self.assertTrue(builder.current_job.name not in out, out)
+        self.assertTrue('Private build' in out, out)
+
+    def makeBuilderWithCurrentJob(self, is_private):
+        project = factory.makeProject(is_private=is_private)
+        job = factory.makeBuildResult(project=project)
+        builder = factory.makeLexbuilder(current_job=job)
+        builder.current_state = 'BUILDING'
+        builder.save()
+        return builder
+
+
 def make_user_and_login(client):
     user = factory.makeUser()
     return client.login(username=user.username, password=user.username)

=== modified file 'lib/offspring/web/templates/base.html'
--- lib/offspring/web/templates/base.html	2011-10-10 20:12:47 +0000
+++ lib/offspring/web/templates/base.html	2011-10-19 15:12:46 +0000
@@ -112,17 +112,17 @@
         <ul id="sidebarul">
             {% block sidebar-failedbuilds %}
             <li>
-                {% show_sidebar_failedbuilds %}
+                {% show_sidebar_failedbuilds user %}
             </li>
             {% endblock %}
             {% block sidebar-queuedbuilds %}
             <li>
-                {% show_sidebar_queuedbuilds %}
+                {% show_sidebar_queuedbuilds user %}
             </li>
             {% endblock %}
             {% block sidebar-buildfarm %}
             <li class="gray">
-                {% show_sidebar_buildfarm %}
+                {% show_sidebar_buildfarm user %}
             </li>
             {% endblock %}
         </ul>

=== modified file 'lib/offspring/web/templates/queuemanager/sidebars/build_farm.html'
--- lib/offspring/web/templates/queuemanager/sidebars/build_farm.html	2010-11-29 08:27:24 +0000
+++ lib/offspring/web/templates/queuemanager/sidebars/build_farm.html	2011-10-19 15:12:46 +0000
@@ -3,17 +3,21 @@
 <h2>Build Farm</h2>
 <ul class="builder_status">
 {% if lexbuilders %}
-    {% for builder in lexbuilders %}
+    {% for builder, should_show_build in lexbuilders.items %}
     <li class="{{ builder.status }}">
         <a href="{% url builder_details builder %}" title="View builder details">{{ builder }}</a>: 
         {% ifequal builder.current_state "BUILDING" %}
         <p>
+          {% if should_show_build %}
             <a title="View project details" href="{% url offspring.web.queuemanager.views.project_details builder.current_build_projectname %}">
             {{builder.current_build_projectname}}
             </a>
             <a title="View build log in new window" target="_blank" href="{{ builder.current_build_projectname|link_results:builder.current_build_buildname }}/build-log.txt">
             ({{builder.current_build_buildname|default:"..."}})
             </a>
+          {% else %}
+            Private build
+          {% endif %}
         </p>
         {% else %}
             {{ builder.status }}

=== modified file 'lib/offspring/web/templates/queuemanager/sidebars/queued_builds.html'
--- lib/offspring/web/templates/queuemanager/sidebars/queued_builds.html	2010-11-29 08:27:24 +0000
+++ lib/offspring/web/templates/queuemanager/sidebars/queued_builds.html	2011-10-19 15:12:46 +0000
@@ -1,8 +1,12 @@
 <h2 class="blue">Pending Builds</h2>
 {% if pending_builds %}
 <ul class="builds_pending">
-    {% for build_request in pending_builds %}
+    {% for build_request, should_show in pending_builds.items %}
+      {% if should_show %}
         <li title="Build Pending"> <a href="{% url offspring.web.queuemanager.views.project_details build_request.project.name %}" title="{{ build_request }}{% if user.is_staff %} Score: {{ build_request.score }} {% endif %}">{{ build_request.project }}</a></li>
+      {% else %}
+        <li title="Build Pending">Private build</li>
+      {% endif %}
     {% endfor %}
 {% else %}
 <ul>