Merge lp:~cjohnston/ubuntu-ci-services-itself/ts-ticket-more-write-api into lp:ubuntu-ci-services-itself

[Chris Johnston]

Add a write API to the TS SubTicket/SPU/Artifact resources

- Removed set ticket status and set subticket status as they will both be done on a pull basis for phase 0.
- Added write API to SubTicket, Artifact, and SPU resources
- Updated docs

[Francis Ginther (fginther)]

The API looks reasonable for what was discussed in IRC. I would recommend an example if someone else was working on the CLI, but in this case it's not needed.

I noticed a few doc rendering issues caused by a missing line between '::' and the following code snippet.

review: Approve

[Chris Johnston (cjohnston)]

I will fix the doc in the second branch just to not cause any issues with conflicts.

=== modified file 'docs/components/ticket-system.rst'
--- docs/components/ticket-system.rst	2013-12-17 16:50:29 +0000
+++ docs/components/ticket-system.rst	2013-12-20 19:48:25 +0000
@@ -32,6 +32,13 @@
 * Handle status updates from the Landing Manager.
 * Provide read API for the Web Server.
 
+TODO:
+-----
+
+* Bundle the ticket creation API
+
+  * For speed, I have left the different APIs to fully create a ticket as seperate. If/when there is time, it would be much improved to bundle this together into one single 'Bundle API'
+
 Future
 ------
 
@@ -146,6 +153,10 @@
 
 Create a ticket from one or more source package uploads.
 
+::
+
+ curl --dump-header - -H "Content-Type: application/json" -X POST --data '{"owner": "[e-mail]", "title": "My first ticket", "description": "This if my first ticket. See what it can do", "bug_id": "12345", "added_binaries": "binary-1,binary-2", "removed_binaries": "binary-3,binary-4"}' http://localhost:8000/api/v1/ticket/
+
 get_ticket
 ~~~~~~~~~~
 
@@ -160,15 +171,25 @@
 
 Get the ticket status.
 
-set_ticket_status
-~~~~~~~~~~~~~~~~~
-
-Set the ticket status.
-
-set_subticket_status
-~~~~~~~~~~~~~~~~~~~~
-
-Set a subticket status, given the ticket number and the source package name.
+create_source_package_upload
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+::
+
+ curl --dump-header - -H "Content-Type: application/json" -X POST --data '{"sourcepackage": "/api/v1/sourcepackage/X/", "version": "1.0"}' http://localhost:8000/api/v1/spu/
+
+create_artifact
+~~~~~~~~~~~~~~~
+
+::
+
+ curl --dump-header - -H "Content-Type: application/json" -X POST --data '{"name": "my_artifact", "ticket_component": "/api/v1/ticket/X/", "reference": "http://path.to/artifact/", "type": "SPU"}' http://localhost:8000/api/v1/artifact/
+
+create_subticket
+~~~~~~~~~~~~~~~~
+
+::
+ curl --dump-header - -H "Content-Type: application/json" -X POST --data '{"source_package_upload": "/api/v1/spu/X/, "ticket": "/api/v1/ticket/X/, "assignee": "[e-mail]"}' http://localhost:8000/api/v1/subticket/
 
 Person
 ------

=== modified file 'ticket_system/project/admin.py'
--- ticket_system/project/admin.py	2013-12-09 19:35:22 +0000
+++ ticket_system/project/admin.py	2013-12-20 19:48:25 +0000
@@ -23,9 +23,8 @@
 
 
 class BinaryPackageAdmin(admin.ModelAdmin):
-    list_filter = ['seeded']
     search_fields = ['name', 'sourcepackage']
-    list_display = ('name', 'sourcepackage', 'seeded')
+    list_display = ('name', 'sourcepackage')
 
 admin.site.register(SourcePackage, SourcePackageAdmin)
 admin.site.register(BinaryPackage, BinaryPackageAdmin)

=== modified file 'ticket_system/ticket/api.py'
--- ticket_system/ticket/api.py	2013-12-19 20:25:35 +0000
+++ ticket_system/ticket/api.py	2013-12-20 19:48:25 +0000
@@ -35,7 +35,9 @@
 
     class Meta:
         queryset = SourcePackageUpload.objects.all()
-        allowed_methods = ['get']
+        allowed_methods = ['get', 'post']
+        authorization = Authorization()
+        resource_name = 'spu'
 
 
 class SubTicketResource(ModelResource):
@@ -46,7 +48,8 @@
 
     class Meta:
         queryset = SubTicket.objects.all()
-        allowed_methods = ['get']
+        allowed_methods = ['get', 'post']
+        authorization = Authorization()
 
 
 class ArtifactResource(ModelResource):
@@ -55,7 +58,8 @@
 
     class Meta:
         queryset = Artifact.objects.all()
-        allowed_methods = ['get']
+        allowed_methods = ['get', 'post']
+        authorization = Authorization()
 
 
 class FullArtifactResource(ModelResource):

=== modified file 'ticket_system/ticket/tests/test_full_read_api.py'
--- ticket_system/ticket/tests/test_full_read_api.py	2013-12-19 17:26:40 +0000
+++ ticket_system/ticket/tests/test_full_read_api.py	2013-12-20 19:48:25 +0000
@@ -57,7 +57,7 @@
                         u'name': unicode(self.sourcepackage.name)},
                     u'id': self.spu.pk,
                     u'resource_uri':
-                    u'/api/v1/sourcepackageupload/{0}/'.format(self.spu.pk)},
+                    u'/api/v1/spu/{0}/'.format(self.spu.pk)},
                 u'id': self.subticket.pk,
                 u'resource_uri': u'/api/v1/fullsubticket/{0}/'.format(
                     self.subticket.pk)}],
@@ -107,7 +107,7 @@
                     u'name': unicode(self.sourcepackage.name)},
                 u'id': self.spu.pk,
                 u'resource_uri':
-                u'/api/v1/sourcepackageupload/{0}/'.format(self.spu.pk)},
+                u'/api/v1/spu/{0}/'.format(self.spu.pk)},
             u'id': self.subticket.pk,
             u'resource_uri': u'/api/v1/fullsubticket/{0}/'.format(
                 self.subticket.pk),

=== modified file 'ticket_system/ticket/tests/test_read_api.py'
--- ticket_system/ticket/tests/test_read_api.py	2013-12-19 16:07:20 +0000
+++ ticket_system/ticket/tests/test_read_api.py	2013-12-20 19:48:25 +0000
@@ -47,7 +47,7 @@
                         u'name': unicode(self.sourcepackage.name)},
                     u'id': self.spu.pk,
                     u'resource_uri':
-                    u'/api/v1/sourcepackageupload/{0}/'.format(self.spu.pk)},
+                    u'/api/v1/spu/{0}/'.format(self.spu.pk)},
                 u'ticket': {
                     u'status': self.ticket.status,
                     u'current_workflow_step':
@@ -83,7 +83,7 @@
                     u'name': unicode(self.sourcepackage.name)},
                 u'id': self.spu.pk,
                 u'resource_uri':
-                u'/api/v1/sourcepackageupload/{0}/'.format(self.spu.pk)},
+                u'/api/v1/spu/{0}/'.format(self.spu.pk)},
             u'ticket': {
                 u'status': self.ticket.status,
                 u'current_workflow_step':
@@ -118,7 +118,7 @@
         })
 
     def test_get_sourcepackageupload_api(self):
-        obj = self.getResource('sourcepackageupload/')
+        obj = self.getResource('spu/')
         self.assertEqual(obj['objects'][0], {
             u'version': unicode(self.spu.version),
             u'sourcepackage': {
@@ -128,5 +128,5 @@
                 u'name': unicode(self.sourcepackage.name)},
             u'id': self.spu.pk,
             u'resource_uri':
-            u'/api/v1/sourcepackageupload/{0}/'.format(self.spu.pk),
+            u'/api/v1/spu/{0}/'.format(self.spu.pk),
         })

=== modified file 'ticket_system/ticket/tests/test_write_api.py'
--- ticket_system/ticket/tests/test_write_api.py	2013-12-19 20:25:35 +0000
+++ ticket_system/ticket/tests/test_write_api.py	2013-12-20 19:48:25 +0000
@@ -15,7 +15,7 @@
 
 from model_mommy import mommy
 from ci_utils.tastypie.test import TastypieTestCase
-from ticket.models import Ticket
+from ticket.models import Ticket, SourcePackageUpload, SubTicket, Artifact
 
 
 class APICreateTicketResourceTest(TastypieTestCase):
@@ -59,3 +59,134 @@
     def test_delete_ticket_not_allowed(self):
         resp = self.delete(resource=self.detail_url)
         self.assertHttpMethodNotAllowed(resp)
+
+
+class APICreateSPUResourceTest(TastypieTestCase):
+
+    def setUp(self):
+        super(APICreateSPUResourceTest, self).setUp('/api/v1')
+        self.sourcepackage = mommy.make('SourcePackage')
+        self.spu = mommy.make('SourcePackageUpload',
+                              sourcepackage=self.sourcepackage)
+        self.resource = 'spu/'
+        self.detail_url = self.resource + '{0}/'.format(self.spu.pk)
+        self.sourcepackage_uri = '/api/v1/sourcepackage/{0}/'.format(
+            self.sourcepackage.pk)
+        self.post_spu_data = {
+            'sourcepackage': self.sourcepackage_uri,
+            'version': '1.0',
+        }
+
+    def test_post_spu(self):
+        # Check how many are there first.
+        self.assertEqual(SourcePackageUpload.objects.count(), 1)
+        self.post(resource=self.resource, params=self.post_spu_data)
+        # Verify a new one has been added.
+        self.assertEqual(SourcePackageUpload.objects.count(), 2)
+
+    def test_patch_detail(self):
+        # Grab the current data & modify it slightly.
+        original_data = self.getResource(self.detail_url)
+        new_data = original_data.copy()
+        new_data['version'] = '2.0'
+
+        self.assertEqual(SourcePackageUpload.objects.count(), 1)
+        resp = self.client.patch('/api/v1/' + self.detail_url, data=new_data)
+        self.assertHttpMethodNotAllowed(resp)
+        # Make sure the count hasn't changed & we did an update.
+        self.assertEqual(SourcePackageUpload.objects.count(), 1)
+        # Check for updated data.
+        self.assertEqual(SourcePackageUpload.objects.get(
+                         pk=self.spu.pk).version, self.spu.version)
+
+    def test_delete_spu_not_allowed(self):
+        resp = self.delete(resource=self.detail_url)
+        self.assertHttpMethodNotAllowed(resp)
+
+
+class APICreateSubTicketResourceTest(TastypieTestCase):
+
+    def setUp(self):
+        super(APICreateSubTicketResourceTest, self).setUp('/api/v1')
+        self.ticket = mommy.make('Ticket')
+        self.spu = mommy.make('SourcePackageUpload')
+        self.subticket = mommy.make('SubTicket', ticket=self.ticket,
+                                    source_package_upload=self.spu)
+        self.resource = 'subticket/'
+        self.detail_url = self.resource + '{0}/'.format(self.subticket.pk)
+        self.ticket_uri = '/api/v1/spu/{0}/'.format(self.ticket.pk)
+        self.spu_uri = '/api/v1/spu/{0}/'.format(self.spu.pk)
+        self.post_subticket_data = {
+            'source_package_upload': self.spu_uri,
+            'ticket': self.ticket_uri,
+            'assignee': '[e-mail]',
+        }
+
+    def test_post_subticket(self):
+        # Check how many are there first.
+        self.assertEqual(SubTicket.objects.count(), 1)
+        self.post(resource=self.resource, params=self.post_subticket_data)
+        # Verify a new one has been added.
+        self.assertEqual(SubTicket.objects.count(), 2)
+
+    def test_patch_detail(self):
+        # Grab the current data & modify it slightly.
+        original_data = self.getResource(self.detail_url)
+        new_data = original_data.copy()
+        new_data['assignee'] = '[e-mail]'
+
+        self.assertEqual(SubTicket.objects.count(), 1)
+        resp = self.client.patch('/api/v1/' + self.detail_url, data=new_data)
+        self.assertHttpMethodNotAllowed(resp)
+        # Make sure the count hasn't changed & we did an update.
+        self.assertEqual(SubTicket.objects.count(), 1)
+        # Check for updated data.
+        self.assertEqual(SubTicket.objects.get(pk=self.subticket.pk).assignee,
+                         self.subticket.assignee)
+
+    def test_delete_subticket_not_allowed(self):
+        resp = self.delete(resource=self.detail_url)
+        self.assertHttpMethodNotAllowed(resp)
+
+
+class APICreateArtifactResourceTest(TastypieTestCase):
+
+    def setUp(self):
+        super(APICreateArtifactResourceTest, self).setUp('/api/v1')
+        self.subticket = mommy.make('SubTicket')
+        self.artifact = mommy.make('Artifact', ticket_component=self.subticket)
+        self.resource = 'artifact/'
+        self.detail_url = self.resource + '{0}/'.format(self.artifact.pk)
+        self.subticket_uri = '/api/v1/subticket/{0}/'.format(self.subticket.pk)
+        self.post_artifact_data = {
+            'type': 'SPU',
+            'name': 'my_artifact',
+            'ticket_component': self.subticket_uri,
+            'reference': 'm1CTLg5FHY',
+        }
+
+    def test_post_artifact(self):
+        # Check how many are there first.
+        self.assertEqual(Artifact.objects.count(), 1)
+        self.post(resource=self.resource, params=self.post_artifact_data)
+        # Verify a new one has been added.
+        self.assertEqual(Artifact.objects.count(), 2)
+
+    def test_patch_detail(self):
+        # Grab the current data & modify it slightly.
+        original_data = self.getResource(self.detail_url)
+        new_data = original_data.copy()
+        new_data['name'] = 'my_upload'
+
+        self.assertEqual(Artifact.objects.count(), 1)
+        resp = self.client.patch('/api/v1/' + self.detail_url, data=new_data)
+        self.assertHttpMethodNotAllowed(resp)
+        # Make sure the count hasn't changed & we did an update.
+        self.assertEqual(Artifact.objects.count(), 1)
+        # Check for updated data.
+        self.assertEqual(Artifact.objects.get(pk=self.artifact.pk).name,
+                         self.artifact.name)
+
+    def test_delete_artifact_not_allowed(self):
+        resp = self.delete(resource=self.detail_url)
+        self.assertHttpMethodNotAllowed(resp)