From 37c618da7c565b13cf6779f40c41ce895ff0459f Mon Sep 17 00:00:00 2001 From: Dan Prince Date: Tue, 5 Mar 2013 16:17:29 -0500 Subject: [PATCH] Make os-services API extensions consistent. Updates the os-services API extension so that it is consistent internally (index and update return similar formats), and so that it works with the recent novaclient code which sends the following request body format: {"binary": "nova-cert", "host": "nova1"} Also, updates the response body format of the update call so that it wraps things in an extra service dict which should make novaclient happier here as well (and is consistent with other extensions too). Fixes LP Bug #1147746. Change-Id: I932160d64fdd3aaeb2ed90a092ecc7a36dcc9665 --- .../os-services/service-disable-put-req.json | 4 ++-- .../os-services/service-disable-put-resp.json | 10 +++++---- .../os-services/service-enable-put-resp.json | 10 +++++---- .../os-services/services-list-get-resp.json | 2 +- .../api/openstack/compute/contrib/services.py | 21 ++++++++++--------- .../compute/contrib/test_services.py | 12 +++++------ .../service-disable-put-req.json.tpl | 2 +- .../service-disable-put-resp.json.tpl | 8 ++++--- .../service-enable-put-req.json.tpl | 2 +- .../service-enable-put-resp.json.tpl | 9 +++++--- nova/tests/integrated/test_api_samples.py | 12 +++++------ 11 files changed, 51 insertions(+), 41 deletions(-) diff --git a/doc/api_samples/os-services/service-disable-put-req.json b/doc/api_samples/os-services/service-disable-put-req.json index d11afaed9c..f96d34536d 100644 --- a/doc/api_samples/os-services/service-disable-put-req.json +++ b/doc/api_samples/os-services/service-disable-put-req.json @@ -1,4 +1,4 @@ { "host": "host1", - "service": "nova-compute" -} \ No newline at end of file + "binary": "nova-compute" +} diff --git a/doc/api_samples/os-services/service-disable-put-resp.json b/doc/api_samples/os-services/service-disable-put-resp.json index 2e461bc6d7..2c21c547fc 100644 --- a/doc/api_samples/os-services/service-disable-put-resp.json +++ b/doc/api_samples/os-services/service-disable-put-resp.json @@ -1,5 +1,7 @@ { - "disabled": true, - "host": "host1", - "service": "nova-compute" -} \ No newline at end of file + "service": { + "host": "host1", + "binary": "nova-compute", + "status": "disabled" + } +} diff --git a/doc/api_samples/os-services/service-enable-put-resp.json b/doc/api_samples/os-services/service-enable-put-resp.json index 88b9dc7f92..75c4ebd557 100644 --- a/doc/api_samples/os-services/service-enable-put-resp.json +++ b/doc/api_samples/os-services/service-enable-put-resp.json @@ -1,5 +1,7 @@ { - "disabled": false, - "host": "host1", - "service": "nova-compute" -} \ No newline at end of file + "service": { + "host": "host1", + "binary": "nova-compute", + "status": "enabled" + } +} diff --git a/doc/api_samples/os-services/services-list-get-resp.json b/doc/api_samples/os-services/services-list-get-resp.json index dcda1a46e4..572d5d8636 100644 --- a/doc/api_samples/os-services/services-list-get-resp.json +++ b/doc/api_samples/os-services/services-list-get-resp.json @@ -33,4 +33,4 @@ "zone": "nova" } ] -} \ No newline at end of file +} diff --git a/nova/api/openstack/compute/contrib/services.py b/nova/api/openstack/compute/contrib/services.py index fb7b9d591e..558c31586d 100644 --- a/nova/api/openstack/compute/contrib/services.py +++ b/nova/api/openstack/compute/contrib/services.py @@ -51,8 +51,8 @@ class ServicesUpdateTemplate(xmlutil.TemplateBuilder): def construct(self): root = xmlutil.TemplateElement('host') root.set('host') - root.set('service') - root.set('disabled') + root.set('binary') + root.set('status') return xmlutil.MasterTemplate(root, 1) @@ -76,13 +76,13 @@ class ServiceController(object): host = '' if 'host' in req.GET: host = req.GET['host'] - service = '' - if 'service' in req.GET: - service = req.GET['service'] + binary = '' + if 'binary' in req.GET: + binary = req.GET['binary'] if host: services = [s for s in services if s['host'] == host] - if service: - services = [s for s in services if s['binary'] == service] + if binary: + services = [s for s in services if s['binary'] == binary] svcs = [] for svc in services: @@ -113,12 +113,12 @@ class ServiceController(object): try: host = body['host'] - service = body['service'] + binary = body['binary'] except (TypeError, KeyError): raise webob.exc.HTTPUnprocessableEntity() try: - svc = db.service_get_by_args(context, host, service) + svc = db.service_get_by_args(context, host, binary) if not svc: raise webob.exc.HTTPNotFound('Unknown service') @@ -126,7 +126,8 @@ class ServiceController(object): except exception.ServiceNotFound: raise webob.exc.HTTPNotFound("service not found") - return {'host': host, 'service': service, 'disabled': disabled} + status = id + 'd' + return {'service': {'host': host, 'binary': binary, 'status': status}} class Services(extensions.ExtensionDescriptor): diff --git a/nova/tests/api/openstack/compute/contrib/test_services.py b/nova/tests/api/openstack/compute/contrib/test_services.py index cb7ce67cb7..57dd056ee7 100644 --- a/nova/tests/api/openstack/compute/contrib/test_services.py +++ b/nova/tests/api/openstack/compute/contrib/test_services.py @@ -64,7 +64,7 @@ class FakeRequest(object): class FakeRequestWithService(object): environ = {"nova.context": context.get_admin_context()} - GET = {"service": "nova-compute"} + GET = {"binary": "nova-compute"} class FakeRequestWithHost(object): @@ -74,7 +74,7 @@ class FakeRequestWithHost(object): class FakeRequestWithHostService(object): environ = {"nova.context": context.get_admin_context()} - GET = {"host": "host1", "service": "nova-compute"} + GET = {"host": "host1", "binary": "nova-compute"} def fake_host_api_service_get_all(context, filters=None, set_zones=False): @@ -190,15 +190,15 @@ class ServicesTest(test.TestCase): self.assertEqual(res_dict, response) def test_services_enable(self): - body = {'host': 'host1', 'service': 'nova-compute'} + body = {'host': 'host1', 'binary': 'nova-compute'} req = fakes.HTTPRequest.blank('/v2/fake/os-services/enable') res_dict = self.controller.update(req, "enable", body) - self.assertEqual(res_dict['disabled'], False) + self.assertEqual(res_dict['service']['status'], 'enabled') def test_services_disable(self): req = fakes.HTTPRequest.blank('/v2/fake/os-services/disable') - body = {'host': 'host1', 'service': 'nova-compute'} + body = {'host': 'host1', 'binary': 'nova-compute'} res_dict = self.controller.update(req, "disable", body) - self.assertEqual(res_dict['disabled'], True) + self.assertEqual(res_dict['service']['status'], 'disabled') diff --git a/nova/tests/integrated/api_samples/os-services/service-disable-put-req.json.tpl b/nova/tests/integrated/api_samples/os-services/service-disable-put-req.json.tpl index 4d48af1b8e..57182e935c 100644 --- a/nova/tests/integrated/api_samples/os-services/service-disable-put-req.json.tpl +++ b/nova/tests/integrated/api_samples/os-services/service-disable-put-req.json.tpl @@ -1,4 +1,4 @@ { "host": "%(host)s", - "service": "%(service)s" + "binary": "%(binary)s" } diff --git a/nova/tests/integrated/api_samples/os-services/service-disable-put-resp.json.tpl b/nova/tests/integrated/api_samples/os-services/service-disable-put-resp.json.tpl index 8219a43f64..47a8b3d816 100644 --- a/nova/tests/integrated/api_samples/os-services/service-disable-put-resp.json.tpl +++ b/nova/tests/integrated/api_samples/os-services/service-disable-put-resp.json.tpl @@ -1,5 +1,7 @@ { - "disabled": true, - "host": "%(host)s", - "service": "%(service)s" + "service": { + "host": "%(host)s", + "binary": "%(binary)s", + "status": "disabled" + } } diff --git a/nova/tests/integrated/api_samples/os-services/service-enable-put-req.json.tpl b/nova/tests/integrated/api_samples/os-services/service-enable-put-req.json.tpl index 4d48af1b8e..57182e935c 100644 --- a/nova/tests/integrated/api_samples/os-services/service-enable-put-req.json.tpl +++ b/nova/tests/integrated/api_samples/os-services/service-enable-put-req.json.tpl @@ -1,4 +1,4 @@ { "host": "%(host)s", - "service": "%(service)s" + "binary": "%(binary)s" } diff --git a/nova/tests/integrated/api_samples/os-services/service-enable-put-resp.json.tpl b/nova/tests/integrated/api_samples/os-services/service-enable-put-resp.json.tpl index 079b9c76e9..24f72311d1 100644 --- a/nova/tests/integrated/api_samples/os-services/service-enable-put-resp.json.tpl +++ b/nova/tests/integrated/api_samples/os-services/service-enable-put-resp.json.tpl @@ -1,5 +1,8 @@ { - "disabled": false, - "host": "%(host)s", - "service": "%(service)s" + "service": { + "host": "%(host)s", + "binary": "%(binary)s", + "status": "enabled" + } } + diff --git a/nova/tests/integrated/test_api_samples.py b/nova/tests/integrated/test_api_samples.py index 1ca839b3fd..c647e0292a 100644 --- a/nova/tests/integrated/test_api_samples.py +++ b/nova/tests/integrated/test_api_samples.py @@ -1990,24 +1990,24 @@ class ServicesJsonTest(ApiSampleTestBase): def test_service_enable(self): """Enable an existing agent build.""" subs = {"host": "host1", - 'service': 'nova-compute'} - response = self._do_put('/os-services/enable', + 'binary': 'nova-compute'} + response = self._do_put('os-services/enable', 'service-enable-put-req', subs) self.assertEqual(response.status, 200) subs = {"host": "host1", - "service": "nova-compute"} + "binary": "nova-compute"} return self._verify_response('service-enable-put-resp', subs, response) def test_service_disable(self): """Disable an existing agent build.""" subs = {"host": "host1", - 'service': 'nova-compute'} - response = self._do_put('/os-services/disable', + 'binary': 'nova-compute'} + response = self._do_put('os-services/disable', 'service-disable-put-req', subs) self.assertEqual(response.status, 200) subs = {"host": "host1", - "service": "nova-compute"} + "binary": "nova-compute"} return self._verify_response('service-disable-put-resp', subs, response)