python-openstackclient 9.0.0__py3-none-any.whl → 10.1.0__py3-none-any.whl

openstackclient/shell.py

@@ -16,7 +16,9 @@
 
 """Command-line interface to the OpenStack APIs"""
 
+import argparse
 import sys
+from typing import Any
 import warnings
 
 from osc_lib.api import auth
@@ -31,14 +33,16 @@ DEFAULT_DOMAIN = 'default'
 # core OSC
 IGNORED_MODULES = (
     'neutron_taas.taas_client.osc',
+    'neutronclient.osc.v2.fwaas',
     'neutronclient.osc.v2.taas',
+    'neutronclient.osc.v2.networking_bgpvpn',
 )
 
 
 class OpenStackShell(shell.OpenStackShell):
     client_manager: clientmanager.ClientManager
 
-    def __init__(self):
+    def __init__(self) -> None:
         command_manager = commandmanager.CommandManager(
             'openstack.cli', ignored_modules=IGNORED_MODULES
         )
@@ -59,7 +63,12 @@ class OpenStackShell(shell.OpenStackShell):
         # about them
         warnings.filterwarnings('ignore', module='openstack')
 
-    def build_option_parser(self, description, version, argparse_kwargs=None):
+    def build_option_parser(
+        self,
+        description: str | None,
+        version: str | None,
+        argparse_kwargs: dict[str, Any] | None = None,
+    ) -> argparse.ArgumentParser:
         parser = super().build_option_parser(
             description, version, argparse_kwargs
         )
@@ -67,7 +76,7 @@ class OpenStackShell(shell.OpenStackShell):
         parser = auth.build_auth_plugins_option_parser(parser)
         return parser
 
-    def _final_defaults(self):
+    def _final_defaults(self) -> None:
         super()._final_defaults()
 
         # Set the default plugin to admin_token if endpoint and token are given
@@ -77,7 +86,7 @@ class OpenStackShell(shell.OpenStackShell):
         else:
             self._auth_type = 'password'
 
-    def _load_plugins(self):
+    def _load_plugins(self) -> None:
         """Load plugins via stevedore."""
         # Loop through extensions to get API versions
         for mod in clientmanager.PLUGIN_MODULES:
@@ -128,16 +137,43 @@ class OpenStackShell(shell.OpenStackShell):
                             },
                         )
 
-                # Command groups deal only with major versions
-                version = '.v' + version_opt.replace('.', '_').split('_')[0]
-                cmd_group = 'openstack.' + api.replace('-', '_') + version
+                # Build our command group which we expect to look like:
+                #
+                #   openstack.<service>.vN
+                #
+                # Note that command groups deal only with major versions
+                cmd_group = '.'.join(
+                    [
+                        'openstack',
+                        api.replace('-', '_'),
+                        'v' + version_opt.replace('.', '_').split('_')[0],
+                    ]
+                )
                 self.command_manager.add_command_group(cmd_group)
                 self.log.debug(
                     '%(name)s API version %(version)s, cmd group %(group)s',
                     {'name': api, 'version': version_opt, 'group': cmd_group},
                 )
 
-    def _load_commands(self):
+                mod_extensions = getattr(mod, 'API_EXTENSIONS', None)
+                if not mod_extensions:
+                    continue
+
+                for extension in mod_extensions:
+                    extension_cmd_group = '.'.join([cmd_group, extension])
+                    self.command_manager.add_command_group(extension_cmd_group)
+                    self.log.debug(
+                        '%(name)s API version %(version)s '
+                        '(%(extension)s extension), cmd group %(group)s',
+                        {
+                            'name': api,
+                            'version': version_opt,
+                            'extension': extension,
+                            'group': cmd_group,
+                        },
+                    )
+
+    def _load_commands(self) -> None:
         """Load commands via cliff/stevedore
 
         osc-lib has no opinion on what commands should be loaded
@@ -157,7 +193,7 @@ class OpenStackShell(shell.OpenStackShell):
         # }
         self.command_manager.add_command_group('openstack.extension')
 
-    def initialize_app(self, argv):
+    def initialize_app(self, argv: list[str]) -> None:
         super().initialize_app(argv)
 
         # Re-create the client_manager with our subclass
@@ -168,7 +204,7 @@ class OpenStackShell(shell.OpenStackShell):
         )
 
 
-def main(argv=None):
+def main(argv: list[str] | None = None) -> int:
     if argv is None:
         argv = sys.argv[1:]
 

openstackclient/tests/functional/base.py

@@ -10,11 +10,13 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+from collections.abc import Iterable, Mapping, Sequence
 import json
 import logging
 import os
 import shlex
 import subprocess
+from typing import Any, Literal, cast, overload
 
 from tempest.lib.cli import output_parser
 from tempest.lib import exceptions
@@ -24,7 +26,7 @@ ADMIN_CLOUD = os.environ.get('OS_ADMIN_CLOUD', 'devstack-admin')
 LOG = logging.getLogger(__name__)
 
 
-def execute(cmd, *, fail_ok=False):
+def execute(cmd: str, *, fail_ok: bool = False) -> str:
     """Executes specified command for the given action."""
     LOG.debug('Executing: %s', cmd)
     cmdlist = shlex.split(cmd)
@@ -53,15 +55,37 @@ def execute(cmd, *, fail_ok=False):
 
 
 class TestCase(testtools.TestCase):
+    @overload
     @classmethod
     def openstack(
         cls,
-        cmd,
+        cmd: str,
         *,
-        cloud=ADMIN_CLOUD,
-        fail_ok=False,
-        parse_output=False,
-    ):
+        cloud: str | None = ADMIN_CLOUD,
+        fail_ok: bool = False,
+        parse_output: Literal[False] = False,
+    ) -> str: ...
+
+    @overload
+    @classmethod
+    def openstack(
+        cls,
+        cmd: str,
+        *,
+        cloud: str | None = ADMIN_CLOUD,
+        fail_ok: bool = False,
+        parse_output: Literal[True] = ...,
+    ) -> Any: ...
+
+    @classmethod
+    def openstack(
+        cls,
+        cmd: str,
+        *,
+        cloud: str | None = ADMIN_CLOUD,
+        fail_ok: bool = False,
+        parse_output: bool = False,
+    ) -> str | Any:
         """Executes openstackclient command for the given action
 
         :param cmd: A string representation of the command to execute.
@@ -92,7 +116,7 @@ class TestCase(testtools.TestCase):
             format_args.append('-f json')
 
         output = execute(
-            ' '.join(['openstack'] + auth_args + [cmd] + format_args),
+            ' '.join(['openstack', *auth_args, cmd, *format_args]),
             fail_ok=fail_ok,
         )
 
@@ -106,7 +130,9 @@ class TestCase(testtools.TestCase):
             return output
 
     @classmethod
-    def is_service_enabled(cls, service, version=None):
+    def is_service_enabled(
+        cls, service: str, version: str | None = None
+    ) -> bool:
         """Ask client cloud if service is available
 
         :param service: The service name or type. This should be either an
@@ -126,7 +152,9 @@ class TestCase(testtools.TestCase):
         return bool(ret)
 
     @classmethod
-    def is_extension_enabled(cls, alias, *, service='network'):
+    def is_extension_enabled(
+        cls, alias: str, *, service: str = 'network'
+    ) -> bool:
         """Ask client cloud if extension is enabled"""
         extensions = cls.openstack(
             f'extension list --{service}',
@@ -135,38 +163,44 @@ class TestCase(testtools.TestCase):
         return alias in [x['Alias'] for x in extensions]
 
     @classmethod
-    def get_openstack_configuration_value(cls, configuration):
+    def get_openstack_configuration_value(cls, configuration: str) -> str:
         opts = cls.get_opts([configuration])
         return cls.openstack('configuration show ' + opts)
 
     @classmethod
-    def get_opts(cls, fields, output_format='value'):
+    def get_opts(cls, fields: list[str], output_format: str = 'value') -> str:
         return ' -f {} {}'.format(
             output_format, ' '.join(['-c ' + it for it in fields])
         )
 
     @classmethod
-    def assertOutput(cls, expected, actual):
+    def assertOutput(cls, expected: str, actual: str) -> None:
         if expected != actual:
             raise Exception(expected + ' != ' + actual)
 
     @classmethod
-    def assertInOutput(cls, expected, actual):
+    def assertInOutput(cls, expected: str, actual: str) -> None:
         if expected not in actual:
             raise Exception(expected + ' not in ' + actual)
 
     @classmethod
-    def assertsOutputNotNone(cls, observed):
+    def assertsOutputNotNone(cls, observed: Any) -> None:
         if observed is None:
             raise Exception('No output observed')
 
-    def assert_table_structure(self, items, field_names):
+    def assert_table_structure(
+        self, items: Iterable[Mapping[str, Any]], field_names: Sequence[str]
+    ) -> None:
         """Verify that all items have keys listed in field_names."""
         for item in items:
             for field in field_names:
                 self.assertIn(field, item)
 
-    def assert_show_fields(self, show_output, field_names):
+    def assert_show_fields(
+        self,
+        show_output: Iterable[Mapping[str, Any]],
+        field_names: Sequence[str],
+    ) -> None:
         """Verify that all items have keys listed in field_names."""
 
         # field_names = ['name', 'description']
@@ -186,17 +220,18 @@ class TestCase(testtools.TestCase):
             o.update(item)
         return o
 
-    def parse_show(self, raw_output):
+    def parse_show(self, raw_output: str) -> list[dict[str, Any]]:
         """Return list of dicts with item values parsed from cli output."""
 
         items = []
         table_ = output_parser.table(raw_output)
         for row in table_['values']:
             item = {}
-            item[row[0]] = row[1]
+            item[str(row[0])] = row[1]
             items.append(item)
         return items
 
-    def parse_listing(self, raw_output):
+    def parse_listing(self, raw_output: str) -> list[dict[str, Any]]:
         """Return list of dicts with basic item parsed from cli output."""
-        return output_parser.listing(raw_output)
+        # need to add hints to tempest
+        return cast(list[dict[str, Any]], output_parser.listing(raw_output))

openstackclient/tests/functional/common/test_extension.py

@@ -13,6 +13,8 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+from typing import ClassVar
+
 from tempest.lib import exceptions as tempest_exc
 
 from openstackclient.tests.functional import base
@@ -21,6 +23,8 @@ from openstackclient.tests.functional import base
 class ExtensionTests(base.TestCase):
     """Functional tests for extension"""
 
+    haz_network: ClassVar[bool]
+
     @classmethod
     def setUpClass(cls):
         super().setUpClass()

openstackclient/tests/functional/common/test_quota.py

@@ -10,6 +10,7 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+from typing import ClassVar
 import uuid
 
 from tempest.lib.common.utils import data_utils
@@ -25,7 +26,8 @@ class QuotaTests(base.TestCase):
     test runs as these may run in parallel and otherwise step on each other.
     """
 
-    PROJECT_NAME: str
+    haz_network: ClassVar[bool]
+    PROJECT_NAME: ClassVar[str]
 
     @classmethod
     def setUpClass(cls):

openstackclient/tests/functional/compute/v2/common.py

@@ -12,6 +12,7 @@
 #
 
 import time
+from typing import cast
 import uuid
 
 from tempest.lib import exceptions
@@ -35,18 +36,18 @@ class ComputeTestCase(base.TestCase):
 
     @classmethod
     def get_flavor(cls) -> str:
+        valid_flavors = ['m1.tiny', 'cirros256']
         # NOTE(rtheis): Get cirros256 or m1.tiny flavors since functional
         #               tests may create other flavors.
         flavors = cls.openstack("flavor list", parse_output=True)
-        server_flavor = None
         for flavor in flavors:
             if flavor['Name'] in ['m1.tiny', 'cirros256']:
-                server_flavor = flavor['Name']
-                break
-
-        assert server_flavor is not None
+                return cast(str, flavor['Name'])
 
-        return server_flavor
+        raise Exception(
+            f'Failed to find a suitable flavor. Required one of: '
+            f'{", ".join(valid_flavors)}'
+        )
 
     @classmethod
     def get_image(cls) -> str:
@@ -54,18 +55,17 @@ class ComputeTestCase(base.TestCase):
         #               create other images.  Image may be named '-uec' or
         #               '-disk'.
         images = cls.openstack("image list", parse_output=True)
-        server_image = None
         for image in images:
             if image['Name'].startswith('cirros-') and (
                 image['Name'].endswith('-uec')
                 or image['Name'].endswith('-disk')
             ):
-                server_image = image['Name']
-                break
+                return cast(str, image['Name'])
 
-        assert server_image is not None
-
-        return server_image
+        raise Exception(
+            'Failed to find a suitable image. Required one matching one of '
+            'the following patterns: cirros-*-uec, cirros-*-disk'
+        )
 
     @classmethod
     def get_network(cls) -> str:
@@ -78,7 +78,8 @@ class ComputeTestCase(base.TestCase):
             )
         except exceptions.CommandFailed:
             return ''
-        return '--nic net-id=' + cmd_output['id']
+
+        return '='.join(('--nic net-id', cmd_output['id']))
 
     def server_create(self, name=None, cleanup=True):
         """Create server, with cleanup"""

openstackclient/tests/functional/compute/v2/test_flavor.py

@@ -10,6 +10,7 @@
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+from typing import ClassVar
 import uuid
 
 from openstackclient.tests.functional import base
@@ -19,6 +20,7 @@ class FlavorTests(base.TestCase):
     """Functional tests for flavor."""
 
     PROJECT_NAME = uuid.uuid4().hex
+    PROJECT_ID: ClassVar[str]
 
     @classmethod
     def setUpClass(cls):
@@ -28,7 +30,7 @@ class FlavorTests(base.TestCase):
             "project create --enable " + cls.PROJECT_NAME,
             parse_output=True,
         )
-        cls.project_id = cmd_output["id"]
+        cls.PROJECT_ID = cmd_output["id"]
 
     @classmethod
     def tearDownClass(cls):

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

@@ -13,6 +13,7 @@
 import itertools
 import json
 import time
+from typing import ClassVar
 import uuid
 
 from tempest.lib import exceptions
@@ -25,6 +26,8 @@ from openstackclient.tests.functional.volume.v2 import common as volume_common
 class ServerTests(common.ComputeTestCase):
     """Functional tests for openstack server commands"""
 
+    haz_network: ClassVar[bool]
+
     @classmethod
     def setUpClass(cls):
         super().setUpClass()

openstackclient/tests/functional/identity/v2/common.py

@@ -11,6 +11,7 @@
 #    under the License.
 
 import os
+from typing import ClassVar
 import unittest
 
 import fixtures
@@ -57,19 +58,22 @@ class IdentityTests(base.TestCase):
     CATALOG_LIST_HEADERS = ['Name', 'Type', 'Endpoints']
     ENDPOINT_LIST_HEADERS = ['ID', 'Region', 'Service Name', 'Service Type']
 
+    PROJECT_NAME: ClassVar[str]
+    PROJECT_DESCRIPTION: ClassVar[str]
+
     @classmethod
     def setUpClass(cls):
         super().setUpClass()
         # create dummy project
-        cls.project_name = data_utils.rand_name('TestProject')
-        cls.project_description = data_utils.rand_name('description')
+        cls.PROJECT_NAME = data_utils.rand_name('TestProject')
+        cls.PROJECT_DESCRIPTION = data_utils.rand_name('description')
         try:
             cls.openstack(
                 '--os-identity-api-version 2 '
                 'project create '
-                f'--description {cls.project_description} '
+                f'--description {cls.PROJECT_DESCRIPTION} '
                 '--enable '
-                f'{cls.project_name}'
+                f'{cls.PROJECT_NAME}'
             )
         except tempest_exceptions.CommandFailed:
             # Good chance this is due to Identity v2 admin not being enabled
@@ -83,7 +87,7 @@ class IdentityTests(base.TestCase):
         try:
             cls.openstack(
                 '--os-identity-api-version 2 '
-                f'project delete {cls.project_name}'
+                f'project delete {cls.PROJECT_NAME}'
             )
         finally:
             super().tearDownClass()
@@ -125,7 +129,7 @@ class IdentityTests(base.TestCase):
         email = data_utils.rand_name() + '@example.com'
         raw_output = self.openstack(
             'user create '
-            f'--project {self.project_name} '
+            f'--project {self.PROJECT_NAME} '
             f'--password {password} '
             f'--email {email} '
             '--enable '

openstackclient/tests/functional/identity/v2/test_role.py

@@ -39,14 +39,14 @@ class RoleTests(common.IdentityTests):
         username = self._create_dummy_user()
         raw_output = self.openstack(
             'role add '
-            f'--project {self.project_name} '
+            f'--project {self.PROJECT_NAME} '
             f'--user {username} '
             f'{role_name}'
         )
         self.addCleanup(
             self.openstack,
             'role remove '
-            f'--project {self.project_name} '
+            f'--project {self.PROJECT_NAME} '
             f'--user {username} '
             f'{role_name}',
         )
@@ -58,13 +58,13 @@ class RoleTests(common.IdentityTests):
         username = self._create_dummy_user()
         add_raw_output = self.openstack(
             'role add '
-            f'--project {self.project_name} '
+            f'--project {self.PROJECT_NAME} '
             f'--user {username} '
             f'{role_name}'
         )
         del_raw_output = self.openstack(
             'role remove '
-            f'--project {self.project_name} '
+            f'--project {self.PROJECT_NAME} '
             f'--user {username} '
             f'{role_name}'
         )