Merge lp:~gmb/launchpad/link-attachment-bug-524296 into lp:launchpad/db-devel

[Graham Binns]

It's now possible to link existing LibraryFileAliases to a Bug as attachments.

[Graham Binns (gmb)]

This branch adds a linkAttachment() method to IBug and changes
Bug.addAttachment() to use the new linkAttachment() method.

The linkAttachment() method is needed because, when dealing with
uploaded apport blobs we need to be able to link existing
LibraryFileAliases to a bug as attachments rather than creating new
ones.

== lib/lp/bugs/configure.zcml ==

 - I've updated the zcml for IBug / Bug to allow the linkAttachment()
   method for Launchpad.Edit.

== lib/lp/bugs/doc/bugattachments.txt ==

 - I've added tests to cover the new linkAttachment() method. The tests
   for addAttachment() also cover it indirectly.

== lib/lp/bugs/interfaces/bug.py ==

 - I've added a definition of linkAttachment().

== lib/lp/bugs/model/bug.py ==

 - I've added an implementation of linkAttachment().

[Abel Deuring (adeuring)]

Hi Graham,

a nice small and clean branch, r=me.

Reading the diff, I noticed in line 11 of the diff that the value of "set_attributes" looks really scrambled: lots of spaces but no line breaks. I know that you did not change anything there, but could you please re-format it similar to the value of "attributes", as a drive-by fix?

review: Approve (code)

=== modified file 'lib/lp/bugs/configure.zcml'
--- lib/lp/bugs/configure.zcml	2010-02-12 21:34:23 +0000
+++ lib/lp/bugs/configure.zcml	2010-02-19 11:43:16 +0000
@@ -666,8 +666,27 @@
                     addChange
                     markAsDuplicate
                     linkHWSubmission
-                    unlinkHWSubmission"
-                set_attributes="datecreated date_last_updated name title description                                                                                                                 ownerID owner duplicateof communityscore                                                                                                                 communitytimestamp hits hitstimestamp activityscore                                                                                                                 activitytimestamp activity initial_message                                                                                                                 security_related tags who_made_private date_made_private"/>
+                    unlinkHWSubmission
+                    linkAttachment"
+                set_attributes="
+                    activity initial_message
+                    activityscore
+                    activitytimestamp
+                    communityscore
+                    communitytimestamp
+                    date_last_updated
+                    date_made_private
+                    datecreated
+                    duplicateof
+                    hits
+                    hitstimestamp
+                    name
+                    owner
+                    ownerID
+                    security_related
+                    tags
+                    title description
+                    who_made_private"/>
             <require
                 permission="launchpad.AnyPerson"
                 attributes="

=== modified file 'lib/lp/bugs/doc/bugattachments.txt'
--- lib/lp/bugs/doc/bugattachments.txt	2010-02-17 20:00:14 +0000
+++ lib/lp/bugs/doc/bugattachments.txt	2010-02-19 11:43:16 +0000
@@ -1,4 +1,5 @@
-= Bug Attachments =
+Bug Attachments
+===============
 
 Files can be attached to bugs. There are two types of attachment, Patch
 and Unspecified. Patch means a proposed fix to the bug, Unspecified
@@ -17,7 +18,8 @@
     0
 
 
-== Creating attachments ==
+Creating attachments
+--------------------
 
 To create an attachment, call IBug.addAttachment. It will emit an
 ObjectCreatedEvent in order to trigger email notifications:
@@ -291,7 +293,8 @@
     >>> event_listener.unregister()
 
 
-== Security ==
+Security
+--------
 
 If a user can view/edit the bug the attachment is attached to, he can
 also view/edit the attachment. At the moment the bug_one is public, so
@@ -373,7 +376,8 @@
     True
 
 
-== Search for attachments ==
+Search for attachments
+----------------------
 
 We can search for attachment of a specific types:
 
@@ -439,7 +443,8 @@
     False
 
 
-== Deleting attachments ==
+Deleting attachments
+--------------------
 
 It's also possible to delete attachments.
 
@@ -481,7 +486,8 @@
        http://.../foo.baz
 
 
-== Bugs with patches ==
+Bugs with patches
+-----------------
 
 A bug that has patch attachments associated with it has its `has_patches`
 property returning True.
@@ -513,3 +519,60 @@
     >>> bug_two.has_patches
     True
 
+
+Linking existing LibraryFileAliases as attachments
+--------------------------------------------------
+
+It's possible to link an existing LibraryFileAliases to a bug as an
+attachment by calling the bug's linkAttachment() method.
+
+    >>> from canonical.launchpad.interfaces.librarian import (
+    ...     ILibraryFileAliasSet)
+
+    >>> file_content = "Hello, world"
+    >>> content_type = "text/plain"
+    >>> file_alias = getUtility(ILibraryFileAliasSet).create(
+    ...     name='foobar', size=len(file_content),
+    ...     file=StringIO(file_content), contentType=content_type)
+    >>> transaction.commit()
+
+    >>> bug = factory.makeBug()
+    >>> bug.linkAttachment(
+    ...     owner=bug.owner, file_alias=file_alias,
+    ...     comment="Some attachment")
+    <BugAttachment ...>
+
+    >>> bug.attachments.count()
+    1
+    >>> attachment = bug.attachments[0]
+    >>> print attachment.title
+    foobar
+
+The attachment will have a type of BugAttachmentType.UNSPECIFIED, since
+we didn't specify that it was a patch.
+
+    >>> print attachment.type.title
+    Unspecified
+
+We can specify that the attachment is a patch and give it a more
+meaningful description.
+
+    >>> file_alias = getUtility(ILibraryFileAliasSet).create(
+    ...     name='anotherfoobar', size=len(file_content),
+    ...     file=StringIO(file_content), contentType=content_type)
+    >>> transaction.commit()
+
+    >>> bug.linkAttachment(
+    ...     owner=bug.owner, file_alias=file_alias,
+    ...     comment="Some attachment", is_patch=True,
+    ...     description="An attachment of some sort")
+    <BugAttachment ...>
+
+    >>> bug.attachments.count()
+    2
+    >>> attachment = bug.attachments[1]
+    >>> print attachment.title
+    An attachment of some sort
+
+    >>> print attachment.type.title
+    Patch

=== modified file 'lib/lp/bugs/interfaces/bug.py'
--- lib/lp/bugs/interfaces/bug.py	2010-02-09 20:10:31 +0000
+++ lib/lp/bugs/interfaces/bug.py	2010-02-19 11:43:16 +0000
@@ -513,6 +513,18 @@
         :is_patch: A boolean.
         """
 
+    def linkAttachment(owner, file_alias, comment, is_patch=False,
+                       description=None):
+        """Link an `ILibraryFileAlias` to this bug.
+
+        :owner: An IPerson.
+        :file_alias: The `ILibraryFileAlias` to link to this bug.
+        :description: A brief description of the attachment.
+        :comment: An IMessage or string.
+        :filename: A string.
+        :is_patch: A boolean.
+        """
+
     def linkCVE(cve, user):
         """Ensure that this CVE is linked to this bug."""
 

=== modified file 'lib/lp/bugs/model/bug.py'
--- lib/lp/bugs/model/bug.py	2010-02-11 13:54:07 +0000
+++ lib/lp/bugs/model/bug.py	2010-02-19 11:43:16 +0000
@@ -904,10 +904,8 @@
             filecontent = data.read()
 
         if is_patch:
-            attach_type = BugAttachmentType.PATCH
             content_type = 'text/plain'
         else:
-            attach_type = BugAttachmentType.UNSPECIFIED
             if content_type is None:
                 content_type, encoding = guess_content_type(
                     name=filename, body=filecontent)
@@ -916,10 +914,20 @@
             name=filename, size=len(filecontent),
             file=StringIO(filecontent), contentType=content_type)
 
+        return self.linkAttachment(
+            owner, filealias, comment, is_patch, description)
+
+    def linkAttachment(self, owner, file_alias, comment, is_patch=False,
+                       description=None):
+        if is_patch:
+            attach_type = BugAttachmentType.PATCH
+        else:
+            attach_type = BugAttachmentType.UNSPECIFIED
+
         if description:
             title = description
         else:
-            title = filename
+            title = file_alias.filename
 
         if IMessage.providedBy(comment):
             message = comment
@@ -928,7 +936,7 @@
                 owner=owner, subject=description, content=comment)
 
         return getUtility(IBugAttachmentSet).create(
-            bug=self, filealias=filealias, attach_type=attach_type,
+            bug=self, filealias=file_alias, attach_type=attach_type,
             title=title, message=message, send_notifications=True)
 
     def hasBranch(self, branch):