Merge lp:~rackspace-titan/nova/osapi-server-ips-lp751560 into lp:~hudson-openstack/nova/trunk

[Naveed Massjouni]

Added support for listing addresses of a server in the openstack api.
Now you can GET
 * /servers/1/ips
 * /servers/1/ips/public
 * /servers/1/ips/private
Supports v1.0 json and xml.
Added corresponding tests.

[Jay Pipes (jaypipes)]

lgtm. nice work.

review: Approve

[Brian Waldon (bcwaldon)]

Should build_private/public_parts be private?

review: Needs Information

[Brian Waldon (bcwaldon)]

Do you have any plans for v1.1 support?

[Naveed Massjouni (ironcamel)]

@Brian:

> Should build_private/public_parts be private?

Nope. I abstracted that logic out so I could call it from the nova/api/openstack/ips.py controller.

> Do you have any plans for v1.1 support?

Not for cactus.

[Brian Waldon (bcwaldon)]

> @Brian:
>
> > Should build_private/public_parts be private?
>
> Nope. I abstracted that logic out so I could call it from the
> nova/api/openstack/ips.py controller.
>
> > Do you have any plans for v1.1 support?
>
> Not for cactus.

Gotcha.

review: Approve

[lp:~rackspace-titan/nova/osapi-server-ips-lp751560]

946. By Naveed Massjouni on 2011-04-06

Merge from trunk

947. By Naveed Massjouni on 2011-04-06

Controllers now inherit from nova.api.openstack.common.OpenstackController.

[Rick Harris (rconradharris)]

lgtm

review: Approve

[Devin Carlen (devcamcar)]

great unit tests, approve

review: Approve

=== modified file 'nova/api/openstack/__init__.py'
--- nova/api/openstack/__init__.py	2011-03-30 02:09:42 +0000
+++ nova/api/openstack/__init__.py	2011-04-06 21:51:35 +0000
@@ -34,6 +34,7 @@
 from nova.api.openstack import flavors
 from nova.api.openstack import images
 from nova.api.openstack import image_metadata
+from nova.api.openstack import ips
 from nova.api.openstack import limits
 from nova.api.openstack import servers
 from nova.api.openstack import server_metadata
@@ -144,6 +145,11 @@
                         parent_resource=dict(member_name='server',
                         collection_name='servers'))
 
+        mapper.resource("ip", "ips", controller=ips.Controller(),
+                        collection=dict(public='GET', private='GET'),
+                        parent_resource=dict(member_name='server',
+                                             collection_name='servers'))
+
 
 class APIRouterV11(APIRouter):
     """Define routes specific to OpenStack API V1.1."""

=== added file 'nova/api/openstack/ips.py'
--- nova/api/openstack/ips.py	1970-01-01 00:00:00 +0000
+++ nova/api/openstack/ips.py	2011-04-06 21:51:35 +0000
@@ -0,0 +1,72 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4
+
+# Copyright 2011 OpenStack LLC.
+# 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.
+
+import time
+
+from webob import exc
+
+import nova
+import nova.api.openstack.views.addresses
+from nova.api.openstack import common
+from nova.api.openstack import faults
+
+
+class Controller(common.OpenstackController):
+    """The servers addresses API controller for the Openstack API."""
+
+    _serialization_metadata = {
+        'application/xml': {
+            'list_collections': {
+                'public':  {'item_name': 'ip', 'item_key': 'addr'},
+                'private': {'item_name': 'ip', 'item_key': 'addr'},
+            },
+        },
+    }
+
+    def __init__(self):
+        self.compute_api = nova.compute.API()
+        self.builder = nova.api.openstack.views.addresses.ViewBuilderV10()
+
+    def index(self, req, server_id):
+        try:
+            instance = self.compute_api.get(req.environ['nova.context'], id)
+        except nova.exception.NotFound:
+            return faults.Fault(exc.HTTPNotFound())
+        return {'addresses': self.builder.build(instance)}
+
+    def public(self, req, server_id):
+        try:
+            instance = self.compute_api.get(req.environ['nova.context'], id)
+        except nova.exception.NotFound:
+            return faults.Fault(exc.HTTPNotFound())
+        return {'public': self.builder.build_public_parts(instance)}
+
+    def private(self, req, server_id):
+        try:
+            instance = self.compute_api.get(req.environ['nova.context'], id)
+        except nova.exception.NotFound:
+            return faults.Fault(exc.HTTPNotFound())
+        return {'private': self.builder.build_private_parts(instance)}
+
+    def show(self, req, server_id, id):
+        return faults.Fault(exc.HTTPNotImplemented())
+
+    def create(self, req, server_id):
+        return faults.Fault(exc.HTTPNotImplemented())
+
+    def delete(self, req, server_id, id):
+        return faults.Fault(exc.HTTPNotImplemented())

=== modified file 'nova/api/openstack/servers.py'
--- nova/api/openstack/servers.py	2011-04-06 21:51:35 +0000
+++ nova/api/openstack/servers.py	2011-04-06 21:51:35 +0000
@@ -70,15 +70,6 @@
         self._image_service = utils.import_object(FLAGS.image_service)
         super(Controller, self).__init__()
 
-    def ips(self, req, id):
-        try:
-            instance = self.compute_api.get(req.environ['nova.context'], id)
-        except exception.NotFound:
-            return faults.Fault(exc.HTTPNotFound())
-
-        builder = self._get_addresses_view_builder(req)
-        return builder.build(instance)
-
     def index(self, req):
         """ Returns a list of server names and ids for a given user """
         return self._items(req, is_detail=False)

=== modified file 'nova/api/openstack/views/addresses.py'
--- nova/api/openstack/views/addresses.py	2011-03-17 07:21:09 +0000
+++ nova/api/openstack/views/addresses.py	2011-04-06 21:51:35 +0000
@@ -28,10 +28,16 @@
 
 class ViewBuilderV10(ViewBuilder):
     def build(self, inst):
-        private_ips = utils.get_from_path(inst, 'fixed_ip/address')
-        public_ips = utils.get_from_path(inst, 'fixed_ip/floating_ips/address')
+        private_ips = self.build_private_parts(inst)
+        public_ips = self.build_public_parts(inst)
         return dict(public=public_ips, private=private_ips)
 
+    def build_public_parts(self, inst):
+        return utils.get_from_path(inst, 'fixed_ip/floating_ips/address')
+
+    def build_private_parts(self, inst):
+        return utils.get_from_path(inst, 'fixed_ip/address')
+
 
 class ViewBuilderV11(ViewBuilder):
     def build(self, inst):

=== modified file 'nova/tests/api/openstack/test_servers.py'
--- nova/tests/api/openstack/test_servers.py	2011-04-06 21:51:35 +0000
+++ nova/tests/api/openstack/test_servers.py	2011-04-06 21:51:35 +0000
@@ -228,6 +228,84 @@
         self.assertEqual(len(addresses["private"]), 1)
         self.assertEqual(addresses["private"][0], private)
 
+    def test_get_server_addresses_V10(self):
+        private = '192.168.0.3'
+        public = ['1.2.3.4']
+        new_return_server = return_server_with_addresses(private, public)
+        self.stubs.Set(nova.db.api, 'instance_get', new_return_server)
+        req = webob.Request.blank('/v1.0/servers/1/ips')
+        res = req.get_response(fakes.wsgi_app())
+        res_dict = json.loads(res.body)
+        self.assertEqual(res_dict, {
+            'addresses': {'public': public, 'private': [private]}})
+
+    def test_get_server_addresses_xml_V10(self):
+        private_expected = "192.168.0.3"
+        public_expected = ["1.2.3.4"]
+        new_return_server = return_server_with_addresses(private_expected,
+                                                         public_expected)
+        self.stubs.Set(nova.db.api, 'instance_get', new_return_server)
+        req = webob.Request.blank('/v1.0/servers/1/ips')
+        req.headers['Accept'] = 'application/xml'
+        res = req.get_response(fakes.wsgi_app())
+        dom = minidom.parseString(res.body)
+        (addresses,) = dom.childNodes
+        self.assertEquals(addresses.nodeName, 'addresses')
+        (public,) = addresses.getElementsByTagName('public')
+        (ip,) = public.getElementsByTagName('ip')
+        self.assertEquals(ip.getAttribute('addr'), public_expected[0])
+        (private,) = addresses.getElementsByTagName('private')
+        (ip,) = private.getElementsByTagName('ip')
+        self.assertEquals(ip.getAttribute('addr'), private_expected)
+
+    def test_get_server_addresses_public_V10(self):
+        private = "192.168.0.3"
+        public = ["1.2.3.4"]
+        new_return_server = return_server_with_addresses(private, public)
+        self.stubs.Set(nova.db.api, 'instance_get', new_return_server)
+        req = webob.Request.blank('/v1.0/servers/1/ips/public')
+        res = req.get_response(fakes.wsgi_app())
+        res_dict = json.loads(res.body)
+        self.assertEqual(res_dict, {'public': public})
+
+    def test_get_server_addresses_private_V10(self):
+        private = "192.168.0.3"
+        public = ["1.2.3.4"]
+        new_return_server = return_server_with_addresses(private, public)
+        self.stubs.Set(nova.db.api, 'instance_get', new_return_server)
+        req = webob.Request.blank('/v1.0/servers/1/ips/private')
+        res = req.get_response(fakes.wsgi_app())
+        res_dict = json.loads(res.body)
+        self.assertEqual(res_dict, {'private': [private]})
+
+    def test_get_server_addresses_public_xml_V10(self):
+        private = "192.168.0.3"
+        public = ["1.2.3.4"]
+        new_return_server = return_server_with_addresses(private, public)
+        self.stubs.Set(nova.db.api, 'instance_get', new_return_server)
+        req = webob.Request.blank('/v1.0/servers/1/ips/public')
+        req.headers['Accept'] = 'application/xml'
+        res = req.get_response(fakes.wsgi_app())
+        dom = minidom.parseString(res.body)
+        (public_node,) = dom.childNodes
+        self.assertEquals(public_node.nodeName, 'public')
+        (ip,) = public_node.getElementsByTagName('ip')
+        self.assertEquals(ip.getAttribute('addr'), public[0])
+
+    def test_get_server_addresses_private_xml_V10(self):
+        private = "192.168.0.3"
+        public = ["1.2.3.4"]
+        new_return_server = return_server_with_addresses(private, public)
+        self.stubs.Set(nova.db.api, 'instance_get', new_return_server)
+        req = webob.Request.blank('/v1.0/servers/1/ips/private')
+        req.headers['Accept'] = 'application/xml'
+        res = req.get_response(fakes.wsgi_app())
+        dom = minidom.parseString(res.body)
+        (private_node,) = dom.childNodes
+        self.assertEquals(private_node.nodeName, 'private')
+        (ip,) = private_node.getElementsByTagName('ip')
+        self.assertEquals(ip.getAttribute('addr'), private)
+
     def test_get_server_by_id_with_addresses_v11(self):
         private = "192.168.0.3"
         public = ["1.2.3.4"]