openstack/python-openstackclient
Code Issues Proposed changes

Merge "Add security groups options to "port create/set/unset""

Browse Source
This commit is contained in:
Jenkins 2016-10-17 08:27:58 +00:00 committed by Gerrit Code Review
commit ab9cfc4dc4
4 changed files with 325 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/source/command-objects/port.rst
View File

@ -26,6 +26,7 @@ Create new port
[--host <host-id>]
[--enable | --disable]
[--mac-address <mac-address>]
[--security-group <security-group> | --no-security-group]
[--project <project> [--project-domain <project-domain>]]
<name>
@ -75,6 +76,15 @@ Create new port
MAC address of this port
.. option:: --security-group <security-group>
Security group to associate with this port (name or ID)
(repeat option to set multiple security groups)
.. option:: --no-security-group
Associate no security groups with this port
.. option:: --project <project>
Owner's project (name or ID)
@ -159,6 +169,8 @@ Set port properties
[--host <host-id>]
[--enable | --disable]
[--name <name>]
[--security-group <security-group>]
[--no-security-group]
<port>
.. option:: --fixed-ip subnet=<subnet>,ip-address=<ip-address>
@ -215,6 +227,15 @@ Set port properties
Set port name
.. option:: --security-group <security-group>
Security group to associate with this port (name or ID)
(repeat option to set multiple security groups)
.. option:: --no-security-group
Clear existing security groups associated with this port
.. _port_set-port:
.. describe:: <port>
@ -247,6 +268,7 @@ Unset port properties
os port unset
[--fixed-ip subnet=<subnet>,ip-address=<ip-address> [...]]
[--binding-profile <binding-profile-key> [...]]
[--security-group <security-group> [...]]
<port>
.. option:: --fixed-ip subnet=<subnet>,ip-address=<ip-address>
@ -260,6 +282,11 @@ Unset port properties
Desired key which should be removed from binding-profile
(repeat option to unset multiple binding:profile data)
.. option:: --security-group <security-group>
Security group which should be removed from this port (name or ID)
(repeat option to unset multiple security groups)
.. _port_unset-port:
.. describe:: <port>

73
openstackclient/network/v2/port.py
View File

@ -281,7 +281,23 @@ class CreatePort(command.ShowOne):
help=_("Name of this port")
)
# TODO(singhj): Add support for extended options:
# qos,security groups,dhcp, address pairs
# qos,dhcp, address pairs
secgroups = parser.add_mutually_exclusive_group()
secgroups.add_argument(
'--security-group',
metavar='<security-group>',
action='append',
dest='security_groups',
help=_("Security group to associate with this port (name or ID) "
"(repeat option to set multiple security groups)")
)
secgroups.add_argument(
'--no-security-group',
dest='no_security_group',
action='store_true',
help=_("Associate no security groups with this port")
)
return parser
def take_action(self, parsed_args):
@ -291,6 +307,14 @@ class CreatePort(command.ShowOne):
parsed_args.network = _network.id
_prepare_fixed_ips(self.app.client_manager, parsed_args)
attrs = _get_attrs(self.app.client_manager, parsed_args)
if parsed_args.security_groups:
attrs['security_groups'] = [client.find_security_group(
sg, ignore_missing=False).id
for sg in parsed_args.security_groups]
if parsed_args.no_security_group:
attrs['security_groups'] = []
obj = client.create_port(**attrs)
columns = _get_columns(obj)
data = utils.get_item_properties(obj, columns, formatters=_formatters)
@ -474,6 +498,21 @@ class SetPort(command.Command):
metavar="<port>",
help=_("Port to modify (name or ID)")
)
parser.add_argument(
'--security-group',
metavar='<security-group>',
action='append',
dest='security_groups',
help=_("Security group to associate with this port (name or ID) "
"(repeat option to set multiple security groups)")
)
parser.add_argument(
'--no-security-group',
dest='no_security_group',
action='store_true',
help=_("Clear existing security groups associated with this port")
)
return parser
def take_action(self, parsed_args):
@ -501,6 +540,17 @@ class SetPort(command.Command):
attrs['fixed_ips'] += [ip for ip in obj.fixed_ips if ip]
elif parsed_args.no_fixed_ip:
attrs['fixed_ips'] = []
if parsed_args.security_groups and parsed_args.no_security_group:
attrs['security_groups'] = [client.find_security_group(sg,
ignore_missing=False).id
for sg in parsed_args.security_groups]
elif parsed_args.security_groups:
attrs['security_groups'] = obj.security_groups
for sg in parsed_args.security_groups:
sg_id = client.find_security_group(sg, ignore_missing=False).id
attrs['security_groups'].append(sg_id)
elif parsed_args.no_security_group:
attrs['security_groups'] = []
client.update_port(obj, **attrs)
@ -546,6 +596,15 @@ class UnsetPort(command.Command):
action='append',
help=_("Desired key which should be removed from binding:profile"
"(repeat option to unset multiple binding:profile data)"))
parser.add_argument(
'--security-group',
metavar='<security-group>',
action='append',
dest='security_groups',
help=_("Security group which should be removed this port (name "
"or ID) (repeat option to unset multiple security groups)")
)
parser.add_argument(
'port',
metavar="<port>",
@ -561,6 +620,7 @@ class UnsetPort(command.Command):
# Unset* classes
tmp_fixed_ips = copy.deepcopy(obj.fixed_ips)
tmp_binding_profile = copy.deepcopy(obj.binding_profile)
tmp_secgroups = copy.deepcopy(obj.security_groups)
_prepare_fixed_ips(self.app.client_manager, parsed_args)
attrs = {}
if parsed_args.fixed_ip:
@ -579,5 +639,16 @@ class UnsetPort(command.Command):
msg = _("Port does not contain binding-profile %s") % key
raise exceptions.CommandError(msg)
attrs['binding:profile'] = tmp_binding_profile
if parsed_args.security_groups:
try:
for sg in parsed_args.security_groups:
sg_id = client.find_security_group(
sg, ignore_missing=False).id
tmp_secgroups.remove(sg_id)
except ValueError:
msg = _("Port does not contain security group %s") % sg
raise exceptions.CommandError(msg)
attrs['security_groups'] = tmp_secgroups
if attrs:
client.update_port(obj, **attrs)

220
openstackclient/tests/unit/network/v2/test_port.py
View File

@ -228,6 +228,93 @@ class TestCreatePort(TestPort):
self.assertEqual(ref_columns, columns)
self.assertEqual(ref_data, data)
def test_create_with_security_group(self):
secgroup = network_fakes.FakeSecurityGroup.create_one_security_group()
self.network.find_security_group = mock.Mock(return_value=secgroup)
arglist = [
'--network', self._port.network_id,
'--security-group', secgroup.id,
'test-port',
]
verifylist = [
('network', self._port.network_id,),
('enable', True),
('security_groups', [secgroup.id]),
('name', 'test-port'),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = (self.cmd.take_action(parsed_args))
self.network.create_port.assert_called_once_with(**{
'admin_state_up': True,
'network_id': self._port.network_id,
'security_groups': [secgroup.id],
'name': 'test-port',
})
ref_columns, ref_data = self._get_common_cols_data(self._port)
self.assertEqual(ref_columns, columns)
self.assertEqual(ref_data, data)
def test_create_with_security_groups(self):
sg_1 = network_fakes.FakeSecurityGroup.create_one_security_group()
sg_2 = network_fakes.FakeSecurityGroup.create_one_security_group()
self.network.find_security_group = mock.Mock(side_effect=[sg_1, sg_2])
arglist = [
'--network', self._port.network_id,
'--security-group', sg_1.id,
'--security-group', sg_2.id,
'test-port',
]
verifylist = [
('network', self._port.network_id,),
('enable', True),
('security_groups', [sg_1.id, sg_2.id]),
('name', 'test-port'),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = (self.cmd.take_action(parsed_args))
self.network.create_port.assert_called_once_with(**{
'admin_state_up': True,
'network_id': self._port.network_id,
'security_groups': [sg_1.id, sg_2.id],
'name': 'test-port',
})
ref_columns, ref_data = self._get_common_cols_data(self._port)
self.assertEqual(ref_columns, columns)
self.assertEqual(ref_data, data)
def test_create_with_no_secuirty_groups(self):
arglist = [
'--network', self._port.network_id,
'--no-security-group',
'test-port',
]
verifylist = [
('network', self._port.network_id),
('enable', True),
('no_security_group', True),
('name', 'test-port'),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = (self.cmd.take_action(parsed_args))
self.network.create_port.assert_called_once_with(**{
'admin_state_up': True,
'network_id': self._port.network_id,
'security_groups': [],
'name': 'test-port',
})
ref_columns, ref_data = self._get_common_cols_data(self._port)
self.assertEqual(ref_columns, columns)
self.assertEqual(ref_data, data)
class TestDeletePort(TestPort):
@ -692,6 +779,95 @@ class TestSetPort(TestPort):
self.network.update_port.assert_called_once_with(self._port, **attrs)
self.assertIsNone(result)
def test_set_security_group(self):
sg = network_fakes.FakeSecurityGroup.create_one_security_group()
self.network.find_security_group = mock.Mock(return_value=sg)
arglist = [
'--security-group', sg.id,
self._port.name,
]
verifylist = [
('security_groups', [sg.id]),
('port', self._port.name),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
result = self.cmd.take_action(parsed_args)
attrs = {
'security_groups': [sg.id],
}
self.network.update_port.assert_called_once_with(self._port, **attrs)
self.assertIsNone(result)
def test_append_security_group(self):
sg_1 = network_fakes.FakeSecurityGroup.create_one_security_group()
sg_2 = network_fakes.FakeSecurityGroup.create_one_security_group()
sg_3 = network_fakes.FakeSecurityGroup.create_one_security_group()
self.network.find_security_group = mock.Mock(side_effect=[sg_2, sg_3])
_testport = network_fakes.FakePort.create_one_port(
{'security_groups': [sg_1.id]})
self.network.find_port = mock.Mock(return_value=_testport)
arglist = [
'--security-group', sg_2.id,
'--security-group', sg_3.id,
_testport.name,
]
verifylist = [
('security_groups', [sg_2.id, sg_3.id]),
('port', _testport.name),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
result = self.cmd.take_action(parsed_args)
attrs = {
'security_groups': [sg_1.id, sg_2.id, sg_3.id],
}
self.network.update_port.assert_called_once_with(_testport, **attrs)
self.assertIsNone(result)
def test_set_no_security_groups(self):
arglist = [
'--no-security-group',
self._port.name,
]
verifylist = [
('no_security_group', True),
('port', self._port.name),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
result = self.cmd.take_action(parsed_args)
attrs = {
'security_groups': [],
}
self.network.update_port.assert_called_once_with(self._port, **attrs)
self.assertIsNone(result)
def test_overwrite_security_group(self):
sg1 = network_fakes.FakeSecurityGroup.create_one_security_group()
sg2 = network_fakes.FakeSecurityGroup.create_one_security_group()
_testport = network_fakes.FakePort.create_one_port(
{'security_groups': [sg1.id]})
self.network.find_port = mock.Mock(return_value=_testport)
self.network.find_security_group = mock.Mock(return_value=sg2)
arglist = [
'--security-group', sg2.id,
'--no-security-group',
_testport.name,
]
verifylist = [
('security_groups', [sg2.id]),
('no_security_group', True)
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
result = self.cmd.take_action(parsed_args)
attrs = {
'security_groups': [sg2.id],
}
self.network.update_port.assert_called_once_with(_testport, **attrs)
self.assertIsNone(result)
class TestShowPort(TestPort):
@ -808,3 +984,47 @@ class TestUnsetPort(TestPort):
self.assertRaises(exceptions.CommandError,
self.cmd.take_action,
parsed_args)
def test_unset_security_group(self):
_fake_sg1 = network_fakes.FakeSecurityGroup.create_one_security_group()
_fake_sg2 = network_fakes.FakeSecurityGroup.create_one_security_group()
_fake_port = network_fakes.FakePort.create_one_port(
{'security_groups': [_fake_sg1.id, _fake_sg2.id]})
self.network.find_port = mock.Mock(return_value=_fake_port)
self.network.find_security_group = mock.Mock(return_value=_fake_sg2)
arglist = [
'--security-group', _fake_sg2.id,
_fake_port.name,
]
verifylist = [
('security_groups', [_fake_sg2.id]),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
result = self.cmd.take_action(parsed_args)
attrs = {
'security_groups': [_fake_sg1.id]
}
self.network.update_port.assert_called_once_with(
_fake_port, **attrs)
self.assertIsNone(result)
def test_unset_port_security_group_not_existent(self):
_fake_sg1 = network_fakes.FakeSecurityGroup.create_one_security_group()
_fake_sg2 = network_fakes.FakeSecurityGroup.create_one_security_group()
_fake_port = network_fakes.FakePort.create_one_port(
{'security_groups': [_fake_sg1.id]})
self.network.find_security_group = mock.Mock(return_value=_fake_sg2)
arglist = [
'--security-group', _fake_sg2.id,
_fake_port.name,
]
verifylist = [
('security_groups', [_fake_sg2.id]),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.assertRaises(exceptions.CommandError,
self.cmd.take_action,
parsed_args)

6
releasenotes/notes/bug-1612136-051b5f94796e3b51.yaml Normal file
View File

@ -0,0 +1,6 @@
---
features:
- |
Add ``--security-group`` and ``--no-security-group`` options to
``port create``, ``port set`` and ``port unset`` commands.
[Bug `1612136 <https://bugs.launchpad.net/python-openstackclient/+bug/1612136>`_]