Merge lp:~leonardr/lazr.restful/register-operations-when-version-list-is-known into lp:lazr.restful

[Leonard Richardson]

[Leonard Richardson (leonardr)]

The web service registration code runs in the first stage of ZCML processing. Originally, the adapter classes for entries, collections, and named operations were all generated in this first stage. Then came the multi-version code, and there was no way to generate a set of entries without knowing the list of active versions published by the web site.

Unfortunately, the list of active versions is a property of the IWebServiceConfiguration utility, and utilities are not available in the first stage of ZCML processing. So I wrote code that used context.action() to defer the entry generation code until the second stage of ZCML processing, when utilities are available.

The project I'm working on now (no longer exporting mutator methods as named operations) requires that the list of active versions be available when generating the adapters for named operations. This branch does the same trick for named operations as I did earlier for entries: uses context.action() to defer the generation code until the second stage of ZCML processing.

A side effect of this is that when naming the adapters for named operations, we can use the actual name of the first version instead of "__Earliest". I got rid of almost all instances of "__Earliest" in the tests. (There was one I couldn't get rid of, and since that's not the point of my project and it wasn't hurting anything, I've left it alone for now.)

[Brad Crittenden (bac)]

review: Approve (code)

=== modified file 'src/lazr/restful/declarations.py'
--- src/lazr/restful/declarations.py	2010-02-18 15:17:09 +0000
+++ src/lazr/restful/declarations.py	2010-02-23 17:50:32 +0000
@@ -1162,11 +1162,7 @@
                              "version '%s'" % (method.__name__, version))
     tag = match[0]
     if version is None:
-        # We need to incorporate the version into a Python class name,
-        # but we won't find out the name of the earliest version until
-        # runtime. Use a generic string that won't conflict with a
-        # real version string.
-        version = "__Earliest"
+        version = getUtility(IWebServiceConfiguration).active_versions[0]
 
     bases = (BaseResourceOperationAdapter, )
     if tag['type'] == 'read_operation':

=== modified file 'src/lazr/restful/docs/webservice-declarations.txt'
--- src/lazr/restful/docs/webservice-declarations.txt	2010-02-16 16:14:01 +0000
+++ src/lazr/restful/docs/webservice-declarations.txt	2010-02-23 17:50:32 +0000
@@ -1060,15 +1060,15 @@
     >>> IResourceGETOperation.implementedBy(read_method_adapter_factory)
     True
 
-The defined adapter is named GET_<interface>_<exported_name>___Earliest
-and uses the ResourceOperation base class. The "___Earliest" indicates
+The defined adapter is named GET_<interface>_<exported_name>_beta
+and uses the ResourceOperation base class. The "_beta" indicates
 that the adapter will be used in the earliest version of the web
 service, and any subsequent versions, until a newer implementation
 supercedes it.
 
     >>> from lazr.restful import ResourceOperation
     >>> read_method_adapter_factory.__name__
-    'GET_IBookSetOnSteroids_searchBooks___Earliest'
+    'GET_IBookSetOnSteroids_searchBooks_beta'
     >>> issubclass(read_method_adapter_factory, ResourceOperation)
     True
 
@@ -1129,10 +1129,10 @@
     >>> IResourcePOSTOperation.implementedBy(write_method_adapter_factory)
     True
 
-The generated adapter class name is POST_<interface>_<operation>___Earliest.
+The generated adapter class name is POST_<interface>_<operation>_beta.
 
     >>> print write_method_adapter_factory.__name__
-    POST_IBookOnSteroids_checkout___Earliest
+    POST_IBookOnSteroids_checkout_beta
 
 The adapter's params property also contains the available parameters
 (for which there are none in this case.)
@@ -1178,10 +1178,10 @@
     False
 
 The generated adapter class name is also
-POST_<interface>_<operation>___Earliest.
+POST_<interface>_<operation>_beta.
 
     >>> print write_method_adapter_factory.__name__
-    POST_IBookOnSteroids_checkout___Earliest
+    POST_IBookOnSteroids_checkout_beta
 
 The adapter's params property also contains the available parameters.
 
@@ -1253,10 +1253,10 @@
     True
 
 The generated adapter class name is
-DELETE_<interface>_<operation>___Earliest.
+DELETE_<interface>_<operation>_beta.
 
     >>> print destructor_method_adapter_factory.__name__
-    DELETE_IBookOnSteroids_destroy___Earliest
+    DELETE_IBookOnSteroids_destroy_beta
 
 
 === Destructor ===
@@ -2038,7 +2038,7 @@
     >>> method = IMultiVersionMethod['a_method']
     >>> adapter_earliest_factory = generate_operation_adapter(method, None)
     >>> print adapter_earliest_factory.__name__
-    GET_IMultiVersionMethod_a_method___Earliest
+    GET_IMultiVersionMethod_a_method_beta
 
     >>> method_earliest = adapter_earliest_factory(data_object, request)
     >>> print method_earliest.call(required="foo")
@@ -2537,15 +2537,15 @@
     >>> adapter_registry.lookup(
     ...     (IBookSetOnSteroids, request_interface),
     ...     IResourceGETOperation, 'searchBooks')
-    <class '...GET_IBookSetOnSteroids_searchBooks___Earliest'>
+    <class '...GET_IBookSetOnSteroids_searchBooks_beta'>
     >>> adapter_registry.lookup(
     ...     (IBookSetOnSteroids, request_interface),
     ...     IResourcePOSTOperation, 'create_book')
-    <class '...POST_IBookSetOnSteroids_create_book___Earliest'>
+    <class '...POST_IBookSetOnSteroids_create_book_beta'>
     >>> adapter_registry.lookup(
     ...     (IBookOnSteroids, request_interface),
     ...     IResourcePOSTOperation, 'checkout')
-    <class '...POST_IBookOnSteroids_checkout___Earliest'>
+    <class '...POST_IBookOnSteroids_checkout_beta'>
 
 There is also a 'index.html' view on the IWebServiceClientRequest
 registered for the InvalidEmail exception.
@@ -2603,17 +2603,17 @@
     ...     export_as_webservice_entry()
     ...     @operation_parameters(arg=TextLine())
     ...     @export_operation_as('already_been_removed')
-    ...     @operation_removed_in_version("1.0")
+    ...     @operation_removed_in_version("2.0")
     ...     @operation_parameters(arg=Float())
     ...     @export_read_operation()
-    ...     @operation_for_version("2.0")
+    ...     @operation_for_version("1.0")
     ...     def method(arg):
     ...         """A method."""
 
     >>> register_test_module('annotatingremoved', AnnotatingARemovedMethod)
     Traceback (most recent call last):
     ...
-    ZopeXMLConfigurationError: ...
-    AssertionError: Method "method" contains annotations for version
-    "1.0", even though it's not published in that version. The bad
-    annotations are: "params", "as".
+    ConfigurationExecutionError: ... Method "method" contains
+    annotations for version "2.0", even though it's not published in
+    that version. The bad annotations are: "params", "as".
+    ...

=== modified file 'src/lazr/restful/metazcml.py'
--- src/lazr/restful/metazcml.py	2010-02-15 02:24:19 +0000
+++ src/lazr/restful/metazcml.py	2010-02-23 17:50:32 +0000
@@ -201,10 +201,13 @@
                     )
         else:
             raise AssertionError('Unknown export type: %s' % tag['type'])
-        register_webservice_operations(context, interface)
-
-
-def register_webservice_operations(context, interface):
+        context.action(
+            discriminator=('webservice versioned operations', interface),
+            args=(context, interface),
+            callable=generate_and_register_webservice_operations)
+
+
+def generate_and_register_webservice_operations(context, interface):
     """Create and register adapters for all exported methods.
 
     Different versions of the web service may publish the same
@@ -218,11 +221,8 @@
 
         # First, make sure that this method was annotated with the
         # versions in the right order.
-        context.action(
-            discriminator=('webservice version ordering', interface, method),
-            callable=ensure_correct_version_ordering,
-            args=(interface.__name__ + '.' + method.__name__, tag.dict_names)
-        )
+        ensure_correct_version_ordering(
+            interface.__name__ + '.' + method.__name__, tag.dict_names)
 
         operation_name = None
         # If an operation's name does not change between version n and
@@ -294,21 +294,19 @@
             # version, or if the operation was removed in this
             # version, we need to block lookups of the previous name
             # from working.
-            check = (previous_operation_name, previous_operation_provides,
-                     operation_name, operation_provides, version, factory)
             if (operation_name != previous_operation_name
                 and previous_operation_name is not None):
-                _add_versioned_adapter_action(
-                    context, interface, previous_operation_provides,
-                    previous_operation_name, version,
-                    _mask_adapter_registration)
+                register_adapter_for_version(
+                    _mask_adapter_registration, interface, version,
+                    previous_operation_provides, previous_operation_name,
+                    context.info)
 
             # If the operation exists in this version (ie. its name is
             # not None), register it using this version's name.
             if operation_name is not None:
-                _add_versioned_adapter_action(
-                    context, interface, operation_provides, operation_name,
-                    version, factory)
+                register_adapter_for_version(
+                    factory, interface, version, operation_provides,
+                    operation_name, context.info)
             previous_operation_name = operation_name
             previous_operation_provides = operation_provides
 
@@ -322,30 +320,6 @@
     return None
 
 
-def _add_versioned_adapter_action(
-    context, interface, provides, name, version, factory):
-    """Helper function to register a versioned operation factory.
-
-    :param context: The context on which to add a registration action.
-    :param interface: The IEntry subclass that publishes the named
-        operation.
-    :param provides: The IResourceOperation subclass provided by the
-        factory.
-    :param name: The name of the named operation in this version.
-    :param version: The version of the web service that publishes this
-         named operation.
-    :param factory: The object that handles invocations of the named
-        operation.
-    """
-    context.action(
-        discriminator=(
-            'webservice versioned adapter',
-            (interface, IWebServiceClientRequest), provides, name, version),
-        callable=register_adapter_for_version,
-        args=(factory, interface, version, provides, name, context.info),
-        )
-
-
 def register_exception_view(context, exception):
     """Register WebServiceExceptionView to handle exception on the webservice.
     """