Merge lp:~blr/launchpad/project-meta-go-import into lp:launchpad

[Kit Randel]

Add a go-lang remote import meta tag for git and bzr support.

Provides a meta tag with default git repository and bzr branch metadata on Project +index/ProductSeries +index for golang's `go get`.

See: https://golang.org/cmd/go/#hdr-Remote_import_paths

[William Grant (wgrant)]

review: Needs Fixing (code)

[William Grant (wgrant)]

There are a few assertEquals against None that should be assertIs.

review: Approve (code)

=== modified file 'lib/lp/registry/browser/product.py'
--- lib/lp/registry/browser/product.py	2015-07-02 01:50:50 +0000
+++ lib/lp/registry/browser/product.py	2015-07-02 07:06:37 +0000
@@ -161,7 +161,7 @@
     )
 from lp.code.interfaces.gitrepository import IGitRepositorySet
 from lp.code.browser.vcslisting import TargetDefaultVCSNavigationMixin
-
+from lp.code.interfaces.gitrepository import IGitRepositorySet
 from lp.registry.browser import (
     add_subscribe_link,
     BaseRdfView,
@@ -217,6 +217,7 @@
     stepto,
     structured,
     )
+from lp.services.config import config
 from lp.services.webapp.authorization import check_permission
 from lp.services.webapp.batching import BatchNavigator
 from lp.services.webapp.breadcrumb import Breadcrumb
@@ -1022,6 +1023,31 @@
     def requestCountry(self):
         return ICountry(self.request, None)
 
+    @property
+    def golang_import_spec(self):
+        """Meta string for golang remote import path.
+        See: https://golang.org/cmd/go/#hdr-Remote_import_paths
+        """
+        if self.context.vcs == VCSType.GIT:
+            repo = getUtility(IGitRepositorySet).getDefaultRepository(
+                self.context)
+            if repo:
+                return "{base_url}/{product} git {git_https_url}".format(
+                    base_url=config.vhost.mainsite.hostname,
+                    product=self.context.name,
+                    git_https_url=repo.git_https_url)
+            else:
+                return None
+        elif (self.context.vcs == VCSType.BZR and
+        self.context.development_focus.branch):
+            return ("{base_url}/{name} bzr "
+                    "{browse_root}{name}").format(
+                        base_url=config.vhost.mainsite.hostname,
+                        name=self.context.development_focus.branch.unique_name,
+                        browse_root=config.codehosting.supermirror_root)
+        else:
+            return None
+
     def browserLanguages(self):
         return browser_languages(self.request)
 

=== modified file 'lib/lp/registry/browser/productseries.py'
--- lib/lp/registry/browser/productseries.py	2015-06-25 00:33:52 +0000
+++ lib/lp/registry/browser/productseries.py	2015-07-02 07:06:37 +0000
@@ -71,7 +71,6 @@
     )
 from lp.bugs.interfaces.bugtask import IBugTaskSet
 from lp.code.browser.branchref import BranchRef
-from lp.code.enums import RevisionControlSystems
 from lp.code.interfaces.branchtarget import IBranchTarget
 from lp.registry.browser import (
     add_subscribe_link,
@@ -85,6 +84,7 @@
     PillarInvolvementView,
     )
 from lp.registry.browser.product import ProductSetBranchView
+from lp.registry.enums import VCSType
 from lp.registry.errors import CannotPackageProprietaryProduct
 from lp.registry.interfaces.packaging import (
     IPackaging,
@@ -92,6 +92,7 @@
     )
 from lp.registry.interfaces.productseries import IProductSeries
 from lp.registry.interfaces.series import SeriesStatus
+from lp.services.config import config
 from lp.services.propertycache import cachedproperty
 from lp.services.webapp import (
     ApplicationMenu,
@@ -379,6 +380,20 @@
         """The country associated with the IP of the request."""
         return ICountry(self.request, None)
 
+    @property
+    def golang_import_spec(self):
+        """Meta string for golang remote import path.
+        See: https://golang.org/cmd/go/#hdr-Remote_import_paths
+        """
+        if (self.context.product.vcs == VCSType.BZR and
+            self.context.product.development_focus.branch):
+            return ("{base_url}/{name} bzr {root}{name}").format(
+                base_url=config.vhost.mainsite.hostname,
+                name=self.context.branch.unique_name,
+                root=config.codehosting.supermirror_root)
+        else:
+            return None
+
     def browserLanguages(self):
         """The languages the user's browser requested."""
         return browser_languages(self.request)

=== modified file 'lib/lp/registry/browser/tests/test_product.py'
--- lib/lp/registry/browser/tests/test_product.py	2015-07-02 01:50:50 +0000
+++ lib/lp/registry/browser/tests/test_product.py	2015-07-02 07:06:37 +0000
@@ -27,6 +27,7 @@
     PROPRIETARY_INFORMATION_TYPES,
     ServiceUsage,
     )
+from lp.code.interfaces.gitrepository import IGitRepositorySet
 from lp.registry.browser.product import (
     ProjectAddStepOne,
     ProjectAddStepTwo,
@@ -295,6 +296,81 @@
         super(TestProductView, self).setUp()
         self.product = self.factory.makeProduct(name='fnord')
 
+    def test_golang_meta_renders_git(self):
+        # ensure golang meta import path is rendered if project has
+        # git default vcs.
+        # See: https://golang.org/cmd/go/#hdr-Remote_import_paths
+        repo = self.factory.makeGitRepository()
+        view = create_initialized_view(repo.target, '+index')
+        with person_logged_in(repo.target.owner):
+            getUtility(IGitRepositorySet).setDefaultRepository(
+                target=repo.target, repository=repo)
+            repo.target.vcs = VCSType.GIT
+
+        golang_import = '{base}/{product_name} git {repo_url}'.format(
+            base=config.vhost.mainsite.hostname,
+            product_name=repo.target.name,
+            repo_url=repo.git_https_url
+            )
+        self.assertEqual(golang_import, view.golang_import_spec)
+        meta_tag = Tag('go-import-meta', 'meta',
+                       attrs={'name': 'go-import', 'content': golang_import})
+        browser = self.getViewBrowser(repo.target, '+index',
+                                      user=repo.target.owner)
+        self.assertThat(browser.contents, HTMLContains(meta_tag))
+
+    def test_golang_meta_renders_bzr(self):
+        # ensure golang meta import path is rendered if project has
+        # bzr default vcs.
+        # See: https://golang.org/cmd/go/#hdr-Remote_import_paths
+        owner = self.factory.makePerson(name='zardoz')
+        product = self.factory.makeProduct(name='wapcaplet')
+        branch = self.factory.makeBranch(product=product, name='a-branch',
+                                         owner=owner)
+        view = create_initialized_view(branch.product, '+index')
+
+        with person_logged_in(branch.product.owner):
+            branch.product.development_focus.branch = branch
+            branch.product.vcs = VCSType.BZR
+
+        golang_import = (
+            "{base}/~zardoz/wapcaplet/a-branch bzr "
+            "{root}~zardoz/wapcaplet/a-branch").format(
+                base=config.vhost.mainsite.hostname,
+                root=config.codehosting.supermirror_root
+            )
+        self.assertEqual(golang_import, view.golang_import_spec)
+        meta_tag = Tag('go-import-meta', 'meta',
+                       attrs={'name': 'go-import', 'content': golang_import})
+        browser = self.getViewBrowser(branch.product, '+index',
+                                      user=branch.owner)
+        self.assertThat(browser.contents, HTMLContains(meta_tag))
+
+    def test_golang_meta_no_default_vcs(self):
+        # ensure golang meta import path is not rendered without
+        # a default vcs
+        branch = self.factory.makeBranch()
+        view = create_initialized_view(branch.product, '+index')
+        self.assertIsNone(view.golang_import_spec)
+
+    def test_golang_meta_no_default_branch(self):
+        # ensure golang meta import path is not rendered without
+        # a product development_focus.
+        branch = self.factory.makeBranch()
+        view = create_initialized_view(branch.product, '+index')
+        with person_logged_in(branch.product.owner):
+            branch.product.vcs = VCSType.BZR
+        self.assertIsNone(view.golang_import_spec)
+
+    def test_golang_meta_no_default_repo(self):
+        # ensure golang meta import path is not rendered without
+        # a default repo.
+        repo = self.factory.makeGitRepository()
+        view = create_initialized_view(repo.target, '+index')
+        with person_logged_in(repo.target.owner):
+            repo.target.vcs = VCSType.GIT
+        self.assertIsNone(view.golang_import_spec)
+
     def test_show_programming_languages_without_languages(self):
         # show_programming_languages is false when there are no programming
         # languages set.

=== modified file 'lib/lp/registry/browser/tests/test_productseries_views.py'
--- lib/lp/registry/browser/tests/test_productseries_views.py	2013-04-03 03:09:04 +0000
+++ lib/lp/registry/browser/tests/test_productseries_views.py	2015-07-02 07:06:37 +0000
@@ -15,6 +15,8 @@
     BugTaskStatus,
     BugTaskStatusSearch,
     )
+from lp.registry.enums import VCSType
+from lp.services.config import config
 from lp.services.webapp import canonical_url
 from lp.testing import (
     BrowserTestCase,
@@ -30,6 +32,34 @@
 
     layer = DatabaseFunctionalLayer
 
+    def test_golang_meta_renders(self):
+        # ensure golang meta import path is rendered if project has
+        # bzr default vcs.
+        # See: https://golang.org/cmd/go/#hdr-Remote_import_paths
+        owner = self.factory.makePerson(name='zardoz')
+        product = self.factory.makeProduct(name='wapcaplet')
+        branch = self.factory.makeBranch(product=product, name='a-branch',
+                                         owner=owner)
+        view = create_initialized_view(branch.product.development_focus,
+                                       '+index')
+        with person_logged_in(branch.product.owner):
+            branch.product.development_focus.branch = branch
+            branch.product.vcs = VCSType.BZR
+
+        golang_import = (
+            "{base}/~zardoz/wapcaplet/a-branch bzr "
+            "{root}~zardoz/wapcaplet/a-branch").format(
+                base=config.vhost.mainsite.hostname,
+                root=config.codehosting.supermirror_root
+            )
+        self.assertEqual(golang_import, view.golang_import_spec)
+        meta_tag = soupmatchers.Tag('go-import-meta', 'meta',
+                                    attrs={'name': 'go-import',
+                                           'content': golang_import})
+        browser = self.getViewBrowser(branch.product.development_focus,
+                                      '+index', user=branch.owner)
+        self.assertThat(browser.contents, soupmatchers.HTMLContains(meta_tag))
+
     def test_information_type_public(self):
         # A ProductSeries view should include its information_type,
         # which defaults to Public for new projects.

=== modified file 'lib/lp/registry/templates/product-index.pt'
--- lib/lp/registry/templates/product-index.pt	2015-06-19 01:10:52 +0000
+++ lib/lp/registry/templates/product-index.pt	2015-07-02 07:06:37 +0000
@@ -25,6 +25,9 @@
           });
       </script>
     </tal:uses_launchpad_bugtracker>
+
+    <meta name="go-import" tal:condition="view/golang_import_spec"
+          tal:attributes="content view/golang_import_spec" />
   </tal:head-epilogue>
 </head>
 

=== modified file 'lib/lp/registry/templates/productseries-index.pt'
--- lib/lp/registry/templates/productseries-index.pt	2012-10-16 15:12:09 +0000
+++ lib/lp/registry/templates/productseries-index.pt	2015-07-02 07:06:37 +0000
@@ -25,6 +25,8 @@
           });
       </script>
     </tal:uses_launchpad_bugtracker>
+    <meta name="go-import" tal:condition="view/golang_import_spec"
+          tal:attributes="content view/golang_import_spec" />
   </metal:block>
 
     <tal:heading metal:fill-slot="heading">