Merge lp:~leonardr/lazr.restful/fix-test-failures into lp:lazr.restful

[Leonard Richardson]

This branch fixes some test failures that started happening when I decoupled the webservice sanity checks from the module registration. Earlier, a web service that failed the sanity check would raise an exception during module registration. Now, the module is registered and the sanity check must be run afterwards. But I didn't change my tests to run the sanity check at all, so they just saw the module being registered and said "wait, that shouldn't have worked".

To fix the failures, I explicitly run webservice_sanity_checks and verify that it throws the expected exception. I also created a tearDown method to wipe lazr.restful's record of things that need to be sanity-checked.

[j.c.sackett (jcsackett)]

Looks good.

review: Approve

[lp:~leonardr/lazr.restful/fix-test-failures]

188. By Leonard Richardson on 2011-03-24

Run the sanity checks whenever registering a module.

189. By Leonard Richardson on 2011-03-24

Have the sanity-checking code itself responsible for clearing out the list of registered operations.

190. By Leonard Richardson on 2011-03-24

Removed unnecessary code.

=== modified file 'src/lazr/restful/NEWS.txt'
--- src/lazr/restful/NEWS.txt	2011-03-23 16:30:43 +0000
+++ src/lazr/restful/NEWS.txt	2011-03-24 21:21:48 +0000
@@ -2,6 +2,11 @@
 NEWS for lazr.restful
 =====================
 
+0.18.1 (2011-03-24)
+===================
+
+Fixed minor test failures.
+
 0.18.0 (2011-03-23)
 ===================
 

=== modified file 'src/lazr/restful/example/base/configure.zcml'
--- src/lazr/restful/example/base/configure.zcml	2011-02-02 14:15:24 +0000
+++ src/lazr/restful/example/base/configure.zcml	2011-03-24 21:21:48 +0000
@@ -6,6 +6,9 @@
   <webservice:register module="lazr.restful.example.base.interfaces" />
   <grok:grok package="lazr.restful.example.base" />
 
+  <subscriber for="zope.processlifetime.IProcessStarting"
+      handler="lazr.restful.metazcml.webservice_sanity_checks" />
+
   <!--Registering these two adapters will cause web_link to show up in
       representations.-->
 

=== modified file 'src/lazr/restful/metazcml.py'
--- src/lazr/restful/metazcml.py	2011-03-23 14:38:04 +0000
+++ src/lazr/restful/metazcml.py	2011-03-24 21:21:48 +0000
@@ -331,6 +331,9 @@
     it may not be published in the same version in which it's
     referenced.
     """
+    global REGISTERED_ENTRIES
+    global REGISTERED_OPERATIONS
+
     # Create a mapping of marker interfaces to version names.
     versions = getUtility(IWebServiceConfiguration).active_versions
     version_for_marker = { IWebServiceClientRequest: versions[0] }
@@ -388,6 +391,11 @@
                 _assert_interface_registered_for_version(
                     version, referenced_interface, available_registrations,
                     "named operation %s accepts %s" % (tags['as'], what))
+    while len(REGISTERED_OPERATIONS) > 0:
+        REGISTERED_OPERATIONS.pop()
+    while len(REGISTERED_ENTRIES) > 0:
+        REGISTERED_ENTRIES.pop()
+
 
 def _extract_reference_type(field):
     """Determine what kind of object the given field is a reference to.

=== modified file 'src/lazr/restful/testing/helpers.py'
--- src/lazr/restful/testing/helpers.py	2011-03-08 19:59:46 +0000
+++ src/lazr/restful/testing/helpers.py	2011-03-24 21:21:48 +0000
@@ -4,7 +4,9 @@
 from zope.configuration import xmlconfig
 from zope.interface import implements
 
+from lazr.restful import metazcml
 from lazr.restful.interfaces import IWebServiceConfiguration
+from lazr.restful.metazcml import webservice_sanity_checks
 from lazr.restful.simple import (
     Request,
     RootResource,
@@ -24,6 +26,11 @@
 
 def register_test_module(name, *contents):
     new_module = create_test_module(name, *contents)
+    # Clear out any registrations from other imports that weren't
+    # sanity-checked.
+    metazcml.REGISTERED_OPERATIONS = []
+    metazcml.REGISTERED_ENTRIES = []
+
     try:
         xmlconfig.string("""
             <configure
@@ -33,6 +40,7 @@
               <webservice:register module="lazr.restful.%s" />
             </configure>
             """ % name)
+        webservice_sanity_checks(None)
     except Exception, e:
         del sys.modules['lazr.restful.' + name]
         raise e

=== modified file 'src/lazr/restful/tests/test_declarations.py'
--- src/lazr/restful/tests/test_declarations.py	2011-03-18 15:31:53 +0000
+++ src/lazr/restful/tests/test_declarations.py	2011-03-24 21:21:48 +0000
@@ -835,8 +835,8 @@
             this list, so there's no need to specify it again.
         """
         exception = self.assertRaises(
-            ConfigurationExecutionError, register_test_module, 'testmod',
-            *(list(classes) + [expect_failure_due_to_interface]))
+            ValueError, register_test_module,
+            'testmod', *(list(classes) + [expect_failure_due_to_interface]))
         expected_message = (
             "In version %(version)s, %(reason)s, but version %(version)s "
             "of the web service does not publish %(interface)s as an entry. "
@@ -844,7 +844,8 @@
                 version=expect_failure_in_version,
                 reason=expect_failure_for_reason,
                 interface=expect_failure_due_to_interface.__name__))
-        self.assertTrue(expected_message in str(exception))
+        self.assertEquals(str(exception), expected_message)
+
 
     def test_reference_to_unpublished_object_fails(self):
         self._test_fails_sanity_check(

=== modified file 'src/lazr/restful/version.txt'
--- src/lazr/restful/version.txt	2011-03-21 14:00:50 +0000
+++ src/lazr/restful/version.txt	2011-03-24 21:21:48 +0000
@@ -1,1 +1,1 @@
-0.18.0
+0.18.1