Merge lp:~james-w/launchpad/export-code-import into lp:launchpad

[James Westby]

Expose the main code import attributes read only.

This exports ICodeImport.

It's not intended to be all-singing, all-dancing, just export
the objects, we can do more in future branches.

Thanks,

James

[Tim Penhey (thumper)]

I think this is a great start.

review: Approve

[Francis J. Lacoste (flacoste)]

On March 16, 2010, James Westby wrote:
 + owner = exported(
> + PublicPersonChoice(
> + title=_('Owner'), required=True, readonly=False,
> + vocabulary='ValidPersonOrTeam',
> + description=_("The community contact for this import.")))
>

> + review_status = exported(
> + Choice(
> + title=_("Review Status"), vocabulary=CodeImportReviewStatus,
> + default=CodeImportReviewStatus.NEW,
> + description=_("Before a code import is performed, it is
> reviewed." + " Only reviewed imports are processed.")))
> +

Do we know if the security wrapper were properly defined for the exported field?

> + date_last_successful = exported(
> + Datetime(title=_("Last successful"), required=False))
>

This should probably be a readonly field?

--
Francis J. Lacoste
<email address hidden>

[James Westby (james-w)]

> On March 16, 2010, James Westby wrote:
> + owner = exported(
> > + PublicPersonChoice(
> > + title=_('Owner'), required=True, readonly=False,
> > + vocabulary='ValidPersonOrTeam',
> > + description=_("The community contact for this import.")))
> >
>
> > + review_status = exported(
> > + Choice(
> > + title=_("Review Status"), vocabulary=CodeImportReviewStatus,
> > + default=CodeImportReviewStatus.NEW,
> > + description=_("Before a code import is performed, it is
> > reviewed." + " Only reviewed imports are processed.")))
> > +
>
> Do we know if the security wrapper were properly defined for the exported
> field?

I don't know what that means, so probably not.

> > + date_last_successful = exported(
> > + Datetime(title=_("Last successful"), required=False))
> >
>
> This should probably be a readonly field?

It is in the latest diff.

Thanks,

James

=== modified file 'lib/canonical/launchpad/doc/canonical_url_examples.txt'
--- lib/canonical/launchpad/doc/canonical_url_examples.txt	2010-03-12 18:28:28 +0000
+++ lib/canonical/launchpad/doc/canonical_url_examples.txt	2010-03-17 21:52:39 +0000
@@ -356,6 +356,16 @@
     http://code.launchpad.dev/~name12/gnome-terminal/main/+merge/.../comments/...
 
 
+== Code Imports ==
+
+Code imports have a canonical URL which is a subordinate of the branch
+that they import to.
+
+    >>> from lp.code.interfaces.codeimport import ICodeImportSet
+    >>> code_import = getUtility(ICodeImportSet).get(1)
+    >>> print canonical_url(code_import)
+    http://code.launchpad.dev/~vcs-imports/gnome-terminal/import/+code-import
+
 == Specifications ==
 
     >>> from canonical.launchpad.interfaces import ISpecificationSet

=== modified file 'lib/canonical/launchpad/interfaces/_schema_circular_imports.py'
--- lib/canonical/launchpad/interfaces/_schema_circular_imports.py	2010-03-16 05:09:55 +0000
+++ lib/canonical/launchpad/interfaces/_schema_circular_imports.py	2010-03-17 21:52:39 +0000
@@ -40,6 +40,7 @@
 from lp.code.interfaces.branch import IBranch
 from lp.code.interfaces.branchmergeproposal import IBranchMergeProposal
 from lp.code.interfaces.branchsubscription import IBranchSubscription
+from lp.code.interfaces.codeimport import ICodeImport
 from lp.code.interfaces.codereviewcomment import ICodeReviewComment
 from lp.code.interfaces.codereviewvote import ICodeReviewVoteReference
 from lp.code.interfaces.diff import IPreviewDiff
@@ -95,6 +96,7 @@
 patch_plain_parameter_type(
     IBranch, 'setTarget', 'source_package', ISourcePackage)
 patch_reference_property(IBranch, 'sourcepackage', ISourcePackage)
+patch_reference_property(IBranch, 'code_import', ICodeImport)
 
 IBranch['spec_links'].value_type.schema = ISpecificationBranch
 IBranch['subscribe'].queryTaggedValue(

=== modified file 'lib/lp/code/browser/branch.py'
--- lib/lp/code/browser/branch.py	2010-02-24 13:37:51 +0000
+++ lib/lp/code/browser/branch.py	2010-03-17 21:52:39 +0000
@@ -181,6 +181,11 @@
             if proposal.id == id:
                 return proposal
 
+    @stepto("+code-import")
+    def traverse_code_import(self):
+        """Traverses to the `ICodeImport` for the branch."""
+        return self.context.code_import
+
 
 class BranchEditMenu(NavigationMenu):
     """Edit menu for IBranch."""

=== modified file 'lib/lp/code/browser/codeimport.py'
--- lib/lp/code/browser/codeimport.py	2010-03-08 19:27:29 +0000
+++ lib/lp/code/browser/codeimport.py	2010-03-17 21:52:39 +0000
@@ -435,9 +435,9 @@
 class EditCodeImportForm(Interface):
     """The fields presented on the form for editing a code import."""
 
-    use_template(
-        ICodeImport,
-        ['url', 'cvs_root', 'cvs_module'])
+    url = copy_field(ICodeImport['url'], readonly=False)
+    cvs_root = copy_field(ICodeImport['cvs_root'], readonly=False)
+    cvs_module = copy_field(ICodeImport['cvs_module'], readonly=False)
     whiteboard = copy_field(IBranch['whiteboard'])
 
 

=== modified file 'lib/lp/code/browser/configure.zcml'
--- lib/lp/code/browser/configure.zcml	2010-03-12 18:28:28 +0000
+++ lib/lp/code/browser/configure.zcml	2010-03-17 21:52:39 +0000
@@ -714,6 +714,11 @@
             template="../templates/codeimport-new.pt"
             permission="launchpad.AnyPerson"/>
     </facet>
+    <browser:url
+        for="lp.code.interfaces.codeimport.ICodeImport"
+        attribute_to_parent="branch"
+        path_expression="string:+code-import"
+        rootsite="code"/>
     <browser:navigation
         module="lp.code.browser.codeimport"
         classes="

=== modified file 'lib/lp/code/doc/codeimport.txt'
--- lib/lp/code/doc/codeimport.txt	2010-03-09 12:01:49 +0000
+++ lib/lp/code/doc/codeimport.txt	2010-03-17 21:52:39 +0000
@@ -468,14 +468,14 @@
     >>> print canonical_url(code_import_set)
     http://code.launchpad.dev/+code-imports
 
-The code imports themselves are viewed under the branch's URL,
-and are not traversable in themselves.
+The code imports themselves have a canonical URL that is subordinate of
+the branches, though they cannot currently be viewed that way in the webapp,
+only over the API.
 
     >>> print canonical_url(svn_import.branch)
     http://code.launchpad.dev/~no-priv/firefox/trunk-svn
     >>> print canonical_url(svn_import)
-    Traceback (most recent call last):
-    NoCanonicalUrl: ...
+    http://code.launchpad.dev/~no-priv/firefox/trunk-svn/+code-import
 
 
 Modifying CodeImports

=== modified file 'lib/lp/code/interfaces/branch.py'
--- lib/lp/code/interfaces/branch.py	2010-03-10 18:58:02 +0000
+++ lib/lp/code/interfaces/branch.py	2010-03-17 21:52:39 +0000
@@ -855,8 +855,10 @@
     browse_source_url = Attribute(
         "The URL of the source browser for this branch.")
 
-    # Don't use Object -- that would cause an import loop with ICodeImport.
-    code_import = Attribute("The associated CodeImport, if any.")
+    # Really ICodeImport, but that would cause a circular import
+    code_import = exported(
+        Reference(
+            title=_("The associated CodeImport, if any."), schema=Interface))
 
     bzr_identity = exported(
         Text(

=== modified file 'lib/lp/code/interfaces/codeimport.py'
--- lib/lp/code/interfaces/codeimport.py	2010-03-05 03:51:59 +0000
+++ lib/lp/code/interfaces/codeimport.py	2010-03-17 21:52:39 +0000
@@ -23,6 +23,9 @@
 from canonical.launchpad.validators import LaunchpadValidationError
 from lp.code.enums import CodeImportReviewStatus, RevisionControlSystems
 
+from lazr.restful.declarations import (
+    export_as_webservice_entry, exported)
+
 
 def validate_cvs_root(cvsroot):
     try:
@@ -60,13 +63,17 @@
 class ICodeImport(Interface):
     """A code import to a Bazaar Branch."""
 
+    export_as_webservice_entry()
+
     id = Int(readonly=True, required=True)
     date_created = Datetime(
         title=_("Date Created"), required=True, readonly=True)
 
-    branch = Choice(
-        title=_('Branch'), required=True, readonly=True, vocabulary='Branch',
-        description=_("The Bazaar branch produced by the import system."))
+    branch = exported(
+        Choice(
+            title=_('Branch'), required=True, readonly=True,
+            vocabulary='Branch',
+            description=_("The Bazaar branch produced by the import system.")))
 
     registrant = PublicPersonChoice(
         title=_('Registrant'), required=True, readonly=True,
@@ -94,39 +101,44 @@
         description=_("The series this import is registered as the "
                       "code for, or None if there is no such series."))
 
-    review_status = Choice(
-        title=_("Review Status"), vocabulary=CodeImportReviewStatus,
-        default=CodeImportReviewStatus.NEW,
-        description=_("Before a code import is performed, it is reviewed."
-            " Only reviewed imports are processed."))
-
-    rcs_type = Choice(title=_("Type of RCS"),
-        required=True, vocabulary=RevisionControlSystems,
-        description=_(
-            "The version control system to import from. "
-            "Can be CVS or Subversion."))
-
-    url = URIField(title=_("URL"), required=False,
-        description=_("The URL of the VCS branch."),
-        allowed_schemes=["http", "https", "svn", "git"],
-        allow_userinfo=False, # Only anonymous access is supported.
-        allow_port=True,
-        allow_query=False,    # Query makes no sense in Subversion.
-        allow_fragment=False, # Fragment makes no sense in Subversion.
-        trailing_slash=False) # See http://launchpad.net/bugs/56357.
-
-    cvs_root = TextLine(title=_("Repository"), required=False,
-        constraint=validate_cvs_root,
-        description=_("The CVSROOT. "
-            "Example: :pserver:[e-mail]:/cvs/gnome"))
-
-    cvs_module = TextLine(title=_("Module"), required=False,
-        constraint=validate_cvs_module,
-        description=_("The path to import within the repository."
-            " Usually, it is the name of the project."))
-
-    date_last_successful = Datetime(
-        title=_("Last successful"), required=False)
+    review_status = exported(
+        Choice(
+            title=_("Review Status"), vocabulary=CodeImportReviewStatus,
+            default=CodeImportReviewStatus.NEW, readonly=True,
+            description=_("Before a code import is performed, it is reviewed."
+                " Only reviewed imports are processed.")))
+
+    rcs_type = exported(
+        Choice(title=_("Type of RCS"), readonly=True,
+            required=True, vocabulary=RevisionControlSystems,
+            description=_(
+                "The version control system to import from. "
+                "Can be CVS or Subversion.")))
+
+    url = exported(
+        URIField(title=_("URL"), required=False, readonly=True,
+            description=_("The URL of the VCS branch."),
+            allowed_schemes=["http", "https", "svn", "git"],
+            allow_userinfo=False, # Only anonymous access is supported.
+            allow_port=True,
+            allow_query=False,    # Query makes no sense in Subversion.
+            allow_fragment=False, # Fragment makes no sense in Subversion.
+            trailing_slash=False)) # See http://launchpad.net/bugs/56357.
+
+    cvs_root = exported(
+        TextLine(title=_("Repository"), required=False, readonly=True,
+            constraint=validate_cvs_root,
+            description=_("The CVSROOT. "
+                "Example: :pserver:[e-mail]:/cvs/gnome")))
+
+    cvs_module = exported(
+        TextLine(title=_("Module"), required=False, readonly=True,
+            constraint=validate_cvs_module,
+            description=_("The path to import within the repository."
+                " Usually, it is the name of the project.")))
+
+    date_last_successful = exported(
+        Datetime(title=_("Last successful"), required=False, readonly=True))
 
     update_interval = Timedelta(
         title=_("Update interval"), required=False, description=_(

=== modified file 'lib/lp/code/interfaces/webservice.py'
--- lib/lp/code/interfaces/webservice.py	2009-07-17 00:26:05 +0000
+++ lib/lp/code/interfaces/webservice.py	2010-03-17 21:52:39 +0000
@@ -6,6 +6,7 @@
 from lp.code.interfaces.branch import IBranch, IBranchSet
 from lp.code.interfaces.branchmergeproposal import IBranchMergeProposal
 from lp.code.interfaces.branchsubscription import IBranchSubscription
+from lp.code.interfaces.codeimport import ICodeImport
 from lp.code.interfaces.codereviewcomment import ICodeReviewComment
 from lp.code.interfaces.codereviewvote import ICodeReviewVoteReference
 from lp.code.interfaces.diff import IDiff, IPreviewDiff, IStaticDiff

=== modified file 'lib/lp/code/stories/webservice/xx-branch.txt'
--- lib/lp/code/stories/webservice/xx-branch.txt	2010-02-17 22:34:52 +0000
+++ lib/lp/code/stories/webservice/xx-branch.txt	2010-03-17 21:52:39 +0000
@@ -108,6 +108,7 @@
     branch_format: None
     branch_type: u'Hosted'
     bzr_identity: u'lp://dev/~eric/fooix/trunk'
+    code_import_link: None
     control_format: None
     date_created: u'2009-01-01T00:00:00+00:00'
     date_last_modified: u'2009-01-01T00:00:00+00:00'

=== added file 'lib/lp/code/stories/webservice/xx-code-import.txt'
--- lib/lp/code/stories/webservice/xx-code-import.txt	1970-01-01 00:00:00 +0000
+++ lib/lp/code/stories/webservice/xx-code-import.txt	2010-03-17 21:52:39 +0000
@@ -0,0 +1,59 @@
+Introduction
+============
+
+Launchpad can tell you about the code imports that power a branch
+if it is an import branch.
+
+    >>> from zope.security.proxy import removeSecurityProxy
+
+First we create some objects for use in the tests.
+
+    >>> login(ANONYMOUS)
+    >>> person = factory.makePerson(name='import-owner')
+    >>> product = factory.makeProduct(name='scruff')
+    >>> code_import = removeSecurityProxy(factory.makeCodeImport(
+    ...    registrant=person, product=product, branch_name='import'))
+    >>> no_import_branch = removeSecurityProxy(factory.makeProductBranch(
+    ...     owner=person, product=product, name='no-import'))
+    >>> logout()
+
+If we query a branch with no import then we find that it tells us
+it doesn't have one.
+
+    >>> branch_url = '/' + no_import_branch.unique_name
+    >>> response = webservice.get(branch_url)
+    >>> representation = response.jsonBody()
+    >>> print representation['code_import_link']
+    None
+
+For a branch with an import we get a link to the import entry in its
+representation.
+
+    >>> branch_url = '/' + code_import.branch.unique_name
+    >>> response = webservice.get(branch_url)
+    >>> representation = response.jsonBody()
+    >>> print representation['code_import_link']
+    http://.../~import-owner/scruff/import/+code-import
+
+We can get some information about the import using this URL.
+
+    >>> import_url = representation['code_import_link']
+    >>> response = webservice.get(import_url)
+    >>> representation = response.jsonBody()
+    >>> print representation['self_link'] == import_url
+    True
+    >>> print representation['branch_link']
+    http://.../~import-owner/scruff/import
+    >>> print representation['review_status']
+    Pending Review
+    >>> print representation['rcs_type']
+    Subversion via CSCVS
+    >>> print representation['url']
+    http://domain9.domain.com/path10
+    >>> print representation['cvs_root']
+    None
+    >>> print representation['cvs_module']
+    None
+    >>> print representation['date_last_successful']
+    None
+