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

[Chris Johnston]

Add next/ API for the lander to get tickets from the TS

Adds a next/ api for the lander to either get the current ticket in progress, or if there are no in progress tickets, the next ticket in the queue.

[Francis Ginther (fginther)]

Approve from the lander (api consumer) perspective.

review: Approve

[Andy Doan (doanac)]

On 01/15/2014 03:14 PM, Chris Johnston wrote:
> + def get_object_list(self, request):
> + exclude = ['000', '1000']
> + in_progress = ['200', '300', '400', '500']

aren't there constants in models.py we can use instead?

[Chris Johnston (cjohnston)]

How do you suggest using them?

[Andy Doan (doanac)]

On 01/16/2014 07:02 AM, Chris Johnston wrote:
> How do you suggest using them?

This is one way, and I'm sure 2 other people would have 2 more ways, but:

  exclude = [
      TicketWorkflowStepStatus.NEW.value,
      TicketWorkflowStepStatus.COMPLETE.value,
  ]

[lp:~cjohnston/ubuntu-ci-services-itself/ts-next]

104. By Chris Johnston on 2014-01-16

Update per review

[Chris Johnston (cjohnston)]

review: Needs Resubmitting

[Andy Doan (doanac)]

review: Approve

=== modified file 'docs/components/ticket-system.rst'
--- docs/components/ticket-system.rst	2014-01-15 02:23:07 +0000
+++ docs/components/ticket-system.rst	2014-01-16 15:41:47 +0000
@@ -171,6 +171,10 @@
 
 Show the current in progress, or the first pending ticket.
 
+::
+
+ curl --dump-header - http://162.213.34.2:8000/api/v1/next/
+
 get_ticket_status
 ~~~~~~~~~~~~~~~~~
 
 
=== modified file 'ticket_system/ticket/api.py'
--- ticket_system/ticket/api.py	2014-01-15 00:31:20 +0000
+++ ticket_system/ticket/api.py	2014-01-16 15:41:47 +0000
@@ -161,3 +161,31 @@
         filtering = {
             "current_workflow_step": ALL,
         }
+
+
+class NextTicketResource(TicketTranslatedResource):
+    subticket = fields.ToManyField(FullSubTicketResource, 'subticket_set',
+                                   full=True)
+
+    class Meta:
+        queryset = Ticket.objects.all()
+        allowed_methods = ['get']
+        resource_name = 'next'
+
+    def get_object_list(self, request):
+        exclude = [TicketWorkflowStep.NEW.value,
+                   TicketWorkflowStep.COMPLETED.value]
+        in_progress = [TicketWorkflowStep.PKG_BUILDING.value,
+                       TicketWorkflowStep.IMAGE_BUILDING.value,
+                       TicketWorkflowStep.IMAGE_TESTING.value,
+                       TicketWorkflowStep.PKG_PUBLISHING.value]
+        qs = super(NextTicketResource, self).get_object_list(request).exclude(
+            current_workflow_step__in=exclude).order_by('id')[:1]
+        process = Ticket.objects.exclude(
+            current_workflow_step__in=exclude,
+        ).filter(current_workflow_step__in=in_progress)
+        if process:
+            qs = process
+        else:
+            qs = qs
+        return qs
 
=== modified file 'ticket_system/ticket/tests/test_full_read_api.py'
--- ticket_system/ticket/tests/test_full_read_api.py	2014-01-09 21:06:18 +0000
+++ ticket_system/ticket/tests/test_full_read_api.py	2014-01-16 15:41:47 +0000
@@ -123,3 +123,120 @@
             u'resource_uri': u'/api/v1/fullsubticket/{0}/'.format(
                 self.subticket.pk),
         })
+
+
+class GetNextTicketTest(TastypieTestCase):
+    """
+    Test that /next/ returns the current inprogress ticket, or the next
+    'queued' ticket.
+    """
+    def setUp(self):
+        super(GetNextTicketTest, 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.QUEUED))
+        self.ticket_4 = 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)
+
+    def test_queued_ticket_next(self):
+        obj = self.getResource('next/')
+        self.assertEqual(len(obj['objects']), 1)
+        self.assertEqual(obj['objects'][0][u'resource_uri'],
+                         u'/api/v1/next/{0}/'.format(
+                             self.ticket_2.pk))
+        self.assertEqual(
+            obj['objects'][0][u'current_workflow_step'], get_enum_title(
+                self.ticket_2.current_workflow_step, TicketWorkflowStep))
+
+    def test_pkg_building_ticket_next(self):
+        self.ticket_3.current_workflow_step = int(
+            TicketWorkflowStep.PKG_BUILDING)
+        self.ticket_3.save()
+        obj = self.getResource('next/')
+        self.assertEqual(len(obj['objects']), 1)
+        self.assertEqual(obj['objects'][0][u'resource_uri'],
+                         u'/api/v1/next/{0}/'.format(
+                             self.ticket_3.pk))
+        self.assertEqual(
+            obj['objects'][0][u'current_workflow_step'], get_enum_title(
+                self.ticket_3.current_workflow_step, TicketWorkflowStep))
+
+    def test_image_building_ticket_next(self):
+        self.ticket_3.current_workflow_step = int(
+            TicketWorkflowStep.IMAGE_BUILDING)
+        self.ticket_3.save()
+        obj = self.getResource('next/')
+        self.assertEqual(len(obj['objects']), 1)
+        self.assertEqual(obj['objects'][0][u'resource_uri'],
+                         u'/api/v1/next/{0}/'.format(
+                             self.ticket_3.pk))
+        self.assertEqual(
+            obj['objects'][0][u'current_workflow_step'], get_enum_title(
+                self.ticket_3.current_workflow_step, TicketWorkflowStep))
+
+    def test_image_testing_ticket_next(self):
+        self.ticket_3.current_workflow_step = int(
+            TicketWorkflowStep.IMAGE_TESTING)
+        self.ticket_3.save()
+        obj = self.getResource('next/')
+        self.assertEqual(len(obj['objects']), 1)
+        self.assertEqual(obj['objects'][0][u'resource_uri'],
+                         u'/api/v1/next/{0}/'.format(
+                             self.ticket_3.pk))
+        self.assertEqual(
+            obj['objects'][0][u'current_workflow_step'], get_enum_title(
+                self.ticket_3.current_workflow_step, TicketWorkflowStep))
+
+    def test_pkg_publishing_ticket_next(self):
+        self.ticket_3.current_workflow_step = int(
+            TicketWorkflowStep.PKG_PUBLISHING)
+        self.ticket_3.save()
+        obj = self.getResource('next/')
+        self.assertEqual(len(obj['objects']), 1)
+        self.assertEqual(obj['objects'][0][u'resource_uri'],
+                         u'/api/v1/next/{0}/'.format(
+                             self.ticket_3.pk))
+        self.assertEqual(
+            obj['objects'][0][u'current_workflow_step'], get_enum_title(
+                self.ticket_3.current_workflow_step, TicketWorkflowStep))
+
+    def test_ticket_complete_next_new_ticket_next(self):
+        self.ticket_3.current_workflow_step = int(
+            TicketWorkflowStep.COMPLETED)
+        self.ticket_3.save()
+        obj = self.getResource('next/')
+        self.assertEqual(len(obj['objects']), 1)
+        self.assertEqual(obj['objects'][0][u'resource_uri'],
+                         u'/api/v1/next/{0}/'.format(
+                             self.ticket_2.pk))
+        self.assertEqual(
+            obj['objects'][0][u'current_workflow_step'], get_enum_title(
+                self.ticket_2.current_workflow_step, TicketWorkflowStep))
+
+    def test_no_queued_or_in_progress_ticket_next(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()
+        obj = self.getResource('next/')
+        self.assertEqual(len(obj['objects']), 0)
 
=== modified file 'ticket_system/ticket_system/urls.py'
--- ticket_system/ticket_system/urls.py	2014-01-15 00:16:52 +0000
+++ ticket_system/ticket_system/urls.py	2014-01-16 15:41:47 +0000
@@ -21,9 +21,9 @@
 from ticket.api import (TicketResource, SubTicketResource, ArtifactResource,
                         SourcePackageUploadResource, FullSubTicketResource,
                         FullTicketResource, FullArtifactResource,
-                        SubTicketUpdateStatusResource,
-                        SubTicketStatusResource,
-                        TicketStatusResource, TicketUpdateStatusResource)
+                        TicketStatusResource, TicketUpdateStatusResource,
+                        SubTicketUpdateStatusResource, NextTicketResource,
+                        SubTicketStatusResource)
 
 admin.autodiscover()
 v1_api = Api(api_name='v1')
@@ -41,6 +41,7 @@
 v1_api.register(SubTicketStatusResource())
 v1_api.register(TicketUpdateStatusResource())
 v1_api.register(TicketStatusResource())
+v1_api.register(NextTicketResource())
 
 urlpatterns = patterns(
     '',