openstack/python-openstackclient
Code Issues Proposed changes

Switch add fixed IP to SDK

Browse Source 
Switch the add fixed IP command from novaclient to SDK.

Change-Id: I4752ea7b4bfc17e04b8f46dbe9a68d938501a89e
This commit is contained in:
Ritvik Vinodkumar 2021-12-01 16:54:53 +00:00 committed by Stephen Finucane
parent c10a4cd966
commit 9971d7253e
3 changed files with 212 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
openstackclient/compute/v2/server.py
View File

@ -237,30 +237,44 @@ class AddFixedIP(command.Command):
return parser return parser
def take_action(self, parsed_args): def take_action(self, parsed_args):
compute_client = self.app.client_manager.compute compute_client = self.app.client_manager.sdk_connection.compute
server = compute_client.find_server(
server = utils.find_resource( parsed_args.server,
compute_client.servers, parsed_args.server) ignore_missing=False
)
network = compute_client.api.network_find(parsed_args.network)
kwargs = {
'port_id': None,
'net_id': network['id'],
'fixed_ip': parsed_args.fixed_ip_address,
}
if parsed_args.tag: if parsed_args.tag:
if compute_client.api_version < api_versions.APIVersion('2.49'): if not sdk_utils.supports_microversion(compute_client, '2.49'):
msg = _( msg = _(
'--os-compute-api-version 2.49 or greater is required to ' '--os-compute-api-version 2.49 or greater is required to '
'support the --tag option' 'support the --tag option'
) )
raise exceptions.CommandError(msg) raise exceptions.CommandError(msg)
kwargs['tag'] = parsed_args.tag if self.app.client_manager.is_network_endpoint_enabled():
network_client = self.app.client_manager.network
net_id = network_client.find_network(
parsed_args.network,
ignore_missing=False
).id
else:
net_id = parsed_args.network
server.interface_attach(**kwargs) if not sdk_utils.supports_microversion(compute_client, '2.44'):
compute_client.add_fixed_ip_to_server(
server.id,
net_id
)
return
kwargs = {
'net_id': net_id,
'fixed_ip': parsed_args.fixed_ip_address,
}
if parsed_args.tag:
kwargs['tag'] = parsed_args.tag
compute_client.create_server_interface(server.id, **kwargs)
class AddFloatingIP(network_common.NetworkAndComputeCommand): class AddFloatingIP(network_common.NetworkAndComputeCommand):

226
openstackclient/tests/unit/compute/v2/test_server.py
View File

@ -217,104 +217,104 @@ class TestServerAddFixedIP(TestServer):
# Get the command object to test # Get the command object to test
self.cmd = server.AddFixedIP(self.app, None) self.cmd = server.AddFixedIP(self.app, None)
# Mock network methods
self.find_network = mock.Mock()
self.app.client_manager.network.find_network = self.find_network
# Set add_fixed_ip method to be tested. # Set add_fixed_ip method to be tested.
self.methods = { self.methods = {
'interface_attach': None, 'interface_attach': None,
} }
def _test_server_add_fixed_ip(self, extralist, fixed_ip_address): @mock.patch.object(sdk_utils, 'supports_microversion')
servers = self.setup_servers_mock(count=1) def test_server_add_fixed_ip_pre_2_44(self, sm_mock):
network = compute_fakes.FakeNetwork.create_one_network() sm_mock.return_value = False
with mock.patch(
'openstackclient.api.compute_v2.APIv2.network_find'
) as net_mock:
net_mock.return_value = network
servers = self.setup_sdk_servers_mock(count=1)
network = compute_fakes.FakeNetwork.create_one_network()
with mock.patch.object(
self.app.client_manager,
'is_network_endpoint_enabled',
return_value=False
):
arglist = [ arglist = [
servers[0].id, servers[0].id,
network['id'], network['id'],
] + extralist ]
verifylist = [ verifylist = [
('server', servers[0].id), ('server', servers[0].id),
('network', network['id']), ('network', network['id']),
('fixed_ip_address', fixed_ip_address), ('fixed_ip_address', None),
] ]
parsed_args = self.check_parser(self.cmd, arglist, verifylist) parsed_args = self.check_parser(self.cmd, arglist, verifylist)
result = self.cmd.take_action(parsed_args) result = self.cmd.take_action(parsed_args)
servers[0].interface_attach.assert_called_once_with( self.sdk_client.add_fixed_ip_to_server.assert_called_once_with(
port_id=None, servers[0].id,
net_id=network['id'], network['id']
fixed_ip=fixed_ip_address,
) )
self.assertIsNone(result) self.assertIsNone(result)
def test_server_add_fixed_ip(self): @mock.patch.object(sdk_utils, 'supports_microversion')
self._test_server_add_fixed_ip([], None) def test_server_add_fixed_ip_pre_2_44_with_fixed_ip(self, sm_mock):
sm_mock.return_value = False
def test_server_add_specific_fixed_ip(self): servers = self.setup_sdk_servers_mock(count=1)
extralist = ['--fixed-ip-address', '5.6.7.8']
self._test_server_add_fixed_ip(extralist, '5.6.7.8')
def test_server_add_fixed_ip_with_tag(self):
self.app.client_manager.compute.api_version = api_versions.APIVersion(
'2.49')
servers = self.setup_servers_mock(count=1)
network = compute_fakes.FakeNetwork.create_one_network() network = compute_fakes.FakeNetwork.create_one_network()
with mock.patch(
'openstackclient.api.compute_v2.APIv2.network_find'
) as net_mock:
net_mock.return_value = network
with mock.patch.object(
self.app.client_manager,
'is_network_endpoint_enabled',
return_value=False
):
arglist = [ arglist = [
servers[0].id, servers[0].id,
network['id'], network['id'],
'--fixed-ip-address', '5.6.7.8', '--fixed-ip-address', '5.6.7.8'
'--tag', 'tag1',
] ]
verifylist = [ verifylist = [
('server', servers[0].id), ('server', servers[0].id),
('network', network['id']), ('network', network['id']),
('fixed_ip_address', '5.6.7.8'), ('fixed_ip_address', '5.6.7.8'),
('tag', 'tag1'),
] ]
parsed_args = self.check_parser(self.cmd, arglist, verifylist) parsed_args = self.check_parser(self.cmd, arglist, verifylist)
result = self.cmd.take_action(parsed_args) result = self.cmd.take_action(parsed_args)
servers[0].interface_attach.assert_called_once_with( self.sdk_client.add_fixed_ip_to_server.assert_called_once_with(
port_id=None, servers[0].id,
net_id=network['id'], network['id']
fixed_ip='5.6.7.8',
tag='tag1'
) )
self.assertIsNone(result) self.assertIsNone(result)
def test_server_add_fixed_ip_with_tag_pre_v249(self): @mock.patch.object(sdk_utils, 'supports_microversion')
self.app.client_manager.compute.api_version = api_versions.APIVersion( def test_server_add_fixed_ip_pre_2_44_with_tag(self, sm_mock):
'2.48') sm_mock.return_value = False
servers = self.setup_servers_mock(count=1) servers = self.setup_sdk_servers_mock(count=1)
network = compute_fakes.FakeNetwork.create_one_network() network = compute_fakes.FakeNetwork.create_one_network()
with mock.patch(
'openstackclient.api.compute_v2.APIv2.network_find'
) as net_mock:
net_mock.return_value = network
with mock.patch.object(
self.app.client_manager,
'is_network_endpoint_enabled',
return_value=False
):
arglist = [ arglist = [
servers[0].id, servers[0].id,
network['id'], network['id'],
'--fixed-ip-address', '5.6.7.8', '--fixed-ip-address', '5.6.7.8',
'--tag', 'tag1', '--tag', 'tag1'
] ]
verifylist = [ verifylist = [
('server', servers[0].id), ('server', servers[0].id),
('network', network['id']), ('network', network['id']),
('fixed_ip_address', '5.6.7.8'), ('fixed_ip_address', '5.6.7.8'),
('tag', 'tag1'), ('tag', 'tag1')
] ]
parsed_args = self.check_parser(self.cmd, arglist, verifylist) parsed_args = self.check_parser(self.cmd, arglist, verifylist)
ex = self.assertRaises( ex = self.assertRaises(
exceptions.CommandError, exceptions.CommandError,
self.cmd.take_action, self.cmd.take_action,
@ -323,6 +323,140 @@ class TestServerAddFixedIP(TestServer):
'--os-compute-api-version 2.49 or greater is required', '--os-compute-api-version 2.49 or greater is required',
str(ex)) str(ex))
@mock.patch.object(sdk_utils, 'supports_microversion')
def test_server_add_fixed_ip_pre_2_49_with_tag(self, sm_mock):
sm_mock.side_effect = [False, True]
servers = self.setup_sdk_servers_mock(count=1)
network = compute_fakes.FakeNetwork.create_one_network()
with mock.patch.object(
self.app.client_manager,
'is_network_endpoint_enabled',
return_value=False
):
arglist = [
servers[0].id,
network['id'],
'--fixed-ip-address', '5.6.7.8',
'--tag', 'tag1'
]
verifylist = [
('server', servers[0].id),
('network', network['id']),
('fixed_ip_address', '5.6.7.8'),
('tag', 'tag1')
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
ex = self.assertRaises(
exceptions.CommandError,
self.cmd.take_action,
parsed_args)
self.assertIn(
'--os-compute-api-version 2.49 or greater is required',
str(ex))
@mock.patch.object(sdk_utils, 'supports_microversion')
def test_server_add_fixed_ip_post_2_49(self, sm_mock):
sm_mock.side_effect = [True, True]
servers = self.setup_sdk_servers_mock(count=1)
network = compute_fakes.FakeNetwork.create_one_network()
with mock.patch.object(
self.app.client_manager,
'is_network_endpoint_enabled',
return_value=False
):
arglist = [
servers[0].id,
network['id']
]
verifylist = [
('server', servers[0].id),
('network', network['id'])
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
result = self.cmd.take_action(parsed_args)
self.sdk_client.create_server_interface.assert_called_once_with(
servers[0].id,
net_id=network['id'],
fixed_ip=None
)
self.assertIsNone(result)
@mock.patch.object(sdk_utils, 'supports_microversion')
def test_server_add_fixed_ip_post_2_49_with_fixedip(self, sm_mock):
sm_mock.side_effect = [True, True]
servers = self.setup_sdk_servers_mock(count=1)
network = compute_fakes.FakeNetwork.create_one_network()
with mock.patch.object(
self.app.client_manager,
'is_network_endpoint_enabled',
return_value=False
):
arglist = [
servers[0].id,
network['id'],
'--fixed-ip-address', '5.6.7.8'
]
verifylist = [
('server', servers[0].id),
('network', network['id']),
('fixed_ip_address', '5.6.7.8')
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
result = self.cmd.take_action(parsed_args)
self.sdk_client.create_server_interface.assert_called_once_with(
servers[0].id,
net_id=network['id'],
fixed_ip='5.6.7.8'
)
self.assertIsNone(result)
@mock.patch.object(sdk_utils, 'supports_microversion')
def test_server_add_fixed_ip_post_2_49_with_tag(self, sm_mock):
sm_mock.side_effect = [True, True]
servers = self.setup_sdk_servers_mock(count=1)
network = compute_fakes.FakeNetwork.create_one_network()
with mock.patch.object(
self.app.client_manager,
'is_network_endpoint_enabled',
return_value=False
):
arglist = [
servers[0].id,
network['id'],
'--fixed-ip-address', '5.6.7.8',
'--tag', 'tag1'
]
verifylist = [
('server', servers[0].id),
('network', network['id']),
('fixed_ip_address', '5.6.7.8'),
('tag', 'tag1')
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
result = self.cmd.take_action(parsed_args)
self.sdk_client.create_server_interface.assert_called_once_with(
servers[0].id,
net_id=network['id'],
fixed_ip='5.6.7.8',
tag='tag1'
)
self.assertIsNone(result)
@mock.patch( @mock.patch(
'openstackclient.api.compute_v2.APIv2.floating_ip_add' 'openstackclient.api.compute_v2.APIv2.floating_ip_add'

3
releasenotes/notes/migrate-add-fixed-ip-to-sdk-3d932d77633bc765.yaml Normal file
View File

@ -0,0 +1,3 @@
features:
- |
Switch the add fixed IP command from novaclient to SDK.