Merge lp:~salgado/lazr.restful/fix-exporting-empty-entries into lp:lazr.restful

[Guilherme Salgado]

Fix a bug that Leonard uncovered when running the Launchpad test suite using the latest lazr.restful.

The IEntry adapters generated for interfaces that didn't export any fields/operations didn't include the '_orig_interfaces' attribute, as all adapters should. That was causing EntryResource.redacted_fields to raise an AttributeError for those empty interfaces.

[Leonard Richardson (leonardr)]

review: Approve

=== modified file 'src/lazr/restful/declarations.py'
--- src/lazr/restful/declarations.py	2010-08-06 15:28:40 +0000
+++ src/lazr/restful/declarations.py	2010-08-10 18:41:18 +0000
@@ -966,6 +966,10 @@
             # dictionary to adapters_by_version. This dictionary will
             # be turned into an adapter class for this version.
             adapter_dict = adapters_by_version.setdefault(tags_version, {})
+            
+            # Set '_orig_interfaces' as early as possible as we want that
+            # attribute (even if empty) on all adapters.
+            orig_interfaces = adapter_dict.setdefault('_orig_interfaces', {})
 
             # Figure out the mutator for this version and add it to
             # this version's adapter class dictionary.
@@ -1000,7 +1004,6 @@
 
             # A dict mapping field names to the interfaces where they came
             # from.
-            orig_interfaces = adapter_dict.setdefault('_orig_interfaces', {})
             orig_interfaces[name] = orig_iface
 
     adapters = []
@@ -1009,6 +1012,12 @@
             raise TypeError('webservice_interface is not an interface.')
         class_dict = adapters_by_version.get(version, {})
 
+        # If this interface doesn't export a single field/operation,
+        # class_dict will be empty, and so we'll add '_orig_interfaces'
+        # manually as it should be always available, even if empty.
+        if class_dict == {}:
+            class_dict['_orig_interfaces'] = {}
+
         class_dict['schema'] = webservice_interface
         class_dict['__doc__'] = webservice_interface.__doc__
         # The webservice interface class name already includes the version

=== modified file 'src/lazr/restful/tests/test_declarations.py'
--- src/lazr/restful/tests/test_declarations.py	2010-08-04 19:38:18 +0000
+++ src/lazr/restful/tests/test_declarations.py	2010-08-10 18:41:18 +0000
@@ -130,6 +130,18 @@
         self.assertEqual(adapter.bug_count, 10)
         self.assertEqual(adapter.development_branch, self.product._dev_branch)
 
+    def test_redacted_fields_for_empty_entry(self):
+        # An entry which doesn't export any fields/operations will have no
+        # redacted fields.
+        class IEmpty(Interface):
+            export_as_webservice_entry()
+        class Empty:
+            implements(IEmpty)
+        register_test_module('testmod', IEmpty)
+        entry_resource = EntryResource(Empty(), self.beta_request)
+        self.assertEquals({}, entry_resource.entry._orig_interfaces)
+        self.assertEquals([], entry_resource.redacted_fields)
+
     def test_redacted_fields_with_no_permission_checker(self):
         # When looking up an entry's redacted_fields, we take into account the
         # interface where the field is defined and adapt the context to that

=== modified file 'src/lazr/restful/tests/test_webservice.py'
--- src/lazr/restful/tests/test_webservice.py	2010-08-09 19:33:20 +0000
+++ src/lazr/restful/tests/test_webservice.py	2010-08-10 18:41:18 +0000
@@ -9,25 +9,23 @@
 import unittest
 
 from zope.component import getGlobalSiteManager, getUtility
-from zope.interface import implements, Interface, directlyProvides
+from zope.interface import implements, Interface
 from zope.publisher.browser import TestRequest
 from zope.schema import Date, Datetime, TextLine
-from zope.security.management import (
-    endInteraction, newInteraction, queryInteraction)
+from zope.security.management import newInteraction, queryInteraction
 from zope.traversing.browser.interfaces import IAbsoluteURL
 
 from lazr.restful import ResourceOperation
 from lazr.restful.fields import Reference
 from lazr.restful.interfaces import (
-    ICollection, IEntry, IEntryResource, IResourceGETOperation,
-    IServiceRootResource, IWebServiceConfiguration,
-    IWebServiceClientRequest, IWebServiceVersion)
+    ICollection, IEntry, IResourceGETOperation, IServiceRootResource,
+    IWebServiceConfiguration, IWebServiceClientRequest, IWebServiceVersion)
 from lazr.restful import EntryResource, ResourceGETOperation
-from lazr.restful.declarations import (exported, export_as_webservice_entry,
-    LAZR_WEBSERVICE_NAME)
+from lazr.restful.declarations import (
+    exported, export_as_webservice_entry, LAZR_WEBSERVICE_NAME)
 from lazr.restful.testing.webservice import (
     create_web_service_request, IGenericCollection, IGenericEntry,
-    WebServiceTestCase, WebServiceTestPublication)
+    WebServiceTestCase)
 from lazr.restful.testing.tales import test_tales
 from lazr.restful.utils import (
     get_current_browser_request, get_current_web_service_request,

=== modified file 'versions.cfg'
--- versions.cfg	2010-08-06 15:28:40 +0000
+++ versions.cfg	2010-08-10 18:41:18 +0000
@@ -6,6 +6,7 @@
 [versions]
 # Alphabetical, case-SENSITIVE, blank line after this comment
 
+distribute = 0.6.14
 Jinja2 = 2.5
 Pygments = 1.3.1
 RestrictedPython = 3.5.1