Merge lp:~leonardr/lazr.restful/integrate-strict-versioning into lp:lazr.restful

[Leonard Richardson]

This branch makes minor changes that were neccessary to integrate lazr.restful's 'strict versioning' feature into Launchpad.

* Instead of being run when register_webservice is called, webservice_sanity_checks() is run when Zope starts up. This was necessary because register_webservice can be called many times over the course of building a webservice, and when that happens the web service will not necessarily be self-consistent any of those times (except the last).

* Fixed a bad entry in utils.py __all__.

Also some minor cleanup:

* Use dict_for_name() in one place instead of reinventing the wheel.

[lp:~leonardr/lazr.restful/integrate-strict-versioning]

190. By Leonard Richardson on 2011-03-23

Removed another breakpoint.

[Данило Шеган (danilo)]

review: Approve

=== modified file 'setup.py'
--- setup.py	2010-10-05 17:55:44 +0000
+++ setup.py	2011-03-23 14:39:44 +0000
@@ -74,6 +74,7 @@
         'zope.event',
         'zope.interface',
         'zope.pagetemplate',
+        'zope.processlifetime',
         'zope.proxy',
         'zope.publisher',
         'zope.schema',

=== modified file 'src/lazr/restful/NEWS.txt'
--- src/lazr/restful/NEWS.txt	2011-03-14 23:07:52 +0000
+++ src/lazr/restful/NEWS.txt	2011-03-23 14:39:44 +0000
@@ -2,6 +2,14 @@
 NEWS for lazr.restful
 =====================
 
+0.18.0 (Unreleased)
+===================
+
+If the configuration variable `require_explicit_versions` is set,
+lazr.restful will not load up a web service unless every field, entry,
+and named operation explicitly states which version of the web service
+it first appears in.
+
 0.17.5 (2011-03-15)
 ===================
 

=== modified file 'src/lazr/restful/configure.zcml'
--- src/lazr/restful/configure.zcml	2011-03-15 15:44:46 +0000
+++ src/lazr/restful/configure.zcml	2011-03-23 14:39:44 +0000
@@ -19,6 +19,9 @@
         <allow interface='lazr.restful.interfaces.IJSONPublishable' />
     </class>
 
+    <subscriber for="zope.processlifetime.IProcessStarting"
+        handler="lazr.restful.metazcml.webservice_sanity_checks" />
+
     <!--
     XXX flacoste 2008/05/09 bug=185958:
     Ideally, we would use webservice_error() to register the view,

=== modified file 'src/lazr/restful/declarations.py'
--- src/lazr/restful/declarations.py	2011-03-17 14:21:32 +0000
+++ src/lazr/restful/declarations.py	2011-03-23 14:39:44 +0000
@@ -1344,12 +1344,10 @@
     if tag is None:
         raise TypeError(
             "'%s' isn't tagged for webservice export." % method.__name__)
-    match = [annotations for version_name, annotations in tag.stack
-             if version_name==version]
-    if len(match) == 0:
+    match = tag.dict_for_name(version)
+    if match is None:
         raise AssertionError("'%s' isn't tagged for export to web service "
                              "version '%s'" % (method.__name__, version))
-    tag = match[0]
     config = getUtility(IWebServiceConfiguration)
     if version is None:
         # This code path is not currently used except in a test, since
@@ -1365,7 +1363,7 @@
                 'annotation stack.' % (method.__name__, version, version))
 
     bases = (BaseResourceOperationAdapter, )
-    operation_type = tag['type']
+    operation_type = match['type']
     if operation_type == 'read_operation':
         prefix = 'GET'
         provides = IResourceGETOperation
@@ -1380,16 +1378,16 @@
     else:
         raise AssertionError('Unknown method export type: %s' % operation_type)
 
-    return_type = tag['return_type']
+    return_type = match['return_type']
 
     name = _versioned_class_name(
-        '%s_%s_%s' % (prefix, method.interface.__name__, tag['as']),
+        '%s_%s_%s' % (prefix, method.interface.__name__, match['as']),
         version)
     class_dict = {
-        'params': tuple(tag['params'].values()),
+        'params': tuple(match['params'].values()),
         'return_type': return_type,
         '_orig_iface': method.interface,
-        '_export_info': tag,
+        '_export_info': match,
         '_method_name': method.__name__,
         '__doc__': method.__doc__}
 

=== modified file 'src/lazr/restful/metazcml.py'
--- src/lazr/restful/metazcml.py	2011-03-18 15:31:53 +0000
+++ src/lazr/restful/metazcml.py	2011-03-23 14:39:44 +0000
@@ -10,6 +10,7 @@
 import itertools
 
 from zope.component import (
+    adapter,
     getGlobalSiteManager,
     getUtility,
     )
@@ -17,6 +18,7 @@
 from zope.configuration.fields import GlobalObject
 from zope.interface import Interface
 from zope.interface.interfaces import IInterface
+from zope.processlifetime import IProcessStarting
 
 from lazr.restful.declarations import (
     COLLECTION_TYPE,
@@ -47,6 +49,12 @@
 from lazr.restful.utils import VersionedObject
 
 
+# Keep track of entry and operation registrations so we can
+# sanity-check them later.
+REGISTERED_ENTRIES = []
+REGISTERED_OPERATIONS = []
+
+
 class IRegisterDirective(Interface):
     """Directive to hook up webservice based on the declarations in a module.
     """
@@ -281,11 +289,6 @@
                         module, type(module))
     interfaces_with_contributors = find_interfaces_and_contributors(module)
 
-    # Keep track of entry and operation registrations so we can
-    # sanity-check them later.
-    registered_entries = []
-    registered_operations = []
-
     for interface, contributors in interfaces_with_contributors.items():
         if issubclass(interface, Exception):
             register_exception_view(context, interface)
@@ -297,7 +300,7 @@
                 discriminator=('webservice entry interface', interface),
                     callable=generate_and_register_entry_adapters,
                     args=(interface, context.info, contributors,
-                          registered_entries),
+                          REGISTERED_ENTRIES),
                     )
         elif tag['type'] == COLLECTION_TYPE:
             for version in tag['collection_default_content'].keys():
@@ -315,19 +318,11 @@
             raise AssertionError('Unknown export type: %s' % tag['type'])
         context.action(
             discriminator=('webservice versioned operations', interface),
-            args=(context, interface, contributors, registered_operations),
+            args=(context, interface, contributors, REGISTERED_OPERATIONS),
             callable=generate_and_register_webservice_operations)
 
-    # Now that all the adapters and operations are registered, run a
-    # sanity check to make sure no version of the web service
-    # references a feature not available in that version
-    context.action(
-        discriminator=('webservice sanity checks'),
-        args=(registered_entries, registered_operations),
-        callable=webservice_sanity_checks)
-
-
-def webservice_sanity_checks(entries, operations):
+@adapter(IProcessStarting)
+def webservice_sanity_checks(registration):
     """Ensure the web service contains no references to unpublished objects.
 
     We are worried about fields that link to unpublished objects, and
@@ -336,7 +331,6 @@
     it may not be published in the same version in which it's
     referenced.
     """
-
     # Create a mapping of marker interfaces to version names.
     versions = getUtility(IWebServiceConfiguration).active_versions
     version_for_marker = { IWebServiceClientRequest: versions[0] }
@@ -362,7 +356,7 @@
     # Check every Reference and CollectionField field in every IEntry
     # interface, making sure that they only reference entries that are
     # published in that version.
-    for version, interface in entries:
+    for version, interface in REGISTERED_ENTRIES:
         for name, field in interface.namesAndDescriptions():
             referenced_interface, what = _extract_reference_type(field)
             if referenced_interface is not None:
@@ -376,7 +370,7 @@
     # named operation published in that version, making sure that
     # there are no references to IEntries not published in that
     # version.
-    for version, method in operations:
+    for version, method in REGISTERED_OPERATIONS:
         tags = method.getTaggedValue(LAZR_WEBSERVICE_EXPORTED)
         return_type = tags.get('return_type')
         referenced_interface, what = _extract_reference_type(return_type)

=== modified file 'src/lazr/restful/utils.py'
--- src/lazr/restful/utils.py	2011-03-17 14:21:32 +0000
+++ src/lazr/restful/utils.py	2011-03-23 14:39:44 +0000
@@ -15,8 +15,8 @@
     'smartquote',
     'simple_popen2',
     'tag_request_with_version_name',
-    'VersionedAnnotations',
     'VersionedDict',
+    'VersionedObject',
     ]
 
 

=== modified file 'src/lazr/restful/version.txt'
--- src/lazr/restful/version.txt	2011-03-14 23:26:59 +0000
+++ src/lazr/restful/version.txt	2011-03-23 14:39:44 +0000
@@ -1,1 +1,1 @@
-0.17.5
+0.18.0

=== modified file 'versions.cfg'
--- versions.cfg	2010-10-05 15:55:18 +0000
+++ versions.cfg	2011-03-23 14:39:44 +0000
@@ -58,6 +58,7 @@
 zope.lifecycleevent = 3.5.2
 zope.location = 3.7.0
 zope.pagetemplate = 3.5.0
+zope.processlifetime = 1.0
 zope.proxy = 3.5.0
 zope.publisher = 3.12.0
 zope.schema = 3.5.4