typing: Typing updates for openstacksdk 4.15.0

More of SDK is typed. That exposes more bugs.

Change-Id: I8a9a839e2d06a8b29b0b596ca8233a59979deba1
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>

Author: stephenfin

openstackclient/compute/v2/console.py

@@ -155,6 +155,8 @@ def take_action(
         )
 
         display_columns, columns = _get_console_columns(console)
-        data = utils.get_dict_properties(console, columns)
+        # this is a bug in SDK
+        # https://review.opendev.org/c/openstack/openstacksdk/+/992548
+        data = utils.get_dict_properties(console, columns)  # type: ignore[arg-type]
 
         return (display_columns, data)

openstackclient/compute/v2/console_connection.py

@@ -49,8 +49,10 @@ def take_action(
         self, parsed_args: argparse.Namespace
     ) -> tuple[Sequence[str], Iterable[Any]]:
         compute_client = self.app.client_manager.compute
-        data = compute_client.validate_console_auth_token(parsed_args.token)
-        display_columns, columns = _get_console_connection_columns(data)
-        data = utils.get_dict_properties(data, columns)
+        auth_token = compute_client.validate_console_auth_token(
+            parsed_args.token
+        )
+        display_columns, columns = _get_console_connection_columns(auth_token)
+        data = utils.get_dict_properties(auth_token, columns)
 
         return (display_columns, data)

openstackclient/compute/v2/server.py

@@ -703,9 +703,10 @@ def take_action(self, parsed_args: argparse.Namespace) -> None:
         errors = 0
         for security_group in security_groups:
             try:
+                # SDK wants a SecurityGroup object but will handle a dict
                 compute_client.add_security_group_to_server(
                     server,
-                    {'name': security_group},
+                    {'name': security_group},  # type: ignore[arg-type]
                 )
             except sdk_exceptions.HttpException as e:
                 errors += 1
@@ -4214,9 +4215,10 @@ def take_action(self, parsed_args: argparse.Namespace) -> None:
         errors = 0
         for security_group in security_groups:
             try:
+                # SDK wants a SecurityGroup object but will handle a dict
                 compute_client.remove_security_group_from_server(
                     server,
-                    {'name': security_group},
+                    {'name': security_group},  # type: ignore[arg-type]
                 )
             except sdk_exceptions.HttpException as e:
                 errors += 1
@@ -4320,17 +4322,17 @@ def take_action(self, parsed_args: argparse.Namespace) -> None:
         compute_client = self.app.client_manager.compute
         image_client = self.app.client_manager.image
 
-        image_ref = None
+        image = None
         if parsed_args.image:
-            image_ref = image_client.find_image(
+            image = image_client.find_image(
                 parsed_args.image, ignore_missing=False
             ).id
 
         server = compute_client.find_server(
             parsed_args.server, ignore_missing=False
         )
         compute_client.rescue_server(
-            server, admin_pass=parsed_args.password, image_ref=image_ref
+            server, admin_pass=parsed_args.password, image=image
         )
 
 

openstackclient/compute/v2/service.py

@@ -20,6 +20,7 @@
 import logging
 from typing import Any
 
+from openstack.compute.v2 import service as _service
 from openstack import utils as sdk_utils
 from osc_lib import exceptions
 from osc_lib import utils
@@ -199,7 +200,7 @@ def get_parser(self, prog_name: str) -> argparse.ArgumentParser:
     @staticmethod
     def _find_service_by_host_and_binary(
         compute_client: Any, host: str, binary: str
-    ) -> Any:
+    ) -> _service.Service:
         """Utility method to find a compute service by host and binary
 
         :param host: the name of the compute service host
@@ -264,13 +265,17 @@ def take_action(self, parsed_args: argparse.Namespace) -> None:
                 enabled = False
 
             if enabled is not None:
+                # these are bugs in SDK
+                # https://review.opendev.org/c/openstack/openstacksdk/+/992549
                 if enabled:
                     compute_client.enable_service(
-                        service_id, parsed_args.host, parsed_args.service
+                        service_id,  # type: ignore[arg-type]
+                        parsed_args.host,
+                        parsed_args.service,
                     )
                 else:
                     compute_client.disable_service(
-                        service_id,
+                        service_id,  # type: ignore[arg-type]
                         parsed_args.host,
                         parsed_args.service,
                         parsed_args.disable_reason,

openstackclient/image/v2/metadef_namespaces.py

@@ -393,9 +393,7 @@ def take_action(self, parsed_args: argparse.Namespace) -> None:
 
         errors = 0
         if parsed_args.all_tags:
-            namespace = image_client.remove_tags_from_metadef_namespace(
-                namespace
-            )
+            image_client.remove_tags_from_metadef_namespace(namespace)
         elif parsed_args.tags:
             for tag in parsed_args.tags:
                 try:

openstackclient/tests/unit/compute/v2/test_server.py

@@ -7539,7 +7539,7 @@ def test_rescue(self):
             self.server.id, ignore_missing=False
         )
         self.compute_client.rescue_server.assert_called_once_with(
-            self.server, admin_pass=None, image_ref=None
+            self.server, admin_pass=None, image=None
         )
         self.assertIsNone(result)
 
@@ -7566,7 +7566,7 @@ def test_rescue_with_image(self):
             self.server.id, ignore_missing=False
         )
         self.compute_client.rescue_server.assert_called_once_with(
-            self.server, admin_pass=None, image_ref=new_image.id
+            self.server, admin_pass=None, image=new_image.id
         )
         self.assertIsNone(result)
 
@@ -7589,7 +7589,7 @@ def test_rescue_with_password(self):
             self.server.id, ignore_missing=False
         )
         self.compute_client.rescue_server.assert_called_once_with(
-            self.server, admin_pass=password, image_ref=None
+            self.server, admin_pass=password, image=None
         )
         self.assertIsNone(result)
 

openstackclient/volume/v2/volume_backup.py

@@ -404,8 +404,12 @@ def take_action(
                 )
                 raise exceptions.CommandError(msg % parsed_args.volume)
 
+        # this is a bug in SDK
+        # https://review.opendev.org/c/openstack/openstacksdk/+/992473
         restore = volume_client.restore_backup(
-            backup.id, volume=volume_id, name=volume_name
+            backup.id,
+            volume=volume_id,  # type: ignore[arg-type]
+            name=volume_name,  # type: ignore[arg-type]
         )
 
         data = utils.get_dict_properties(restore, columns)