Merge lp:~justin-fathomdb/nova/bug740576 into lp:~hudson-openstack/nova/trunk

[justinsb]

Support providing an XML namespace on the XML output from the OpenStack API

[Brian Waldon (bcwaldon)]

How do you plan to handle versioning? Right now if I do a request on /v1.1/servers/1.xml, I get the v1.0 url.

I think it would be much more elegant to solve this problem once we move away from centralized serialization and delegate that responsibility to some sort of resource- or controller-specific response object.

If you want to stick with this approach, I guess you could have get_default_xmlns inspect the request object and build the url.

review: Needs Information

[justinsb (justin-fathomdb)]

Thanks Brian. Yes - get_default_xmlns is the hook point at the moment. But
it's actually complicated by the fact that we don't have a 1.1 XSD yet (or
even an XML namespace?) It may be that the right place is actually in the
serialization_metadata, where you can also put an xmlns to override any
particular namespace.

I'm about to open a bug on the fact that we don't have an XML NS or XSD for
v1.1. Once we have that, the best way to handle this should be a lot
clearer, but I wanted to put in a suggested placeholder hook.

I'd like to see this land first though, because without it I can't do any
validation against the XSD schemas we do have.

[Brian Lamar (blamar)]

Should we put OpenStack API specific information in nova/wsgi.py? I think that should go in the nova/api/openstack/* namespace.

Unit tests for verification?

review: Needs Fixing

[justinsb (justin-fathomdb)]

Thanks Brian (L). I agree that the OpenStack namespace shouldn't be in wsgi.py long-term. Until we see what's going to happen with v1.1 I don't think we really know where it should go. I'm guessing we'll need a new class OpenStackController from which all Openstack controllers will derive, but it's too early to tell. I added a big note, and hopefully we can get the v1.1 schema soon and get this all fixed 'for real'.

Thankfully there are some unit tests that were broken, but I had forgotten to push them. The limits tests check the XML explicitly, so I added the namespace check there.

[Brian Lamar (blamar)]

Hey Justin, I really don't think a note should be the answer. Having implementation-specific information in library level shared code shouldn't happen and breaking out an OpenStack API specific Controller or Serializer is the way to go IMO.

Based on the current code I would:

1) Add support for an XML namespace at the Serializer level
2) Break out a custom OpenStack Controller and Serializer and re-point all current Controllers to these new ones which have the XML namespace.

Seeing how we have a good deal of versioning changes coming down the line, this is going to change significantly and I'd like to propose that I can handle this bug after working with the versioning merge props, or that you wait on this until the versioning changes go in.

[justinsb (justin-fathomdb)]

Brian: Which merge proposal are you talking about here? Is it going to make the cutoff?

[Brian Lamar (blamar)]

https://code.launchpad.net/~rackspace-titan/nova/openstack-api-versioned-controllers

It was merged 12 hours ago, sorry for the lag in discussion here, but I've been working on some other branches. I'm going to look at this now to see what this change might entail re: the current trunk.

[justinsb (justin-fathomdb)]

No worries. This is a bugfix, so isn't subject to FF, so doesn't need to
get attention today.

[termie (termie)]

I think I agree with Brian Lamar as to where this code should live, a subclass of our controller/serializer that the nova.api.openstack code uses

review: Needs Fixing

[justinsb (justin-fathomdb)]

Refactored per suggestions; fixed up failing tests and added an explicit one.

[Brian Lamar (blamar)]

Justin, quick question: nova/tests/integrated/test_xml.py seems to make some assumptions which I don't understand. /limits should be available via /v1.0/limits and /v1.1/limits, and /servers should be available via /v1.0/servers and /v1.1/servers which return their corresponding XML namespace strings.

Are those integration tests testing v1.0 or v1.1?

Thanks!

review: Needs Information

[justinsb (justin-fathomdb)]

The integrated tests currently only test one endpoint, and they're bound to
v1.1 so that I can test extensions (v1.1 only) The v1.1 bit of the URL is
supplied by the TestOpenStackClient in
nova/tests/api/integrated/api/client.py

Limits hasn't changed between v1.0 and v1.1 (that I know of), so presumably
we're not going to change the XML namespace for the fun of it.

Servers has changed between v1.0 and v1.1, so that element must come from
the new XML namespace.

That's what the test is checking. Fun, huh?

[Brian Lamar (blamar)]

v1.1 Limits: http://paste.openstack.org/show/1037/

v1.0 Limits: http://paste.openstack.org/show/1038/

I think the v1.1 limits XMLNS is a typo, but they are absolutely different.

[Brian Lamar (blamar)]

(references)

v1.1 : http://docs.openstack.org/openstack-compute/developer/content/ch03s09.html
v1.0 : http://docs.rackspacecloud.com/servers/api/v1.0/xsd/limits.xsd

[justinsb (justin-fathomdb)]

Thanks Brian. And bugger.

I was going by the fact that the limits.py implementation doesn't
differentiate.

This is sort of my worst fears realized... even once we get the namespace
declared, the XML output is likely to not be 100% correct. We need the
namespace and the schema to even start verifying this.

Do you know of any off the top of your head that legitimately didn't change?

If not, I suggest we go with the namespace declaration as-is if we're
otherwise happy, and then fix the other problems. Otherwise this patch is
going to get huge, as my patches have a tendency to do.

[justinsb (justin-fathomdb)]

I filed bug #746016 to track the limits problem. I think it's a much bigger
problem (and applies to JSON and XML), so I'd suggest that we shouldn't
block this branch from merging because of it.

[Soren Hansen (soren)]

lgtm

review: Approve

[Brian Waldon (bcwaldon)]

Looking better. The following came to mind while reading over your diff. They aren't anything major:

1) Would it make more sense to put the OpenstackController and xmlns strings in (a newly created) api/openstack/wsgi.py module?
2) Does the word "default" belong in "get_default_xmlns"? This isn't really a default, it is explicitly set.

review: Needs Information

[justinsb (justin-fathomdb)]

Thanks Brian. I feel 'common' is already there, so I'm leaning towards
sticking with what we've got. Don't know how others feel?

The default in get_default_xmlns is because it won't be applied if a
namespace is applied in some other way. For example, I suspect we'll come
across a need to explicitly specify namespaces for some responses, for
example if we need to mix namespaces in the same response.

[Brian Waldon (bcwaldon)]

> Thanks Brian. I feel 'common' is already there, so I'm leaning towards
> sticking with what we've got. Don't know how others feel?

The other issue is that there is already 'wsgi' related code in __init__.py, so if anything, OpenstackController should live there.

> The default in get_default_xmlns is because it won't be applied if a
> namespace is applied in some other way. For example, I suspect we'll come
> across a need to explicitly specify namespaces for some responses, for
> example if we need to mix namespaces in the same response.

Okay. I missed that in the code.

[justinsb (justin-fathomdb)]

I initially put it into __init__.py, but - to be honest - I'm still a python
newbie, and couldn't figure out how to import it. Any pointers?

[Brian Waldon (bcwaldon)]

> I initially put it into __init__.py, but - to be honest - I'm still a python
> newbie, and couldn't figure out how to import it. Any pointers?

I wouldn't say I'm a pro either, but you should be able to import the parent module (nova.api.openstack) and access it like so: nova.api.openstack.OpenstackController

[Vish Ishaya (vishvananda)]

In general, we should be keeping code out of init.

Class definitions can go there, but in general I prefer keeping them out as well.

On Mar 31, 2011, at 1:56 PM, Brian Waldon wrote:

>> I initially put it into __init__.py, but - to be honest - I'm still a python
>> newbie, and couldn't figure out how to import it. Any pointers?
>
> I wouldn't say I'm a pro either, but you should be able to import the parent module (nova.api.openstack) and access it like so: nova.api.openstack.OpenstackController
> --
> https://code.launchpad.net/~justin-fathomdb/nova/bug740576/+merge/54447
> You are subscribed to branch lp:nova.

[Brian Waldon (bcwaldon)]

> In general, we should be keeping code out of init.
>
> Class definitions can go there, but in general I prefer keeping them out as
> well.
>

I definitely agree. But in this case, most wsgi-related code already lives in __init__.py and it would be a pain to change it across the project.

[justinsb (justin-fathomdb)]

Sorry Brian - missed your comment.

Let's get this merged... I don't mind where it lives. Brian - are you OK with Vish making the call as PTL? Or could you explain a bit more why this needs to live in __init__ - in the patch below it's in common and it doesn't look too bad...

[Brian Lamar (blamar)]

Should XML_NS_V10 and XML_NS_V11 be flags? I could see them changing and they might be needed other places. Otherwise looks ok to me!

[justinsb (justin-fathomdb)]

I don't think we should let end-users change the schema namespace, so I
don't think it should be a flag. I think if anyone other code needs them
they can just import the 'common' module (or wherever they end up)

[Brian Waldon (bcwaldon)]

> Let's get this merged... I don't mind where it lives. Brian - are you OK with
> Vish making the call as PTL? Or could you explain a bit more why this needs
> to live in __init__ - in the patch below it's in common and it doesn't look
> too bad...

I do agree with Vish that we should keep as much code out of __init__.py as possible. We have already disregarded that guideline and put the OS-specific wsgi code directly in __init__.py (such as APIRouter and FaultWrapper). My end goal here is to make a wsgi-specific module (perhaps api/openstack/wsgi.py), and for this branch I wanted to group what will go there into __init__.py for now. I would be fine leaving it in common.py with the assumption that it will be moving for Diablo.

review: Approve

[Vish Ishaya (vishvananda)]

> I do agree with Vish that we should keep as much code out of __init__.py as
> possible. We have already disregarded that guideline and put the OS-specific
> wsgi code directly in __init__.py (such as APIRouter and FaultWrapper). My end
> goal here is to make a wsgi-specific module (perhaps api/openstack/wsgi.py),
> and for this branch I wanted to group what will go there into __init__.py for
> now. I would be fine leaving it in common.py with the assumption that it will
> be moving for Diablo.

This is fine with me. Please make a bug for this so we don't lose track of it.

review: Approve

[Brian Lamar (blamar)]

review: Approve

[Vish Ishaya (vishvananda)]

Termie is away today. I also think his concerns have been addressed, so I'm going to go ahead and approve this.

[OpenStack Infra (hudson-openstack)]

The attempt to merge lp:~justin-fathomdb/nova/bug740576 into lp:nova failed. Below is the output from the failed tests.

AccountsTest
    test_account_create OK
    test_account_delete OK
    test_account_update OK
    test_get_account OK
AdminAPITest
    test_admin_disabled OK
    test_admin_enabled OK
APITest
    test_exceptions_are_converted_to_faults OK
Test
    test_authorize_token OK
    test_authorize_user OK
    test_bad_token OK
    test_bad_user_bad_key OK
    test_bad_user_good_key OK
    test_no_user OK
    test_token_expiry OK
TestFunctional
    test_token_doesnotexist OK
    test_token_expiry OK
TestLimiter
    test_authorize_token OK
LimiterTest
    test_limiter_custom_max_limit OK
    test_limiter_limit_and_offset OK
    test_limiter_limit_medium OK
    test_limiter_limit_over_max OK
    test_limiter_limit_zero OK
    test_limiter_negative_limit OK
    test_limiter_negative_offset OK
    test_limiter_nothing OK
    test_limiter_offset_bad OK
    test_limiter_offset_blank OK
    test_limiter_offset_medium OK
    test_limiter_offset_over_max OK
    test_limiter_offset_zero OK
ActionExtensionTest
    test_extended_action OK
    test_invalid_action OK
    test_invalid_action_body OK
ExtensionControllerTest
    test_get_by_alias OK
    test_index OK
ExtensionManagerTest
    test_get_resources OK
ResourceExtensionTest
    test_get_resources OK
    test_get_resources_with_controller OK
    test_no_extension_present OK
ResponseExtensionTest
    test_get_resources_with_mgr OK
    test_get_resources_with_stub_mgr OK
TestFaults
    test_400_fault_json OK
    test_400_fault_xml OK
...

[justinsb (justin-fathomdb)]

Another test was added that didn't check the namespace during the approval process. Remerged with trunk & fixed

=== modified file 'nova/api/direct.py'
--- nova/api/direct.py	2011-03-24 20:20:15 +0000
+++ nova/api/direct.py	2011-04-06 20:56:32 +0000
@@ -206,10 +206,14 @@
         # NOTE(vish): make sure we have no unicode keys for py2.6.
         params = dict([(str(k), v) for (k, v) in params.iteritems()])
         result = method(context, **params)
+
         if result is None or type(result) is str or type(result) is unicode:
             return result
+
         try:
-            return self._serialize(result, req.best_match_content_type())
+            content_type = req.best_match_content_type()
+            default_xmlns = self.get_default_xmlns(req)
+            return self._serialize(result, content_type, default_xmlns)
         except:
             raise exception.Error("returned non-serializable type: %s"
                                   % result)

=== modified file 'nova/api/openstack/accounts.py'
--- nova/api/openstack/accounts.py	2011-03-18 14:34:08 +0000
+++ nova/api/openstack/accounts.py	2011-04-06 20:56:32 +0000
@@ -13,15 +13,14 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
-import common
 import webob.exc
 
 from nova import exception
 from nova import flags
 from nova import log as logging
-from nova import wsgi
 
 from nova.auth import manager
+from nova.api.openstack import common
 from nova.api.openstack import faults
 
 FLAGS = flags.FLAGS
@@ -35,7 +34,7 @@
                 manager=account.project_manager_id)
 
 
-class Controller(wsgi.Controller):
+class Controller(common.OpenstackController):
 
     _serialization_metadata = {
         'application/xml': {

=== modified file 'nova/api/openstack/backup_schedules.py'
--- nova/api/openstack/backup_schedules.py	2011-03-28 18:31:12 +0000
+++ nova/api/openstack/backup_schedules.py	2011-04-06 20:56:32 +0000
@@ -19,7 +19,7 @@
 
 from webob import exc
 
-from nova import wsgi
+from nova.api.openstack import common
 from nova.api.openstack import faults
 import nova.image.service
 
@@ -29,7 +29,7 @@
     return dict(backupSchedule=inst)
 
 
-class Controller(wsgi.Controller):
+class Controller(common.OpenstackController):
     """ The backup schedule API controller for the Openstack API """
 
     _serialization_metadata = {

=== modified file 'nova/api/openstack/common.py'
--- nova/api/openstack/common.py	2011-03-28 01:48:32 +0000
+++ nova/api/openstack/common.py	2011-04-06 20:56:32 +0000
@@ -22,6 +22,7 @@
 from nova import exception
 from nova import flags
 from nova import log as logging
+from nova import wsgi
 
 
 LOG = logging.getLogger('common')
@@ -30,6 +31,10 @@
 FLAGS = flags.FLAGS
 
 
+XML_NS_V10 = 'http://docs.rackspacecloud.com/servers/api/v1.0'
+XML_NS_V11 = 'http://docs.openstack.org/compute/api/v1.1'
+
+
 def limited(items, request, max_limit=FLAGS.osapi_max_limit):
     """
     Return a slice of items according to requested offset and limit.
@@ -128,3 +133,9 @@
     except:
         LOG.debug(_("Error extracting id from href: %s") % href)
         raise webob.exc.HTTPBadRequest(_('could not parse id from href'))
+
+
+class OpenstackController(wsgi.Controller):
+    def get_default_xmlns(self, req):
+        # Use V10 by default
+        return XML_NS_V10

=== modified file 'nova/api/openstack/consoles.py'
--- nova/api/openstack/consoles.py	2011-03-11 19:49:32 +0000
+++ nova/api/openstack/consoles.py	2011-04-06 20:56:32 +0000
@@ -19,7 +19,7 @@
 
 from nova import console
 from nova import exception
-from nova import wsgi
+from nova.api.openstack import common
 from nova.api.openstack import faults
 
 
@@ -43,7 +43,7 @@
     return dict(console=info)
 
 
-class Controller(wsgi.Controller):
+class Controller(common.OpenstackController):
     """The Consoles Controller for the Openstack API"""
 
     _serialization_metadata = {

=== modified file 'nova/api/openstack/extensions.py'
--- nova/api/openstack/extensions.py	2011-03-30 01:16:09 +0000
+++ nova/api/openstack/extensions.py	2011-04-06 20:56:32 +0000
@@ -28,6 +28,7 @@
 from nova import flags
 from nova import log as logging
 from nova import wsgi
+from nova.api.openstack import common
 from nova.api.openstack import faults
 
 
@@ -115,7 +116,7 @@
         return response_exts
 
 
-class ActionExtensionController(wsgi.Controller):
+class ActionExtensionController(common.OpenstackController):
 
     def __init__(self, application):
 
@@ -136,7 +137,7 @@
         return res
 
 
-class ResponseExtensionController(wsgi.Controller):
+class ResponseExtensionController(common.OpenstackController):
 
     def __init__(self, application):
         self.application = application
@@ -155,7 +156,8 @@
                 body = res.body
                 headers = res.headers
             except AttributeError:
-                body = self._serialize(res, content_type)
+                default_xmlns = None
+                body = self._serialize(res, content_type, default_xmlns)
                 headers = {"Content-Type": content_type}
             res = webob.Response()
             res.body = body
@@ -163,7 +165,7 @@
         return res
 
 
-class ExtensionController(wsgi.Controller):
+class ExtensionController(common.OpenstackController):
 
     def __init__(self, extension_manager):
         self.extension_manager = extension_manager

=== modified file 'nova/api/openstack/faults.py'
--- nova/api/openstack/faults.py	2011-03-29 18:56:18 +0000
+++ nova/api/openstack/faults.py	2011-04-06 20:56:32 +0000
@@ -20,10 +20,10 @@
 import webob.exc
 
 from nova import wsgi
+from nova.api.openstack import common
 
 
 class Fault(webob.exc.HTTPException):
-
     """An RS API fault response."""
 
     _fault_names = {
@@ -57,7 +57,8 @@
             fault_data[fault_name]['retryAfter'] = retry
         # 'code' is an attribute on the fault tag itself
         metadata = {'application/xml': {'attributes': {fault_name: 'code'}}}
-        serializer = wsgi.Serializer(metadata)
+        default_xmlns = common.XML_NS_V10
+        serializer = wsgi.Serializer(metadata, default_xmlns)
         content_type = req.best_match_content_type()
         self.wrapped_exc.body = serializer.serialize(fault_data, content_type)
         self.wrapped_exc.content_type = content_type

=== modified file 'nova/api/openstack/flavors.py'
--- nova/api/openstack/flavors.py	2011-03-24 16:46:39 +0000
+++ nova/api/openstack/flavors.py	2011-04-06 20:56:32 +0000
@@ -19,11 +19,11 @@
 
 from nova import db
 from nova import exception
-from nova import wsgi
+from nova.api.openstack import common
 from nova.api.openstack import views
 
 
-class Controller(wsgi.Controller):
+class Controller(common.OpenstackController):
     """Flavor controller for the OpenStack API."""
 
     _serialization_metadata = {
@@ -76,3 +76,6 @@
     def _get_view_builder(self, req):
         base_url = req.application_url
         return views.flavors.ViewBuilderV11(base_url)
+
+    def get_default_xmlns(self, req):
+        return common.XML_NS_V11

=== modified file 'nova/api/openstack/image_metadata.py'
--- nova/api/openstack/image_metadata.py	2011-03-25 14:07:42 +0000
+++ nova/api/openstack/image_metadata.py	2011-04-06 20:56:32 +0000
@@ -20,13 +20,14 @@
 from nova import flags
 from nova import utils
 from nova import wsgi
+from nova.api.openstack import common
 from nova.api.openstack import faults
 
 
 FLAGS = flags.FLAGS
 
 
-class Controller(wsgi.Controller):
+class Controller(common.OpenstackController):
     """The image metadata API controller for the Openstack API"""
 
     def __init__(self):

=== modified file 'nova/api/openstack/images.py'
--- nova/api/openstack/images.py	2011-03-29 16:12:26 +0000
+++ nova/api/openstack/images.py	2011-04-06 20:56:32 +0000
@@ -13,8 +13,6 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
-import datetime
-
 import webob.exc
 
 from nova import compute
@@ -22,7 +20,6 @@
 from nova import flags
 from nova import log
 from nova import utils
-from nova import wsgi
 from nova.api.openstack import common
 from nova.api.openstack import faults
 from nova.api.openstack.views import images as images_view
@@ -32,7 +29,7 @@
 FLAGS = flags.FLAGS
 
 
-class Controller(wsgi.Controller):
+class Controller(common.OpenstackController):
     """Base `wsgi.Controller` for retrieving/displaying images."""
 
     _serialization_metadata = {
@@ -153,3 +150,6 @@
         """Property to get the ViewBuilder class we need to use."""
         base_url = request.application_url
         return images_view.ViewBuilderV11(base_url)
+
+    def get_default_xmlns(self, req):
+        return common.XML_NS_V11

=== modified file 'nova/api/openstack/limits.py'
--- nova/api/openstack/limits.py	2011-03-17 20:26:52 +0000
+++ nova/api/openstack/limits.py	2011-04-06 20:56:32 +0000
@@ -31,8 +31,8 @@
 from webob.dec import wsgify
 
 from nova import wsgi
+from nova.api.openstack import common
 from nova.api.openstack import faults
-from nova.wsgi import Controller
 from nova.wsgi import Middleware
 
 
@@ -43,7 +43,7 @@
 PER_DAY = 60 * 60 * 24
 
 
-class LimitsController(Controller):
+class LimitsController(common.OpenstackController):
     """
     Controller for accessing limits in the OpenStack API.
     """

=== modified file 'nova/api/openstack/server_metadata.py'
--- nova/api/openstack/server_metadata.py	2011-03-22 14:01:18 +0000
+++ nova/api/openstack/server_metadata.py	2011-04-06 20:56:32 +0000
@@ -19,10 +19,11 @@
 
 from nova import compute
 from nova import wsgi
+from nova.api.openstack import common
 from nova.api.openstack import faults
 
 
-class Controller(wsgi.Controller):
+class Controller(common.OpenstackController):
     """ The server metadata API controller for the Openstack API """
 
     def __init__(self):

=== modified file 'nova/api/openstack/servers.py'
--- nova/api/openstack/servers.py	2011-04-04 17:56:19 +0000
+++ nova/api/openstack/servers.py	2011-04-06 20:56:32 +0000
@@ -44,7 +44,7 @@
 FLAGS = flags.FLAGS
 
 
-class Controller(wsgi.Controller):
+class Controller(common.OpenstackController):
     """ The Server API controller for the OpenStack API """
 
     _serialization_metadata = {
@@ -648,6 +648,9 @@
     def _limit_items(self, items, req):
         return common.limited_by_marker(items, req)
 
+    def get_default_xmlns(self, req):
+        return common.XML_NS_V11
+
 
 class ServerCreateRequestXMLDeserializer(object):
     """

=== modified file 'nova/api/openstack/shared_ip_groups.py'
--- nova/api/openstack/shared_ip_groups.py	2011-03-28 18:02:53 +0000
+++ nova/api/openstack/shared_ip_groups.py	2011-04-06 20:56:32 +0000
@@ -17,7 +17,7 @@
 
 from webob import exc
 
-from nova import wsgi
+from nova.api.openstack import common
 from nova.api.openstack import faults
 
 
@@ -32,7 +32,7 @@
     return dict(sharedIpGroups=inst)
 
 
-class Controller(wsgi.Controller):
+class Controller(common.OpenstackController):
     """ The Shared IP Groups Controller for the Openstack API """
 
     _serialization_metadata = {

=== modified file 'nova/api/openstack/users.py'
--- nova/api/openstack/users.py	2011-03-16 19:15:57 +0000
+++ nova/api/openstack/users.py	2011-04-06 20:56:32 +0000
@@ -18,7 +18,6 @@
 from nova import exception
 from nova import flags
 from nova import log as logging
-from nova import wsgi
 from nova.api.openstack import common
 from nova.api.openstack import faults
 from nova.auth import manager
@@ -35,7 +34,7 @@
                 admin=user.admin)
 
 
-class Controller(wsgi.Controller):
+class Controller(common.OpenstackController):
 
     _serialization_metadata = {
         'application/xml': {

=== modified file 'nova/api/openstack/zones.py'
--- nova/api/openstack/zones.py	2011-03-24 19:04:24 +0000
+++ nova/api/openstack/zones.py	2011-04-06 20:56:32 +0000
@@ -13,12 +13,10 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
-import common
-
 from nova import db
 from nova import flags
 from nova import log as logging
-from nova import wsgi
+from nova.api.openstack import common
 from nova.scheduler import api
 
 
@@ -43,7 +41,7 @@
                     'deleted', 'deleted_at', 'updated_at'))
 
 
-class Controller(wsgi.Controller):
+class Controller(common.OpenstackController):
 
     _serialization_metadata = {
         'application/xml': {

=== modified file 'nova/tests/api/openstack/test_faults.py'
--- nova/tests/api/openstack/test_faults.py	2011-03-30 13:39:35 +0000
+++ nova/tests/api/openstack/test_faults.py	2011-04-06 20:56:32 +0000
@@ -22,6 +22,7 @@
 import webob.exc
 
 from nova import test
+from nova.api.openstack import common
 from nova.api.openstack import faults
 
 
@@ -47,10 +48,10 @@
             response = request.get_response(fault)
 
             expected = self._prepare_xml("""
-                <badRequest code="400">
+                <badRequest code="400" xmlns="%s">
                     <message>scram</message>
                 </badRequest>
-            """)
+            """ % common.XML_NS_V10)
             actual = self._prepare_xml(response.body)
 
             self.assertEqual(response.content_type, "application/xml")
@@ -91,11 +92,11 @@
             response = request.get_response(fault)
 
             expected = self._prepare_xml("""
-                <overLimit code="413">
+                <overLimit code="413" xmlns="%s">
                     <message>sorry</message>
                     <retryAfter>4</retryAfter>
                 </overLimit>
-            """)
+            """ % common.XML_NS_V10)
             actual = self._prepare_xml(response.body)
 
             self.assertEqual(expected, actual)

=== modified file 'nova/tests/api/openstack/test_images.py'
--- nova/tests/api/openstack/test_images.py	2011-04-04 14:59:44 +0000
+++ nova/tests/api/openstack/test_images.py	2011-04-06 20:56:32 +0000
@@ -146,7 +146,7 @@
         for x in [1, 2, 3]:
             tempfile.mkstemp(prefix='ami-', dir=self.tempdir)
         # create some valid image directories names
-        for x in ["1485baed", "1a60f0ee",  "3123a73d"]:
+        for x in ["1485baed", "1a60f0ee", "3123a73d"]:
             os.makedirs(os.path.join(self.tempdir, x))
         found_image_ids = self.service._ids()
         self.assertEqual(True, isinstance(found_image_ids, list))
@@ -335,7 +335,8 @@
                     name="public image"
                     updated="%(expected_now)s"
                     created="%(expected_now)s"
-                    status="ACTIVE" />
+                    status="ACTIVE"
+                    xmlns="http://docs.rackspacecloud.com/servers/api/v1.0" />
         """ % (locals()))
 
         self.assertEqual(expected_image.toxml(), actual_image.toxml())
@@ -353,7 +354,8 @@
                     name="None"
                     updated="%(expected_now)s"
                     created="%(expected_now)s"
-                    status="ACTIVE" />
+                    status="ACTIVE"
+                    xmlns="http://docs.rackspacecloud.com/servers/api/v1.0" />
         """ % (locals()))
 
         self.assertEqual(expected_image.toxml(), actual_image.toxml())
@@ -372,7 +374,8 @@
                 name="public image"
                 updated="%(expected_now)s"
                 created="%(expected_now)s"
-                status="ACTIVE">
+                status="ACTIVE"
+                xmlns="http://docs.openstack.org/compute/api/v1.1">
             <links>
                 <link href="%(expected_href)s" rel="self"/>
                 <link href="%(expected_href)s" rel="bookmark"
@@ -408,7 +411,8 @@
         self.assertEqual(404, response.status_int)
 
         expected = minidom.parseString("""
-            <itemNotFound code="404">
+            <itemNotFound code="404"
+                    xmlns="http://docs.rackspacecloud.com/servers/api/v1.0">
                 <message>
                     Image not found.
                 </message>
@@ -441,8 +445,11 @@
         response = request.get_response(fakes.wsgi_app())
         self.assertEqual(404, response.status_int)
 
+        # NOTE(justinsb): I believe this should still use the v1.0 XSD,
+        # because the element hasn't changed definition
         expected = minidom.parseString("""
-            <itemNotFound code="404">
+            <itemNotFound code="404"
+                    xmlns="http://docs.rackspacecloud.com/servers/api/v1.0">
                 <message>
                     Image not found.
                 </message>

=== modified file 'nova/tests/api/openstack/test_limits.py'
--- nova/tests/api/openstack/test_limits.py	2011-03-17 20:26:52 +0000
+++ nova/tests/api/openstack/test_limits.py	2011-04-06 20:56:32 +0000
@@ -136,10 +136,17 @@
         request = self._get_index_request("application/xml")
         response = request.get_response(self.controller)
 
-        expected = "<limits><rate/><absolute/></limits>"
-        body = response.body.replace("\n", "").replace(" ", "")
-
-        self.assertEqual(expected, body)
+        expected = parseString("""
+            <limits
+                xmlns="http://docs.rackspacecloud.com/servers/api/v1.0">
+                <rate/>
+                <absolute/>
+            </limits>
+        """.replace("  ", ""))
+
+        body = parseString(response.body.replace("  ", ""))
+
+        self.assertEqual(expected.toxml(), body.toxml())
 
     def test_index_xml(self):
         """Test getting limit details in XML."""
@@ -148,7 +155,8 @@
         response = request.get_response(self.controller)
 
         expected = parseString("""
-            <limits>
+            <limits
+                xmlns="http://docs.rackspacecloud.com/servers/api/v1.0">
                 <rate>
                     <limit URI="*" regex=".*" remaining="10" resetTime="0"
                         unit="MINUTE" value="10" verb="GET"/>

=== added file 'nova/tests/integrated/test_xml.py'
--- nova/tests/integrated/test_xml.py	1970-01-01 00:00:00 +0000
+++ nova/tests/integrated/test_xml.py	2011-04-06 20:56:32 +0000
@@ -0,0 +1,56 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright 2011 Justin Santa Barbara
+# All Rights Reserved.
+#
+#    Licensed under the Apache License, Version 2.0 (the "License"); you may
+#    not use this file except in compliance with the License. You may obtain
+#    a copy of the License at
+#
+#         http://www.apache.org/licenses/LICENSE-2.0
+#
+#    Unless required by applicable law or agreed to in writing, software
+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+#    License for the specific language governing permissions and limitations
+#    under the License.
+
+from nova import flags
+from nova.log import logging
+from nova.tests.integrated import integrated_helpers
+from nova.api.openstack import common
+
+
+LOG = logging.getLogger('nova.tests.integrated')
+
+
+FLAGS = flags.FLAGS
+FLAGS.verbose = True
+
+
+class XmlTests(integrated_helpers._IntegratedTestBase):
+    """"Some basic XML sanity checks."""
+
+    def test_namespace_limits(self):
+        """/limits should have v1.0 namespace (hasn't changed in 1.1)."""
+        headers = {}
+        headers['Accept'] = 'application/xml'
+
+        response = self.api.api_request('/limits', headers=headers)
+        data = response.read()
+        LOG.debug("data: %s" % data)
+
+        prefix = '<limits xmlns="%s"' % common.XML_NS_V10
+        self.assertTrue(data.startswith(prefix))
+
+    def test_namespace_servers(self):
+        """/servers should have v1.1 namespace (has changed in 1.1)."""
+        headers = {}
+        headers['Accept'] = 'application/xml'
+
+        response = self.api.api_request('/servers', headers=headers)
+        data = response.read()
+        LOG.debug("data: %s" % data)
+
+        prefix = '<servers xmlns="%s"' % common.XML_NS_V11
+        self.assertTrue(data.startswith(prefix))

=== modified file 'nova/wsgi.py'
--- nova/wsgi.py	2011-04-05 12:55:19 +0000
+++ nova/wsgi.py	2011-04-06 20:56:32 +0000
@@ -355,24 +355,25 @@
 
         if type(result) is dict:
             content_type = req.best_match_content_type()
-            body = self._serialize(result, content_type)
+            default_xmlns = self.get_default_xmlns(req)
+            body = self._serialize(result, content_type, default_xmlns)
 
             response = webob.Response()
             response.headers["Content-Type"] = content_type
             response.body = body
             return response
-
         else:
             return result
 
-    def _serialize(self, data, content_type):
+    def _serialize(self, data, content_type, default_xmlns):
         """
         Serialize the given dict to the provided content_type.
         Uses self._serialization_metadata if it exists, which is a dict mapping
         MIME types to information needed to serialize to that type.
         """
         _metadata = getattr(type(self), "_serialization_metadata", {})
-        serializer = Serializer(_metadata)
+
+        serializer = Serializer(_metadata, default_xmlns)
         try:
             return serializer.serialize(data, content_type)
         except exception.InvalidContentType:
@@ -388,19 +389,24 @@
         serializer = Serializer(_metadata)
         return serializer.deserialize(data, content_type)
 
+    def get_default_xmlns(self, req):
+        """Provide the XML namespace to use if none is otherwise specified."""
+        return None
+
 
 class Serializer(object):
     """
     Serializes and deserializes dictionaries to certain MIME types.
     """
 
-    def __init__(self, metadata=None):
+    def __init__(self, metadata=None, default_xmlns=None):
         """
         Create a serializer based on the given WSGI environment.
         'metadata' is an optional dict mapping MIME types to information
         needed to serialize a dictionary to that type.
         """
         self.metadata = metadata or {}
+        self.default_xmlns = default_xmlns
 
     def _get_serialize_handler(self, content_type):
         handlers = {
@@ -478,11 +484,23 @@
         root_key = data.keys()[0]
         doc = minidom.Document()
         node = self._to_xml_node(doc, metadata, root_key, data[root_key])
+
+        xmlns = node.getAttribute('xmlns')
+        if not xmlns and self.default_xmlns:
+            node.setAttribute('xmlns', self.default_xmlns)
+
         return node.toprettyxml(indent='    ')
 
     def _to_xml_node(self, doc, metadata, nodename, data):
         """Recursive method to convert data members to XML nodes."""
         result = doc.createElement(nodename)
+
+        # Set the xml namespace if one is specified
+        # TODO(justinsb): We could also use prefixes on the keys
+        xmlns = metadata.get('xmlns', None)
+        if xmlns:
+            result.setAttribute('xmlns', xmlns)
+
         if type(data) is list:
             singular = metadata.get('plurals', {}).get(nodename, None)
             if singular is None: