Merge lp:~deryck/launchpad/use-specification-sharing-policy into lp:launchpad

[Deryck Hodge]

Get Product.getAllowedSpecificationInformationTypes and Product.getDefaultSpecificationInformationType working to start making use of SpecificationSharingPolicy for products.

To start making use of SpecificationSharingPolicy, this branch updates or adds the methods getAllowedSpecificationInformationTypes and getDefaultSpecificationInformationType. This is largely a branch that adds tests and fixes these methods on Product. All we really care about for Specifications is Products, but I also updated the methods on Distribution to return Public for those objects.

To get this working, I needed to add SPECIFICATION_POLICY_DEFAULT_TYPES to make sure the defaults were correct. Also, there is no QA for this since it's just tests and model changes. We're also lint free. The LOC count is justified since this is for the disclosure project which already has approval for LOC increase.

[j.c.sackett (jcsackett)]

This looks fine. Thanks, Deryck.

review: Approve

=== modified file 'lib/lp/blueprints/interfaces/specificationtarget.py'
--- lib/lp/blueprints/interfaces/specificationtarget.py	2012-09-07 19:40:53 +0000
+++ lib/lp/blueprints/interfaces/specificationtarget.py	2012-09-13 18:00:38 +0000
@@ -111,7 +111,10 @@
         """
 
     def getAllowedSpecificationInformationTypes():
-        """Get the InformationTypes for this targets' specifications."""
+        """Get the InformationTypes for this target's specifications."""
+
+    def getDefaultSpecificationInformationType():
+        """Get the default InformationType for the target's specifications."""
 
 
 class ISpecificationGoal(ISpecificationTarget):

=== modified file 'lib/lp/blueprints/model/specification.py'
--- lib/lp/blueprints/model/specification.py	2012-09-13 18:00:38 +0000
+++ lib/lp/blueprints/model/specification.py	2012-09-13 18:00:38 +0000
@@ -10,6 +10,7 @@
     'recursive_dependent_query',
     'Specification',
     'SPECIFICATION_POLICY_ALLOWED_TYPES',
+    'SPECIFICATION_POLICY_DEFAULT_TYPES',
     'SpecificationSet',
     ]
 
@@ -140,6 +141,17 @@
         [InformationType.PROPRIETARY, InformationType.EMBARGOED],
     }
 
+SPECIFICATION_POLICY_DEFAULT_TYPES = {
+    SpecificationSharingPolicy.PUBLIC: InformationType.PUBLIC,
+    SpecificationSharingPolicy.PUBLIC_OR_PROPRIETARY: (
+        InformationType.PUBLIC),
+    SpecificationSharingPolicy.PROPRIETARY_OR_PUBLIC: (
+        InformationType.PROPRIETARY),
+    SpecificationSharingPolicy.PROPRIETARY: InformationType.PROPRIETARY,
+    SpecificationSharingPolicy.EMBARGOED_OR_PROPRIETARY: (
+        InformationType.EMBARGOED),
+    }
+
 
 class Specification(SQLBase, BugLinkTargetMixin):
     """See ISpecification."""

=== modified file 'lib/lp/registry/model/distribution.py'
--- lib/lp/registry/model/distribution.py	2012-09-11 19:14:06 +0000
+++ lib/lp/registry/model/distribution.py	2012-09-13 18:00:38 +0000
@@ -979,6 +979,10 @@
         """See `ISpecificationTarget`."""
         return (InformationType.PUBLIC,)
 
+    def getDefaultSpecificationInformationType(self):
+        """See `ISpecificationTarget`."""
+        return InformationType.PUBLIC
+
     def searchQuestions(self, search_text=None,
                         status=QUESTION_STATUS_DEFAULT_SEARCH,
                         language=None, sort=None, owner=None,

=== modified file 'lib/lp/registry/model/product.py'
--- lib/lp/registry/model/product.py	2012-09-13 18:00:38 +0000
+++ lib/lp/registry/model/product.py	2012-09-13 18:00:38 +0000
@@ -87,6 +87,7 @@
     HasSpecificationsMixin,
     Specification,
     SPECIFICATION_POLICY_ALLOWED_TYPES,
+    SPECIFICATION_POLICY_DEFAULT_TYPES,
     )
 from lp.blueprints.model.sprint import HasSprintsMixin
 from lp.bugs.interfaces.bugsummary import IBugSummaryDimension
@@ -124,7 +125,6 @@
     InformationType,
     PRIVATE_INFORMATION_TYPES,
     SpecificationSharingPolicy,
-    PUBLIC_PROPRIETARY_INFORMATION_TYPES,
     )
 from lp.registry.errors import CommercialSubscribersOnly
 from lp.registry.interfaces.accesspolicy import (
@@ -629,7 +629,17 @@
 
     def getAllowedSpecificationInformationTypes(self):
         """See `ISpecificationTarget`."""
-        return PUBLIC_PROPRIETARY_INFORMATION_TYPES
+        if self.specification_sharing_policy is not None:
+            return SPECIFICATION_POLICY_ALLOWED_TYPES[
+                self.specification_sharing_policy]
+        return [InformationType.PUBLIC]
+
+    def getDefaultSpecificationInformationType(self):
+        """See `ISpecificationTarget`."""
+        if self.specification_sharing_policy is not None:
+            return SPECIFICATION_POLICY_DEFAULT_TYPES[
+                self.specification_sharing_policy]
+        return InformationType.PUBLIC
 
     def _ensurePolicies(self, information_types):
         # Ensure that the product has access policies for the specified

=== modified file 'lib/lp/registry/tests/test_distribution.py'
--- lib/lp/registry/tests/test_distribution.py	2012-09-05 06:48:36 +0000
+++ lib/lp/registry/tests/test_distribution.py	2012-09-13 18:00:38 +0000
@@ -286,6 +286,22 @@
             InformationType.PUBLIC,
             self.factory.makeDistribution().getDefaultBugInformationType())
 
+    def test_getAllowedSpecificationInformationTypes(self):
+        # All distros currently support only public specifications.
+        distro = self.factory.makeDistribution()
+        self.assertContentEqual(
+            [InformationType.PUBLIC],
+            distro.getAllowedSpecificationInformationTypes()
+            )
+
+    def test_getDefaultSpecificationInformtationType(self):
+        # All distros currently support only Public by default
+        # specifications.
+        distro = self.factory.makeDistribution()
+        self.assertEqual(
+            InformationType.PUBLIC,
+            distro.getDefaultSpecificationInformationType())
+
 
 class TestDistributionCurrentSourceReleases(
     CurrentSourceReleasesMixin, TestCase):

=== modified file 'lib/lp/registry/tests/test_product.py'
--- lib/lp/registry/tests/test_product.py	2012-09-03 01:35:58 +0000
+++ lib/lp/registry/tests/test_product.py	2012-09-13 18:00:38 +0000
@@ -34,6 +34,7 @@
     FREE_INFORMATION_TYPES,
     INCLUSIVE_TEAM_POLICY,
     InformationType,
+    SpecificationSharingPolicy,
     )
 from lp.registry.errors import (
     CommercialSubscribersOnly,
@@ -459,6 +460,86 @@
             product.getDefaultBugInformationType())
 
 
+class TestProductSpecificationPolicyAndInformationTypes(TestCaseWithFactory):
+
+    layer = DatabaseFunctionalLayer
+
+    def makeProductWithPolicy(self, specification_sharing_policy):
+        product = self.factory.makeProduct()
+        self.factory.makeCommercialSubscription(product=product)
+        with person_logged_in(product.owner):
+            product.setSpecificationSharingPolicy(
+                specification_sharing_policy)
+        return product
+
+    def test_no_policy(self):
+        # Projects that have not specified a policy can use the PUBLIC
+        # information type.
+        product = self.factory.makeProduct()
+        self.assertContentEqual(
+            [InformationType.PUBLIC],
+            product.getAllowedSpecificationInformationTypes())
+        self.assertEqual(
+            InformationType.PUBLIC,
+            product.getDefaultSpecificationInformationType())
+
+    def test_sharing_policy_public(self):
+        # Projects with a purely public policy should use PUBLIC
+        # information type.
+        product = self.makeProductWithPolicy(
+            SpecificationSharingPolicy.PUBLIC)
+        self.assertContentEqual(
+            [InformationType.PUBLIC],
+            product.getAllowedSpecificationInformationTypes())
+        self.assertEqual(
+            InformationType.PUBLIC,
+            product.getDefaultSpecificationInformationType())
+
+    def test_sharing_policy_public_or_proprietary(self):
+        # specification_sharing_policy can enable Proprietary.
+        product = self.makeProductWithPolicy(
+            SpecificationSharingPolicy.PUBLIC_OR_PROPRIETARY)
+        self.assertContentEqual(
+            [InformationType.PUBLIC, InformationType.PROPRIETARY],
+            product.getAllowedSpecificationInformationTypes())
+        self.assertEqual(
+            InformationType.PUBLIC,
+            product.getDefaultSpecificationInformationType())
+
+    def test_sharing_policy_proprietary_or_public(self):
+        # specification_sharing_policy can enable and default to Proprietary.
+        product = self.makeProductWithPolicy(
+            SpecificationSharingPolicy.PROPRIETARY_OR_PUBLIC)
+        self.assertContentEqual(
+            [InformationType.PUBLIC, InformationType.PROPRIETARY],
+            product.getAllowedSpecificationInformationTypes())
+        self.assertEqual(
+            InformationType.PROPRIETARY,
+            product.getDefaultSpecificationInformationType())
+
+    def test_sharing_policy_proprietary(self):
+        # specification_sharing_policy can enable only Proprietary.
+        product = self.makeProductWithPolicy(
+            SpecificationSharingPolicy.PROPRIETARY)
+        self.assertContentEqual(
+            [InformationType.PROPRIETARY],
+            product.getAllowedSpecificationInformationTypes())
+        self.assertEqual(
+            InformationType.PROPRIETARY,
+            product.getDefaultSpecificationInformationType())
+
+    def test_sharing_policy_embargoed_or_proprietary(self):
+        # specification_sharing_policy can be embargoed and then proprietary.
+        product = self.makeProductWithPolicy(
+            SpecificationSharingPolicy.EMBARGOED_OR_PROPRIETARY)
+        self.assertContentEqual(
+            [InformationType.PROPRIETARY, InformationType.EMBARGOED],
+            product.getAllowedSpecificationInformationTypes())
+        self.assertEqual(
+            InformationType.EMBARGOED,
+            product.getDefaultSpecificationInformationType())
+
+
 class ProductPermissionTestCase(TestCaseWithFactory):
 
     layer = DatabaseFunctionalLayer

=== modified file 'lib/lp/scripts/garbo.py'
--- lib/lp/scripts/garbo.py	2012-09-03 06:41:06 +0000
+++ lib/lp/scripts/garbo.py	2012-09-13 18:00:38 +0000
@@ -27,7 +27,11 @@
 import iso8601
 from psycopg2 import IntegrityError
 import pytz
-from storm.expr import In
+from storm.expr import (
+    In,
+    Select,
+    Update,
+    )
 from storm.locals import (
     Max,
     Min,
@@ -906,6 +910,33 @@
         self._update_oldest()
 
 
+class SpecificationSharingPolicyDefault(TunableLoop):
+    """Set all Product.specification_sharing_policy to Public."""
+
+    maximum_chunk_size = 1000
+
+    def __init__(self, log, abort_time=None):
+        super(SpecificationSharingPolicyDefault, self).__init__(
+            log, abort_time)
+        self.rows_updated = None
+        self.store = IMasterStore(Product)
+
+    def isDone(self):
+        """See `TunableLoop`."""
+        return self.rows_updated == 0
+
+    def __call__(self, chunk_size):
+        """See `TunableLoop`."""
+        subselect = Select(
+            Product.id, Product.specification_sharing_policy == None,
+            limit=chunk_size)
+        result = self.store.execute(
+            Update({Product.specification_sharing_policy: 1},
+            Product.id.is_in(subselect)))
+        transaction.commit()
+        self.rows_updated = result.rowcount
+
+
 class SuggestiveTemplatesCacheUpdater(TunableLoop):
     """Refresh the SuggestivePOTemplate cache.
 
@@ -1300,6 +1331,7 @@
         OldTimeLimitedTokenDeleter,
         RevisionAuthorEmailLinker,
         ScrubPOFileTranslator,
+        SpecificationSharingPolicyDefault,
         SuggestiveTemplatesCacheUpdater,
         POTranslationPruner,
         UnlinkedAccountPruner,

=== modified file 'lib/lp/scripts/tests/test_garbo.py'
--- lib/lp/scripts/tests/test_garbo.py	2012-09-03 06:41:06 +0000
+++ lib/lp/scripts/tests/test_garbo.py	2012-09-13 18:00:38 +0000
@@ -19,6 +19,7 @@
     In,
     Min,
     Not,
+    Update,
     SQL,
     )
 from storm.locals import (
@@ -58,6 +59,8 @@
     )
 from lp.registry.interfaces.accesspolicy import IAccessPolicySource
 from lp.registry.interfaces.person import IPersonSet
+from lp.registry.interfaces.product import IProductSet
+from lp.registry.model.product import Product
 from lp.scripts.garbo import (
     AntiqueSessionPruner,
     BulkPruner,
@@ -1057,6 +1060,23 @@
             [InformationType.PRIVATESECURITY, InformationType.PROPRIETARY],
             self.getAccessPolicyTypes(product))
 
+    def test_SpecificationSharingPolicyDefault(self):
+        switch_dbuser('testadmin')
+        # Set all existing projects to something other than None or 1.
+        store = IMasterStore(Product)
+        store.execute(Update(
+            {Product.specification_sharing_policy: 2}))
+        store.flush()
+        # Make a new product without a specification_sharing_policy.
+        product = self.factory.makeProduct()
+        removeSecurityProxy(product).specification_sharing_policy = None
+        store.flush()
+        self.assertEqual(1, store.find(Product,
+            Product.specification_sharing_policy == None).count())
+        self.runDaily()
+        self.assertEqual(0, store.find(Product,
+            Product.specification_sharing_policy == None).count())
+
 
 class TestGarboTasks(TestCaseWithFactory):
     layer = LaunchpadZopelessLayer