openstack/python-openstackclient
Code Issues Proposed changes

Merge "image: Trivial fixes"

Browse Source
This commit is contained in:
Zuul
2024-01-29 19:41:46 +00:00
committed by Gerrit Code Review
parent 2ed10e9a72 8a63b51039
commit 5435f11dd0
5 changed files with 118 additions and 102 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
openstackclient/image/v2/metadef_namespaces.py
View File

@@ -62,7 +62,7 @@ def _format_namespace(namespace):
return info return info
class CreateMetadefNameSpace(command.ShowOne): class CreateMetadefNamespace(command.ShowOne):
_description = _("Create a metadef namespace") _description = _("Create a metadef namespace")
def get_parser(self, prog_name): def get_parser(self, prog_name):
@@ -136,16 +136,16 @@ class CreateMetadefNameSpace(command.ShowOne):
return zip(*sorted(info.items())) return zip(*sorted(info.items()))
class DeleteMetadefNameSpace(command.Command): class DeleteMetadefNamespace(command.Command):
_description = _("Delete metadef namespace") _description = _("Delete metadef namespace")
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super().get_parser(prog_name) parser = super().get_parser(prog_name)
parser.add_argument( parser.add_argument(
"namespace_name", "namespace",
metavar="<namespace_name>", metavar="<namespace>",
nargs="+", nargs="+",
help=_("An identifier (a name) for the namespace"), help=_("Metadef namespace(s) to delete (name)"),
) )
return parser return parser
@@ -153,9 +153,9 @@ class DeleteMetadefNameSpace(command.Command):
image_client = self.app.client_manager.image image_client = self.app.client_manager.image
result = 0 result = 0
for i in parsed_args.namespace_name: for ns in parsed_args.namespace:
try: try:
namespace = image_client.get_metadef_namespace(i) namespace = image_client.get_metadef_namespace(ns)
image_client.delete_metadef_namespace(namespace.id) image_client.delete_metadef_namespace(namespace.id)
except Exception as e: except Exception as e:
result += 1 result += 1
@@ -164,18 +164,18 @@ class DeleteMetadefNameSpace(command.Command):
"Failed to delete namespace with name or " "Failed to delete namespace with name or "
"ID '%(namespace)s': %(e)s" "ID '%(namespace)s': %(e)s"
), ),
{'namespace': i, 'e': e}, {'namespace': ns, 'e': e},
) )
if result > 0: if result > 0:
total = len(parsed_args.namespace_name) total = len(parsed_args.namespace)
msg = _( msg = _(
"%(result)s of %(total)s namespace failed " "to delete." "%(result)s of %(total)s namespace failed " "to delete."
) % {'result': result, 'total': total} ) % {'result': result, 'total': total}
raise exceptions.CommandError(msg) raise exceptions.CommandError(msg)
class ListMetadefNameSpaces(command.Lister): class ListMetadefNamespace(command.Lister):
_description = _("List metadef namespaces") _description = _("List metadef namespaces")
def get_parser(self, prog_name): def get_parser(self, prog_name):
@@ -217,7 +217,7 @@ class ListMetadefNameSpaces(command.Lister):
) )
class SetMetadefNameSpace(command.Command): class SetMetadefNamespace(command.Command):
_description = _("Set metadef namespace properties") _description = _("Set metadef namespace properties")
def get_parser(self, prog_name): def get_parser(self, prog_name):
@@ -225,7 +225,7 @@ class SetMetadefNameSpace(command.Command):
parser.add_argument( parser.add_argument(
"namespace", "namespace",
metavar="<namespace>", metavar="<namespace>",
help=_("Namespace (name) for the namespace"), help=_("Metadef namespace to modify (name)"),
) )
parser.add_argument( parser.add_argument(
"--display-name", "--display-name",
@@ -243,14 +243,16 @@ class SetMetadefNameSpace(command.Command):
action="store_const", action="store_const",
const="public", const="public",
dest="visibility", dest="visibility",
help=_("Set namespace visibility 'public'"), help=_("Metadef namespace is accessible to the public"),
) )
visibility_group.add_argument( visibility_group.add_argument(
"--private", "--private",
action="store_const", action="store_const",
const="private", const="private",
dest="visibility", dest="visibility",
help=_("Set namespace visibility 'private'"), help=_(
"Metadef namespace is inaccessible to the public (default)"
),
) )
protected_group = parser.add_mutually_exclusive_group() protected_group = parser.add_mutually_exclusive_group()
protected_group.add_argument( protected_group.add_argument(
@@ -291,24 +293,24 @@ class SetMetadefNameSpace(command.Command):
image_client.update_metadef_namespace(namespace, **kwargs) image_client.update_metadef_namespace(namespace, **kwargs)
class ShowMetadefNameSpace(command.ShowOne): class ShowMetadefNamespace(command.ShowOne):
_description = _("Show a metadef namespace") _description = _("Show a metadef namespace")
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super().get_parser(prog_name) parser = super().get_parser(prog_name)
parser.add_argument( parser.add_argument(
"namespace_name", "namespace",
metavar="<namespace_name>", metavar="<namespace>",
help=_("Namespace (name) for the namespace"), help=_("Metadef namespace to show (name)"),
) )
return parser return parser
def take_action(self, parsed_args): def take_action(self, parsed_args):
image_client = self.app.client_manager.image image_client = self.app.client_manager.image
namespace_name = parsed_args.namespace_name namespace = parsed_args.namespace
data = image_client.get_metadef_namespace(namespace_name) data = image_client.get_metadef_namespace(namespace)
info = _format_namespace(data) info = _format_namespace(data)
return zip(*sorted(info.items())) return zip(*sorted(info.items()))

56
openstackclient/image/v2/metadef_objects.py
View File

@@ -55,7 +55,7 @@ class CreateMetadefObjects(command.ShowOne):
parser.add_argument( parser.add_argument(
"--namespace", "--namespace",
metavar="<namespace>", metavar="<namespace>",
help=_("Metadef namespace to create the metadef object in (name)"), help=_("Metadef namespace to create the object in (name)"),
) )
parser.add_argument( parser.add_argument(
"name", "name",
@@ -81,31 +81,29 @@ class CreateMetadefObjects(command.ShowOne):
class ShowMetadefObjects(command.ShowOne): class ShowMetadefObjects(command.ShowOne):
_description = _( _description = _("Show a particular metadef object")
"Describe a specific metadata definitions object inside a namespace"
)
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super().get_parser(prog_name) parser = super().get_parser(prog_name)
parser.add_argument( parser.add_argument(
"namespace_name", "namespace",
metavar="<namespace_name>", metavar="<namespace>",
help=_("Namespace (name) for the namespace"), help=_("Metadef namespace of the object (name)"),
) )
parser.add_argument( parser.add_argument(
"object_name", "object",
metavar="<object_name>", metavar="<object>",
help=_("Name of an object."), help=_("Metadef object to show"),
) )
return parser return parser
def take_action(self, parsed_args): def take_action(self, parsed_args):
image_client = self.app.client_manager.image image_client = self.app.client_manager.image
namespace_name = parsed_args.namespace_name namespace = parsed_args.namespace
object_name = parsed_args.object_name object = parsed_args.object
data = image_client.get_metadef_object(object_name, namespace_name) data = image_client.get_metadef_object(object, namespace)
fields, value = _format_object(data) fields, value = _format_object(data)
@@ -113,35 +111,33 @@ class ShowMetadefObjects(command.ShowOne):
class DeleteMetadefObject(command.Command): class DeleteMetadefObject(command.Command):
_description = _( _description = _("Delete metadata definitions object(s)")
"Delete a specific metadata definitions object inside a namespace"
)
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super().get_parser(prog_name) parser = super().get_parser(prog_name)
parser.add_argument( parser.add_argument(
"namespace_name", "namespace",
metavar="<namespace_name>", metavar="<namespace>",
help=_("Namespace (name) for the namespace"), help=_("Metadef namespace of the object (name)"),
) )
parser.add_argument( parser.add_argument(
"object_name", "objects",
metavar="<object_name>", metavar="<object>",
nargs="+", nargs="+",
help=_("Name of an object."), help=_("Metadef object(s) to delete (name)"),
) )
return parser return parser
def take_action(self, parsed_args): def take_action(self, parsed_args):
image_client = self.app.client_manager.image image_client = self.app.client_manager.image
namespace_name = parsed_args.namespace_name namespace = parsed_args.namespace
result = 0 result = 0
for i in parsed_args.object_name: for obj in parsed_args.objects:
try: try:
object = image_client.get_metadef_object(i, namespace_name) object = image_client.get_metadef_object(obj, namespace)
image_client.delete_metadef_object(object, namespace_name) image_client.delete_metadef_object(object, namespace)
except Exception as e: except Exception as e:
result += 1 result += 1
LOG.error( LOG.error(
@@ -149,11 +145,11 @@ class DeleteMetadefObject(command.Command):
"Failed to delete object with name or " "Failed to delete object with name or "
"ID '%(object)s': %(e)s" "ID '%(object)s': %(e)s"
), ),
{'object': i, 'e': e}, {'object': obj, 'e': e},
) )
if result > 0: if result > 0:
total = len(parsed_args.namespace_name) total = len(parsed_args.namespace)
msg = _("%(result)s of %(total)s object failed to delete.") % { msg = _("%(result)s of %(total)s object failed to delete.") % {
'result': result, 'result': result,
'total': total, 'total': total,
@@ -176,10 +172,10 @@ class ListMetadefObjects(command.Lister):
def take_action(self, parsed_args): def take_action(self, parsed_args):
image_client = self.app.client_manager.image image_client = self.app.client_manager.image
namespace_name = parsed_args.namespace namespace = parsed_args.namespace
columns = ['name', 'description'] columns = ['name', 'description']
md_objects = list(image_client.metadef_objects(namespace_name)) md_objects = list(image_client.metadef_objects(namespace))
column_headers = columns column_headers = columns
return ( return (
column_headers, column_headers,

84
openstackclient/image/v2/metadef_properties.py
View File

@@ -13,6 +13,7 @@
# under the License. # under the License.
import json import json
import logging
from osc_lib.command import command from osc_lib.command import command
from osc_lib import exceptions from osc_lib import exceptions
@@ -21,6 +22,9 @@ from osc_lib import utils
from openstackclient.i18n import _ from openstackclient.i18n import _
LOG = logging.getLogger(__name__)
def _format_property(prop): def _format_property(prop):
prop = prop.to_dict(ignore_none=True, original_names=True) prop = prop.to_dict(ignore_none=True, original_names=True)
return { return {
@@ -76,7 +80,7 @@ class CreateMetadefProperty(command.ShowOne):
help=_("Valid JSON schema of the property"), help=_("Valid JSON schema of the property"),
) )
parser.add_argument( parser.add_argument(
"namespace_name", "namespace",
help=_("Name of namespace the property will belong."), help=_("Name of namespace the property will belong."),
) )
return parser return parser
@@ -100,7 +104,7 @@ class CreateMetadefProperty(command.ShowOne):
) )
data = image_client.create_metadef_property( data = image_client.create_metadef_property(
parsed_args.namespace_name, **kwargs parsed_args.namespace, **kwargs
) )
info = _format_property(data) info = _format_property(data)
@@ -108,42 +112,56 @@ class CreateMetadefProperty(command.ShowOne):
class DeleteMetadefProperty(command.Command): class DeleteMetadefProperty(command.Command):
_description = _("Delete a metadef property") _description = _("Delete metadef propert(ies)")
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super().get_parser(prog_name) parser = super().get_parser(prog_name)
parser.add_argument( parser.add_argument(
"namespace_name", "namespace",
help=_("An identifier (a name) for the namespace"), metavar="<namespace>",
help=_("Metadef namespace of the property (name)"),
) )
parser.add_argument( parser.add_argument(
"property_name", "properties",
help=_("Property to delete"), metavar="<property>",
nargs="+",
help=_("Metadef propert(ies) to delete (name)"),
) )
return parser return parser
def take_action(self, parsed_args): def take_action(self, parsed_args):
image_client = self.app.client_manager.image image_client = self.app.client_manager.image
result = 0
for prop in parsed_args.properties:
try: try:
image_client.delete_metadef_property( image_client.delete_metadef_property(
parsed_args.property_name, prop,
parsed_args.namespace_name, parsed_args.namespace,
ignore_missing=False, ignore_missing=False,
) )
except Exception as e: except Exception as e:
raise exceptions.CommandError( result += 1
LOG.error(
_( _(
"Failed to delete property with name or " "Failed to delete property with name or ID "
"ID '%(property)s' from namespace '%(namespace)s': %(e)s" "'%(property)s' from namespace '%(namespace)s': %(e)s"
) ),
% { {
'property': parsed_args.property_name, 'property': prop,
'namespace': parsed_args.namespace_name, 'namespace': parsed_args.namespace,
'e': e, 'e': e,
} },
) )
if result > 0:
total = len(parsed_args.namespace)
msg = _("%(result)s of %(total)s properties failed to delete.") % {
'result': result,
'total': total,
}
raise exceptions.CommandError(msg)
class ListMetadefProperties(command.Lister): class ListMetadefProperties(command.Lister):
_description = _("List metadef properties") _description = _("List metadef properties")
@@ -151,15 +169,15 @@ class ListMetadefProperties(command.Lister):
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super().get_parser(prog_name) parser = super().get_parser(prog_name)
parser.add_argument( parser.add_argument(
"namespace_name", "namespace",
metavar="<namespace_name>", metavar="<namespace>",
help=_("An identifier (a name) for the namespace"), help=_("An identifier (a name) for the namespace"),
) )
return parser return parser
def take_action(self, parsed_args): def take_action(self, parsed_args):
image_client = self.app.client_manager.image image_client = self.app.client_manager.image
props = image_client.metadef_properties(parsed_args.namespace_name) props = image_client.metadef_properties(parsed_args.namespace)
columns = ['name', 'title', 'type'] columns = ['name', 'title', 'type']
return ( return (
columns, columns,
@@ -195,11 +213,11 @@ class SetMetadefProperty(command.Command):
help=_("Valid JSON schema of the property"), help=_("Valid JSON schema of the property"),
) )
parser.add_argument( parser.add_argument(
"namespace_name", "namespace",
help=_("Namespace of the namespace to which the property belongs"), help=_("Namespace of the namespace to which the property belongs"),
) )
parser.add_argument( parser.add_argument(
"property_name", "property",
help=_("Property to update"), help=_("Property to update"),
) )
return parser return parser
@@ -211,7 +229,8 @@ class SetMetadefProperty(command.Command):
# update_metadef_property(), otherwise the attributes that are not # update_metadef_property(), otherwise the attributes that are not
# listed will be reset. # listed will be reset.
data = image_client.get_metadef_property( data = image_client.get_metadef_property(
parsed_args.property_name, parsed_args.namespace_name parsed_args.property,
parsed_args.namespace,
) )
kwargs = _format_property(data) kwargs = _format_property(data)
for key in ['name', 'title', 'type']: for key in ['name', 'title', 'type']:
@@ -231,23 +250,25 @@ class SetMetadefProperty(command.Command):
) )
image_client.update_metadef_property( image_client.update_metadef_property(
parsed_args.property_name, parsed_args.namespace_name, **kwargs parsed_args.property,
parsed_args.namespace,
**kwargs,
) )
class ShowMetadefProperty(command.ShowOne): class ShowMetadefProperty(command.ShowOne):
_description = _("Describe a specific property from a namespace") _description = _("Show a particular metadef property")
def get_parser(self, prog_name): def get_parser(self, prog_name):
parser = super().get_parser(prog_name) parser = super().get_parser(prog_name)
parser.add_argument( parser.add_argument(
"namespace_name", "namespace",
metavar="<namespace_name>", metavar="<namespace>",
help=_("Namespace (name) for the namespace"), help=_("Metadef namespace of the property (name)"),
) )
parser.add_argument( parser.add_argument(
"property_name", "property",
metavar="<property_name>", metavar="<property>",
help=_("Property to show"), help=_("Property to show"),
) )
return parser return parser
@@ -255,7 +276,8 @@ class ShowMetadefProperty(command.ShowOne):
def take_action(self, parsed_args): def take_action(self, parsed_args):
image_client = self.app.client_manager.image image_client = self.app.client_manager.image
data = image_client.get_metadef_property( data = image_client.get_metadef_property(
parsed_args.property_name, parsed_args.namespace_name parsed_args.property,
parsed_args.namespace,
) )
info = _format_property(data) info = _format_property(data)

10
openstackclient/tests/unit/image/v2/test_metadef_namespaces.py
View File

@@ -40,7 +40,7 @@ class TestMetadefNamespaceCreate(image_fakes.TestImagev2):
self.image_client.create_metadef_namespace.return_value = ( self.image_client.create_metadef_namespace.return_value = (
self._metadef_namespace self._metadef_namespace
) )
self.cmd = metadef_namespaces.CreateMetadefNameSpace(self.app, None) self.cmd = metadef_namespaces.CreateMetadefNamespace(self.app, None)
self.datalist = self._metadef_namespace self.datalist = self._metadef_namespace
def test_namespace_create(self): def test_namespace_create(self):
@@ -64,7 +64,7 @@ class TestMetadefNamespaceDelete(image_fakes.TestImagev2):
self.image_client.delete_metadef_namespace.return_value = ( self.image_client.delete_metadef_namespace.return_value = (
self._metadef_namespace self._metadef_namespace
) )
self.cmd = metadef_namespaces.DeleteMetadefNameSpace(self.app, None) self.cmd = metadef_namespaces.DeleteMetadefNamespace(self.app, None)
self.datalist = self._metadef_namespace self.datalist = self._metadef_namespace
def test_namespace_create(self): def test_namespace_create(self):
@@ -97,7 +97,7 @@ class TestMetadefNamespaceList(image_fakes.TestImagev2):
self.image_client.metadef_namespaces.return_value = iter( self.image_client.metadef_namespaces.return_value = iter(
self._metadef_namespace self._metadef_namespace
) )
self.cmd = metadef_namespaces.ListMetadefNameSpaces(self.app, None) self.cmd = metadef_namespaces.ListMetadefNamespace(self.app, None)
self.datalist = self._metadef_namespace self.datalist = self._metadef_namespace
def test_namespace_list_no_options(self): def test_namespace_list_no_options(self):
@@ -122,7 +122,7 @@ class TestMetadefNamespaceSet(image_fakes.TestImagev2):
self.image_client.update_metadef_namespace.return_value = ( self.image_client.update_metadef_namespace.return_value = (
self._metadef_namespace self._metadef_namespace
) )
self.cmd = metadef_namespaces.SetMetadefNameSpace(self.app, None) self.cmd = metadef_namespaces.SetMetadefNamespace(self.app, None)
self.datalist = self._metadef_namespace self.datalist = self._metadef_namespace
def test_namespace_set_no_options(self): def test_namespace_set_no_options(self):
@@ -162,7 +162,7 @@ class TestMetadefNamespaceShow(image_fakes.TestImagev2):
self.image_client.get_metadef_namespace.return_value = ( self.image_client.get_metadef_namespace.return_value = (
self._metadef_namespace self._metadef_namespace
) )
self.cmd = metadef_namespaces.ShowMetadefNameSpace(self.app, None) self.cmd = metadef_namespaces.ShowMetadefNamespace(self.app, None)
def test_namespace_show_no_options(self): def test_namespace_show_no_options(self):
arglist = [self._metadef_namespace.namespace] arglist = [self._metadef_namespace.namespace]

14
setup.cfg
View File

@@ -393,20 +393,17 @@ openstack.image.v2 =
image_import = openstackclient.image.v2.image:ImportImage image_import = openstackclient.image.v2.image:ImportImage
image_stores_list = openstackclient.image.v2.image:StoresInfo image_stores_list = openstackclient.image.v2.image:StoresInfo
image_metadef_namespace_create = openstackclient.image.v2.metadef_namespaces:CreateMetadefNamespace
image_metadef_namespace_create = openstackclient.image.v2.metadef_namespaces:CreateMetadefNameSpace image_metadef_namespace_delete = openstackclient.image.v2.metadef_namespaces:DeleteMetadefNamespace
image_metadef_namespace_delete = openstackclient.image.v2.metadef_namespaces:DeleteMetadefNameSpace image_metadef_namespace_list = openstackclient.image.v2.metadef_namespaces:ListMetadefNamespace
image_metadef_namespace_list = openstackclient.image.v2.metadef_namespaces:ListMetadefNameSpaces image_metadef_namespace_set = openstackclient.image.v2.metadef_namespaces:SetMetadefNamespace
image_metadef_namespace_set = openstackclient.image.v2.metadef_namespaces:SetMetadefNameSpace image_metadef_namespace_show = openstackclient.image.v2.metadef_namespaces:ShowMetadefNamespace
image_metadef_namespace_show = openstackclient.image.v2.metadef_namespaces:ShowMetadefNameSpace
image_metadef_object_create = openstackclient.image.v2.metadef_objects:CreateMetadefObjects image_metadef_object_create = openstackclient.image.v2.metadef_objects:CreateMetadefObjects
image_metadef_object_show = openstackclient.image.v2.metadef_objects:ShowMetadefObjects image_metadef_object_show = openstackclient.image.v2.metadef_objects:ShowMetadefObjects
image_metadef_object_list = openstackclient.image.v2.metadef_objects:ListMetadefObjects image_metadef_object_list = openstackclient.image.v2.metadef_objects:ListMetadefObjects
image_metadef_object_delete = openstackclient.image.v2.metadef_objects:DeleteMetadefObject image_metadef_object_delete = openstackclient.image.v2.metadef_objects:DeleteMetadefObject
image_metadef_property_create = openstackclient.image.v2.metadef_properties:CreateMetadefProperty image_metadef_property_create = openstackclient.image.v2.metadef_properties:CreateMetadefProperty
image_metadef_property_delete = openstackclient.image.v2.metadef_properties:DeleteMetadefProperty image_metadef_property_delete = openstackclient.image.v2.metadef_properties:DeleteMetadefProperty
image_metadef_property_list = openstackclient.image.v2.metadef_properties:ListMetadefProperties image_metadef_property_list = openstackclient.image.v2.metadef_properties:ListMetadefProperties
@@ -420,7 +417,6 @@ openstack.image.v2 =
cached_image_delete = openstackclient.image.v2.cache:DeleteCachedImage cached_image_delete = openstackclient.image.v2.cache:DeleteCachedImage
cached_image_clear = openstackclient.image.v2.cache:ClearCachedImage cached_image_clear = openstackclient.image.v2.cache:ClearCachedImage
openstack.network.v2 = openstack.network.v2 =
address_group_create = openstackclient.network.v2.address_group:CreateAddressGroup address_group_create = openstackclient.network.v2.address_group:CreateAddressGroup
address_group_delete = openstackclient.network.v2.address_group:DeleteAddressGroup address_group_delete = openstackclient.network.v2.address_group:DeleteAddressGroup