[Fix] CLI Server Set/Unset tags and properties (#614)

[Fix] CLI Server Set/Unset tags and properties

Update server tags setting according latest python-openstackclient changes

Reviewed-by: Tino Schr

Author: anton-sidelnikov

.stestr.blacklist.functional

@@ -1,4 +1,5 @@
 otcextensions.tests.unit.sdk.cce*
+otcextensions.tests.functional.osclient.compute*
 otcextensions.tests.functional.osclient.dcaas
 otcextensions.tests.functional.osclient.dns*
 otcextensions.tests.functional.osclient.obs*

AUTHORS

@@ -14,6 +14,7 @@ Irina Pereiaslavskaia <[email protected]>
 Irina Pereiaslavskaia <[email protected]>
 Nils Magnus <[email protected]>
 Nils-Magnus <[email protected]>
+Peter <[email protected]>
 Polina Gubina <[email protected]>
 Reik Keutterling <[email protected]>
 Rodion Gyrbu <[email protected]>

otcextensions/osclient/compute/v2/server.py

@@ -18,14 +18,14 @@
 import getpass
 import logging
 
-from novaclient import api_versions
 from osc_lib.cli import parseractions
 from osc_lib.command import command
 from osc_lib import exceptions
-from osc_lib import utils
 
 from openstackclient.i18n import _
 
+from openstack import utils as sdk_utils
+
 from otcextensions import sdk
 
 
@@ -53,11 +53,14 @@ def get_parser(self, prog_name):
             help=_('Set new root password (interactive only)'),
         )
         parser.add_argument(
-            "--property",
-            metavar="<key=value>",
+            '--property',
+            metavar='<key=value>',
             action=parseractions.KeyValueAction,
-            help=_('Property to add/change for this server '
-                   '(repeat option to set multiple properties)'),
+            dest='properties',
+            help=_(
+                'Property to add/change for this server '
+                '(repeat option to set multiple properties)'
+            ),
         )
         parser.add_argument(
             '--state',
@@ -83,18 +86,16 @@ def get_parser(self, prog_name):
     def take_action(self, parsed_args):
 
         compute_client = self.app.client_manager.compute
-        server = utils.find_resource(
-            compute_client.servers,
-            parsed_args.server,
+        server = compute_client.find_server(
+            parsed_args.server, ignore_missing=False
         )
 
         if parsed_args.name:
             server.update(name=parsed_args.name)
 
-        if parsed_args.property:
-            compute_client.servers.set_meta(
-                server,
-                parsed_args.property,
+        if parsed_args.properties:
+            compute_client.set_server_metadata(
+                server, **parsed_args.properties
             )
 
         if parsed_args.state:
@@ -110,16 +111,20 @@ def take_action(self, parsed_args):
                 raise exceptions.CommandError(msg)
 
         if parsed_args.description:
-            if server.api_version < api_versions.APIVersion("2.19"):
-                msg = _("Description is not supported for "
-                        "--os-compute-api-version less than 2.19")
+            if not sdk_utils.supports_microversion(compute_client, '2.19'):
+                msg = _(
+                    '--os-compute-api-version 2.19 or greater is required to '
+                    'support the --description option'
+                )
                 raise exceptions.CommandError(msg)
             server.update(description=parsed_args.description)
 
         if parsed_args.tag:
-            if server.api_version < api_versions.APIVersion("2.26"):
-                msg = _("Modifying tags is not supported for "
-                        "--os-compute-api-version less than 2.26")
+            if not sdk_utils.supports_microversion(compute_client, '2.26'):
+                msg = _(
+                    '--os-compute-api-version 2.26 or greater is required to '
+                    'support the --tag option'
+                )
                 raise exceptions.CommandError(msg)
             sdk.load(self.app.client_manager.sdk_connection)
             client = self.app.client_manager.sdk_connection.compute
@@ -140,11 +145,13 @@ def get_parser(self, prog_name):
         )
         parser.add_argument(
             '--property',
-            metavar='<key>',
-            action='append',
-            default=[],
-            help=_('Property key to remove from server '
-                   '(repeat option to remove multiple values)'),
+            metavar='<key=value>',
+            action=parseractions.KeyValueAction,
+            dest='properties',
+            help=_(
+                'Property to add/change for this server '
+                '(repeat option to set multiple properties)'
+            ),
         )
         parser.add_argument(
             '--description',
@@ -164,31 +171,31 @@ def get_parser(self, prog_name):
 
     def take_action(self, parsed_args):
         compute_client = self.app.client_manager.compute
-        server = utils.find_resource(
-            compute_client.servers,
-            parsed_args.server,
+        server = compute_client.find_server(
+            parsed_args.server, ignore_missing=False
         )
 
-        if parsed_args.property:
-            compute_client.servers.delete_meta(
-                server,
-                parsed_args.property,
+        if parsed_args.properties:
+            compute_client.delete_server_metadata(
+                server, parsed_args.properties or None
             )
 
         if parsed_args.description:
-            if compute_client.api_version < api_versions.APIVersion("2.19"):
-                msg = _("Description is not supported for "
-                        "--os-compute-api-version less than 2.19")
+            if not sdk_utils.supports_microversion(compute_client, '2.19'):
+                msg = _(
+                    '--os-compute-api-version 2.19 or greater is required to '
+                    'support the --description option'
+                )
                 raise exceptions.CommandError(msg)
-            compute_client.servers.update(
-                server,
-                description="",
-            )
+
+            compute_client.update_server(server, description="")
 
         if parsed_args.tag:
-            if compute_client.api_version < api_versions.APIVersion("2.26"):
-                msg = _("Modifying tags is not supported for "
-                        "--os-compute-api-version less than 2.26")
+            if not sdk_utils.supports_microversion(compute_client, '2.26'):
+                msg = _(
+                    '--os-compute-api-version 2.26 or greater is required to '
+                    'support the --tag option'
+                )
                 raise exceptions.CommandError(msg)
             sdk.load(self.app.client_manager.sdk_connection)
             client = self.app.client_manager.sdk_connection.compute

otcextensions/sdk/apig/v2/backend_server.py

@@ -74,15 +74,15 @@ def send_request(session, gateway_id, vpc_channel_id, method,
 
     def enable_server(self, session, gateway_id, vpc_channel_id, **attrs):
         uri = f'apigw/instances/{gateway_id}/vpc-channels/'\
-              f'{vpc_channel_id}/members/batch-enable'
+            f'{vpc_channel_id}/members/batch-enable'
         response = session.post(uri, json=attrs)
         exceptions.raise_from_response(response)
         self._translate_response(response)
         return response
 
     def disable_server(self, session, gateway_id, vpc_channel_id, **attrs):
         uri = f'apigw/instances/{gateway_id}/vpc-channels/'\
-              f'{vpc_channel_id}/members/batch-disable'
+            f'{vpc_channel_id}/members/batch-disable'
         response = session.post(uri, json=attrs)
         exceptions.raise_from_response(response)
         self._translate_response(response)

otcextensions/sdk/obs/v1/_proxy.py

@@ -65,7 +65,7 @@ def get_container_endpoint(self, container):
         split_url = urlsplit(self.get_endpoint())
 
         return f'{split_url.scheme}://%(container)s.{split_url.netloc}' % \
-               {'container': container}
+            {'container': container}
 
     def _get_req_auth(self, host=None):
         auth = getattr(self, '_ak_auth', None)

otcextensions/tests/functional/osclient/compute/__init__.py

@@ -0,0 +1,36 @@
+#    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 json
+
+from openstackclient.tests.functional import base
+
+
+class TestCce(base.TestCase):
+    """Functional tests for Compute Instance. """
+    SERVER_ID = "d420440b-834d-4af2-92a2-e7eb03119123"
+
+    def test_01_server_get(self):
+        cmd = (
+            f'server show {self.SERVER_ID} -f json '
+        )
+        json_output = json.loads(self.openstack(cmd))
+        self.assertIsNotNone(json_output['id'])
+
+    def test_02_create_server_tag(self):
+        cmd = (
+            f'server set {self.SERVER_ID} '
+            f'--tag test=tag'
+        )
+
+        json_output = json.loads(self.openstack(cmd))
+        print(json_output)

otcextensions/tests/functional/osclient/compute/v2/__init__.py

@@ -0,0 +1,4 @@
+---
+fixes:
+  - |
+    Fixed Compute CLI overrides according latest upstream changes

otcextensions/tests/functional/osclient/compute/v2/test_server_tag.py

@@ -87,7 +87,7 @@ commands =
 # W503 Is supposed to be off by default but in the latest pycodestyle isn't.
 #      Also, both openstacksdk and Donald Knuth disagree with the rule. Line
 #      breaks should occur before the binary operator for readability.
-ignore = H306,H4,W503
+ignore = H306,H4,W503,E231
 show-source = True
 exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build,openstack/_services_mixin.py