Merge lp:~jtv/launchpad/branch-url into lp:launchpad

[Jeroen T. Vermeulen]

Compose public URLs for branches.

[Jeroen T. Vermeulen (jtv)]

= IBranch.composePublicURL =

It turns out to be useful to have a method to compose a public URL for a branch on a given protocol. For the Translations buildfarm work, as the driving use-case, it makes it easy for us to open up a single firewall hole for a slave to check out a read-only copy of a public branch.

Test:

{{{
./bin/test -vv -t TestComposePublicURL
}}}

There is a bunch of pre-existing lint in {{{lib/lp/code/interfaces/branch.py}}} that's obviously caused by a confused checker. It complains about named parameters, thinking the "=" signs are assignments. I left those untouched, but eliminated all other lint (including a drive-by on a duplicate import).

Jeroen

[Aaron Bentley (abentley)]

review: Approve

=== modified file 'lib/lp/code/configure.zcml'
--- lib/lp/code/configure.zcml	2010-02-17 11:19:42 +0000
+++ lib/lp/code/configure.zcml	2010-02-19 17:26:20 +0000
@@ -395,6 +395,7 @@
                     branch_type
                     name
                     url
+                    composePublicURL
                     whiteboard
                     target
                     mirror_status_message

=== modified file 'lib/lp/code/interfaces/branch.py'
--- lib/lp/code/interfaces/branch.py	2010-02-17 22:34:52 +0000
+++ lib/lp/code/interfaces/branch.py	2010-02-19 17:26:21 +0000
@@ -1,4 +1,4 @@
-# Copyright 2009 Canonical Ltd.  This software is licensed under the
+# Copyright 2009-2010 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 # pylint: disable-msg=E0211,E0213,F0401,W0611
@@ -356,6 +356,17 @@
                 "This is the external location where the Bazaar "
                 "branch is hosted.")))
 
+    @operation_parameters(
+        scheme=TextLine(title=_("URL scheme"), default=u'http'))
+    @export_read_operation()
+    def composePublicURL(scheme='http'):
+        """Return a public URL for the branch using the given protocol.
+
+        :param scheme: a protocol name accepted by the public
+            code-hosting API.  (As a legacy issue, 'sftp' is also
+            accepted).
+        """
+
     description = exported(
         Text(
             title=_('Description'), required=False,

=== modified file 'lib/lp/code/model/branch.py'
--- lib/lp/code/model/branch.py	2010-02-02 22:26:04 +0000
+++ lib/lp/code/model/branch.py	2010-02-19 17:26:21 +0000
@@ -1,4 +1,4 @@
-# Copyright 2009 Canonical Ltd.  This software is licensed under the
+# Copyright 2009-2010 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 # pylint: disable-msg=E0611,W0212,W0141,F0401
@@ -7,9 +7,11 @@
 __all__ = [
     'Branch',
     'BranchSet',
+    'compose_public_url',
     ]
 
 from datetime import datetime
+import os.path
 
 from bzrlib.branch import Branch as BzrBranch
 from bzrlib.revision import NULL_REVISION
@@ -27,6 +29,8 @@
 from sqlobject import (
     ForeignKey, IntCol, StringCol, BoolCol, SQLMultipleJoin, SQLRelatedJoin)
 
+from lazr.uri import URI
+
 from canonical.config import config
 from canonical.database.constants import DEFAULT, UTC_NOW
 from canonical.database.sqlbase import (
@@ -75,7 +79,6 @@
 from lp.registry.interfaces.person import (
     validate_person_not_private_membership, validate_public_person)
 from lp.services.job.interfaces.job import JobStatus
-from lp.services.job.model.job import Job
 from lp.services.mail.notificationrecipientset import (
     NotificationRecipientSet)
 
@@ -478,6 +481,14 @@
             is_dev_focus = False
         return bazaar_identity(self, is_dev_focus)
 
+    def composePublicURL(self, scheme='http'):
+        """See `IBranch`."""
+        # Not all protocols work for private branches.
+        public_schemes = ['http']
+        assert not (self.private and scheme in public_schemes), (
+            "Private branch %s has no public URL." % self.unique_name)
+        return compose_public_url(scheme, self.unique_name)
+
     @property
     def warehouse_url(self):
         """See `IBranch`."""
@@ -1287,3 +1298,18 @@
     """
     update_trigger_modified_fields(branch)
     send_branch_modified_notifications(branch, event)
+
+
+def compose_public_url(scheme, unique_name, suffix=None):
+    # Avoid circular imports.
+    from lp.code.xmlrpc.branch import PublicCodehostingAPI
+
+    # Accept sftp as a legacy protocol.
+    accepted_schemes = set(PublicCodehostingAPI.supported_schemes)
+    accepted_schemes.add('sftp')
+    assert scheme in accepted_schemes, "Unknown scheme: %s" % scheme
+    host = URI(config.codehosting.supermirror_root).host
+    path = '/' + unique_name
+    if suffix is not None:
+        path = os.path.join(path, suffix)
+    return str(URI(scheme=scheme, host=host, path=path))

=== modified file 'lib/lp/code/tests/test_branch.py'
--- lib/lp/code/tests/test_branch.py	2009-12-14 00:04:19 +0000
+++ lib/lp/code/tests/test_branch.py	2010-02-19 17:26:20 +0000
@@ -17,6 +17,7 @@
     BranchSubscriptionDiffSize, BranchSubscriptionNotificationLevel,
     CodeReviewNotificationLevel)
 from lp.code.interfaces.linkedbranch import ICanHasLinkedBranch
+from lp.code.xmlrpc.branch import PublicCodehostingAPI
 from lp.registry.interfaces.series import SeriesStatus
 from lp.registry.interfaces.pocket import PackagePublishingPocket
 from lp.soyuz.interfaces.archivepermission import IArchivePermissionSet
@@ -348,5 +349,51 @@
         self.assertCanEdit(registrant, branch)
 
 
+class TestComposePublicURL(TestCaseWithFactory):
+
+    layer = DatabaseFunctionalLayer
+
+    def setUp(self):
+        super(TestComposePublicURL, self).setUp('[e-mail]')
+
+    def test_composePublicURL_accepts_supported_schemes(self):
+        # composePublicURL accepts all schemes that PublicCodehostingAPI
+        # supports.
+        branch = self.factory.makeAnyBranch()
+
+        url_pattern = '%%s://bazaar.launchpad.dev/~%s/%s/%s' % (
+            branch.owner.name, branch.product.name, branch.name)
+        for scheme in PublicCodehostingAPI.supported_schemes:
+            public_url = branch.composePublicURL(scheme)
+            self.assertEqual(url_pattern % scheme, public_url)
+
+        # sftp support is also grandfathered in.
+        sftp_url = branch.composePublicURL('sftp')
+        self.assertEqual(url_pattern % 'sftp', sftp_url)
+
+    def test_composePublicURL_default_http(self):
+        # The default scheme for composePublicURL is http.
+        branch = self.factory.makeAnyBranch()
+        prefix = 'http://'
+        public_url = branch.composePublicURL()
+        self.assertEqual(prefix, public_url[:len(prefix)])
+
+    def test_composePublicURL_unknown_scheme(self):
+        # Schemes that aren't known to be supported are not accepted.
+        branch = self.factory.makeAnyBranch()
+        self.assertRaises(AssertionError, branch.composePublicURL, 'irc')
+
+    def test_composePublicURL_http_private(self):
+        # Private branches don't have public http URLs.
+        branch = self.factory.makeAnyBranch(private=True)
+        self.assertRaises(AssertionError, branch.composePublicURL, 'http')
+
+    def test_composePublicURL_no_https(self):
+        # There's no https support.  If there were, it should probably
+        # not work for private branches.
+        branch = self.factory.makeAnyBranch()
+        self.assertRaises(AssertionError, branch.composePublicURL, 'https')
+
+
 def test_suite():
     return unittest.TestLoader().loadTestsFromName(__name__)

=== modified file 'lib/lp/code/xmlrpc/branch.py'
--- lib/lp/code/xmlrpc/branch.py	2009-07-17 00:26:05 +0000
+++ lib/lp/code/xmlrpc/branch.py	2010-02-19 17:26:21 +0000
@@ -11,13 +11,10 @@
     'BranchSetAPI', 'IBranchSetAPI', 'IPublicCodehostingAPI',
     'PublicCodehostingAPI']
 
-import os
 
 from zope.component import getUtility
 from zope.interface import Interface, implements
 
-from lazr.uri import URI
-
 from canonical.config import config
 from lp.bugs.interfaces.bug import IBugSet
 from canonical.launchpad.webapp.interfaces import ILaunchBag, NotFoundError
@@ -185,10 +182,6 @@
 
     supported_schemes = 'bzr+ssh', 'http'
 
-    def _getBazaarHost(self):
-        """Return the hostname for the codehosting server."""
-        return URI(config.codehosting.supermirror_root).host
-
     def _getResultDict(self, branch, suffix=None, supported_schemes=None):
         """Return a result dict with a list of URLs for the given branch.
 
@@ -207,16 +200,13 @@
 
     def _getUniqueNameResultDict(self, unique_name, suffix=None,
                                  supported_schemes=None):
+        from lp.code.model.branch import compose_public_url
         if supported_schemes is None:
             supported_schemes = self.supported_schemes
         result = dict(urls=[])
-        host = self._getBazaarHost()
-        path = '/' + unique_name
-        if suffix is not None:
-            path = os.path.join(path, suffix)
         for scheme in supported_schemes:
             result['urls'].append(
-                str(URI(host=host, scheme=scheme, path=path)))
+                compose_public_url(scheme, unique_name, suffix))
         return result
 
     @return_fault