Adds CLI support for glance md-tags

Mridula Joshi · CyrilRoelandteNovance · commit fef4f38901d4 · 2026-04-29T17:47:09.000+02:00
This patch adds support for metadef tags associated to a namespace,
to add, set, remove tags from a namespace.

Change-Id: I51397e257631e6e2065656bffdba3b0241e7ba34
Signed-off-by: Mridula Joshi &lt;mrjoshi@redhat.com&gt;
Signed-off-by: Cyril Roelandt &lt;cyril@redhat.com&gt;
diff --git a/doc/source/cli/data/glance.csv b/doc/source/cli/data/glance.csv
@@ -30,7 +30,7 @@ md-namespace-objects-delete,image metadef object delete,Delete all metadata defi
 md-namespace-properties-delete,image metadef property delete,Delete all metadata definitions property inside a specific namespace.
 md-namespace-resource-type-list,image metadef resource type association list,List resource types associated to specific namespace.
 md-namespace-show,image metadef namespace show,Describe a specific metadata definitions namespace.
-md-namespace-tags-delete,,Delete all metadata definitions tags inside a specific namespace.
+md-namespace-tags-delete,image metadef namespace unset --all,Delete all metadata definitions tags inside a specific namespace.
 md-namespace-update,,Update an existing metadata definitions namespace.
 md-object-create,image metadef object create,Create a new metadata definitions object inside a namespace.
 md-object-show,image metadef object show,Describe a specific metadata definitions object inside a namespace.
@@ -46,12 +46,12 @@ md-property-update,image metadef property set,Update metadata definitions proper
 md-resource-type-associate,image metadef resource type association create,Associate resource type with a metadata definitions namespace.
 md-resource-type-deassociate,image metadef resource type association delete,Deassociate resource type with a metadata definitions namespace.
 md-resource-type-list,image metadef resource type list,List available resource type names.
-md-tag-create,,Add a new metadata definitions tag inside a namespace.
+md-tag-create,image metadef namespace set --tag,Add a new metadata definitions tag inside a namespace.
 md-tag-create-multiple,,Create new metadata definitions tags inside a namespace.
-md-tag-delete,,Delete a specific metadata definitions tag inside a namespace.
-md-tag-list,,List metadata definitions tags inside a specific namespace.
-md-tag-show,,Describe a specific metadata definitions tag inside a namespace.
-md-tag-update,,Rename a metadata definitions tag inside a namespace.
+md-tag-delete,image metadef namespace unset --tag,Delete a specific metadata definitions tag inside a namespace.
+md-tag-list,image metadef namespace show,List metadata definitions tags inside a specific namespace.
+md-tag-show,image metadef namespace show,Describe a specific metadata definitions tag inside a namespace.
+md-tag-update,image metadef namespace set --tag,Rename a metadata definitions tag inside a namespace.
 member-create,image add project,Create member for a given image.
 member-delete,image remove project,Delete image member.
 member-get,image member get,Show details of an image member
diff --git a/openstackclient/image/v2/metadef_namespaces.py b/openstackclient/image/v2/metadef_namespaces.py
@@ -44,6 +44,7 @@ def _format_namespace(namespace: Any) -> dict[str, Any]:
         'namespace',
         'owner',
         'protected',
+        'tags',
         'schema',
         'updated_at',
         'visibility',
@@ -278,6 +279,17 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
             dest="is_protected",
             help=_("Allow metadef namespace to be deleted (default)"),
         )
+        parser.add_argument(
+            "--tag",
+            metavar="<tag>",
+            action='append',
+            default=[],
+            dest='tags',
+            help=_(
+                "Set a tag on this metadef namespace "
+                "(repeat option to set multiple tags)"
+            ),
+        )
         return parser
 
     def take_action(self, parsed_args: argparse.Namespace) -> None:
@@ -301,6 +313,21 @@ def take_action(self, parsed_args: argparse.Namespace) -> None:
 
         image_client.update_metadef_namespace(namespace, **kwargs)
 
+        errors = 0
+        for tag in parsed_args.tags:
+            try:
+                image_client.add_tag_to_metadef_namespace(namespace, tag)
+            except Exception:
+                LOG.error(_("Tag set failed for tag %s"), tag)
+                errors += 1
+
+        if errors > 0:
+            msg = _("Failed to set %(errors)s of %(total)s tags.") % {
+                'errors': errors,
+                'total': len(parsed_args.tags),
+            }
+            raise exceptions.CommandError(msg)
+
 
 class ShowMetadefNamespace(command.ShowOne):
     _description = _("Show a metadef namespace")
@@ -326,3 +353,61 @@ def take_action(
 
         col_headers, col_data = zip(*sorted(info.items()))
         return col_headers, col_data
+
+
+class UnsetMetadefNamespace(command.Command):
+    _description = _("Unset metadef namespace tags")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            "namespace",
+            metavar="<namespace>",
+            help=_("Metadef namespace to modify (name)"),
+        )
+        tag_group = parser.add_mutually_exclusive_group(required=True)
+        tag_group.add_argument(
+            "--tag",
+            metavar="<tag>",
+            action='append',
+            default=[],
+            dest='tags',
+            help=_(
+                "Unset a tag on this metadef namespace "
+                "(repeat option to unset multiple tags)"
+            ),
+        )
+        tag_group.add_argument(
+            "--all-tags",
+            action="store_true",
+            default=False,
+            help=_("Unset all metadef tags"),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        image_client = self.app.client_manager.image
+
+        namespace = image_client.get_metadef_namespace(parsed_args.namespace)
+
+        errors = 0
+        if parsed_args.all_tags:
+            namespace = image_client.remove_tags_from_metadef_namespace(
+                namespace
+            )
+        elif parsed_args.tags:
+            for tag in parsed_args.tags:
+                try:
+                    image_client.remove_tag_from_metadef_namespace(
+                        namespace, tag
+                    )
+                except Exception:
+                    LOG.error(_("tag unset failed for tag %s"), tag)
+                    errors += 1
+
+        if errors > 0:
+            msg = _("Failed to unset %(errors)s of %(total)s tags.") % {
+                'errors': errors,
+                'total': len(parsed_args.tags),
+            }
+            raise exceptions.CommandError(msg)
diff --git a/openstackclient/tests/unit/image/v2/test_metadef_namespaces.py b/openstackclient/tests/unit/image/v2/test_metadef_namespaces.py
@@ -12,6 +12,8 @@
 #   License for the specific language governing permissions and limitations
 #   under the License.
 
+from unittest import mock
+
 from openstackclient.image.v2 import metadef_namespaces
 from openstackclient.tests.unit.image.v2 import fakes as image_fakes
 
@@ -24,13 +26,15 @@ class TestMetadefNamespaceCreate(image_fakes.TestImagev2):
         'display_name',
         'namespace',
         'owner',
+        'tags',
         'visibility',
     )
     expected_data = (
         _metadef_namespace.created_at,
         _metadef_namespace.display_name,
         _metadef_namespace.namespace,
         _metadef_namespace.owner,
+        _metadef_namespace.tags,
         _metadef_namespace.visibility,
     )
 
@@ -114,21 +118,25 @@ def test_namespace_list_no_options(self):
 
 
 class TestMetadefNamespaceSet(image_fakes.TestImagev2):
-    _metadef_namespace = image_fakes.create_one_metadef_namespace()
-
     def setUp(self):
         super().setUp()
 
+        self.metadef_namespace = image_fakes.create_one_metadef_namespace()
+
+        self.image_client.get_metadef_namespace.return_value = (
+            self.metadef_namespace
+        )
         self.image_client.update_metadef_namespace.return_value = (
-            self._metadef_namespace
+            self.metadef_namespace
         )
+        self.image_client.add_tag_to_metadef_namespace.return_value = None
+
         self.cmd = metadef_namespaces.SetMetadefNamespace(self.app, None)
-        self.datalist = self._metadef_namespace
 
     def test_namespace_set_no_options(self):
-        arglist = [self._metadef_namespace.namespace]
+        arglist = [self.metadef_namespace.namespace]
         verifylist = [
-            ('namespace', self._metadef_namespace.namespace),
+            ('namespace', self.metadef_namespace.namespace),
         ]
 
         parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -137,6 +145,95 @@ def test_namespace_set_no_options(self):
 
         self.assertIsNone(result)
 
+    def test_namespace_set_tag(self):
+        arglist = [
+            self.metadef_namespace.namespace,
+            '--tag',
+            't1',
+            '--tag',
+            't2',
+        ]
+        verifylist = [
+            ('namespace', self.metadef_namespace.namespace),
+            ('tags', ['t1', 't2']),
+        ]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        self.image_client.add_tag_to_metadef_namespace.assert_has_calls(
+            [
+                mock.call(self.metadef_namespace.namespace, 't1'),
+                mock.call(self.metadef_namespace.namespace, 't2'),
+            ]
+        )
+
+
+class TestMetadefNamespaceUnset(image_fakes.TestImagev2):
+    def setUp(self):
+        super().setUp()
+
+        self.metadef_namespace = image_fakes.create_one_metadef_namespace(
+            attrs={'tags': [{'name': 't1'}]}
+        )
+
+        self.image_client.get_metadef_namespace.return_value = (
+            self.metadef_namespace
+        )
+        self.image_client.update_metadef_namespace.return_value = (
+            self.metadef_namespace
+        )
+        self.image_client.remove_tag_from_metadef_namespace.return_value = None
+        self.image_client.remove_tags_from_metadef_namespace.return_value = (
+            None
+        )
+
+        self.cmd = metadef_namespaces.UnsetMetadefNamespace(self.app, None)
+
+    def test_namespace_unset_tag(self):
+        arglist = [
+            self.metadef_namespace.namespace,
+            '--tag',
+            't1',
+            '--tag',
+            't2',
+        ]
+        verifylist = [
+            ('namespace', self.metadef_namespace.namespace),
+            ('tags', ['t1', 't2']),
+        ]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        self.image_client.remove_tag_from_metadef_namespace.assert_has_calls(
+            [
+                mock.call(self.metadef_namespace, 't1'),
+                mock.call(self.metadef_namespace, 't2'),
+            ]
+        )
+        self.image_client.remove_tags_from_metadef_namespace.assert_not_called()
+
+    def test_namespace_unset_all_tag(self):
+        arglist = [
+            self.metadef_namespace.namespace,
+            '--all-tags',
+        ]
+        verifylist = [
+            ('namespace', self.metadef_namespace.namespace),
+        ]
+
+        parsed_args = self.check_parser(self.cmd, arglist, verifylist)
+
+        self.cmd.take_action(parsed_args)
+
+        self.image_client.remove_tags_from_metadef_namespace.assert_called_once_with(
+            self.metadef_namespace
+        )
+        self.image_client.remove_tag_from_metadef_namespace.assert_not_called()
+
 
 class TestMetadefNamespaceShow(image_fakes.TestImagev2):
     _metadef_namespace = image_fakes.create_one_metadef_namespace()
@@ -146,13 +243,15 @@ class TestMetadefNamespaceShow(image_fakes.TestImagev2):
         'display_name',
         'namespace',
         'owner',
+        'tags',
         'visibility',
     )
     expected_data = (
         _metadef_namespace.created_at,
         _metadef_namespace.display_name,
         _metadef_namespace.namespace,
         _metadef_namespace.owner,
+        _metadef_namespace.tags,
         _metadef_namespace.visibility,
     )
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -357,6 +357,7 @@ image_metadef_namespace_delete = "openstackclient.image.v2.metadef_namespaces:De
 image_metadef_namespace_list = "openstackclient.image.v2.metadef_namespaces:ListMetadefNamespace"
 image_metadef_namespace_set = "openstackclient.image.v2.metadef_namespaces:SetMetadefNamespace"
 image_metadef_namespace_show = "openstackclient.image.v2.metadef_namespaces:ShowMetadefNamespace"
+image_metadef_namespace_unset = "openstackclient.image.v2.metadef_namespaces:UnsetMetadefNamespace"
 image_metadef_object_create = "openstackclient.image.v2.metadef_objects:CreateMetadefObjects"
 image_metadef_object_show = "openstackclient.image.v2.metadef_objects:ShowMetadefObjects"
 image_metadef_object_list = "openstackclient.image.v2.metadef_objects:ListMetadefObjects"
diff --git a/releasenotes/notes/add-image-metadef-tag-list-64cb60f80d4331e6.yaml b/releasenotes/notes/add-image-metadef-tag-list-64cb60f80d4331e6.yaml
@@ -0,0 +1,5 @@
+---
+features:
+  - |
+    Add support for metadef-tags associated to namespace for adding, updating,
+    removing a tag.
