Skip to content

Commit 2183a61

Browse files
diweizhudiweizhu
committed
Switch openstack server add port/network to using sdk.
The old novaclient.v2.server.Server.interface_attach() method is replaced with proxy.create_server_interface(). In swargs, 'net_id' and 'port_id' are mutual-exclusive, if one of them is given with value, the other one cannot be None, as the API would responde with 400 (None is not string). In unit test, temporary method 'setup_sdk_servers_mock' is added, because other tests are still using the old 'setup_servers_mock'. Functional tests are added. Releasenote is generated. Change-Id: I9899f0509febc5143560a1859ae6344d0a6d1427
1 parent f824e13 commit 2183a61

4 files changed

Lines changed: 104 additions & 29 deletions

File tree

‎openstackclient/compute/v2/server.py‎

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
from novaclient import api_versions
2828
from novaclient.v2 import servers
2929
from openstack import exceptions as sdk_exceptions
30+
from openstack import utils as sdk_utils
3031
from osc_lib.cli import format_columns
3132
from osc_lib.cli import parseractions
3233
from osc_lib.command import command
@@ -378,10 +379,10 @@ def get_parser(self, prog_name):
378379
return parser
379380

380381
def take_action(self, parsed_args):
381-
compute_client = self.app.client_manager.compute
382+
compute_client = self.app.client_manager.sdk_connection.compute
382383

383-
server = utils.find_resource(
384-
compute_client.servers, parsed_args.server)
384+
server = compute_client.find_server(
385+
parsed_args.server, ignore_missing=False)
385386

386387
if self.app.client_manager.is_network_endpoint_enabled():
387388
network_client = self.app.client_manager.network
@@ -392,20 +393,19 @@ def take_action(self, parsed_args):
392393

393394
kwargs = {
394395
'port_id': port_id,
395-
'net_id': None,
396396
'fixed_ip': None,
397397
}
398398

399399
if parsed_args.tag:
400-
if compute_client.api_version < api_versions.APIVersion("2.49"):
400+
if not sdk_utils.supports_microversion(compute_client, '2.49'):
401401
msg = _(
402402
'--os-compute-api-version 2.49 or greater is required to '
403403
'support the --tag option'
404404
)
405405
raise exceptions.CommandError(msg)
406406
kwargs['tag'] = parsed_args.tag
407407

408-
server.interface_attach(**kwargs)
408+
compute_client.create_server_interface(server, **kwargs)
409409

410410

411411
class AddNetwork(command.Command):
@@ -434,10 +434,10 @@ def get_parser(self, prog_name):
434434
return parser
435435

436436
def take_action(self, parsed_args):
437-
compute_client = self.app.client_manager.compute
437+
compute_client = self.app.client_manager.sdk_connection.compute
438438

439-
server = utils.find_resource(
440-
compute_client.servers, parsed_args.server)
439+
server = compute_client.find_server(
440+
parsed_args.server, ignore_missing=False)
441441

442442
if self.app.client_manager.is_network_endpoint_enabled():
443443
network_client = self.app.client_manager.network
@@ -447,13 +447,12 @@ def take_action(self, parsed_args):
447447
net_id = parsed_args.network
448448

449449
kwargs = {
450-
'port_id': None,
451450
'net_id': net_id,
452451
'fixed_ip': None,
453452
}
454453

455454
if parsed_args.tag:
456-
if compute_client.api_version < api_versions.APIVersion('2.49'):
455+
if not sdk_utils.supports_microversion(compute_client, '2.49'):
457456
msg = _(
458457
'--os-compute-api-version 2.49 or greater is required to '
459458
'support the --tag option'
@@ -462,7 +461,7 @@ def take_action(self, parsed_args):
462461

463462
kwargs['tag'] = parsed_args.tag
464463

465-
server.interface_attach(**kwargs)
464+
compute_client.create_server_interface(server, **kwargs)
466465

467466

468467
class AddServerSecurityGroup(command.Command):

‎openstackclient/tests/functional/compute/v2/test_server.py‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1071,3 +1071,51 @@ def test_server_create_with_empty_network_option_latest(self):
10711071
# networks and the test didn't specify a specific network.
10721072
self.assertNotIn('nics are required after microversion 2.36',
10731073
e.stderr)
1074+
1075+
def test_server_add_remove_network_port(self):
1076+
name = uuid.uuid4().hex
1077+
cmd_output = json.loads(self.openstack(
1078+
'server create -f json ' +
1079+
'--network private ' +
1080+
'--flavor ' + self.flavor_name + ' ' +
1081+
'--image ' + self.image_name + ' ' +
1082+
'--wait ' +
1083+
name
1084+
))
1085+
1086+
self.assertIsNotNone(cmd_output['id'])
1087+
self.assertEqual(name, cmd_output['name'])
1088+
1089+
self.openstack(
1090+
'server add network ' + name + ' public')
1091+
1092+
cmd_output = json.loads(self.openstack(
1093+
'server show -f json ' + name
1094+
))
1095+
1096+
addresses = cmd_output['addresses']
1097+
self.assertIn('public', addresses)
1098+
1099+
port_name = 'test-port'
1100+
1101+
cmd_output = json.loads(self.openstack(
1102+
'port list -f json'
1103+
))
1104+
self.assertNotIn(port_name, cmd_output)
1105+
1106+
cmd_output = json.loads(self.openstack(
1107+
'port create -f json ' +
1108+
'--network private ' + port_name
1109+
))
1110+
self.assertIsNotNone(cmd_output['id'])
1111+
1112+
self.openstack('server add port ' + name + ' ' + port_name)
1113+
1114+
cmd_output = json.loads(self.openstack(
1115+
'server show -f json ' + name
1116+
))
1117+
1118+
# TODO(diwei): test remove network/port after the commands are switched
1119+
1120+
self.openstack('server delete ' + name)
1121+
self.openstack('port delete ' + port_name)

‎openstackclient/tests/unit/compute/v2/test_server.py‎

Lines changed: 41 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
import iso8601
2525
from novaclient import api_versions
2626
from openstack import exceptions as sdk_exceptions
27+
from openstack import utils as sdk_utils
2728
from osc_lib.cli import format_columns
2829
from osc_lib import exceptions
2930
from osc_lib import utils as common_utils
@@ -69,6 +70,10 @@ def setUp(self):
6970
self.servers_mock = self.app.client_manager.compute.servers
7071
self.servers_mock.reset_mock()
7172

73+
self.app.client_manager.sdk_connection = mock.Mock()
74+
self.app.client_manager.sdk_connection.compute = mock.Mock()
75+
self.sdk_client = self.app.client_manager.sdk_connection.compute
76+
7277
# Get a shortcut to the compute client ServerMigrationsManager Mock
7378
self.server_migrations_mock = \
7479
self.app.client_manager.compute.server_migrations
@@ -133,6 +138,21 @@ def setup_servers_mock(self, count):
133138
0)
134139
return servers
135140

141+
def setup_sdk_servers_mock(self, count):
142+
servers = compute_fakes.FakeServer.create_sdk_servers(
143+
attrs=self.attrs,
144+
methods=self.methods,
145+
count=count,
146+
)
147+
148+
# This is the return value for compute_client.find_server()
149+
self.sdk_client.find_server = compute_fakes.FakeServer.get_servers(
150+
servers,
151+
0,
152+
)
153+
154+
return servers
155+
136156
def run_method_with_servers(self, method_name, server_count):
137157
servers = self.setup_servers_mock(server_count)
138158

@@ -570,7 +590,7 @@ def setUp(self):
570590
self.app.client_manager.network.find_port = self.find_port
571591

572592
def _test_server_add_port(self, port_id):
573-
servers = self.setup_servers_mock(count=1)
593+
servers = self.setup_sdk_servers_mock(count=1)
574594
port = 'fake-port'
575595

576596
arglist = [
@@ -585,8 +605,8 @@ def _test_server_add_port(self, port_id):
585605

586606
result = self.cmd.take_action(parsed_args)
587607

588-
servers[0].interface_attach.assert_called_once_with(
589-
port_id=port_id, net_id=None, fixed_ip=None)
608+
self.sdk_client.create_server_interface.assert_called_once_with(
609+
servers[0], port_id=port_id, fixed_ip=None)
590610
self.assertIsNone(result)
591611

592612
def test_server_add_port(self):
@@ -599,11 +619,12 @@ def test_server_add_port_no_neutron(self):
599619
self._test_server_add_port('fake-port')
600620
self.find_port.assert_not_called()
601621

602-
def test_server_add_port_with_tag(self):
622+
@mock.patch.object(sdk_utils, 'supports_microversion', return_value=True)
623+
def test_server_add_port_with_tag(self, sm_mock):
603624
self.app.client_manager.compute.api_version = api_versions.APIVersion(
604625
'2.49')
605626

606-
servers = self.setup_servers_mock(count=1)
627+
servers = self.setup_sdk_servers_mock(count=1)
607628
self.find_port.return_value.id = 'fake-port'
608629
arglist = [
609630
servers[0].id,
@@ -620,13 +641,14 @@ def test_server_add_port_with_tag(self):
620641
result = self.cmd.take_action(parsed_args)
621642
self.assertIsNone(result)
622643

623-
servers[0].interface_attach.assert_called_once_with(
644+
self.sdk_client.create_server_interface.assert_called_once_with(
645+
servers[0],
624646
port_id='fake-port',
625-
net_id=None,
626647
fixed_ip=None,
627648
tag='tag1')
628649

629-
def test_server_add_port_with_tag_pre_v249(self):
650+
@mock.patch.object(sdk_utils, 'supports_microversion', return_value=False)
651+
def test_server_add_port_with_tag_pre_v249(self, sm_mock):
630652
self.app.client_manager.compute.api_version = api_versions.APIVersion(
631653
'2.48')
632654

@@ -891,7 +913,7 @@ def setUp(self):
891913
self.app.client_manager.network.find_network = self.find_network
892914

893915
def _test_server_add_network(self, net_id):
894-
servers = self.setup_servers_mock(count=1)
916+
servers = self.setup_sdk_servers_mock(count=1)
895917
network = 'fake-network'
896918

897919
arglist = [
@@ -906,8 +928,8 @@ def _test_server_add_network(self, net_id):
906928

907929
result = self.cmd.take_action(parsed_args)
908930

909-
servers[0].interface_attach.assert_called_once_with(
910-
port_id=None, net_id=net_id, fixed_ip=None)
931+
self.sdk_client.create_server_interface.assert_called_once_with(
932+
servers[0], net_id=net_id, fixed_ip=None)
911933
self.assertIsNone(result)
912934

913935
def test_server_add_network(self):
@@ -920,11 +942,12 @@ def test_server_add_network_no_neutron(self):
920942
self._test_server_add_network('fake-network')
921943
self.find_network.assert_not_called()
922944

923-
def test_server_add_network_with_tag(self):
945+
@mock.patch.object(sdk_utils, 'supports_microversion', return_value=True)
946+
def test_server_add_network_with_tag(self, sm_mock):
924947
self.app.client_manager.compute.api_version = api_versions.APIVersion(
925948
'2.49')
926949

927-
servers = self.setup_servers_mock(count=1)
950+
servers = self.setup_sdk_servers_mock(count=1)
928951
self.find_network.return_value.id = 'fake-network'
929952

930953
arglist = [
@@ -942,18 +965,19 @@ def test_server_add_network_with_tag(self):
942965
result = self.cmd.take_action(parsed_args)
943966
self.assertIsNone(result)
944967

945-
servers[0].interface_attach.assert_called_once_with(
946-
port_id=None,
968+
self.sdk_client.create_server_interface.assert_called_once_with(
969+
servers[0],
947970
net_id='fake-network',
948971
fixed_ip=None,
949972
tag='tag1'
950973
)
951974

952-
def test_server_add_network_with_tag_pre_v249(self):
975+
@mock.patch.object(sdk_utils, 'supports_microversion', return_value=False)
976+
def test_server_add_network_with_tag_pre_v249(self, sm_mock):
953977
self.app.client_manager.compute.api_version = api_versions.APIVersion(
954978
'2.48')
955979

956-
servers = self.setup_servers_mock(count=1)
980+
servers = self.setup_sdk_servers_mock(count=1)
957981
self.find_network.return_value.id = 'fake-network'
958982

959983
arglist = [

‎releasenotes/notes/migrate-server-add-network-add-port-to-sdk-7d81b25f59cfbec9.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
features:
3+
- |
4+
Migrate server add network/port from novaclient to openstacksdk.

0 commit comments

Comments
 (0)