Merge lp:~intellectronica/launchpad/expectations-bug-556499-model into lp:launchpad/db-devel

[Eleanor Berger]

Model for IBugTarget.bug_reported_acknowledgement.

This branch has the model changes for recording an acknowledgement message to display to users after they've filed a bug. The database field is already in db-devel, and the UI follows in another branch.

[Leonard Richardson (leonardr)]

review: Approve (code)

=== added file 'lib/lp/bugs/doc/bug-reported-acknowledgement.txt'
--- lib/lp/bugs/doc/bug-reported-acknowledgement.txt	1970-01-01 00:00:00 +0000
+++ lib/lp/bugs/doc/bug-reported-acknowledgement.txt	2010-05-24 14:27:31 +0000
@@ -0,0 +1,122 @@
+= Bug Reported Acknowledgement Message =
+
+A message of acknowledgement to be displayed to bug reporters after they've
+reported a bug can be set at the Distribution, DistributionSourcePackage,
+ProjectGroup or Product level to help users file good bug reports, direct
+them to FAQs, and so forth.
+
+    >>> login('[e-mail]')
+
+    >>> from canonical.launchpad.interfaces import (
+    ...     IDistributionSet, IProjectGroupSet, IProductSet)
+
+    >>> distribution = getUtility(IDistributionSet).getByName('ubuntu')
+    >>> distribution_source_package = (
+    ...     distribution.getSourcePackage('alsa-utils'))
+    >>> project = getUtility(IProjectGroupSet).getByName('mozilla')
+    >>> product = getUtility(IProductSet).getByName('firefox')
+
+    >>> settable_contexts = [
+    ...     distribution,
+    ...     distribution_source_package,
+    ...     project,
+    ...     product,
+    ...     ]
+
+    >>> for context in settable_contexts:
+    ...     context.bug_reported_acknowledgement = (
+    ...         "Bug reported on %s." % context.displayname)
+
+In fact, all IBugTargets have an acknowledgement message available, but the
+others delegate to the distribution or product level.
+
+DistroSeries and SourcePackages defer to the Distribution:
+
+    >>> distro_series = distribution.getSeries('warty')
+    >>> print distro_series.bug_reported_acknowledgement
+    Bug reported on Ubuntu.
+
+    >>> source_package = distro_series.getSourcePackage('alsa-utils')
+    >>> print source_package.bug_reported_acknowledgement
+    Bug reported on Ubuntu.
+
+ProductSeries defer to the Product:
+
+    >>> product_series = product.getSeries('trunk')
+    >>> print product_series.bug_reported_acknowledgement
+    Bug reported on Mozilla Firefox.
+
+One day these objects that defer bug_reported_acknowledgement may have
+their own message. In the meantime the deferral is done with a
+read-only property, and the security proxies also only allow read
+access.
+
+    >>> distro_series.bug_reported_acknowledgement = 'Foobar'
+    Traceback (most recent call last):
+    ...
+    ForbiddenAttribute: ...
+
+    >>> source_package.bug_reported_acknowledgement = 'Foobar'
+    Traceback (most recent call last):
+    ...
+    ForbiddenAttribute: ...
+
+    >>> product_series.bug_reported_acknowledgement = 'Foobar'
+    Traceback (most recent call last):
+    ...
+    ForbiddenAttribute: ...
+
+The security proxies also prevent unprivileged users from editing the
+message.
+
+    >>> from canonical.launchpad.interfaces import IPerson
+
+    >>> def check_access(user, context):
+    ...     if IPerson.providedBy(user):
+    ...         login_person(user)
+    ...     else:
+    ...         login(user)
+    ...     context.bug_reported_acknowledgement = (
+    ...         "%s let %s have access." % (
+    ...             context.displayname,
+    ...             getUtility(ILaunchBag).user.displayname))
+    ...     print context.bug_reported_acknowledgement
+
+    >>> check_access("[e-mail]", distribution)
+    Traceback (most recent call last):
+    ...
+    Unauthorized: ...
+
+    >>> check_access("[e-mail]", distribution_source_package)
+    Traceback (most recent call last):
+    ...
+    Unauthorized: ...
+
+    >>> check_access("[e-mail]", project)
+    Traceback (most recent call last):
+    ...
+    Unauthorized: ...
+
+    >>> check_access("[e-mail]", product)
+    Traceback (most recent call last):
+    ...
+    Unauthorized: ...
+
+Of course the owner can edit the message.
+
+    >>> check_access(distribution.owner.activemembers[0], distribution)
+    Ubuntu let Alexander Limi have access.
+
+    >>> check_access(project.owner, project)
+    the Mozilla Project let Sample Person have access.
+
+    >>> check_access(product.owner, product)
+    Mozilla Firefox let Sample Person have access.
+
+In the case of DistributionSourcePackages, the owner of the
+Distribution can edit the message.
+
+    >>> check_access(
+    ...     distribution_source_package.distribution.owner.activemembers[0],
+    ...     distribution_source_package)
+    alsa-utils in ubuntu let Alexander Limi have access.

=== modified file 'lib/lp/bugs/interfaces/bugtarget.py'
--- lib/lp/bugs/interfaces/bugtarget.py	2010-05-06 01:46:55 +0000
+++ lib/lp/bugs/interfaces/bugtarget.py	2010-05-24 14:27:31 +0000
@@ -237,6 +237,16 @@
             required=False,
             max_length=50000))
 
+    bug_reported_acknowledgement = exported(
+        Text(
+            title=(
+                u"After reporting a bug, I can expect the following."),
+            description=(
+                u"This message of acknowledgement will be displayed "
+                "to anyone after reporting a bug."),
+            required=False,
+            max_length=50000))
+
     def createBug(bug_params):
         """Create a new bug on this target.
 

=== modified file 'lib/lp/registry/configure.zcml'
--- lib/lp/registry/configure.zcml	2010-04-27 13:57:18 +0000
+++ lib/lp/registry/configure.zcml	2010-05-24 14:27:31 +0000
@@ -382,6 +382,7 @@
                 publishing_history
                 current_publishing_records
                 bug_reporting_guidelines
+                bug_reported_acknowledgement
                 latest_overall_publication
                 __getitem__
                 getVersion
@@ -446,7 +447,9 @@
                 removeAnswerContact"/>
         <require
             permission="launchpad.Edit"
-            set_attributes="bug_reporting_guidelines"/>
+            set_attributes="
+                bug_reported_acknowledgement
+                bug_reporting_guidelines"/>
     </class>
     <adapter
         for="lp.registry.interfaces.distributionsourcepackage.IDistributionSourcePackage"
@@ -1088,7 +1091,8 @@
             interface="lp.registry.interfaces.product.IProductEditRestricted"/>
         <require
             permission="launchpad.Edit"
-            set_attributes="bug_reporting_guidelines bugtracker
+            set_attributes="bug_reporting_guidelines
+                            bug_reported_acknowledgement bugtracker
                             commercial_subscription description
                             development_focus displayname downloadurl
                             driver enable_bug_expiration
@@ -1407,7 +1411,8 @@
                 displayname title summary description driver
                 members owner security_contact mirror_admin homepage_content
                 icon logo mugshot enable_bug_expiration
-                bug_reporting_guidelines official_blueprints official_malone
+                bug_reporting_guidelines bug_reported_acknowledgement
+                official_blueprints official_malone
                 official_rosetta official_answers official_bug_tags"/>
         <require
             permission="launchpad.TranslationsAdmin"

=== modified file 'lib/lp/registry/interfaces/projectgroup.py'
--- lib/lp/registry/interfaces/projectgroup.py	2010-04-19 08:30:06 +0000
+++ lib/lp/registry/interfaces/projectgroup.py	2010-05-24 14:27:31 +0000
@@ -261,6 +261,16 @@
             required=False,
             max_length=50000))
 
+    bug_reported_acknowledgement = exported(
+        Text(
+            title=(
+                u"After reporting a bug, I can expect the following."),
+            description=(
+                u"This message of acknowledgement will be displayed "
+                "to anyone after reporting a bug."),
+            required=False,
+            max_length=50000))
+
     def getProduct(name):
         """Get a product with name `name`."""
 

=== modified file 'lib/lp/registry/model/distribution.py'
--- lib/lp/registry/model/distribution.py	2010-05-07 20:09:03 +0000
+++ lib/lp/registry/model/distribution.py	2010-05-24 14:27:31 +0000
@@ -156,6 +156,7 @@
         notNull=False,
         default=None)
     bug_reporting_guidelines = StringCol(default=None)
+    bug_reported_acknowledgement = StringCol(default=None)
     security_contact = ForeignKey(
         dbName='security_contact', foreignKey='Person',
         storm_validator=validate_public_person, notNull=False,

=== modified file 'lib/lp/registry/model/distroseries.py'
--- lib/lp/registry/model/distroseries.py	2010-05-12 23:23:19 +0000
+++ lib/lp/registry/model/distroseries.py	2010-05-24 14:27:31 +0000
@@ -505,6 +505,11 @@
         """See `IBugTarget`."""
         return self.distribution.bug_reporting_guidelines
 
+    @property
+    def bug_reported_acknowledgement(self):
+        """See `IBugTarget`."""
+        return self.distribution.bug_reported_acknowledgement
+
     def _getMilestoneCondition(self):
         """See `HasMilestonesMixin`."""
         return (Milestone.distroseries == self)

=== modified file 'lib/lp/registry/model/product.py'
--- lib/lp/registry/model/product.py	2010-04-27 13:57:18 +0000
+++ lib/lp/registry/model/product.py	2010-05-24 14:27:31 +0000
@@ -288,6 +288,7 @@
         foreignKey="ProductSeries", dbName="development_focus", notNull=False,
         default=None)
     bug_reporting_guidelines = StringCol(default=None)
+    bug_reported_acknowledgement = StringCol(default=None)
     _cached_licenses = None
 
     def _validate_active(self, attr, value):

=== modified file 'lib/lp/registry/model/productseries.py'
--- lib/lp/registry/model/productseries.py	2010-03-24 02:53:42 +0000
+++ lib/lp/registry/model/productseries.py	2010-05-24 14:27:31 +0000
@@ -181,6 +181,11 @@
         return self.product.bug_reporting_guidelines
 
     @property
+    def bug_reported_acknowledgement(self):
+        """See `IBugTarget`."""
+        return self.product.bug_reported_acknowledgement
+
+    @property
     def sourcepackages(self):
         """See IProductSeries"""
         from lp.registry.model.sourcepackage import SourcePackage

=== modified file 'lib/lp/registry/model/projectgroup.py'
--- lib/lp/registry/model/projectgroup.py	2010-04-16 15:06:55 +0000
+++ lib/lp/registry/model/projectgroup.py	2010-05-24 14:27:31 +0000
@@ -123,6 +123,7 @@
         foreignKey="BugTracker", dbName="bugtracker", notNull=False,
         default=None)
     bug_reporting_guidelines = StringCol(default=None)
+    bug_reported_acknowledgement = StringCol(default=None)
     max_bug_heat = Int()
 
     # convenient joins

=== modified file 'lib/lp/registry/model/sourcepackage.py'
--- lib/lp/registry/model/sourcepackage.py	2010-04-14 18:31:51 +0000
+++ lib/lp/registry/model/sourcepackage.py	2010-05-24 14:27:31 +0000
@@ -427,6 +427,11 @@
         """See `IBugTarget`."""
         return self.distribution.bug_reporting_guidelines
 
+    @property
+    def bug_reported_acknowledgement(self):
+        """See `IBugTarget`."""
+        return self.distribution.bug_reported_acknowledgement
+
     def _customizeSearchParams(self, search_params):
         """Customize `search_params` for this source package."""
         search_params.setSourcePackage(self)