openstack
/
python-ironicclient
Code Issues Proposed changes

Merge "Add portgroup support to osc plugin"

This commit is contained in:
Jenkins 2016-12-21 15:01:35 +00:00 committed by Gerrit Code Review
parent 430ac0e548 8595b59e1a
commit 1f586f1977
10 changed files with 1253 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ironicclient/osc/v1/baremetal_node.py
View File

@ -322,6 +322,7 @@ class CreateBaremetalNode(command.ShowOne):
node.pop('links', None)
node.pop('ports', None)
node.pop('portgroups', None)
node.setdefault('chassis_uuid', '')
@ -962,6 +963,7 @@ class ShowBaremetalNode(command.ShowOne):
parsed_args.node, fields=fields)._info
node.pop("links", None)
node.pop("ports", None)
node.pop('portgroups', None)
node.setdefault('chassis_uuid', '')

33
ironicclient/osc/v1/baremetal_port.py
View File

@ -74,6 +74,12 @@ class CreateBaremetalPort(command.ShowOne):
help='Indicates whether this Port should be used when '
'PXE booting this Node.')
parser.add_argument(
'--port-group',
dest='portgroup_uuid',
metavar='<uuid>',
help="UUID of the port group that this port belongs to.")
return parser
def take_action(self, parsed_args):
@ -93,7 +99,7 @@ class CreateBaremetalPort(command.ShowOne):
parsed_args.local_link_connection_deprecated)
field_list = ['address', 'extra', 'node_uuid', 'pxe_enabled',
'local_link_connection']
'local_link_connection', 'portgroup_uuid']
fields = dict((k, v) for (k, v) in vars(parsed_args).items()
if k in field_list and v is not None)
fields = utils.args_array_to_dict(fields, 'extra')
@ -173,6 +179,12 @@ class UnsetBaremetalPort(command.Command):
help='Extra to unset on this baremetal port '
'(repeat option to unset multiple extras)')
parser.add_argument(
'--port-group',
action='store_true',
dest='portgroup',
help="Remove port from the port group")
return parser
def take_action(self, parsed_args):
@ -184,6 +196,9 @@ class UnsetBaremetalPort(command.Command):
properties.extend(utils.args_array_to_patch(
'remove',
['extra/' + x for x in parsed_args.extra]))
if parsed_args.portgroup:
properties.extend(utils.args_array_to_patch('remove',
['portgroup_uuid']))
if not properties:
self.log.warning("Please specify what to unset.")
@ -222,6 +237,12 @@ class SetBaremetalPort(command.Command):
help='Extra to set on this baremetal port '
'(repeat option to set multiple extras)')
parser.add_argument(
"--port-group",
metavar="<uuid>",
dest='portgroup_uuid',
help='Set UUID of the port group that this port belongs to.')
return parser
def take_action(self, parsed_args):
@ -240,6 +261,9 @@ class SetBaremetalPort(command.Command):
if parsed_args.extra:
properties.extend(utils.args_array_to_patch(
'add', ['extra/' + x for x in parsed_args.extra]))
if parsed_args.portgroup_uuid:
portgroup_uuid = ["portgroup_uuid=%s" % parsed_args.portgroup_uuid]
properties.extend(utils.args_array_to_patch('add', portgroup_uuid))
if not properties:
self.log.warning("Please specify what to set.")
@ -298,6 +322,11 @@ class ListBaremetalPort(command.Lister):
metavar='<node>',
help="Only list ports of this node (name or UUID)."
)
parser.add_argument(
"--port-group",
metavar="<port group>",
dest='portgroup',
help='Only list ports of this port group (name or UUID).')
parser.add_argument(
'--limit',
metavar='<limit>',
@ -359,6 +388,8 @@ class ListBaremetalPort(command.Lister):
params['address'] = parsed_args.address
if parsed_args.node is not None:
params['node'] = parsed_args.node
if parsed_args.portgroup is not None:
params['portgroup'] = parsed_args.portgroup
if parsed_args.detail:
params['detail'] = parsed_args.detail

425
ironicclient/osc/v1/baremetal_portgroup.py Normal file
View File

@ -0,0 +1,425 @@
#
# Copyright 2016 Mirantis, Inc.
#
# 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 itertools
import logging
from osc_lib.command import command
from osc_lib import utils as oscutils
from ironicclient.common.i18n import _, _LW
from ironicclient.common import utils
from ironicclient import exc
from ironicclient.v1 import resource_fields as res_fields
class CreateBaremetalPortGroup(command.ShowOne):
"""Create a new baremetal port group."""
log = logging.getLogger(__name__ + ".CreateBaremetalPortGroup")
def get_parser(self, prog_name):
parser = super(CreateBaremetalPortGroup, self).get_parser(prog_name)
parser.add_argument(
'--node',
dest='node_uuid',
metavar='<uuid>',
required=True,
help='UUID of the node that this port group belongs to.')
parser.add_argument(
'--address',
metavar='<mac-address>',
help='MAC address for this port group.')
parser.add_argument(
'--name',
dest='name',
help='Name of the port group.')
parser.add_argument(
'--uuid',
dest='uuid',
help='UUID of the port group.')
parser.add_argument(
'--extra',
metavar="<key=value>",
action='append',
help="Record arbitrary key/value metadata. "
"Can be specified multiple times.")
standalone_ports_group = parser.add_mutually_exclusive_group()
standalone_ports_group.add_argument(
'--support-standalone-ports',
action='store_true',
help="Ports that are members of this port group "
"can be used as stand-alone ports. (default)"
)
standalone_ports_group.add_argument(
'--unsupport-standalone-ports',
action='store_true',
help="Ports that are members of this port group "
"cannot be used as stand-alone ports."
)
return parser
def take_action(self, parsed_args):
self.log.debug("take_action(%s)" % parsed_args)
baremetal_client = self.app.client_manager.baremetal
field_list = ['node_uuid', 'address', 'name', 'uuid', 'extra']
fields = dict((k, v) for (k, v) in vars(parsed_args).items()
if k in field_list and v is not None)
if parsed_args.support_standalone_ports:
fields['standalone_ports_supported'] = True
if parsed_args.unsupport_standalone_ports:
fields['standalone_ports_supported'] = False
fields = utils.args_array_to_dict(fields, 'extra')
portgroup = baremetal_client.portgroup.create(**fields)
data = dict([(f, getattr(portgroup, f, '')) for f in
res_fields.PORTGROUP_DETAILED_RESOURCE.fields])
return self.dict2columns(data)
class ShowBaremetalPortGroup(command.ShowOne):
"""Show baremetal port group details."""
log = logging.getLogger(__name__ + ".ShowBaremetalPortGroup")
def get_parser(self, prog_name):
parser = super(ShowBaremetalPortGroup, self).get_parser(prog_name)
parser.add_argument(
"portgroup",
metavar="<id>",
help="UUID or name of the port group "
"(or MAC address if --address is specified)."
)
parser.add_argument(
'--address',
dest='address',
action='store_true',
default=False,
help='<id> is the MAC address (instead of UUID or name) '
'of the port group.')
parser.add_argument(
'--fields',
nargs='+',
dest='fields',
metavar='<field>',
action='append',
choices=res_fields.PORTGROUP_DETAILED_RESOURCE.fields,
default=[],
help="One or more port group fields. Only these fields will be "
"fetched from the server.")
return parser
def take_action(self, parsed_args):
self.log.debug("take_action(%s)", parsed_args)
baremetal_client = self.app.client_manager.baremetal
fields = list(itertools.chain.from_iterable(parsed_args.fields))
fields = fields if fields else None
if parsed_args.address:
portgroup = baremetal_client.portgroup.get_by_address(
parsed_args.portgroup, fields=fields)._info
else:
portgroup = baremetal_client.portgroup.get(
parsed_args.portgroup, fields=fields)._info
portgroup.pop("links", None)
portgroup.pop("ports", None)
return zip(*sorted(portgroup.items()))
class ListBaremetalPortGroup(command.Lister):
"""List baremetal port groups."""
log = logging.getLogger(__name__ + ".ListBaremetalPortGroup")
def get_parser(self, prog_name):
parser = super(ListBaremetalPortGroup, self).get_parser(prog_name)
parser.add_argument(
'--limit',
metavar='<limit>',
type=int,
help='Maximum number of port groups to return per request, '
'0 for no limit. Default is the maximum number used '
'by the Baremetal API Service.'
)
parser.add_argument(
'--marker',
metavar='<port group>',
help='Port group UUID (for example, of the last port group in the '
'list from a previous request). Returns the list of '
'port groups after this UUID.'
)
parser.add_argument(
'--sort',
metavar="<key>[:<direction>]",
help='Sort output by specified port group fields and directions '
'(asc or desc) (default: asc). Multiple fields and '
'directions can be specified, separated by comma.',
)
parser.add_argument(
'--address',
metavar='<mac-address>',
help="Only show information for the port group with this MAC "
"address.",
)
parser.add_argument(
'--node',
dest='node',
metavar='<node>',
help="Only list port groups of this node (name or UUID)."
)
display_group = parser.add_mutually_exclusive_group(required=False)
display_group.add_argument(
'--long',
default=False,
dest='detail',
help="Show detailed information about the port groups.",
action='store_true')
display_group.add_argument(
'--fields',
nargs='+',
dest='fields',
metavar='<field>',
action='append',
default=[],
choices=res_fields.PORTGROUP_DETAILED_RESOURCE.fields,
help="One or more port group fields. Only these fields will be "
"fetched from the server. Can not be used when '--long' is "
"specified.")
return parser
def take_action(self, parsed_args):
self.log.debug("take_action(%s)" % parsed_args)
client = self.app.client_manager.baremetal
columns = res_fields.PORTGROUP_RESOURCE.fields
labels = res_fields.PORTGROUP_RESOURCE.labels
params = {}
if parsed_args.limit is not None and parsed_args.limit < 0:
raise exc.CommandError(
_('Expected non-negative --limit, got %s') %
parsed_args.limit)
params['limit'] = parsed_args.limit
params['marker'] = parsed_args.marker
if parsed_args.address is not None:
params['address'] = parsed_args.address
if parsed_args.node is not None:
params['node'] = parsed_args.node
if parsed_args.detail:
params['detail'] = parsed_args.detail
columns = res_fields.PORTGROUP_DETAILED_RESOURCE.fields
labels = res_fields.PORTGROUP_DETAILED_RESOURCE.labels
elif parsed_args.fields:
params['detail'] = False
fields = itertools.chain.from_iterable(parsed_args.fields)
resource = res_fields.Resource(list(fields))
columns = resource.fields
labels = resource.labels
params['fields'] = columns
self.log.debug("params(%s)" % params)
data = client.portgroup.list(**params)
data = oscutils.sort_items(data, parsed_args.sort)
return (labels,
(oscutils.get_item_properties(s, columns, formatters={
'Properties': oscutils.format_dict},) for s in data))
class DeleteBaremetalPortGroup(command.Command):
"""Unregister baremetal port group(s)."""
log = logging.getLogger(__name__ + ".DeleteBaremetalPortGroup")
def get_parser(self, prog_name):
parser = super(DeleteBaremetalPortGroup, self).get_parser(prog_name)
parser.add_argument(
"portgroups",
metavar="<port group>",
nargs="+",
help="Port group(s) to delete (name or UUID).")
return parser
def take_action(self, parsed_args):
self.log.debug("take_action(%s)", parsed_args)
baremetal_client = self.app.client_manager.baremetal
failures = []
for portgroup in parsed_args.portgroups:
try:
baremetal_client.portgroup.delete(portgroup)
print(_('Deleted port group %s') % portgroup)
except exc.ClientException as e:
failures.append(_("Failed to delete port group %(portgroup)s: "
" %(error)s")
% {'portgroup': portgroup, 'error': e})
if failures:
raise exc.ClientException("\n".join(failures))
class SetBaremetalPortGroup(command.Command):
"""Set baremetal port group properties."""
log = logging.getLogger(__name__ + ".SetBaremetalPortGroup")
def get_parser(self, prog_name):
parser = super(SetBaremetalPortGroup, self).get_parser(prog_name)
parser.add_argument(
'portgroup',
metavar='<port group>',
help="Name or UUID of the port group.",
)
parser.add_argument(
'--node',
dest='node_uuid',
metavar='<uuid>',
help='Update UUID of the node that this port group belongs to.'
)
parser.add_argument(
"--address",
metavar="<mac-address>",
help="MAC address for this port group.",
)
parser.add_argument(
"--name",
metavar="<name>",
help="Name of the port group.",
)
parser.add_argument(
"--extra",
metavar="<key=value>",
action='append',
help='Extra to set on this baremetal port group '
'(repeat option to set multiple extras).',
)
standalone_ports_group = parser.add_mutually_exclusive_group()
standalone_ports_group.add_argument(
'--support-standalone-ports',
action='store_true',
default=None,
help="Ports that are members of this port group "
"can be used as stand-alone ports."
)
standalone_ports_group.add_argument(
'--unsupport-standalone-ports',
action='store_true',
help="Ports that are members of this port group "
"cannot be used as stand-alone ports."
)
return parser
def take_action(self, parsed_args):
self.log.debug("take_action(%s)", parsed_args)
baremetal_client = self.app.client_manager.baremetal
properties = []
if parsed_args.node_uuid:
properties.extend(utils.args_array_to_patch(
'add', ["node_uuid=%s" % parsed_args.node_uuid]))
if parsed_args.address:
properties.extend(utils.args_array_to_patch(
'add', ["address=%s" % parsed_args.address]))
if parsed_args.name:
name = ["name=%s" % parsed_args.name]
properties.extend(utils.args_array_to_patch(
'add', name))
if parsed_args.support_standalone_ports:
properties.extend(utils.args_array_to_patch(
'add', ["standalone_ports_supported=True"]))
if parsed_args.unsupport_standalone_ports:
properties.extend(utils.args_array_to_patch(
'add', ["standalone_ports_supported=False"]))
if parsed_args.extra:
properties.extend(utils.args_array_to_patch(
'add', ['extra/' + x for x in parsed_args.extra]))
if properties:
baremetal_client.portgroup.update(parsed_args.portgroup,
properties)
else:
self.log.warning(_LW("Please specify what to set."))
class UnsetBaremetalPortGroup(command.Command):
"""Unset baremetal port group properties."""
log = logging.getLogger(__name__ + ".UnsetBaremetalPortGroup")
def get_parser(self, prog_name):
parser = super(UnsetBaremetalPortGroup, self).get_parser(prog_name)
parser.add_argument(
'portgroup',
metavar='<port group>',
help="Name or UUID of the port group."
)
parser.add_argument(
"--name",
action='store_true',
help="Unset the name of the port group.",
)
parser.add_argument(
"--address",
action='store_true',
help="Unset the address of the port group.",
)
parser.add_argument(
"--extra",
metavar="<key>",
action='append',
help='Extra to unset on this baremetal port group '
'(repeat option to unset multiple extras).',
)
return parser
def take_action(self, parsed_args):
self.log.debug("take_action(%s)", parsed_args)
baremetal_client = self.app.client_manager.baremetal
properties = []
if parsed_args.name:
properties.extend(utils.args_array_to_patch('remove',
['name']))
if parsed_args.address:
properties.extend(utils.args_array_to_patch('remove',
['address']))
if parsed_args.extra:
properties.extend(utils.args_array_to_patch('remove',
['extra/' + x for x in parsed_args.extra]))
if properties:
baremetal_client.portgroup.update(parsed_args.portgroup,
properties)
else:
self.log.warning(_LW("Please specify what to unset."))

12
ironicclient/tests/unit/osc/v1/fakes.py
View File

@ -74,6 +74,18 @@ BAREMETAL_DRIVER_PASSTHRU = {"lookup": {"attach": "false",
"description": "",
"async": "false"}}
baremetal_portgroup_uuid = 'ppp-gggggg-pppp'
baremetal_portgroup_name = 'Portgroup-name'
baremetal_portgroup_address = 'AA:BB:CC:CC:BB:AA'
baremetal_portgroup_extra = {'key1': 'value1',
'key2': 'value2'}
PORTGROUP = {'uuid': baremetal_portgroup_uuid,
'name': baremetal_portgroup_name,
'node_uuid': baremetal_uuid,
'address': baremetal_portgroup_address,
'extra': baremetal_portgroup_extra}
class TestBaremetal(utils.TestCommand):

71
ironicclient/tests/unit/osc/v1/test_baremetal_port.py
View File

@ -120,6 +120,33 @@ class TestCreateBaremetalPort(TestBaremetalPort):
'switch_id=aa:bb:cc:dd:ee:ff'])]
)
def test_baremetal_port_create_portgroup_uuid(self):
arglist = [
baremetal_fakes.baremetal_port_address,
'--node', baremetal_fakes.baremetal_uuid,
'--port-group', baremetal_fakes.baremetal_portgroup_uuid,
]
verifylist = [
('node_uuid', baremetal_fakes.baremetal_uuid),
('address', baremetal_fakes.baremetal_port_address),
('portgroup_uuid', baremetal_fakes.baremetal_portgroup_uuid)
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
# DisplayCommandBase.take_action() returns two tuples
self.cmd.take_action(parsed_args)
# Set expected values
args = {
'address': baremetal_fakes.baremetal_port_address,
'node_uuid': baremetal_fakes.baremetal_uuid,
'portgroup_uuid': baremetal_fakes.baremetal_portgroup_uuid
}
self.baremetal_mock.port.create.assert_called_once_with(**args)
class TestShowBaremetalPort(TestBaremetalPort):
def setUp(self):
@ -231,6 +258,18 @@ class TestBaremetalPortUnset(TestBaremetalPort):
[{'path': '/extra/foo', 'op': 'remove'},
{'path': '/extra/bar', 'op': 'remove'}])
def test_baremetal_port_unset_portgroup_uuid(self):
arglist = ['port', '--port-group']
verifylist = [('port', 'port'),
('portgroup', True)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.port.update.assert_called_once_with(
'port',
[{'path': '/portgroup_uuid', 'op': 'remove'}])
class TestBaremetalPortSet(TestBaremetalPort):
def setUp(self):
@ -289,6 +328,23 @@ class TestBaremetalPortSet(TestBaremetalPort):
'port',
[{'path': '/extra/foo', 'value': 'bar', 'op': 'add'}])
def test_baremetal_port_set_portgroup_uuid(self):
new_portgroup_uuid = '1111-111111-1111'
arglist = [
baremetal_fakes.baremetal_port_uuid,
'--port-group', new_portgroup_uuid]
verifylist = [
('port', baremetal_fakes.baremetal_port_uuid),
('portgroup_uuid', new_portgroup_uuid)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.port.update.assert_called_once_with(
baremetal_fakes.baremetal_port_uuid,
[{'path': '/portgroup_uuid', 'value': new_portgroup_uuid,
'op': 'add'}])
def test_baremetal_port_set_no_options(self):
arglist = []
verifylist = []
@ -419,6 +475,21 @@ class TestBaremetalPortList(TestBaremetalPort):
}
self.baremetal_mock.port.list.assert_called_with(**kwargs)
def test_baremetal_port_list_portgroup(self):
arglist = ['--port-group', baremetal_fakes.baremetal_portgroup_uuid]
verifylist = [('portgroup', baremetal_fakes.baremetal_portgroup_uuid)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
# DisplayCommandBase.take_action() returns two tuples
columns, data = self.cmd.take_action(parsed_args)
kwargs = {
'portgroup': baremetal_fakes.baremetal_portgroup_uuid,
'marker': None,
'limit': None,
}
self.baremetal_mock.port.list.assert_called_with(**kwargs)
def test_baremetal_port_list_long(self):
arglist = ['--long']
verifylist = [('detail', True)]

666
ironicclient/tests/unit/osc/v1/test_baremetal_portgroup.py Normal file
View File

@ -0,0 +1,666 @@
#
# Copyright 2016 Mirantis, Inc.
#
# 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 copy
import mock
from osc_lib.tests import utils as osctestutils
from ironicclient.osc.v1 import baremetal_portgroup
from ironicclient.tests.unit.osc.v1 import fakes as baremetal_fakes
class TestBaremetalPortGroup(baremetal_fakes.TestBaremetal):
def setUp(self):
super(TestBaremetalPortGroup, self).setUp()
self.baremetal_mock = self.app.client_manager.baremetal
self.baremetal_mock.reset_mock()
class TestCreateBaremetalPortGroup(TestBaremetalPortGroup):
def setUp(self):
super(TestCreateBaremetalPortGroup, self).setUp()
self.baremetal_mock.portgroup.create.return_value = (
baremetal_fakes.FakeBaremetalResource(
None,
copy.deepcopy(baremetal_fakes.PORTGROUP),
loaded=True,
))
# Get the command object to test
self.cmd = baremetal_portgroup.CreateBaremetalPortGroup(self.app, None)
def test_baremetal_portgroup_create(self):
arglist = [
'--node', baremetal_fakes.baremetal_uuid,
]
verifylist = [
('node_uuid', baremetal_fakes.baremetal_uuid),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
# DisplayCommandBase.take_action() returns two tuples
self.cmd.take_action(parsed_args)
# Set expected values
args = {
'node_uuid': baremetal_fakes.baremetal_uuid,
}
self.baremetal_mock.portgroup.create.assert_called_once_with(**args)
def test_baremetal_portgroup_create_name_address_uuid(self):
arglist = [
'--address', baremetal_fakes.baremetal_portgroup_address,
'--node', baremetal_fakes.baremetal_uuid,
'--name', baremetal_fakes.baremetal_portgroup_name,
'--uuid', baremetal_fakes.baremetal_portgroup_uuid,
]
verifylist = [
('node_uuid', baremetal_fakes.baremetal_uuid),
('address', baremetal_fakes.baremetal_portgroup_address),
('name', baremetal_fakes.baremetal_portgroup_name),
('uuid', baremetal_fakes.baremetal_portgroup_uuid),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
# DisplayCommandBase.take_action() returns two tuples
self.cmd.take_action(parsed_args)
# Set expected values
args = {
'address': baremetal_fakes.baremetal_portgroup_address,
'node_uuid': baremetal_fakes.baremetal_uuid,
'name': baremetal_fakes.baremetal_portgroup_name,
'uuid': baremetal_fakes.baremetal_portgroup_uuid,
}
self.baremetal_mock.portgroup.create.assert_called_once_with(**args)
def test_baremetal_portgroup_create_support_standalone_ports(self):
arglist = [
'--address', baremetal_fakes.baremetal_portgroup_address,
'--node', baremetal_fakes.baremetal_uuid,
'--support-standalone-ports'
]
verifylist = [
('node_uuid', baremetal_fakes.baremetal_uuid),
('address', baremetal_fakes.baremetal_portgroup_address),
('support_standalone_ports', True),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
# DisplayCommandBase.take_action() returns two tuples
self.cmd.take_action(parsed_args)
# Set expected values
args = {
'address': baremetal_fakes.baremetal_portgroup_address,
'node_uuid': baremetal_fakes.baremetal_uuid,
'standalone_ports_supported': True,
}
self.baremetal_mock.portgroup.create.assert_called_once_with(**args)
def test_baremetal_portgroup_create_unsupport_standalone_ports(self):
arglist = [
'--address', baremetal_fakes.baremetal_portgroup_address,
'--node', baremetal_fakes.baremetal_uuid,
'--unsupport-standalone-ports'
]
verifylist = [
('node_uuid', baremetal_fakes.baremetal_uuid),
('address', baremetal_fakes.baremetal_portgroup_address),
('unsupport_standalone_ports', True),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
# DisplayCommandBase.take_action() returns two tuples
self.cmd.take_action(parsed_args)
# Set expected values
args = {
'address': baremetal_fakes.baremetal_portgroup_address,
'node_uuid': baremetal_fakes.baremetal_uuid,
'standalone_ports_supported': False,
}
self.baremetal_mock.portgroup.create.assert_called_once_with(**args)
def test_baremetal_portgroup_create_name_extras(self):
arglist = [
'--address', baremetal_fakes.baremetal_portgroup_address,
'--node', baremetal_fakes.baremetal_uuid,
'--name', baremetal_fakes.baremetal_portgroup_name,
'--extra', 'key1=value1',
'--extra', 'key2=value2'
]
verifylist = [
('node_uuid', baremetal_fakes.baremetal_uuid),
('address', baremetal_fakes.baremetal_portgroup_address),
('name', baremetal_fakes.baremetal_portgroup_name),
('extra', ['key1=value1', 'key2=value2'])
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
# DisplayCommandBase.take_action() returns two tuples
self.cmd.take_action(parsed_args)
# Set expected values
args = {
'address': baremetal_fakes.baremetal_portgroup_address,
'node_uuid': baremetal_fakes.baremetal_uuid,
'name': baremetal_fakes.baremetal_portgroup_name,
'extra': baremetal_fakes.baremetal_portgroup_extra
}
self.baremetal_mock.portgroup.create.assert_called_once_with(**args)
def test_baremetal_portgroup_create_no_options(self):
arglist = []
verifylist = []
self.assertRaises(osctestutils.ParserException,
self.check_parser,
self.cmd, arglist, verifylist)
class TestShowBaremetalPortGroup(TestBaremetalPortGroup):
def setUp(self):
super(TestShowBaremetalPortGroup, self).setUp()
self.baremetal_mock.portgroup.get.return_value = (
baremetal_fakes.FakeBaremetalResource(
None,
copy.deepcopy(baremetal_fakes.PORTGROUP),
loaded=True))
self.baremetal_mock.portgroup.get_by_address.return_value = (
baremetal_fakes.FakeBaremetalResource(
None,
copy.deepcopy(baremetal_fakes.PORTGROUP),
loaded=True))
self.cmd = baremetal_portgroup.ShowBaremetalPortGroup(self.app, None)
def test_baremetal_portgroup_show(self):
arglist = ['ppp-gggggg-pppp']
verifylist = [('portgroup', baremetal_fakes.baremetal_portgroup_uuid)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
# Set expected values
args = ['ppp-gggggg-pppp']
self.baremetal_mock.portgroup.get.assert_called_with(*args,
fields=None)
collist = ('address', 'extra', 'name', 'node_uuid', 'uuid')
self.assertEqual(collist, columns)
datalist = (
baremetal_fakes.baremetal_portgroup_address,
baremetal_fakes.baremetal_portgroup_extra,
baremetal_fakes.baremetal_portgroup_name,
baremetal_fakes.baremetal_uuid,
baremetal_fakes.baremetal_portgroup_uuid)
self.assertEqual(datalist, tuple(data))
def test_baremetal_portgroup_show_address(self):
arglist = ['--address', baremetal_fakes.baremetal_portgroup_address]
verifylist = [('address', True)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
args = {baremetal_fakes.baremetal_portgroup_address}
self.baremetal_mock.portgroup.get_by_address.assert_called_with(
*args, fields=None)
def test_baremetal_portgroup_show_no_options(self):
arglist = []
verifylist = []
self.assertRaises(osctestutils.ParserException,
self.check_parser,
self.cmd, arglist, verifylist)
class TestBaremetalPortGroupList(TestBaremetalPortGroup):
def setUp(self):
super(TestBaremetalPortGroupList, self).setUp()
self.baremetal_mock.portgroup.list.return_value = [
baremetal_fakes.FakeBaremetalResource(
None,
copy.deepcopy(baremetal_fakes.PORTGROUP),
loaded=True)
]
self.cmd = baremetal_portgroup.ListBaremetalPortGroup(self.app, None)
def test_baremetal_portgroup_list(self):
arglist = []
verifylist = []
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
kwargs = {
'marker': None,
'limit': None}
self.baremetal_mock.portgroup.list.assert_called_with(**kwargs)
collist = (
"UUID",
"Address",
"Name")
self.assertEqual(collist, columns)
datalist = ((baremetal_fakes.baremetal_portgroup_uuid,
baremetal_fakes.baremetal_portgroup_address,
baremetal_fakes.baremetal_portgroup_name),)
self.assertEqual(datalist, tuple(data))
def test_baremetal_portgroup_list_address(self):
arglist = ['--address', baremetal_fakes.baremetal_portgroup_address]
verifylist = [('address', baremetal_fakes.baremetal_portgroup_address)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
kwargs = {
'address': baremetal_fakes.baremetal_portgroup_address,
'marker': None,
'limit': None}
self.baremetal_mock.portgroup.list.assert_called_with(**kwargs)
collist = (
"UUID",
"Address",
"Name")
self.assertEqual(collist, columns)
datalist = ((baremetal_fakes.baremetal_portgroup_uuid,
baremetal_fakes.baremetal_portgroup_address,
baremetal_fakes.baremetal_portgroup_name),)
self.assertEqual(datalist, tuple(data))
def test_baremetal_portgroup_list_node(self):
arglist = ['--node', baremetal_fakes.baremetal_uuid]
verifylist = [('node', baremetal_fakes.baremetal_uuid)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
kwargs = {
'node': baremetal_fakes.baremetal_uuid,
'marker': None,
'limit': None}
self.baremetal_mock.portgroup.list.assert_called_with(**kwargs)
collist = (
"UUID",
"Address",
"Name")
self.assertEqual(collist, columns)
datalist = ((baremetal_fakes.baremetal_portgroup_uuid,
baremetal_fakes.baremetal_portgroup_address,
baremetal_fakes.baremetal_portgroup_name),)
self.assertEqual(datalist, tuple(data))
def test_baremetal_portgroup_list_long(self):
arglist = ['--long']
verifylist = [('detail', True)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
kwargs = {
'detail': True,
'marker': None,
'limit': None,
}
self.baremetal_mock.portgroup.list.assert_called_with(**kwargs)
collist = ('UUID', 'Address', 'Created At', 'Extra',
'Standalone Ports Supported', 'Node UUID', 'Name',
'Updated At', 'Internal Info')
self.assertEqual(collist, columns)
datalist = ((baremetal_fakes.baremetal_portgroup_uuid,
baremetal_fakes.baremetal_portgroup_address,
'',
baremetal_fakes.baremetal_portgroup_extra,
'',
baremetal_fakes.baremetal_uuid,
baremetal_fakes.baremetal_portgroup_name,
'',
''),)
self.assertEqual(datalist, tuple(data))
def test_baremetal_portgroup_list_fields(self):
arglist = ['--fields', 'uuid', 'address']
verifylist = [('fields', [['uuid', 'address']])]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
kwargs = {
'marker': None,
'limit': None,
'detail': False,
'fields': ('uuid', 'address')
}
self.baremetal_mock.portgroup.list.assert_called_with(**kwargs)
def test_baremetal_portgroup_list_fields_multiple(self):
arglist = ['--fields', 'uuid', 'address', '--fields', 'extra']
verifylist = [('fields', [['uuid', 'address'], ['extra']])]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
kwargs = {
'marker': None,
'limit': None,
'detail': False,
'fields': ('uuid', 'address', 'extra')
}
self.baremetal_mock.portgroup.list.assert_called_with(**kwargs)
def test_baremetal_portgroup_list_invalid_fields(self):
arglist = ['--fields', 'uuid', 'invalid']
verifylist = [('fields', [['uuid', 'invalid']])]
self.assertRaises(osctestutils.ParserException,
self.check_parser,
self.cmd, arglist, verifylist)
class TestBaremetalPortGroupDelete(TestBaremetalPortGroup):
def setUp(self):
super(TestBaremetalPortGroupDelete, self).setUp()
self.baremetal_mock.portgroup.get.return_value = (
baremetal_fakes.FakeBaremetalResource(
None,
copy.deepcopy(baremetal_fakes.PORTGROUP),
loaded=True))
self.cmd = baremetal_portgroup.DeleteBaremetalPortGroup(self.app, None)
def test_baremetal_portgroup_delete(self):
arglist = [baremetal_fakes.baremetal_portgroup_uuid]
verifylist = []
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
args = baremetal_fakes.baremetal_portgroup_uuid
self.baremetal_mock.portgroup.delete.assert_called_with(args)
def test_baremetal_portgroup_delete_multiple(self):
arglist = [baremetal_fakes.baremetal_portgroup_uuid,
baremetal_fakes.baremetal_portgroup_name]
verifylist = []
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
args = [baremetal_fakes.baremetal_portgroup_uuid,
baremetal_fakes.baremetal_portgroup_name]
self.baremetal_mock.portgroup.delete.has_calls(
[mock.call(x) for x in args])
self.assertEqual(2, self.baremetal_mock.portgroup.delete.call_count)
def test_baremetal_portgroup_delete_no_options(self):
arglist = []
verifylist = []
self.assertRaises(osctestutils.ParserException,
self.check_parser,
self.cmd, arglist, verifylist)
class TestBaremetalPortGroupSet(TestBaremetalPortGroup):
def setUp(self):
super(TestBaremetalPortGroupSet, self).setUp()
self.baremetal_mock.portgroup.update.return_value = (
baremetal_fakes.FakeBaremetalResource(
None,
copy.deepcopy(baremetal_fakes.PORTGROUP),
loaded=True))
self.cmd = baremetal_portgroup.SetBaremetalPortGroup(self.app, None)
def test_baremetal_portgroup_set_name(self):
new_portgroup_name = 'New-Portgroup-name'
arglist = [
baremetal_fakes.baremetal_portgroup_uuid,
'--name', new_portgroup_name]
verifylist = [
('portgroup', baremetal_fakes.baremetal_portgroup_uuid),
('name', new_portgroup_name)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.portgroup.update.assert_called_once_with(
baremetal_fakes.baremetal_portgroup_uuid,
[{'path': '/name', 'value': new_portgroup_name, 'op': 'add'}])
def test_baremetal_portgroup_set_address(self):
new_portgroup_address = '00:22:44:66:88:00'
arglist = [
baremetal_fakes.baremetal_portgroup_uuid,
'--address', new_portgroup_address]
verifylist = [
('portgroup', baremetal_fakes.baremetal_portgroup_uuid),
('address', new_portgroup_address)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.portgroup.update.assert_called_once_with(
baremetal_fakes.baremetal_portgroup_uuid,
[{'path': '/address', 'value': new_portgroup_address,
'op': 'add'}])
def test_baremetal_portgroup_set_node_uuid(self):
new_node_uuid = 'nnnnnn-uuuuuuuu'
arglist = [
baremetal_fakes.baremetal_portgroup_uuid,
'--node', new_node_uuid]
verifylist = [
('portgroup', baremetal_fakes.baremetal_portgroup_uuid),
('node_uuid', new_node_uuid)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.portgroup.update.assert_called_once_with(
baremetal_fakes.baremetal_portgroup_uuid,
[{'path': '/node_uuid', 'value': new_node_uuid,
'op': 'add'}])
def test_baremetal_portgroup_set_support_standalone_ports(self):
arglist = [
baremetal_fakes.baremetal_portgroup_uuid,
'--support-standalone-ports']
verifylist = [
('portgroup', baremetal_fakes.baremetal_portgroup_uuid),
('support_standalone_ports', True)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.portgroup.update.assert_called_once_with(
baremetal_fakes.baremetal_portgroup_uuid,
[{'path': '/standalone_ports_supported', 'value': 'True',
'op': 'add'}])
def test_baremetal_portgroup_set_unsupport_standalone_ports(self):
arglist = [
baremetal_fakes.baremetal_portgroup_uuid,
'--unsupport-standalone-ports']
verifylist = [
('portgroup', baremetal_fakes.baremetal_portgroup_uuid),
('unsupport_standalone_ports', True)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.portgroup.update.assert_called_once_with(
baremetal_fakes.baremetal_portgroup_uuid,
[{'path': '/standalone_ports_supported', 'value': 'False',
'op': 'add'}])
def test_baremetal_set_extra(self):
arglist = ['portgroup', '--extra', 'foo=bar']
verifylist = [('portgroup', 'portgroup'),
('extra', ['foo=bar'])]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.portgroup.update.assert_called_once_with(
'portgroup',
[{'path': '/extra/foo', 'value': 'bar', 'op': 'add'}])
def test_baremetal_portgroup_set_multiple_extras(self):
arglist = ['portgroup',
'--extra', 'key1=val1',
'--extra', 'key2=val2']
verifylist = [('portgroup', 'portgroup'),
('extra', ['key1=val1', 'key2=val2'])]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.portgroup.update.assert_called_once_with(
'portgroup',
[{'path': '/extra/key1', 'value': 'val1', 'op': 'add'},
{'path': '/extra/key2', 'value': 'val2', 'op': 'add'}])
def test_baremetal_portgroup_set_no_options(self):
arglist = []
verifylist = []
self.assertRaises(osctestutils.ParserException,
self.check_parser,
self.cmd, arglist, verifylist)
def test_baremetal_portgroup_set_no_property(self):
uuid = baremetal_fakes.baremetal_portgroup_uuid
arglist = [uuid]
verifylist = [('portgroup', uuid)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.assertFalse(self.baremetal_mock.portgroup.update.called)
class TestBaremetalPortGroupUnset(TestBaremetalPortGroup):
def setUp(self):
super(TestBaremetalPortGroupUnset, self).setUp()
self.baremetal_mock.portgroup.update.return_value = (
baremetal_fakes.FakeBaremetalResource(
None,
copy.deepcopy(baremetal_fakes.PORTGROUP),
loaded=True))
self.cmd = baremetal_portgroup.UnsetBaremetalPortGroup(self.app, None)
def test_baremetal_portgroup_unset_extra(self):
arglist = ['portgroup', '--extra', 'key1']
verifylist = [('portgroup', 'portgroup'),
('extra', ['key1'])]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.portgroup.update.assert_called_once_with(
'portgroup',
[{'path': '/extra/key1', 'op': 'remove'}])
def test_baremetal_portgroup_unset_name(self):
arglist = ['portgroup', '--name']
verifylist = [('name', True)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.portgroup.update.assert_called_once_with(
'portgroup',
[{'path': '/name', 'op': 'remove'}])
def test_baremetal_portgroup_unset_address(self):
arglist = ['portgroup', '--address']
verifylist = [('address', True)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.portgroup.update.assert_called_once_with(
'portgroup',
[{'path': '/address', 'op': 'remove'}])
def test_baremetal_portgroup_unset_multiple_extras(self):
arglist = ['portgroup',
'--extra', 'key1',
'--extra', 'key2']
verifylist = [('portgroup', 'portgroup'),
('extra', ['key1', 'key2'])]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.portgroup.update.assert_called_once_with(
'portgroup',
[{'path': '/extra/key1', 'op': 'remove'},
{'path': '/extra/key2', 'op': 'remove'}])
def test_baremetal_portgroup_unset_no_options(self):
arglist = []
verifylist = []
self.assertRaises(osctestutils.ParserException,
self.check_parser,
self.cmd, arglist, verifylist)
def test_baremetal_portgroup_unset_no_property(self):
uuid = baremetal_fakes.baremetal_portgroup_uuid
arglist = [uuid]
verifylist = [('portgroup', uuid)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.assertFalse(self.baremetal_mock.portgroup.update.called)

16
ironicclient/tests/unit/v1/test_port.py
View File

@ -116,6 +116,13 @@ fake_responses = {
{"ports": [PORT]},
),
},
'/v1/ports/?portgroup=%s' % PORT['portgroup_uuid']:
{
'GET': (
{},
{"ports": [PORT]},
),
},
}
fake_responses_pagination = {
@ -200,6 +207,15 @@ class PortManagerTest(testtools.TestCase):
self.assertEqual(expect, self.api.calls)
self.assertEqual(1, len(ports))
def test_ports_list_by_portgroup(self):
ports = self.mgr.list(portgroup=PORT['portgroup_uuid'])
expect = [
('GET', '/v1/ports/?portgroup=%s' % PORT['portgroup_uuid'],
{}, None),
]
self.assertEqual(expect, self.api.calls)
self.assertEqual(1, len(ports))
def test_ports_list_detail(self):
ports = self.mgr.list(detail=True)
expect = [

8
ironicclient/v1/port.py
View File

@ -33,7 +33,8 @@ class PortManager(base.CreateManager):
_resource_name = 'ports'
def list(self, address=None, limit=None, marker=None, sort_key=None,
sort_dir=None, detail=False, fields=None, node=None):
sort_dir=None, detail=False, fields=None, node=None,
portgroup=None):
"""Retrieve a list of ports.
:param address: Optional, MAC address of a port, to get
@ -65,6 +66,9 @@ class PortManager(base.CreateManager):
:param node: Optional, name or UUID of a node. Used to get
ports of this node.
:param portgroup: Optional, name or UUID of a portgroup. Used to get
ports of this portgroup.
:returns: A list of ports.
"""
@ -81,6 +85,8 @@ class PortManager(base.CreateManager):
filters.append('address=%s' % address)
if node is not None:
filters.append('node=%s' % node)
if portgroup is not None:
filters.append('portgroup=%s' % portgroup)
path = ''
if detail:

16
releasenotes/notes/osc-plugin-f87e0fbb472261dd.yaml Normal file
View File

@ -0,0 +1,16 @@
---
features:
- |
Extend the OpenStackClient plugin with new commands:
* openstack baremetal port group create
* openstack baremetal port group show
* openstack baremetal port group list
* openstack baremetal port group delete
* openstack baremetal port group set
* openstack baremetal port group unset
Extends the 'openstack baremetal port' commands
(where applicable) to allow specifying the port group
(if any) that a port is a member of, via the new --port-group
argument.

6
setup.cfg
View File

@ -75,6 +75,12 @@ openstack.baremetal.v1 =
baremetal_port_set = ironicclient.osc.v1.baremetal_port:SetBaremetalPort
baremetal_port_show = ironicclient.osc.v1.baremetal_port:ShowBaremetalPort
baremetal_port_unset = ironicclient.osc.v1.baremetal_port:UnsetBaremetalPort
baremetal_port_group_create = ironicclient.osc.v1.baremetal_portgroup:CreateBaremetalPortGroup
baremetal_port_group_delete = ironicclient.osc.v1.baremetal_portgroup:DeleteBaremetalPortGroup
baremetal_port_group_list = ironicclient.osc.v1.baremetal_portgroup:ListBaremetalPortGroup
baremetal_port_group_set = ironicclient.osc.v1.baremetal_portgroup:SetBaremetalPortGroup
baremetal_port_group_show = ironicclient.osc.v1.baremetal_portgroup:ShowBaremetalPortGroup
baremetal_port_group_unset = ironicclient.osc.v1.baremetal_portgroup:UnsetBaremetalPortGroup
baremetal_set = ironicclient.osc.v1.baremetal_node:SetBaremetal
baremetal_show = ironicclient.osc.v1.baremetal_node:ShowBaremetal
baremetal_unset = ironicclient.osc.v1.baremetal_node:UnsetBaremetal