openstack/nova
Code Issues Proposed changes

Convert v3 server SchedulerHints plugin to v2.1

Browse Source 
This patch converts v3 server SchedulerHints plugin to v2.1 and makes v2
unit tests share between v2 and v2.1.

The differences between v2 and v3 are described on the wiki page
https://wiki.openstack.org/wiki/NovaAPIv2tov3.

Note- to make V2.1 SchedulerHints extension work in V3 framework,
an extra parameter (request body) is being passed in server_create
function of each extensions.

Partially implements blueprint v2-on-v3-api

Change-Id: I8a0d50efcda6fcd12971a41505127de5987eec18
This commit is contained in:
Ghanshyam 2014-08-22 14:15:28 +09:00
parent d05cc3f78f
commit 3792bd0e43
14 changed files with 122 additions and 294 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/v3/api_samples/os-scheduler-hints/scheduler-hints-post-req.json
View File

@ -2,9 +2,9 @@
"server" : {
"name" : "new-server-test",
"imageRef" : "http://glance.openstack.example.com/openstack/images/70a599e0-31e7-49b7-b260-868f441e862b",
"flavorRef" : "http://openstack.example.com/openstack/flavors/1",
"os-scheduler-hints:scheduler_hints": {
"same_host": "48e6a9f6-30af-47e0-bc04-acaed113bb4e"
}
"flavorRef" : "http://openstack.example.com/openstack/flavors/1"
},
"OS-SCH-HNT:scheduler_hints": {
"same_host": "48e6a9f6-30af-47e0-bc04-acaed113bb4e"
}
}

7
nova/api/openstack/compute/plugins/v3/access_ips.py
View File

@ -90,7 +90,12 @@ class AccessIPs(extensions.V3APIExtensionBase):
def get_resources(self):
return []
def server_create(self, server_dict, create_kwargs):
# NOTE(gmann): This function is not supposed to use 'body_deprecated_param'
# parameter as this is placed to handle scheduler_hint extension for V2.1.
# making 'body_deprecated_param' as optional to avoid changes for
# server_update & server_rebuild
def server_create(self, server_dict, create_kwargs,
body_deprecated_param=None):
if AccessIPs.v4_key in server_dict:
access_ip_v4 = server_dict.get(AccessIPs.v4_key)
if access_ip_v4:

4
nova/api/openstack/compute/plugins/v3/availability_zone.py
View File

@ -139,5 +139,7 @@ class AvailabilityZone(extensions.V3APIExtensionBase):
"""
return []
def server_create(self, server_dict, create_kwargs):
# NOTE(gmann): This function is not supposed to use 'body_deprecated_param'
# parameter as this is placed to handle scheduler_hint extension for V2.1.
def server_create(self, server_dict, create_kwargs, body_deprecated_param):
create_kwargs['availability_zone'] = server_dict.get(ATTRIBUTE_NAME)

4
nova/api/openstack/compute/plugins/v3/block_device_mapping.py
View File

@ -40,7 +40,9 @@ class BlockDeviceMapping(extensions.V3APIExtensionBase):
# use nova.api.extensions.server.extensions entry point to modify
# server create kwargs
def server_create(self, server_dict, create_kwargs):
# NOTE(gmann): This function is not supposed to use 'body_deprecated_param'
# parameter as this is placed to handle scheduler_hint extension for V2.1.
def server_create(self, server_dict, create_kwargs, body_deprecated_param):
block_device_mapping = server_dict.get(ATTRIBUTE_NAME, [])
try:

4
nova/api/openstack/compute/plugins/v3/config_drive.py
View File

@ -68,7 +68,9 @@ class ConfigDrive(extensions.V3APIExtensionBase):
def get_resources(self):
return []
def server_create(self, server_dict, create_kwargs):
# NOTE(gmann): This function is not supposed to use 'body_deprecated_param'
# parameter as this is placed to handle scheduler_hint extension for V2.1.
def server_create(self, server_dict, create_kwargs, body_deprecated_param):
create_kwargs['config_drive'] = server_dict.get(ATTRIBUTE_NAME)
def get_server_create_schema(self):

4
nova/api/openstack/compute/plugins/v3/keypairs.py
View File

@ -178,7 +178,9 @@ class Keypairs(extensions.V3APIExtensionBase):
# use nova.api.extensions.server.extensions entry point to modify
# server create kwargs
def server_create(self, server_dict, create_kwargs):
# NOTE(gmann): This function is not supposed to use 'body_deprecated_param'
# parameter as this is placed to handle scheduler_hint extension for V2.1.
def server_create(self, server_dict, create_kwargs, body_deprecated_param):
create_kwargs['key_name'] = server_dict.get('key_name')
def get_server_create_schema(self):

4
nova/api/openstack/compute/plugins/v3/multiple_create.py
View File

@ -42,7 +42,9 @@ class MultipleCreate(extensions.V3APIExtensionBase):
# use nova.api.extensions.server.extensions entry point to modify
# server create kwargs
def server_create(self, server_dict, create_kwargs):
# NOTE(gmann): This function is not supposed to use 'body_deprecated_param'
# parameter as this is placed to handle scheduler_hint extension for V2.1.
def server_create(self, server_dict, create_kwargs, body_deprecated_param):
# min_count and max_count are optional. If they exist, they may come
# in as strings. Verify that they are valid integers and > 0.
# Also, we want to default 'min_count' to 1, and default

13
nova/api/openstack/compute/plugins/v3/scheduler_hints.py
View File

@ -33,8 +33,17 @@ class SchedulerHints(extensions.V3APIExtensionBase):
def get_resources(self):
return []
def server_create(self, server_dict, create_kwargs):
scheduler_hints = server_dict.get(ALIAS + ':scheduler_hints', {})
# NOTE(gmann): Accepting request body in this function to fetch "scheduler
# hint". This is a workaround to allow OS_SCH-HNT at the top level
# of the body request, but that it will be changed in the future to be a
# subset of the servers dict.
def server_create(self, server_dict, create_kwargs, req_body):
scheduler_hints = {}
if 'os:scheduler_hints' in req_body:
scheduler_hints = req_body['os:scheduler_hints']
elif 'OS-SCH-HNT:scheduler_hints' in req_body:
scheduler_hints = req_body['OS-SCH-HNT:scheduler_hints']
if not isinstance(scheduler_hints, dict):
msg = _("Malformed scheduler_hints attribute")
raise webob.exc.HTTPBadRequest(explanation=msg)

4
nova/api/openstack/compute/plugins/v3/security_groups.py
View File

@ -121,7 +121,9 @@ class SecurityGroups(extensions.V3APIExtensionBase):
def get_resources(self):
return []
def server_create(self, server_dict, create_kwargs):
# NOTE(gmann): This function is not supposed to use 'body_deprecated_param'
# parameter as this is placed to handle scheduler_hint extension for V2.1.
def server_create(self, server_dict, create_kwargs, body_deprecated_param):
security_groups = server_dict.get(ATTRIBUTE_NAME)
if security_groups is not None:
create_kwargs['security_group'] = [

10
nova/api/openstack/compute/plugins/v3/servers.py
View File

@ -459,7 +459,7 @@ class ServersController(wsgi.Controller):
# moved to the extension
if list(self.create_extension_manager):
self.create_extension_manager.map(self._create_extension_point,
server_dict, create_kwargs)
server_dict, create_kwargs, body)
image_uuid = self._image_from_req_data(server_dict, create_kwargs)
@ -570,11 +570,15 @@ class ServersController(wsgi.Controller):
return self._add_location(robj)
def _create_extension_point(self, ext, server_dict, create_kwargs):
# NOTE(gmann): Parameter 'req_body' is placed to handle scheduler_hint
# extension for V2.1. No other extension supposed to use this as
# it will be removed soon.
def _create_extension_point(self, ext, server_dict,
create_kwargs, req_body):
handler = ext.obj
LOG.debug("Running _create_extension_point for %s", ext.obj)
handler.server_create(server_dict, create_kwargs)
handler.server_create(server_dict, create_kwargs, req_body)
def _rebuild_extension_point(self, ext, rebuild_dict, rebuild_kwargs):
handler = ext.obj

4
nova/api/openstack/compute/plugins/v3/user_data.py
View File

@ -32,5 +32,7 @@ class UserData(extensions.V3APIExtensionBase):
def get_resources(self):
return []
def server_create(self, server_dict, create_kwargs):
# NOTE(gmann): This function is not supposed to use 'body_deprecated_param'
# parameter as this is placed to handle scheduler_hint extension for V2.1.
def server_create(self, server_dict, create_kwargs, body_deprecated_param):
create_kwargs['user_data'] = server_dict.get(ATTRIBUTE_NAME)

88
nova/tests/api/openstack/compute/contrib/test_scheduler_hints.py
View File

@ -15,8 +15,12 @@
import datetime
from oslo.config import cfg
from nova.api.openstack import compute
from nova.api.openstack.compute import servers
from nova.api.openstack.compute import plugins
from nova.api.openstack.compute.plugins.v3 import servers as servers_v21
from nova.api.openstack.compute import servers as servers_v2
from nova.api.openstack import extensions
import nova.compute.api
from nova.compute import flavors
@ -31,16 +35,22 @@ from nova.tests.image import fake
UUID = fakes.FAKE_UUID
class SchedulerHintsTestCase(test.TestCase):
CONF = cfg.CONF
class SchedulerHintsTestCaseV21(test.TestCase):
def setUp(self):
super(SchedulerHintsTestCase, self).setUp()
super(SchedulerHintsTestCaseV21, self).setUp()
self.fake_instance = fakes.stub_instance(1, uuid=UUID)
self.flags(
osapi_compute_extension=[
'nova.api.openstack.compute.contrib.select_extensions'],
osapi_compute_ext_list=['Scheduler_hints'])
self.app = compute.APIRouter(init_only=('servers',))
self._set_up_router()
def _set_up_router(self):
self.app = compute.APIRouterV3(init_only=('servers',
'os-scheduler-hints'))
def _get_request(self):
return fakes.HTTPRequestV3.blank('/servers')
def test_create_server_without_hints(self):
@ -50,7 +60,7 @@ class SchedulerHintsTestCase(test.TestCase):
self.stubs.Set(nova.compute.api.API, 'create', fake_create)
req = fakes.HTTPRequest.blank('/fake/servers')
req = self._get_request()
req.method = 'POST'
req.content_type = 'application/json'
body = {'server': {
@ -71,7 +81,7 @@ class SchedulerHintsTestCase(test.TestCase):
self.stubs.Set(nova.compute.api.API, 'create', fake_create)
req = fakes.HTTPRequest.blank('/fake/servers')
req = self._get_request()
req.method = 'POST'
req.content_type = 'application/json'
body = {
@ -88,7 +98,7 @@ class SchedulerHintsTestCase(test.TestCase):
self.assertEqual(202, res.status_int)
def test_create_server_bad_hints(self):
req = fakes.HTTPRequest.blank('/fake/servers')
req = self._get_request()
req.method = 'POST'
req.content_type = 'application/json'
body = {
@ -105,16 +115,27 @@ class SchedulerHintsTestCase(test.TestCase):
self.assertEqual(400, res.status_int)
class ServersControllerCreateTest(test.TestCase):
class SchedulerHintsTestCaseV2(SchedulerHintsTestCaseV21):
def _set_up_router(self):
self.flags(
osapi_compute_extension=[
'nova.api.openstack.compute.contrib.select_extensions'],
osapi_compute_ext_list=['Scheduler_hints'])
self.app = compute.APIRouter(init_only=('servers',))
def _get_request(self):
return fakes.HTTPRequest.blank('/fake/servers')
class ServersControllerCreateTestV21(test.TestCase):
def setUp(self):
"""Shared implementation for tests below that create instance."""
super(ServersControllerCreateTest, self).setUp()
super(ServersControllerCreateTestV21, self).setUp()
self.instance_cache_num = 0
self.ext_mgr = extensions.ExtensionManager()
self.ext_mgr.extensions = {}
self.controller = servers.Controller(self.ext_mgr)
self._set_up_controller()
def instance_create(context, inst):
inst_type = flavors.get_flavor_by_flavor_id(3)
@ -146,16 +167,30 @@ class ServersControllerCreateTest(test.TestCase):
fake.stub_out_image_service(self.stubs)
self.stubs.Set(db, 'instance_create', instance_create)
def _set_up_controller(self):
ext_info = plugins.LoadedExtensionInfo()
CONF.set_override('extensions_blacklist', 'os-scheduler-hints',
'osapi_v3')
self.no_scheduler_hints_controller = servers_v21.ServersController(
extension_info=ext_info)
def _verify_availability_zone(self, **kwargs):
self.assertNotIn('scheduler_hints', kwargs)
def _get_request(self):
return fakes.HTTPRequestV3.blank('/servers')
def _test_create_extra(self, params):
image_uuid = 'c905cedb-7281-47e4-8a62-f26bc5fc4c77'
server = dict(name='server_test', imageRef=image_uuid, flavorRef=2)
body = dict(server=server)
body.update(params)
req = fakes.HTTPRequest.blank('/fake//servers')
req = self._get_request()
req.method = 'POST'
req.body = jsonutils.dumps(body)
req.headers["content-type"] = "application/json"
server = self.controller.create(req, body=body).obj['server']
server = self.no_scheduler_hints_controller.create(
req, body=body).obj['server']
def test_create_instance_with_scheduler_hints_disabled(self):
hints = {'same_host': '48e6a9f6-30af-47e0-bc04-acaed113bb4e'}
@ -163,8 +198,23 @@ class ServersControllerCreateTest(test.TestCase):
old_create = nova.compute.api.API.create
def create(*args, **kwargs):
self.assertEqual(kwargs['scheduler_hints'], {})
self._verify_availability_zone(**kwargs)
return old_create(*args, **kwargs)
self.stubs.Set(nova.compute.api.API, 'create', create)
self._test_create_extra(params)
class ServersControllerCreateTestV2(ServersControllerCreateTestV21):
def _set_up_controller(self):
self.ext_mgr = extensions.ExtensionManager()
self.ext_mgr.extensions = {}
self.no_scheduler_hints_controller = servers_v2.Controller(
self.ext_mgr)
def _verify_availability_zone(self, **kwargs):
self.assertEqual(kwargs['scheduler_hints'], {})
def _get_request(self):
return fakes.HTTPRequest.blank('/fake/servers')

254
nova/tests/api/openstack/compute/plugins/v3/test_scheduler_hints.py
View File

@ -1,254 +0,0 @@
# Copyright 2011 OpenStack Foundation
# 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 datetime
import uuid
from oslo.config import cfg
from nova.api.openstack import compute
from nova.api.openstack.compute import plugins
from nova.api.openstack.compute.plugins.v3 import servers
from nova.compute import api as compute_api
from nova.compute import flavors
from nova import db
import nova.db.api
from nova.network import manager
from nova.openstack.common import jsonutils
from nova import test
from nova.tests.api.openstack import fakes
from nova.tests import fake_instance
from nova.tests.image import fake
CONF = cfg.CONF
FAKE_UUID = fakes.FAKE_UUID
def fake_gen_uuid():
return FAKE_UUID
def return_security_group(context, instance_id, security_group_id):
pass
class SchedulerHintsTestCase(test.TestCase):
def setUp(self):
super(SchedulerHintsTestCase, self).setUp()
self.fake_instance = fakes.stub_instance(1, uuid=FAKE_UUID)
self.app = compute.APIRouterV3(init_only=('servers',
'os-scheduler-hints'))
def test_create_server_without_hints(self):
def fake_create(*args, **kwargs):
self.assertEqual(kwargs['scheduler_hints'], {})
return ([self.fake_instance], '')
self.stubs.Set(nova.compute.api.API, 'create', fake_create)
req = fakes.HTTPRequestV3.blank('/servers')
req.method = 'POST'
req.content_type = 'application/json'
body = {'server': {
'name': 'server_test',
'imageRef': 'cedef40a-ed67-4d10-800e-17455edce175',
'flavorRef': '1',
}}
req.body = jsonutils.dumps(body)
res = req.get_response(self.app)
self.assertEqual(202, res.status_int)
def test_create_server_with_hints(self):
hints = {'same_host': '48e6a9f6-30af-47e0-bc04-acaed113bb4e'}
def fake_create(*args, **kwargs):
self.assertEqual(hints, kwargs['scheduler_hints'])
return ([self.fake_instance], '')
self.stubs.Set(nova.compute.api.API, 'create', fake_create)
req = fakes.HTTPRequestV3.blank('/servers')
req.method = 'POST'
req.content_type = 'application/json'
body = {
'server': {
'name': 'server_test',
'imageRef': 'cedef40a-ed67-4d10-800e-17455edce175',
'flavorRef': '1',
'os-scheduler-hints:scheduler_hints': hints,
},
}
req.body = jsonutils.dumps(body)
res = req.get_response(self.app)
self.assertEqual(202, res.status_int)
def test_create_server_bad_hints(self):
req = fakes.HTTPRequestV3.blank('/servers')
req.method = 'POST'
req.content_type = 'application/json'
body = {
'server': {
'name': 'server_test',
'imageRef': 'cedef40a-ed67-4d10-800e-17455edce175',
'flavorRef': '1',
'os-scheduler-hints:scheduler_hints': 'non-dict',
},
}
req.body = jsonutils.dumps(body)
res = req.get_response(self.app)
self.assertEqual(400, res.status_int)
class ServersControllerCreateTest(test.TestCase):
def setUp(self):
"""Shared implementation for tests below that create instance."""
super(ServersControllerCreateTest, self).setUp()
self.flags(verbose=True,
enable_instance_password=True)
self.instance_cache_num = 0
self.instance_cache_by_id = {}
self.instance_cache_by_uuid = {}
ext_info = plugins.LoadedExtensionInfo()
self.controller = servers.ServersController(extension_info=ext_info)
CONF.set_override('extensions_blacklist', 'os-scheduler-hints',
'osapi_v3')
self.no_scheduler_hints_controller = servers.ServersController(
extension_info=ext_info)
def instance_create(context, inst):
inst_type = flavors.get_flavor_by_flavor_id(3)
image_uuid = '76fa36fc-c930-4bf3-8c8a-ea2a2420deb6'
def_image_ref = 'http://localhost/images/%s' % image_uuid
self.instance_cache_num += 1
instance = fake_instance.fake_db_instance(**{
'id': self.instance_cache_num,
'display_name': inst['display_name'] or 'test',
'uuid': FAKE_UUID,
'instance_type': dict(inst_type),
'access_ip_v4': '1.2.3.4',
'access_ip_v6': 'fead::1234',
'image_ref': inst.get('image_ref', def_image_ref),
'user_id': 'fake',
'project_id': 'fake',
'reservation_id': inst['reservation_id'],
"created_at": datetime.datetime(2010, 10, 10, 12, 0, 0),
"updated_at": datetime.datetime(2010, 11, 11, 11, 0, 0),
"config_drive": None,
"progress": 0,
"fixed_ips": [],
"task_state": "",
"vm_state": "",
"root_device_name": inst.get('root_device_name', 'vda'),
})
self.instance_cache_by_id[instance['id']] = instance
self.instance_cache_by_uuid[instance['uuid']] = instance
return instance
def instance_get(context, instance_id):
"""Stub for compute/api create() pulling in instance after
scheduling
"""
return self.instance_cache_by_id[instance_id]
def instance_update(context, uuid, values):
instance = self.instance_cache_by_uuid[uuid]
instance.update(values)
return instance
def server_update(context, instance_uuid, params):
inst = self.instance_cache_by_uuid[instance_uuid]
inst.update(params)
return (inst, inst)
def fake_method(*args, **kwargs):
pass
def project_get_networks(context, user_id):
return dict(id='1', host='localhost')
def queue_get_for(context, *args):
return 'network_topic'
fakes.stub_out_rate_limiting(self.stubs)
fakes.stub_out_key_pair_funcs(self.stubs)
fake.stub_out_image_service(self.stubs)
fakes.stub_out_nw_api(self.stubs)
self.stubs.Set(uuid, 'uuid4', fake_gen_uuid)
self.stubs.Set(db, 'instance_add_security_group',
return_security_group)
self.stubs.Set(db, 'project_get_networks',
project_get_networks)
self.stubs.Set(db, 'instance_create', instance_create)
self.stubs.Set(db, 'instance_system_metadata_update',
fake_method)
self.stubs.Set(db, 'instance_get', instance_get)
self.stubs.Set(db, 'instance_update', instance_update)
self.stubs.Set(db, 'instance_update_and_get_original',
server_update)
self.stubs.Set(manager.VlanManager, 'allocate_fixed_ip',
fake_method)
def _test_create_extra(self, params, no_image=False,
override_controller=None):
image_uuid = 'c905cedb-7281-47e4-8a62-f26bc5fc4c77'
server = dict(name='server_test', imageRef=image_uuid, flavorRef=2)
if no_image:
server.pop('imageRef', None)
server.update(params)
body = dict(server=server)
req = fakes.HTTPRequestV3.blank('/servers')
req.method = 'POST'
req.body = jsonutils.dumps(body)
req.headers["content-type"] = "application/json"
if override_controller:
server = override_controller.create(req, body=body).obj['server']
else:
server = self.controller.create(req, body=body).obj['server']
def test_create_instance_with_scheduler_hints_disabled(self):
hints = {'same_host': '48e6a9f6-30af-47e0-bc04-acaed113bb4e'}
params = {'os-scheduler-hints:scheduler_hints': hints}
old_create = compute_api.API.create
def create(*args, **kwargs):
self.assertNotIn('scheduler_hints', kwargs)
# self.assertEqual(kwargs['scheduler_hints'], {})
return old_create(*args, **kwargs)
self.stubs.Set(compute_api.API, 'create', create)
self._test_create_extra(params,
override_controller=self.no_scheduler_hints_controller)
def test_create_instance_with_scheduler_hints_enabled(self):
hints = {'same_host': '48e6a9f6-30af-47e0-bc04-acaed113bb4e'}
params = {'os-scheduler-hints:scheduler_hints': hints}
old_create = compute_api.API.create
def create(*args, **kwargs):
self.assertEqual(kwargs['scheduler_hints'], hints)
return old_create(*args, **kwargs)
self.stubs.Set(compute_api.API, 'create', create)
self._test_create_extra(params)

8
nova/tests/integrated/v3/api_samples/os-scheduler-hints/scheduler-hints-post-req.json.tpl
View File

@ -2,9 +2,9 @@
"server" : {
"name" : "new-server-test",
"imageRef" : "%(glance_host)s/openstack/images/%(image_id)s",
"flavorRef" : "%(host)s/openstack/flavors/1",
"os-scheduler-hints:scheduler_hints": {
"same_host": "%(uuid)s"
}
"flavorRef" : "%(host)s/openstack/flavors/1"
},
"OS-SCH-HNT:scheduler_hints": {
"same_host": "%(uuid)s"
}
}