Add OSC commands for volume connector

This patch adds the following commands for volume connector.
- openstack baremetal volume connector create
- openstack baremetal volume connector show
- openstack baremetal volume connector list
- openstack baremetal volume connector delete
- openstack baremetal volume connector set
- openstack baremetal volume connector unset

It also bumps known API version to 1.32 and hides a link to volume
resources from node information.

Change-Id: I5bb189631bf79f32cd031e5a5b68a5c8d42a987f
Partial-Bug: 1526231
This commit is contained in:
Hironori Shiina 2017-01-31 07:57:14 +00:00
parent 7fe3ad1f11
commit 26441c51f3
8 changed files with 1151 additions and 2 deletions

View File

@ -26,7 +26,7 @@ LOG = logging.getLogger(__name__)
API_VERSION_OPTION = 'os_baremetal_api_version'
API_NAME = 'baremetal'
LAST_KNOWN_API_VERSION = 31
LAST_KNOWN_API_VERSION = 32
API_VERSIONS = {
'1.%d' % i: 'ironicclient.v1.client.Client'
for i in range(1, LAST_KNOWN_API_VERSION + 1)

View File

@ -425,6 +425,7 @@ class CreateBaremetalNode(command.ShowOne):
node.pop('ports', None)
node.pop('portgroups', None)
node.pop('states', None)
node.pop('volume', None)
node.setdefault('chassis_uuid', '')
@ -1199,6 +1200,7 @@ class ShowBaremetalNode(command.ShowOne):
node.pop("ports", None)
node.pop('portgroups', None)
node.pop('states', None)
node.pop('volume', None)
if not fields or 'chassis_uuid' in fields:
node.setdefault('chassis_uuid', '')

View File

@ -0,0 +1,360 @@
# Copyright 2017 FUJITSU LIMITED
#
# 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 _
from ironicclient.common import utils
from ironicclient import exc
from ironicclient.v1 import resource_fields as res_fields
class CreateBaremetalVolumeConnector(command.ShowOne):
"""Create a new baremetal volume connector."""
log = logging.getLogger(__name__ + ".CraeteBaremetalVolumeConnector")
def get_parser(self, prog_name):
parser = (
super(CreateBaremetalVolumeConnector, self).get_parser(prog_name))
parser.add_argument(
'--node',
dest='node_uuid',
metavar='<uuid>',
required=True,
help=_('UUID of the node that this volume connector belongs to.'))
parser.add_argument(
'--type',
dest='type',
metavar="<type>",
required=True,
help=_("Type of the volume connector. Can be 'iqn', 'ip', 'mac', "
"'wwnn', 'wwpn'."))
parser.add_argument(
'--connector-id',
dest='connector_id',
required=True,
metavar="<connector id>",
help=_("ID of the volume connector in the specified type. For "
"example, the iSCSI initiator IQN for the node if the type "
"is 'iqn'."))
parser.add_argument(
'--uuid',
dest='uuid',
metavar='<uuid>',
help=_("UUID of the volume connector."))
parser.add_argument(
'--extra',
dest='extra',
metavar="<key=value>",
action='append',
help=_("Record arbitrary key/value metadata. "
"Can be specified multiple times."))
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 = ['extra', 'type', 'connector_id', 'node_uuid', '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')
volume_connector = baremetal_client.volume_connector.create(**fields)
data = dict([(f, getattr(volume_connector, f, '')) for f in
res_fields.VOLUME_CONNECTOR_DETAILED_RESOURCE.fields])
return self.dict2columns(data)
class ShowBaremetalVolumeConnector(command.ShowOne):
"""Show baremetal volume connector details."""
log = logging.getLogger(__name__ + ".ShowBaremetalVolumeConnector")
def get_parser(self, prog_name):
parser = (
super(ShowBaremetalVolumeConnector, self).get_parser(prog_name))
parser.add_argument(
'volume_connector',
metavar='<id>',
help=_("UUID of the volume connector."))
parser.add_argument(
'--fields',
nargs='+',
dest='fields',
metavar='<field>',
action='append',
choices=res_fields.VOLUME_CONNECTOR_DETAILED_RESOURCE.fields,
default=[],
help=_("One or more volume connector 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
volume_connector = baremetal_client.volume_connector.get(
parsed_args.volume_connector, fields=fields)._info
volume_connector.pop("links", None)
return zip(*sorted(volume_connector.items()))
class ListBaremetalVolumeConnector(command.Lister):
"""List baremetal volume connectors."""
log = logging.getLogger(__name__ + ".ListBaremetalVolumeConnector")
def get_parser(self, prog_name):
parser = (
super(ListBaremetalVolumeConnector, self).get_parser(prog_name))
parser.add_argument(
'--node',
dest='node',
metavar='<node>',
help=_("Only list volume connectors of this node (name or UUID)."))
parser.add_argument(
'--limit',
dest='limit',
metavar='<limit>',
type=int,
help=_('Maximum number of volume connectors to return per '
'request, 0 for no limit. Default is the maximum number '
'used by the Baremetal API Service.'))
parser.add_argument(
'--marker',
dest='marker',
metavar='<volume connector>',
help=_('Volume connector UUID (for example, of the last volume '
'connector in the list from a previous request). Returns '
'the list of volume connectors after this UUID.'))
parser.add_argument(
'--sort',
dest='sort',
metavar='<key>[:<direction>]',
help=_('Sort output by specified volume connector fields and '
'directions (asc or desc) (default:asc). Multiple fields '
'and directions can be specified, separated by comma.'))
display_group = parser.add_mutually_exclusive_group(required=False)
display_group.add_argument(
'--long',
dest='detail',
action='store_true',
default=False,
help=_("Show detailed information about volume connectors."))
display_group.add_argument(
'--fields',
nargs='+',
dest='fields',
metavar='<field>',
action='append',
default=[],
choices=res_fields.VOLUME_CONNECTOR_DETAILED_RESOURCE.fields,
help=_("One or more volume connector 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.VOLUME_CONNECTOR_RESOURCE.fields
labels = res_fields.VOLUME_CONNECTOR_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.node is not None:
params['node'] = parsed_args.node
if parsed_args.detail:
params['detail'] = parsed_args.detail
columns = res_fields.VOLUME_CONNECTOR_DETAILED_RESOURCE.fields
labels = res_fields.VOLUME_CONNECTOR_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.volume_connector.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 DeleteBaremetalVolumeConnector(command.Command):
"""Unregister baremetal volume connector(s)."""
log = logging.getLogger(__name__ + ".DeleteBaremetalVolumeConnector")
def get_parser(self, prog_name):
parser = (
super(DeleteBaremetalVolumeConnector, self).get_parser(prog_name))
parser.add_argument(
'volume_connectors',
metavar='<volume connector>',
nargs='+',
help=_("UUID(s) of the volume connector(s) to delete."))
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 volume_connector in parsed_args.volume_connectors:
try:
baremetal_client.volume_connector.delete(volume_connector)
print(_('Deleted volume connector %s') % volume_connector)
except exc.ClientException as e:
failures.append(_("Failed to delete volume connector "
"%(volume_connector)s: %(error)s")
% {'volume_connector': volume_connector,
'error': e})
if failures:
raise exc.ClientException("\n".join(failures))
class SetBaremetalVolumeConnector(command.Command):
"""Set baremetal volume connector properties."""
log = logging.getLogger(__name__ + ".SetBaremetalVolumeConnector")
def get_parser(self, prog_name):
parser = (
super(SetBaremetalVolumeConnector, self).get_parser(prog_name))
parser.add_argument(
'volume_connector',
metavar='<volume connector>',
help=_("UUID of the volume connector."))
parser.add_argument(
'--node',
dest='node_uuid',
metavar='<uuid>',
help=_('UUID of the node that this volume connector belongs to.'))
parser.add_argument(
'--type',
dest='type',
metavar="<type>",
help=_("Type of the volume connector. Can be 'iqn', 'ip', 'mac', "
"'wwnn', 'wwpn'."))
parser.add_argument(
'--connector-id',
dest='connector_id',
metavar="<connector id>",
help=_("ID of the volume connector in the specified type."))
parser.add_argument(
'--extra',
dest='extra',
metavar="<key=value>",
action='append',
help=_("Record arbitrary key/value metadata. "
"Can be specified multiple times."))
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.type:
properties.extend(utils.args_array_to_patch(
'add', ["type=%s" % parsed_args.type]))
if parsed_args.connector_id:
properties.extend(utils.args_array_to_patch(
'add', ["connector_id=%s" % parsed_args.connector_id]))
if parsed_args.extra:
properties.extend(utils.args_array_to_patch(
'add', ["extra/" + x for x in parsed_args.extra]))
if properties:
baremetal_client.volume_connector.update(
parsed_args.volume_connector, properties)
else:
self.log.warning("Please specify what to set.")
class UnsetBaremetalVolumeConnector(command.Command):
"""Unset baremetal volume connector properties."""
log = logging.getLogger(__name__ + "UnsetBaremetalVolumeConnector")
def get_parser(self, prog_name):
parser = (
super(UnsetBaremetalVolumeConnector, self).get_parser(prog_name))
parser.add_argument(
'volume_connector',
metavar='<volume connector>',
help=_("UUID of the volume connector."))
parser.add_argument(
'--extra',
dest='extra',
metavar="<key>",
action='append',
help=_('Extra to unset (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.extra:
properties.extend(utils.args_array_to_patch('remove',
['extra/' + x for x in parsed_args.extra]))
if properties:
baremetal_client.volume_connector.update(
parsed_args.volume_connector, properties)
else:
self.log.warning("Please specify what to unset.")

View File

@ -44,7 +44,8 @@ BAREMETAL = {
'power_state': baremetal_power_state,
'provision_state': baremetal_provision_state,
'maintenance': baremetal_maintenance,
'links': []
'links': [],
'volume': [],
}
baremetal_port_uuid = 'zzz-zzzzzz-zzzz'
@ -132,6 +133,19 @@ PORTGROUP = {'uuid': baremetal_portgroup_uuid,
VIFS = {'vifs': [{'id': 'aaa-aa'}]}
baremetal_volume_connector_uuid = 'vvv-cccccc-vvvv'
baremetal_volume_connector_type = 'iscsi'
baremetal_volume_connector_connector_id = 'iqn.2017-01.connector'
baremetal_volume_connector_extra = {'key1': 'value1',
'key2': 'value2'}
VOLUME_CONNECTOR = {
'uuid': baremetal_volume_connector_uuid,
'node_uuid': baremetal_uuid,
'type': baremetal_volume_connector_type,
'connector_id': baremetal_volume_connector_connector_id,
'extra': baremetal_volume_connector_extra,
}
class TestBaremetal(utils.TestCommand):

View File

@ -0,0 +1,729 @@
# Copyright 2017 FUJITSU LIMITED
#
# 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 import exc
from ironicclient.osc.v1 import baremetal_volume_connector as bm_vol_connector
from ironicclient.tests.unit.osc.v1 import fakes as baremetal_fakes
class TestBaremetalVolumeConnector(baremetal_fakes.TestBaremetal):
def setUp(self):
super(TestBaremetalVolumeConnector, self).setUp()
self.baremetal_mock = self.app.client_manager.baremetal
self.baremetal_mock.reset_mock()
class TestCreateBaremetalVolumeConnector(TestBaremetalVolumeConnector):
def setUp(self):
super(TestCreateBaremetalVolumeConnector, self).setUp()
self.baremetal_mock.volume_connector.create.return_value = (
baremetal_fakes.FakeBaremetalResource(
None,
copy.deepcopy(baremetal_fakes.VOLUME_CONNECTOR),
loaded=True,
))
# Get the command object to test
self.cmd = (
bm_vol_connector.CreateBaremetalVolumeConnector(self.app, None))
def test_baremetal_volume_connector_create(self):
arglist = [
'--node', baremetal_fakes.baremetal_uuid,
'--type', baremetal_fakes.baremetal_volume_connector_type,
'--connector-id',
baremetal_fakes.baremetal_volume_connector_connector_id,
'--uuid', baremetal_fakes.baremetal_volume_connector_uuid,
]
verifylist = [
('node_uuid', baremetal_fakes.baremetal_uuid),
('type', baremetal_fakes.baremetal_volume_connector_type),
('connector_id',
baremetal_fakes.baremetal_volume_connector_connector_id),
('uuid', baremetal_fakes.baremetal_volume_connector_uuid),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
args = {
'node_uuid': baremetal_fakes.baremetal_uuid,
'type': baremetal_fakes.baremetal_volume_connector_type,
'connector_id':
baremetal_fakes.baremetal_volume_connector_connector_id,
'uuid': baremetal_fakes.baremetal_volume_connector_uuid,
}
self.baremetal_mock.volume_connector.create.assert_called_once_with(
**args)
def test_baremetal_volume_connector_create_extras(self):
arglist = [
'--node', baremetal_fakes.baremetal_uuid,
'--type', baremetal_fakes.baremetal_volume_connector_type,
'--connector-id',
baremetal_fakes.baremetal_volume_connector_connector_id,
'--extra', 'key1=value1',
'--extra', 'key2=value2',
]
verifylist = [
('node_uuid', baremetal_fakes.baremetal_uuid),
('type', baremetal_fakes.baremetal_volume_connector_type),
('connector_id',
baremetal_fakes.baremetal_volume_connector_connector_id),
('extra', ['key1=value1', 'key2=value2'])
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
args = {
'node_uuid': baremetal_fakes.baremetal_uuid,
'type': baremetal_fakes.baremetal_volume_connector_type,
'connector_id':
baremetal_fakes.baremetal_volume_connector_connector_id,
'extra': baremetal_fakes.baremetal_volume_connector_extra,
}
self.baremetal_mock.volume_connector.create.assert_called_once_with(
**args)
def test_baremetal_volume_connector_create_no_options(self):
arglist = []
verifylist = []
self.assertRaises(osctestutils.ParserException,
self.check_parser,
self.cmd, arglist, verifylist)
class TestShowBaremetalVolumeConnector(TestBaremetalVolumeConnector):
def setUp(self):
super(TestShowBaremetalVolumeConnector, self).setUp()
self.baremetal_mock.volume_connector.get.return_value = (
baremetal_fakes.FakeBaremetalResource(
None,
copy.deepcopy(baremetal_fakes.VOLUME_CONNECTOR),
loaded=True))
self.cmd = (
bm_vol_connector.ShowBaremetalVolumeConnector(self.app, None))
def test_baremetal_volume_connector_show(self):
arglist = ['vvv-cccccc-vvvv']
verifylist = [('volume_connector',
baremetal_fakes.baremetal_volume_connector_uuid)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
args = ['vvv-cccccc-vvvv']
self.baremetal_mock.volume_connector.get.assert_called_once_with(
*args, fields=None)
collist = ('connector_id', 'extra', 'node_uuid', 'type', 'uuid')
self.assertEqual(collist, columns)
datalist = (
baremetal_fakes.baremetal_volume_connector_connector_id,
baremetal_fakes.baremetal_volume_connector_extra,
baremetal_fakes.baremetal_uuid,
baremetal_fakes.baremetal_volume_connector_type,
baremetal_fakes.baremetal_volume_connector_uuid,
)
self.assertEqual(datalist, tuple(data))
def test_baremetal_volume_coneedtor_show_no_options(self):
arglist = []
verifylist = []
self.assertRaises(osctestutils.ParserException,
self.check_parser,
self.cmd, arglist, verifylist)
def test_baremetal_volume_connector_show_fields(self):
arglist = ['vvv-cccccc-vvvv', '--fields', 'uuid', 'connector_id']
verifylist = [('fields', [['uuid', 'connector_id']]),
('volume_connector',
baremetal_fakes.baremetal_volume_connector_uuid)]
fake_vc = copy.deepcopy(baremetal_fakes.VOLUME_CONNECTOR)
fake_vc.pop('type')
fake_vc.pop('extra')
fake_vc.pop('node_uuid')
self.baremetal_mock.volume_connector.get.return_value = (
baremetal_fakes.FakeBaremetalResource(
None,
fake_vc,
loaded=True))
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
args = ['vvv-cccccc-vvvv']
fields = ['uuid', 'connector_id']
self.baremetal_mock.volume_connector.get.assert_called_once_with(
*args, fields=fields)
collist = ('connector_id', 'uuid')
self.assertEqual(collist, columns)
datalist = (
baremetal_fakes.baremetal_volume_connector_connector_id,
baremetal_fakes.baremetal_volume_connector_uuid,
)
self.assertEqual(datalist, tuple(data))
def test_baremetal_volume_connector_show_fields_multiple(self):
arglist = ['vvv-cccccc-vvvv', '--fields', 'uuid', 'connector_id',
'--fields', 'type']
verifylist = [('fields', [['uuid', 'connector_id'], ['type']]),
('volume_connector',
baremetal_fakes.baremetal_volume_connector_uuid)]
fake_vc = copy.deepcopy(baremetal_fakes.VOLUME_CONNECTOR)
fake_vc.pop('extra')
fake_vc.pop('node_uuid')
self.baremetal_mock.volume_connector.get.return_value = (
baremetal_fakes.FakeBaremetalResource(
None,
fake_vc,
loaded=True))
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
args = ['vvv-cccccc-vvvv']
fields = ['uuid', 'connector_id', 'type']
self.baremetal_mock.volume_connector.get.assert_called_once_with(
*args, fields=fields)
collist = ('connector_id', 'type', 'uuid')
self.assertEqual(collist, columns)
datalist = (
baremetal_fakes.baremetal_volume_connector_connector_id,
baremetal_fakes.baremetal_volume_connector_type,
baremetal_fakes.baremetal_volume_connector_uuid,
)
self.assertEqual(datalist, tuple(data))
class TestBaremetalVolumeConnectorList(TestBaremetalVolumeConnector):
def setUp(self):
super(TestBaremetalVolumeConnectorList, self).setUp()
self.baremetal_mock.volume_connector.list.return_value = [
baremetal_fakes.FakeBaremetalResource(
None,
copy.deepcopy(baremetal_fakes.VOLUME_CONNECTOR),
loaded=True)
]
self.cmd = (
bm_vol_connector.ListBaremetalVolumeConnector(self.app, None))
def test_baremetal_volume_connector_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.volume_connector.list.assert_called_once_with(
**kwargs)
collist = (
"UUID",
"Node UUID",
"Type",
"Connector ID")
self.assertEqual(collist, columns)
datalist = ((baremetal_fakes.baremetal_volume_connector_uuid,
baremetal_fakes.baremetal_uuid,
baremetal_fakes.baremetal_volume_connector_type,
baremetal_fakes.baremetal_volume_connector_connector_id),)
self.assertEqual(datalist, tuple(data))
def test_baremetal_volume_connector_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.volume_connector.list.assert_called_once_with(
**kwargs)
collist = (
"UUID",
"Node UUID",
"Type",
"Connector ID")
self.assertEqual(collist, columns)
datalist = ((baremetal_fakes.baremetal_volume_connector_uuid,
baremetal_fakes.baremetal_uuid,
baremetal_fakes.baremetal_volume_connector_type,
baremetal_fakes.baremetal_volume_connector_connector_id),)
self.assertEqual(datalist, tuple(data))
def test_baremetal_volume_connector_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.volume_connector.list.assert_called_with(**kwargs)
collist = ('UUID', 'Node UUID', 'Type', 'Connector ID', 'Extra',
'Created At', 'Updated At')
self.assertEqual(collist, columns)
datalist = ((baremetal_fakes.baremetal_volume_connector_uuid,
baremetal_fakes.baremetal_uuid,
baremetal_fakes.baremetal_volume_connector_type,
baremetal_fakes.baremetal_volume_connector_connector_id,
baremetal_fakes.baremetal_volume_connector_extra,
'',
''),)
self.assertEqual(datalist, tuple(data))
def test_baremetal_volume_connector_list_fields(self):
arglist = ['--fields', 'uuid', 'connector_id']
verifylist = [('fields', [['uuid', 'connector_id']])]
fake_vc = copy.deepcopy(baremetal_fakes.VOLUME_CONNECTOR)
fake_vc.pop('type')
fake_vc.pop('extra')
fake_vc.pop('node_uuid')
self.baremetal_mock.volume_connector.list.return_value = [
baremetal_fakes.FakeBaremetalResource(
None,
fake_vc,
loaded=True)
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
kwargs = {
'detail': False,
'marker': None,
'limit': None,
'fields': ('uuid', 'connector_id')
}
self.baremetal_mock.volume_connector.list.assert_called_with(**kwargs)
collist = ('UUID', 'Connector ID')
self.assertEqual(collist, columns)
datalist = ((baremetal_fakes.baremetal_volume_connector_uuid,
baremetal_fakes.baremetal_volume_connector_connector_id),)
self.assertEqual(datalist, tuple(data))
def test_baremetal_volume_connector_list_fields_multiple(self):
arglist = ['--fields', 'uuid', 'connector_id', '--fields', 'extra']
verifylist = [('fields', [['uuid', 'connector_id'], ['extra']])]
fake_vc = copy.deepcopy(baremetal_fakes.VOLUME_CONNECTOR)
fake_vc.pop('type')
fake_vc.pop('node_uuid')
self.baremetal_mock.volume_connector.list.return_value = [
baremetal_fakes.FakeBaremetalResource(
None,
fake_vc,
loaded=True)
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
kwargs = {
'detail': False,
'marker': None,
'limit': None,
'fields': ('uuid', 'connector_id', 'extra')
}
self.baremetal_mock.volume_connector.list.assert_called_with(**kwargs)
collist = ('UUID', 'Connector ID', 'Extra')
self.assertEqual(collist, columns)
datalist = ((baremetal_fakes.baremetal_volume_connector_uuid,
baremetal_fakes.baremetal_volume_connector_connector_id,
baremetal_fakes.baremetal_volume_connector_extra),)
self.assertEqual(datalist, tuple(data))
def test_baremetal_volume_connector_list_invalid_fields(self):
arglist = ['--fields', 'uuid', 'invalid']
verifylist = [('fields', [['uuid', 'invalid']])]
self.assertRaises(osctestutils.ParserException,
self.check_parser,
self.cmd, arglist, verifylist)
def test_baremetal_volume_connector_list_marker(self):
arglist = ['--marker', baremetal_fakes.baremetal_volume_connector_uuid]
verifylist = [
('marker', baremetal_fakes.baremetal_volume_connector_uuid)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
kwargs = {
'marker': baremetal_fakes.baremetal_volume_connector_uuid,
'limit': None}
self.baremetal_mock.volume_connector.list.assert_called_once_with(
**kwargs)
def test_baremetal_volume_connector_list_limit(self):
arglist = ['--limit', '10']
verifylist = [('limit', 10)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
kwargs = {
'marker': None,
'limit': 10}
self.baremetal_mock.volume_connector.list.assert_called_once_with(
**kwargs)
def test_baremetal_volume_connector_list_sort(self):
arglist = ['--sort', 'type']
verifylist = [('sort', 'type')]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
kwargs = {
'marker': None,
'limit': None}
self.baremetal_mock.volume_connector.list.assert_called_once_with(
**kwargs)
def test_baremetal_volume_connector_list_sort_desc(self):
arglist = ['--sort', 'type:desc']
verifylist = [('sort', 'type:desc')]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
kwargs = {
'marker': None,
'limit': None}
self.baremetal_mock.volume_connector.list.assert_called_once_with(
**kwargs)
def test_baremetal_volume_connector_list_exclusive_options(self):
arglist = ['--fields', 'uuid', '--long']
self.assertRaises(osctestutils.ParserException,
self.check_parser,
self.cmd, arglist, [])
def test_baremetal_volume_connector_list_negative_limit(self):
arglist = ['--limit', '-1']
verifylist = [('limit', -1)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.assertRaises(exc.CommandError,
self.cmd.take_action,
parsed_args)
class TestBaremetalVolumeConnectorDelete(TestBaremetalVolumeConnector):
def setUp(self):
super(TestBaremetalVolumeConnectorDelete, self).setUp()
self.cmd = (
bm_vol_connector.DeleteBaremetalVolumeConnector(self.app, None))
def test_baremetal_volume_connector_delete(self):
arglist = [baremetal_fakes.baremetal_volume_connector_uuid]
verifylist = [('volume_connectors',
[baremetal_fakes.baremetal_volume_connector_uuid])]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.volume_connector.delete.assert_called_with(
baremetal_fakes.baremetal_volume_connector_uuid)
def test_baremetal_volume_connector_delete_multiple(self):
fake_volume_connector_uuid2 = 'vvv-cccccc-cccc'
arglist = [baremetal_fakes.baremetal_volume_connector_uuid,
fake_volume_connector_uuid2]
verifylist = [('volume_connectors',
[baremetal_fakes.baremetal_volume_connector_uuid,
fake_volume_connector_uuid2])]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.volume_connector.delete.has_calls(
[mock.call(baremetal_fakes.baremetal_volume_connector_uuid),
mock.call(fake_volume_connector_uuid2)])
self.assertEqual(
2, self.baremetal_mock.volume_connector.delete.call_count)
def test_baremetal_volume_connector_delete_no_options(self):
arglist = []
verifylist = []
self.assertRaises(osctestutils.ParserException,
self.check_parser,
self.cmd, arglist, verifylist)
def test_baremetal_volume_connector_delete_error(self):
arglist = [baremetal_fakes.baremetal_volume_connector_uuid]
verifylist = [('volume_connectors',
[baremetal_fakes.baremetal_volume_connector_uuid])]
self.baremetal_mock.volume_connector.delete.side_effect = (
exc.NotFound())
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.assertRaises(exc.ClientException,
self.cmd.take_action,
parsed_args)
self.baremetal_mock.volume_connector.delete.assert_called_with(
baremetal_fakes.baremetal_volume_connector_uuid)
def test_baremetal_volume_connector_delete_multiple_error(self):
fake_volume_connector_uuid2 = 'vvv-cccccc-cccc'
arglist = [baremetal_fakes.baremetal_volume_connector_uuid,
fake_volume_connector_uuid2]
verifylist = [('volume_connectors',
[baremetal_fakes.baremetal_volume_connector_uuid,
fake_volume_connector_uuid2])]
self.baremetal_mock.volume_connector.delete.side_effect = [
None, exc.NotFound()]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.assertRaises(exc.ClientException,
self.cmd.take_action,
parsed_args)
self.baremetal_mock.volume_connector.delete.has_calls(
[mock.call(baremetal_fakes.baremetal_volume_connector_uuid),
mock.call(fake_volume_connector_uuid2)])
self.assertEqual(
2, self.baremetal_mock.volume_connector.delete.call_count)
class TestBaremetalVolumeConnectorSet(TestBaremetalVolumeConnector):
def setUp(self):
super(TestBaremetalVolumeConnectorSet, self).setUp()
self.cmd = (
bm_vol_connector.SetBaremetalVolumeConnector(self.app, None))
def test_baremetal_volume_connector_set_node_uuid(self):
new_node_uuid = 'xxx-xxxxxx-zzzz'
arglist = [
baremetal_fakes.baremetal_volume_connector_uuid,
'--node', new_node_uuid]
verifylist = [
('volume_connector',
baremetal_fakes.baremetal_volume_connector_uuid),
('node_uuid', new_node_uuid)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.volume_connector.update.assert_called_once_with(
baremetal_fakes.baremetal_volume_connector_uuid,
[{'path': '/node_uuid', 'value': new_node_uuid, 'op': 'add'}])
def test_baremetal_volume_connector_set_type(self):
new_type = 'wwnn'
arglist = [
baremetal_fakes.baremetal_volume_connector_uuid,
'--type', new_type]
verifylist = [
('volume_connector',
baremetal_fakes.baremetal_volume_connector_uuid),
('type', new_type)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.volume_connector.update.assert_called_once_with(
baremetal_fakes.baremetal_volume_connector_uuid,
[{'path': '/type', 'value': new_type, 'op': 'add'}])
def test_baremetal_volume_connector_set_connector_id(self):
new_conn_id = '11:22:33:44:55:66:77:88'
arglist = [
baremetal_fakes.baremetal_volume_connector_uuid,
'--connector-id', new_conn_id]
verifylist = [
('volume_connector',
baremetal_fakes.baremetal_volume_connector_uuid),
('connector_id', new_conn_id)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.volume_connector.update.assert_called_once_with(
baremetal_fakes.baremetal_volume_connector_uuid,
[{'path': '/connector_id', 'value': new_conn_id, 'op': 'add'}])
def test_baremetal_volume_connector_set_type_and_connector_id(self):
new_type = 'wwnn'
new_conn_id = '11:22:33:44:55:66:77:88'
arglist = [
baremetal_fakes.baremetal_volume_connector_uuid,
'--type', new_type,
'--connector-id', new_conn_id]
verifylist = [
('volume_connector',
baremetal_fakes.baremetal_volume_connector_uuid),
('type', new_type),
('connector_id', new_conn_id)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.volume_connector.update.assert_called_once_with(
baremetal_fakes.baremetal_volume_connector_uuid,
[{'path': '/type', 'value': new_type, 'op': 'add'},
{'path': '/connector_id', 'value': new_conn_id, 'op': 'add'}])
def test_baremetal_volume_connector_set_extra(self):
arglist = [
baremetal_fakes.baremetal_volume_connector_uuid,
'--extra', 'foo=bar']
verifylist = [
('volume_connector',
baremetal_fakes.baremetal_volume_connector_uuid),
('extra', ['foo=bar'])]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.volume_connector.update.assert_called_once_with(
baremetal_fakes.baremetal_volume_connector_uuid,
[{'path': '/extra/foo', 'value': 'bar', 'op': 'add'}])
def test_baremetal_volume_connector_set_multiple_extras(self):
arglist = [
baremetal_fakes.baremetal_volume_connector_uuid,
'--extra', 'key1=val1', '--extra', 'key2=val2']
verifylist = [
('volume_connector',
baremetal_fakes.baremetal_volume_connector_uuid),
('extra', ['key1=val1', 'key2=val2'])]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.volume_connector.update.assert_called_once_with(
baremetal_fakes.baremetal_volume_connector_uuid,
[{'path': '/extra/key1', 'value': 'val1', 'op': 'add'},
{'path': '/extra/key2', 'value': 'val2', 'op': 'add'}])
def test_baremetal_volume_connector_set_no_options(self):
arglist = []
verifylist = []
self.assertRaises(osctestutils.ParserException,
self.check_parser,
self.cmd, arglist, verifylist)
def test_baremetal_volume_connector_set_no_property(self):
arglist = [baremetal_fakes.baremetal_volume_connector_uuid]
verifylist = [('volume_connector',
baremetal_fakes.baremetal_volume_connector_uuid)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.volume_connector.update.assert_not_called()
class TestBaremetalVolumeConnectorUnset(TestBaremetalVolumeConnector):
def setUp(self):
super(TestBaremetalVolumeConnectorUnset, self).setUp()
self.cmd = (
bm_vol_connector.UnsetBaremetalVolumeConnector(self.app, None))
def test_baremetal_volume_connector_unset_extra(self):
arglist = [baremetal_fakes.baremetal_volume_connector_uuid,
'--extra', 'key1']
verifylist = [('volume_connector',
baremetal_fakes.baremetal_volume_connector_uuid),
('extra', ['key1'])]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.volume_connector.update.assert_called_once_with(
baremetal_fakes.baremetal_volume_connector_uuid,
[{'path': '/extra/key1', 'op': 'remove'}])
def test_baremetal_volume_connector_unset_multiple_extras(self):
arglist = [baremetal_fakes.baremetal_volume_connector_uuid,
'--extra', 'key1', '--extra', 'key2']
verifylist = [('volume_connector',
baremetal_fakes.baremetal_volume_connector_uuid),
('extra', ['key1', 'key2'])]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.volume_connector.update.assert_called_once_with(
baremetal_fakes.baremetal_volume_connector_uuid,
[{'path': '/extra/key1', 'op': 'remove'},
{'path': '/extra/key2', 'op': 'remove'}])
def test_baremetal_volume_connector_unset_no_options(self):
arglist = []
verifylist = []
self.assertRaises(osctestutils.ParserException,
self.check_parser,
self.cmd, arglist, verifylist)
def test_baremetal_volume_connector_unset_no_property(self):
arglist = [baremetal_fakes.baremetal_volume_connector_uuid]
verifylist = [('volume_connector',
baremetal_fakes.baremetal_volume_connector_uuid)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
self.cmd.take_action(parsed_args)
self.baremetal_mock.volume_connector.update.assert_not_called()

View File

@ -101,6 +101,7 @@ class Resource(object):
'vendor_interface': 'Vendor Interface',
'standalone_ports_supported': 'Standalone Ports Supported',
'id': 'ID',
'connector_id': 'Connector ID',
}
def __init__(self, field_ids, sort_excluded=None, override_labels=None):
@ -341,3 +342,29 @@ DRIVER_RESOURCE = Resource(
],
override_labels={'name': 'Supported driver(s)'}
)
# Volume connectors
VOLUME_CONNECTOR_DETAILED_RESOURCE = Resource(
['uuid',
'node_uuid',
'type',
'connector_id',
'extra',
'created_at',
'updated_at',
],
sort_excluded=[
# The server cannot sort on "node_uuid" because it isn't a column in
# the "volume_connectors" database table. "node_id" is stored, but it
# is internal to ironic. See bug #1443003 for more details.
'node_uuid',
'extra',
])
VOLUME_CONNECTOR_RESOURCE = Resource(
['uuid',
'node_uuid',
'type',
'connector_id',
],
sort_excluded=['node_uuid']
)

View File

@ -0,0 +1,11 @@
---
features:
- |
Adds OpenStackClient commands for volume connector:
* openstack baremetal volume connector create
* openstack baremetal volume connector show
* openstack baremetal volume connector list
* openstack baremetal volume connector delete
* openstack baremetal volume connector set
* openstack baremetal volume connector unset

View File

@ -86,6 +86,12 @@ openstack.baremetal.v1 =
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_volume_connector_create = ironicclient.osc.v1.baremetal_volume_connector:CreateBaremetalVolumeConnector
baremetal_volume_connector_delete = ironicclient.osc.v1.baremetal_volume_connector:DeleteBaremetalVolumeConnector
baremetal_volume_connector_list = ironicclient.osc.v1.baremetal_volume_connector:ListBaremetalVolumeConnector
baremetal_volume_connector_set = ironicclient.osc.v1.baremetal_volume_connector:SetBaremetalVolumeConnector
baremetal_volume_connector_show = ironicclient.osc.v1.baremetal_volume_connector:ShowBaremetalVolumeConnector
baremetal_volume_connector_unset = ironicclient.osc.v1.baremetal_volume_connector:UnsetBaremetalVolumeConnector
baremetal_set = ironicclient.osc.v1.baremetal_node:SetBaremetal
baremetal_show = ironicclient.osc.v1.baremetal_node:ShowBaremetal
baremetal_unset = ironicclient.osc.v1.baremetal_node:UnsetBaremetal