Merge lp:~bac/launchpad/904335-export-tags into lp:launchpad

[Brad Crittenden]

Export the getTags and setTags methods to the API.

Tests:
bin/test -vv lp.registry.tests.test_milestonetag MilestoneTagWebserviceTest

No real lint.

[j.c.sackett (jcsackett)]

This looks good; you could change the webservice test case to use the WebServiceTestCase. That may save you some setup, but it's not actually necessary.

review: Approve

=== modified file 'lib/lp/registry/interfaces/milestone.py'
--- lib/lp/registry/interfaces/milestone.py	2012-01-10 14:38:32 +0000
+++ lib/lp/registry/interfaces/milestone.py	2012-01-10 14:38:32 +0000
@@ -25,6 +25,7 @@
     export_factory_operation,
     export_operation_as,
     export_read_operation,
+    export_write_operation,
     exported,
     operation_for_version,
     operation_parameters,
@@ -44,6 +45,7 @@
     Bool,
     Choice,
     Int,
+    List,
     TextLine,
     )
 
@@ -228,6 +230,16 @@
 
     export_as_webservice_entry()
 
+    @operation_parameters(
+        tags=List(
+            title=_("Tags for this milestone"),
+            description=_("Space-separated keywords for classifying "
+                          "this milestone."),
+            value_type=TextLine()))
+
+    @call_with(user=REQUEST_USER)
+    @export_write_operation()
+    @operation_for_version('devel')
     def setTags(tags, user):
         """Set the milestone tags.
 
@@ -246,6 +258,8 @@
         why this is not a property.
         """
 
+    @export_read_operation()
+    @operation_for_version('devel')
     def getTags():
         """Return the milestone tags in alphabetical order.
 

=== modified file 'lib/lp/registry/model/milestone.py'
--- lib/lp/registry/model/milestone.py	2012-01-10 14:38:32 +0000
+++ lib/lp/registry/model/milestone.py	2012-01-10 14:38:32 +0000
@@ -308,9 +308,9 @@
         # Prevent circular references.
         from lp.registry.model.milestonetag import MilestoneTag
         store = Store.of(self)
-        return store.find(
+        return list(store.find(
             MilestoneTag, MilestoneTag.milestone_id == self.id
-            ).order_by(MilestoneTag.tag)
+            ).order_by(MilestoneTag.tag))
 
     def getTags(self):
         """See IMilestone."""

=== modified file 'lib/lp/registry/tests/test_milestonetag.py'
--- lib/lp/registry/tests/test_milestonetag.py	2012-01-10 14:38:32 +0000
+++ lib/lp/registry/tests/test_milestonetag.py	2012-01-10 14:38:32 +0000
@@ -1,13 +1,15 @@
-# Copyright 2011 Canonical Ltd.  This software is licensed under the
+# Copyright 2011-2012 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 """Milestone related test helper."""
 
 __metaclass__ = type
 
+import transaction
 import datetime
 
 from lp.testing.layers import (
+    AppServerLayer,
     DatabaseFunctionalLayer,
     )
 from lp.registry.model.milestonetag import (
@@ -17,6 +19,8 @@
 from lp.testing import (
     person_logged_in,
     TestCaseWithFactory,
+    WebServiceTestCase,
+    ws_object,
     )
 
 
@@ -33,13 +37,13 @@
 
     def test_no_tags(self):
         # Ensure a newly created milestone does not have associated tags.
-        self.assertEquals([], list(self.milestone.getTags()))
+        self.assertEquals([], self.milestone.getTags())
 
     def test_tags_setting_and_retrieval(self):
         # Ensure tags are correctly saved and retrieved from the db.
         with person_logged_in(self.person):
             self.milestone.setTags(self.tags, self.person)
-        self.assertEqual(sorted(self.tags), list(self.milestone.getTags()))
+        self.assertEqual(sorted(self.tags), self.milestone.getTags())
 
     def test_tags_override(self):
         # Ensure you can override tags already associated with the milestone.
@@ -47,14 +51,14 @@
             self.milestone.setTags(self.tags, self.person)
             new_tags = [u'tag2', u'tag4', u'tag3']
             self.milestone.setTags(new_tags, self.person)
-        self.assertEqual(sorted(new_tags), list(self.milestone.getTags()))
+        self.assertEqual(sorted(new_tags), self.milestone.getTags())
 
     def test_tags_deletion(self):
         # Ensure passing an empty sequence of tags deletes them all.
         with person_logged_in(self.person):
             self.milestone.setTags(self.tags, self.person)
             self.milestone.setTags([], self.person)
-        self.assertEquals([], list(self.milestone.getTags()))
+        self.assertEquals([], self.milestone.getTags())
 
     def test_user_metadata(self):
         # Ensure the correct user metadata is created when tags are added.
@@ -200,3 +204,41 @@
         specs, milestonetag = self._create_items_for_multiple_tags(
             self._create_specifications)
         self.assertContentEqual(specs, milestonetag.specifications)
+
+
+class MilestoneTagWebServiceTest(WebServiceTestCase):
+    """Test the getter and setter for milestonetags."""
+
+    layer = AppServerLayer
+
+    def setUp(self):
+        super(MilestoneTagWebServiceTest, self).setUp()
+        self.owner = self.factory.makePerson()
+        self.product = self.factory.makeProduct(owner=self.owner)
+        self.milestone = self.factory.makeMilestone(product=self.product)
+        transaction.commit()
+        self.ws_milestone = self.wsObject(self.milestone, self.owner)
+
+    def test_get_tags_none(self):
+        self.assertEqual([], self.ws_milestone.getTags())
+
+    def test_get_tags(self):
+        tags = [u'zeta', u'alpha', u'beta']
+        self.milestone.setTags(tags, self.owner)
+        self.assertEqual(sorted(tags), self.ws_milestone.getTags())
+
+    def test_set_tags_initial(self):
+        tags = [u'zeta', u'alpha', u'beta']
+        self.ws_milestone.setTags(tags=tags)
+        self.ws_milestone.lp_save()
+        transaction.begin()
+        self.assertEqual(sorted(tags), self.milestone.getTags())
+
+    def test_set_tags_replace(self):
+        tags1 = [u'zeta', u'alpha', u'beta']
+        self.milestone.setTags(tags1, self.owner)
+        tags2 = [u'delta', u'alpha', u'gamma']
+        self.ws_milestone.setTags(tags=tags2)
+        self.ws_milestone.lp_save()
+        transaction.begin()
+        self.assertEqual(sorted(tags2), self.milestone.getTags())