Merge lp:~mwhudson/launchpad/code-publisher-in-lp.code into lp:launchpad

[Michael Hudson-Doyle]

Move the code-specific publication code into lp.code

Hi horsemen,

This branch moves the code-specific publication gubbins into lp.code. This was surprisingly easy!

The overriding of the zope:publisher ZCML to make priority optional is a bit odd, but it beats having to insert random values into the zcml imho. I also want to override this to make switching sites off possible based on config values later, so it's worth keeping the code to do that in here.

Cheers,
mwh

[Curtis Hovey (sinzui)]

This looks good to land. I pondered the new metazcml directive. I think we need to dismantle webapp before we add some more to it.

review: Approve

[Michael Hudson-Doyle (mwhudson)]

Hi, can you look at this again? It failed tests so I made a few more changes.

I think we could eliminate some boilerplate by writing our own ZCML directive, how would something like

<lp:site
   name="code"
   web_service="true"
   request_class="lp.code.publisher.CodeLayer"/>

look to you?

[Curtis Hovey (sinzui)]

I like the suggestion. IT is not clear that site is a vhost. The directive could be vhost, but I think vhost="code" is most clear.

=== modified file 'lib/canonical/configure.zcml'
--- lib/canonical/configure.zcml	2010-07-15 15:57:40 +0000
+++ lib/canonical/configure.zcml	2010-07-20 23:57:54 +0000
@@ -99,14 +99,14 @@
     <browser:defaultView
         for="canonical.launchpad.interfaces.ILaunchpadRoot"
         name="+code"
-        layer="canonical.launchpad.layers.CodeLayer"
+        layer="lp.code.publisher.CodeLayer"
         />
     <browser:page
         name=""
         for="canonical.launchpad.interfaces.ILaunchpadRoot"
         class="canonical.launchpad.browser.launchpad.LaunchpadImageFolder"
         permission="zope.Public"
-        layer="canonical.launchpad.layers.CodeLayer"
+        layer="lp.code.publisher.CodeLayer"
         />
 
     <!-- virtual host: translations -->
 
=== modified file 'lib/canonical/launchpad/doc/webapp-publication.txt'
--- lib/canonical/launchpad/doc/webapp-publication.txt	2010-03-02 03:22:01 +0000
+++ lib/canonical/launchpad/doc/webapp-publication.txt	2010-07-20 23:57:54 +0000
@@ -372,10 +372,6 @@
     BugsBrowserRequest
     BugsPublication
 
-    >>> print_request_and_publication('code.launchpad.dev')
-    CodeBrowserRequest
-    CodePublication
-
     >>> print_request_and_publication('feeds.launchpad.dev')
     FeedsBrowserRequest
     FeedsPublication
@@ -417,7 +413,7 @@
     WebServiceClientRequest
     WebServicePublication
     >>> for subdomain in [
-    ...     'answers', 'blueprints', 'bugs', 'code', 'translations']:
+    ...     'answers', 'blueprints', 'bugs', 'translations']:
     ...     print_request_and_publication(
     ...         '%s.launchpad.dev' % subdomain, method='GET',
     ...         extra_environment={'PATH_INFO': '/api'})
@@ -429,8 +425,6 @@
     WebServicePublication
     WebServiceClientRequest
     WebServicePublication
-    WebServiceClientRequest
-    WebServicePublication
 
 Requests for '/api' on other hosts like feeds are handled like
 other requests on these hosts:
 
=== modified file 'lib/canonical/launchpad/layers.py'
--- lib/canonical/launchpad/layers.py	2009-12-25 22:36:11 +0000
+++ lib/canonical/launchpad/layers.py	2010-07-20 23:57:54 +0000
@@ -36,10 +36,6 @@
     """The `BugsLayer` layer."""
 
 
-class CodeLayer(LaunchpadLayer):
-    """The `CodeLayer` layer."""
-
-
 class BlueprintLayer(LaunchpadLayer):
     """The `BlueprintLayer` layer."""
 BlueprintsLayer = BlueprintLayer
 
=== modified file 'lib/canonical/launchpad/webapp/meta.zcml'
--- lib/canonical/launchpad/webapp/meta.zcml	2009-07-13 18:15:02 +0000
+++ lib/canonical/launchpad/webapp/meta.zcml	2010-07-20 23:57:54 +0000
@@ -69,6 +69,13 @@
       handler="canonical.launchpad.webapp.metazcml.authorizations"
       />
 
+  <directive
+      namespace="http://namespaces.zope.org/zope"
+      name="publisher"
+      schema="canonical.launchpad.webapp.metazcml.ILaunchpadPublicationDirective"
+      handler="canonical.launchpad.webapp.metazcml.launchpadPublisher"
+      />
+
   <groupingDirective
      namespace="http://namespaces.zope.org/zope"
      name="facet"
 
=== modified file 'lib/canonical/launchpad/webapp/metazcml.py'
--- lib/canonical/launchpad/webapp/metazcml.py	2010-04-11 14:46:42 +0000
+++ lib/canonical/launchpad/webapp/metazcml.py	2010-07-20 23:57:54 +0000
@@ -10,6 +10,8 @@
 import zope.configuration.config
 from zope.app.file.image import Image
 from zope.app.pagetemplate.engine import TrustedEngine
+from zope.app.publication.metaconfigure import publisher
+from zope.app.publication.metadirectives import IRequestPublicationDirective
 from zope.component import getUtility
 from zope.component.security import PublicPermission
 from zope.component.zcml import adapter, handler, utility, view
@@ -19,7 +21,7 @@
 from zope.publisher.interfaces.browser import (
     IBrowserPublisher, IBrowserRequest, IDefaultBrowserLayer)
 from zope.publisher.interfaces.xmlrpc import IXMLRPCRequest
-from zope.schema import TextLine
+from zope.schema import Int, TextLine
 from zope.security.checker import Checker, CheckerPublic
 from zope.security.interfaces import IPermission
 from zope.security.permission import Permission
@@ -33,6 +35,7 @@
 from z3c.ptcompat.zcml import page_directive as original_page
 from z3c.ptcompat.zcml import pages_directive as original_pages
 
+from canonical.config import config
 from canonical.launchpad.layers import FeedsLayer
 from canonical.launchpad.webapp.interfaces import (
     IApplicationMenu, IAuthorization, ICanonicalUrlData, IContextMenu,
@@ -651,3 +654,19 @@
                      description=''):
     permission = LaunchpadPermission(id, title, access_level, description)
     utility(_context, ILaunchpadPermission, permission, name=id)
+
+
+class ILaunchpadPublicationDirective(IRequestPublicationDirective):
+
+    priorty = Int(required=False)
+
+_arbitrary_priority = 12
+
+
+def launchpadPublisher(_context, name, factory, methods=['*'],
+                       mimetypes=['*'], priority=None):
+    global _arbitrary_priority
+    if priority is None:
+        _arbitrary_priority += 1
+        priority = _arbitrary_priority
+    publisher(_context, name, factory, methods, mimetypes, priority)
 
=== modified file 'lib/canonical/launchpad/webapp/servers.py'
--- lib/canonical/launchpad/webapp/servers.py	2010-07-19 14:45:32 +0000
+++ lib/canonical/launchpad/webapp/servers.py	2010-07-20 23:57:54 +0000
@@ -1023,14 +1023,6 @@
 class BlueprintPublication(LaunchpadBrowserPublication):
     """The publication used for the Blueprint site."""
 
-# ---- code
-
-class CodePublication(LaunchpadBrowserPublication):
-    """The publication used for the Code site."""
-
-class CodeBrowserRequest(LaunchpadBrowserRequest):
-    implements(canonical.launchpad.layers.CodeLayer)
-
 # ---- translations
 
 class TranslationsPublication(LaunchpadBrowserPublication):
@@ -1484,7 +1476,6 @@
         VWSHRP('mainsite', LaunchpadBrowserRequest, MainLaunchpadPublication,
                handle_default_host=True),
         VWSHRP('blueprints', BlueprintBrowserRequest, BlueprintPublication),
-        VWSHRP('code', CodeBrowserRequest, CodePublication),
         VWSHRP('translations', TranslationsBrowserRequest,
                TranslationsPublication),
         VWSHRP('bugs', BugsBrowserRequest, BugsPublication),
 
=== modified file 'lib/canonical/launchpad/zcml/marketing.zcml'
--- lib/canonical/launchpad/zcml/marketing.zcml	2009-07-13 18:15:02 +0000
+++ lib/canonical/launchpad/zcml/marketing.zcml	2010-07-20 23:57:54 +0000
@@ -95,14 +95,14 @@
     <!-- Marketing material for Code. -->
     <browser:renamed-page
         for="canonical.launchpad.webapp.interfaces.ILaunchpadApplication"
-        layer="canonical.launchpad.layers.CodeLayer"
+        layer="lp.code.publisher.CodeLayer"
         name="+about"
         new_name="+tour/branch-hosting-tracking"
         rootsite="mainsite"
         />
     <browser:renamed-page
         for="canonical.launchpad.webapp.interfaces.ILaunchpadApplication"
-        layer="canonical.launchpad.layers.CodeLayer"
+        layer="lp.code.publisher.CodeLayer"
         name="+faq"
         new_name="+tour/branch-hosting-tracking"
         rootsite="mainsite"
@@ -110,7 +110,7 @@
     <browser:renamed-page
         name="+tour"
         for="canonical.launchpad.webapp.interfaces.ILaunchpadApplication"
-        layer="canonical.launchpad.layers.CodeLayer"
+        layer="lp.code.publisher.CodeLayer"
         new_name="+tour/branch-hosting-tracking"
         rootsite="mainsite"
         />
 
=== modified file 'lib/lp/app/tests/test_help.py'
--- lib/lp/app/tests/test_help.py	2010-07-18 00:23:02 +0000
+++ lib/lp/app/tests/test_help.py	2010-07-20 23:57:54 +0000
@@ -11,13 +11,15 @@
 
 from canonical.testing.layers import FunctionalLayer
 from canonical.launchpad.layers import (
-    AnswersLayer, BlueprintsLayer, BugsLayer, CodeLayer, LaunchpadLayer,
+    AnswersLayer, BlueprintsLayer, BugsLayer, LaunchpadLayer,
     TranslationsLayer)
 from canonical.launchpad.testing.systemdocs import create_view
 from canonical.launchpad.webapp.interfaces import ILaunchpadApplication
 
 from canonical.lazr.folder import ExportedFolder
 
+from lp.code.publisher import CodeLayer
+
 # The root of the tree
 ROOT = os.path.realpath(
         os.path.join(
 
=== modified file 'lib/lp/code/browser/configure.zcml'
--- lib/lp/code/browser/configure.zcml	2010-07-14 10:09:35 +0000
+++ lib/lp/code/browser/configure.zcml	2010-07-20 23:57:54 +0000
@@ -18,11 +18,11 @@
 
   <browser:defaultView
       for="lp.registry.interfaces.product.IProductSet"
-      layer="canonical.launchpad.layers.CodeLayer"
+      layer="lp.code.publisher.CodeLayer"
       name="+project-cloud"/>
   <browser:page
       for="lp.registry.interfaces.product.IProductSet"
-      layer="canonical.launchpad.layers.CodeLayer"
+      layer="lp.code.publisher.CodeLayer"
       name="+project-cloud"
       class="lp.code.browser.bazaar.BazaarProductView"
       template="../templates/code-in-branches.pt"
@@ -87,7 +87,7 @@
         <browser:defaultView
             for="lp.code.interfaces.codeimportmachine.ICodeImportMachine"
             name="+index"
-            layer="canonical.launchpad.layers.CodeLayer"/>
+            layer="lp.code.publisher.CodeLayer"/>
         <browser:page
             for="lp.code.interfaces.codeimportmachine.ICodeImportMachine"
             class="lp.code.browser.codeimportmachine.CodeImportMachineView"
@@ -109,7 +109,7 @@
         <browser:defaultView
             for="lp.code.interfaces.codeimportmachine.ICodeImportMachineSet"
             name="+index"
-            layer="canonical.launchpad.layers.CodeLayer"/>
+            layer="lp.code.publisher.CodeLayer"/>
         <browser:page
             for="lp.code.interfaces.codeimportmachine.ICodeImportMachineSet"
             class="lp.code.browser.codeimportmachine.CodeImportMachineSetView"
@@ -685,7 +685,7 @@
         <browser:defaultView
             for="lp.code.interfaces.codeimport.ICodeImportSet"
             name="+index"
-            layer="canonical.launchpad.layers.CodeLayer"/>
+            layer="lp.code.publisher.CodeLayer"/>
         <browser:page
             for="lp.code.interfaces.codeimport.ICodeImportSet"
             class="lp.code.browser.codeimport.CodeImportSetView"
@@ -717,7 +717,7 @@
     <browser:defaultView
         for="lp.registry.interfaces.projectgroup.IProjectGroup"
         name="+branches"
-        layer="canonical.launchpad.layers.CodeLayer"/>
+        layer="lp.code.publisher.CodeLayer"/>
     <browser:page
         for="lp.registry.interfaces.sourcepackage.ISourcePackage"
         class="lp.code.browser.branchlisting.SourcePackageBranchesView"
@@ -804,7 +804,7 @@
                 PersonBranchesMenu"/>
         <browser:defaultView
             for="lp.registry.interfaces.person.IPerson"
-            layer="canonical.launchpad.layers.CodeLayer"
+            layer="lp.code.publisher.CodeLayer"
             name="+branches"/>
         <browser:page
             for="lp.registry.interfaces.person.IPerson"
@@ -914,22 +914,22 @@
 
     <browser:defaultView
         for="lp.registry.interfaces.sourcepackage.ISourcePackage"
-        layer="canonical.launchpad.layers.CodeLayer"
+        layer="lp.code.publisher.CodeLayer"
         name="+branches"/>
 
     <browser:defaultView
         for="lp.registry.interfaces.distributionsourcepackage.IDistributionSourcePackage"
-        layer="canonical.launchpad.layers.CodeLayer"
+        layer="lp.code.publisher.CodeLayer"
         name="+code-index"/>
 
     <browser:defaultView
         for="lp.registry.interfaces.distribution.IDistribution"
-        layer="canonical.launchpad.layers.CodeLayer"
+        layer="lp.code.publisher.CodeLayer"
         name="+branches"/>
 
     <browser:defaultView
         for="lp.registry.interfaces.distroseries.IDistroSeries"
-        layer="canonical.launchpad.layers.CodeLayer"
+        layer="lp.code.publisher.CodeLayer"
         name="+branches"/>
 
     <browser:url
@@ -956,7 +956,7 @@
 
     <browser:defaultView
         for="lp.registry.interfaces.personproduct.IPersonProduct"
-        layer="canonical.launchpad.layers.CodeLayer"
+        layer="lp.code.publisher.CodeLayer"
         name="+branches" />
 
     <browser:page
@@ -1099,7 +1099,7 @@
         <browser:defaultView
             for="lp.code.interfaces.sourcepackagerecipe.ISourcePackageRecipe"
             name="+index"
-            layer="canonical.launchpad.layers.CodeLayer"/>
+            layer="lp.code.publisher.CodeLayer"/>
         <browser:page
             for="lp.code.interfaces.sourcepackagerecipe.ISourcePackageRecipe"
             class="lp.code.browser.sourcepackagerecipe.SourcePackageRecipeView"
@@ -1117,7 +1117,7 @@
         <browser:defaultView
             for="lp.code.interfaces.sourcepackagerecipebuild.ISourcePackageRecipeBuild"
             name="+index"
-            layer="canonical.launchpad.layers.CodeLayer"/>
+            layer="lp.code.publisher.CodeLayer"/>
         <browser:page
             for="lp.code.interfaces.sourcepackagerecipebuild.ISourcePackageRecipeBuild"
             class="lp.code.browser.sourcepackagerecipebuild.SourcePackageRecipeBuildView"
 
=== modified file 'lib/lp/code/configure.zcml'
--- lib/lp/code/configure.zcml	2010-06-16 18:18:32 +0000
+++ lib/lp/code/configure.zcml	2010-07-20 23:57:54 +0000
@@ -13,6 +13,10 @@
   <include package=".browser"/>
   <authorizations module="lp.code.security" />
 
+  <publisher
+     name="code"
+     factory="lp.code.publisher.code_request_publication_factory"/>
+
   <!-- Branch Merge Queue -->
 
   <class class="lp.code.model.branchmergequeue.SingleBranchMergeQueue">
@@ -981,7 +985,7 @@
   <adapter factory="lp.code.model.linkedbranch.DistributionPackageLinkedBranch" />
 
   <lp:help-folder
-      folder="help" type="canonical.launchpad.layers.CodeLayer" />
+      folder="help" type="lp.code.publisher.CodeLayer" />
 
   <!-- Diffs -->
   <class class="lp.code.model.diff.Diff">
 
=== added file 'lib/lp/code/publisher.py'
--- lib/lp/code/publisher.py	1970-01-01 00:00:00 +0000
+++ lib/lp/code/publisher.py	2010-07-20 23:57:54 +0000
@@ -0,0 +1,34 @@
+# Copyright 2010 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Code's custom publication."""
+
+__metaclass__ = type
+__all__ = [
+    'CodeBrowserRequest',
+    'CodeLayer',
+    'code_request_publication_factory',
+    ]
+
+
+from zope.interface import implements
+from zope.publisher.interfaces.browser import (
+    IBrowserRequest, IDefaultBrowserLayer)
+
+from canonical.launchpad.webapp.publication import LaunchpadBrowserPublication
+from canonical.launchpad.webapp.servers import (
+    LaunchpadBrowserRequest, VHostWebServiceRequestPublicationFactory)
+
+
+class CodeLayer(IBrowserRequest, IDefaultBrowserLayer):
+    """The Code layer."""
+
+
+class CodeBrowserRequest(LaunchpadBrowserRequest):
+    """Instances of CodeBrowserRequest provide `CodeLayer`."""
+    implements(CodeLayer)
+
+
+def code_request_publication_factory():
+    return VHostWebServiceRequestPublicationFactory(
+        'code', CodeBrowserRequest, LaunchpadBrowserPublication)
 
=== added file 'lib/lp/code/tests/test_publisher.py'
--- lib/lp/code/tests/test_publisher.py	1970-01-01 00:00:00 +0000
+++ lib/lp/code/tests/test_publisher.py	2010-07-20 23:57:54 +0000
@@ -0,0 +1,45 @@
+# Copyright 2010 Canonical Ltd.  This software is licensed under the
+# GNU Affero General Public License version 3 (see the file LICENSE).
+
+"""Tests for code's custom publications."""
+
+__metaclass__ = type
+
+import unittest
+
+from canonical.config import config
+from canonical.launchpad.layers import WebServiceLayer
+from canonical.testing.layers import FunctionalLayer
+
+from lp.testing import TestCase
+from lp.testing.publication import get_request_and_publication
+
+from lp.code.publisher import CodeLayer
+
+
+class TestRegistration(TestCase):
+    """Code's publication customizations are installed correctly."""
+
+    layer = FunctionalLayer
+
+    def test_code_request_provides_code_layer(self):
+        # The request constructed for requests to the code hostname provides
+        # CodeLayer.
+        request, publication = get_request_and_publication(
+            host=config.vhost.code.hostname)
+        self.assertProvides(request, CodeLayer)
+
+    def test_code_host_has_api(self):
+        # Requests to /api on the code domain are treated as web service
+        # requests.
+        request, publication = get_request_and_publication(
+            host=config.vhost.code.hostname,
+            extra_environment={'PATH_INFO': '/api/1.0'})
+        # XXX MichaelHudson, 2010-07-20, bug=607664: WebServiceLayer only
+        # actually provides WebServiceLayer in the sense of verifyObject after
+        # traversal has started.
+        self.assertTrue(WebServiceLayer.providedBy(request))
+
+
+def test_suite():
+    return unittest.TestLoader().loadTestsFromName(__name__)
 
=== modified file 'lib/lp/registry/browser/configure.zcml'
--- lib/lp/registry/browser/configure.zcml	2010-05-27 04:10:17 +0000
+++ lib/lp/registry/browser/configure.zcml	2010-07-20 23:57:54 +0000
@@ -1357,7 +1357,7 @@
     <browser:defaultView
         for="lp.registry.interfaces.product.IProduct"
         name="+code-index"
-        layer="canonical.launchpad.layers.CodeLayer"/>
+        layer="lp.code.publisher.CodeLayer"/>
     <browser:defaultView
         for="lp.registry.interfaces.product.IProduct"
         layer="canonical.launchpad.layers.AnswersLayer"