Merge lp:~cjohnston/ubuntu-ci-services-itself/ts-opentickets-api into lp:ubuntu-ci-services-itself

[Chris Johnston]

Add an open tickets API call to the TS for the WebUI

The WebUI needs a way to only show open tickets. This provides an API call for that.

[Ursula Junque (ursinha)]

Looks good. I'd probably try to write some helpers in tests so the code could become a bit smaller, but that's up to you. Approving.

review: Approve

=== modified file 'docs/components/ticket-system.rst'
--- docs/components/ticket-system.rst	2014-01-17 01:32:56 +0000
+++ docs/components/ticket-system.rst	2014-01-20 16:43:21 +0000
@@ -175,7 +175,7 @@
 
  curl --dump-header - http://localhost:8000/api/v1/ticket/1/
 
-Get Next Ticket
+Get next ticket
 ~~~~~~~~~~~~~~~
 
 Show the current in progress, or the first pending ticket.
@@ -184,6 +184,15 @@
 
  curl --dump-header - http://localhost:8000/api/v1/next/
 
+Get open tickets
+~~~~~~~~~~~~~~~~
+
+Show a list of all open tickets.
+
+::
+
+ curl --dump-header - http://localhost:8000/api/v1/opentickets/
+
 Get ticket status
 ~~~~~~~~~~~~~~~~~
 

=== modified file 'ticket_system/ticket/api.py'
--- ticket_system/ticket/api.py	2014-01-16 15:41:39 +0000
+++ ticket_system/ticket/api.py	2014-01-20 16:43:21 +0000
@@ -54,6 +54,20 @@
         authorization = Authorization()
 
 
+class OpenTicketResource(TicketTranslatedResource):
+
+    class Meta:
+        queryset = Ticket.objects.all()
+        allowed_methods = ['get']
+        resource_name = 'opentickets'
+
+    def get_object_list(self, request):
+        exclude = [TicketWorkflowStep.NEW.value,
+                   TicketWorkflowStep.COMPLETED.value]
+        return super(OpenTicketResource, self).get_object_list(
+            request).exclude(current_workflow_step__in=exclude).order_by('id')
+
+
 class SourcePackageUploadResource(ModelResource):
     sourcepackage = fields.ToOneField(SourcePackageResource, 'sourcepackage',
                                       full=True)

=== modified file 'ticket_system/ticket/tests/test_read_api.py'
--- ticket_system/ticket/tests/test_read_api.py	2014-01-15 00:32:04 +0000
+++ ticket_system/ticket/tests/test_read_api.py	2014-01-20 16:43:21 +0000
@@ -31,7 +31,6 @@
         self.subticket = mommy.make('SubTicket', ticket=self.ticket,
                                     source_package_upload=self.spu)
         self.artifact = mommy.make('Artifact', subticket=self.subticket)
-        self.maxDiff = None
 
     def test_get_artifact_api(self):
         obj = self.getResource('artifact/')
@@ -249,3 +248,113 @@
             u'status': unicode(get_enum_title(self.subticket.status,
                                SubTicketWorkflowStepStatus)),
         })
+
+
+class GetOpenTicketsTest(TastypieTestCase):
+    """
+    Test that /opentickets/ returns only in progress and queued tickets.
+    """
+
+    def setUp(self):
+        super(GetOpenTicketsTest, self).setUp('/api/v1')
+        self.ticket_1 = mommy.make(
+            'Ticket', current_workflow_step=int(TicketWorkflowStep.NEW))
+        self.ticket_2 = mommy.make(
+            'Ticket', current_workflow_step=int(TicketWorkflowStep.QUEUED))
+        self.ticket_3 = mommy.make(
+            'Ticket', current_workflow_step=int(
+                TicketWorkflowStep.PKG_BUILDING))
+        self.ticket_4 = mommy.make(
+            'Ticket', current_workflow_step=int(
+                TicketWorkflowStep.IMAGE_BUILDING))
+        self.ticket_5 = mommy.make(
+            'Ticket', current_workflow_step=int(
+                TicketWorkflowStep.IMAGE_TESTING))
+        self.ticket_6 = mommy.make(
+            'Ticket', current_workflow_step=int(
+                TicketWorkflowStep.PKG_PUBLISHING))
+        self.ticket_7 = mommy.make(
+            'Ticket', current_workflow_step=int(TicketWorkflowStep.COMPLETED))
+        self.sourcepackage = mommy.make('SourcePackage')
+        self.spu = mommy.make('SourcePackageUpload',
+                              sourcepackage=self.sourcepackage)
+        self.subticket_1 = mommy.make('SubTicket', ticket=self.ticket_1,
+                                      source_package_upload=self.spu)
+        self.artifact_1 = mommy.make('Artifact', subticket=self.subticket_1)
+        self.subticket_2 = mommy.make('SubTicket', ticket=self.ticket_2,
+                                      source_package_upload=self.spu)
+        self.artifact_2 = mommy.make('Artifact', subticket=self.subticket_2)
+        self.subticket_3 = mommy.make('SubTicket', ticket=self.ticket_3,
+                                      source_package_upload=self.spu)
+        self.artifact_3 = mommy.make('Artifact', subticket=self.subticket_3)
+        self.subticket_4 = mommy.make('SubTicket', ticket=self.ticket_4,
+                                      source_package_upload=self.spu)
+        self.artifact_4 = mommy.make('Artifact', subticket=self.subticket_4)
+        self.subticket_5 = mommy.make('SubTicket', ticket=self.ticket_5,
+                                      source_package_upload=self.spu)
+        self.artifact_5 = mommy.make('Artifact', subticket=self.subticket_5)
+        self.subticket_6 = mommy.make('SubTicket', ticket=self.ticket_6,
+                                      source_package_upload=self.spu)
+        self.artifact_6 = mommy.make('Artifact', subticket=self.subticket_6)
+        self.subticket_7 = mommy.make('SubTicket', ticket=self.ticket_7,
+                                      source_package_upload=self.spu)
+        self.artifact_7 = mommy.make('Artifact', subticket=self.subticket_7)
+
+    def test_total_open_tickets(self):
+        obj = self.getResource('opentickets/')
+        self.assertEqual(len(obj['objects']), 5)
+
+    def test_open_ticket_syntax(self):
+        self.ticket_2.current_workflow_step = int(
+            TicketWorkflowStep.NEW)
+        self.ticket_2.save()
+        self.ticket_3.current_workflow_step = int(
+            TicketWorkflowStep.NEW)
+        self.ticket_3.save()
+        self.ticket_4.current_workflow_step = int(
+            TicketWorkflowStep.NEW)
+        self.ticket_4.save()
+        self.ticket_5.current_workflow_step = int(
+            TicketWorkflowStep.NEW)
+        self.ticket_5.save()
+        obj = self.getResource('opentickets/')
+        self.assertEqual(obj['objects'][0], {
+            u'added_binaries': self.ticket_6.added_binaries,
+            u'status': unicode(get_enum_title(self.ticket_6.status,
+                               TicketWorkflowStepStatus)),
+            u'created': unicode(self.ticket_6.created.strftime(
+                "%Y-%m-%dT%H:%M:%S.%f")),
+            u'current_workflow_step': unicode(get_enum_title(
+                self.ticket_6.current_workflow_step,
+                TicketWorkflowStep)),
+            u'description': unicode(self.ticket_6.description),
+            u'title': unicode(self.ticket_6.title),
+            u'bug_id': self.ticket_6.bug_id,
+            u'owner': unicode(self.ticket_6.owner),
+            u'removed_binaries': self.ticket_6.removed_binaries,
+            u'base_image': unicode(self.ticket_6.base_image),
+            u'id': self.ticket_6.pk,
+            u'resource_uri': u'/api/v1/opentickets/{0}/'.format(
+                self.ticket_6.pk),
+            u'updated': unicode(self.ticket_6.updated.strftime(
+                "%Y-%m-%dT%H:%M:%S.%f")),
+        })
+
+    def test_no_open_tickets(self):
+        self.ticket_2.current_workflow_step = int(
+            TicketWorkflowStep.NEW)
+        self.ticket_2.save()
+        self.ticket_3.current_workflow_step = int(
+            TicketWorkflowStep.NEW)
+        self.ticket_3.save()
+        self.ticket_4.current_workflow_step = int(
+            TicketWorkflowStep.NEW)
+        self.ticket_4.save()
+        self.ticket_5.current_workflow_step = int(
+            TicketWorkflowStep.NEW)
+        self.ticket_5.save()
+        self.ticket_6.current_workflow_step = int(
+            TicketWorkflowStep.NEW)
+        self.ticket_6.save()
+        obj = self.getResource('opentickets/')
+        self.assertEqual(len(obj['objects']), 0)

=== modified file 'ticket_system/ticket_system/urls.py'
--- ticket_system/ticket_system/urls.py	2014-01-15 21:12:09 +0000
+++ ticket_system/ticket_system/urls.py	2014-01-20 16:43:21 +0000
@@ -23,7 +23,7 @@
                         FullTicketResource, FullArtifactResource,
                         TicketStatusResource, TicketUpdateStatusResource,
                         SubTicketUpdateStatusResource, NextTicketResource,
-                        SubTicketStatusResource)
+                        SubTicketStatusResource, OpenTicketResource)
 
 admin.autodiscover()
 v1_api = Api(api_name='v1')
@@ -42,6 +42,7 @@
 v1_api.register(TicketUpdateStatusResource())
 v1_api.register(TicketStatusResource())
 v1_api.register(NextTicketResource())
+v1_api.register(OpenTicketResource())
 
 urlpatterns = patterns(
     '',