python-openstackclient 7.4.0__py3-none-any.whl → 8.1.0__py3-none-any.whl

openstackclient/common/availability_zone.py

@@ -117,7 +117,7 @@ class ListAvailabilityZone(command.Lister):
         return parser
 
     def _get_compute_availability_zones(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         try:
             data = list(compute_client.availability_zones(details=True))
         except sdk_exceptions.ForbiddenException:  # policy doesn't allow
@@ -172,17 +172,14 @@ class ListAvailabilityZone(command.Lister):
         return result
 
     def take_action(self, parsed_args):
+        columns: tuple[str, ...] = ('Zone Name', 'Zone Status')
         if parsed_args.long:
-            columns = (
-                'Zone Name',
-                'Zone Status',
+            columns += (
                 'Zone Resource',
                 'Host Name',
                 'Service Name',
                 'Service Status',
             )
-        else:
-            columns = ('Zone Name', 'Zone Status')
 
         # Show everything by default.
         show_all = (

openstackclient/common/clientmanager.py

@@ -18,6 +18,7 @@
 import importlib
 import logging
 import sys
+import typing as ty
 
 from osc_lib import clientmanager
 from osc_lib import shell
@@ -26,7 +27,7 @@ import stevedore
 
 LOG = logging.getLogger(__name__)
 
-PLUGIN_MODULES = []
+PLUGIN_MODULES: list[ty.Any] = []
 
 USER_AGENT = 'python-openstackclient'
 

openstackclient/common/envvars.py

@@ -0,0 +1,57 @@
+# 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 os
+
+from openstackclient.i18n import _
+
+
+def bool_from_str(value, strict=False):
+    true_strings = ('1', 't', 'true', 'on', 'y', 'yes')
+    false_strings = ('0', 'f', 'false', 'off', 'n', 'no')
+
+    if isinstance(value, bool):
+        return value
+
+    lowered = value.strip().lower()
+    if lowered in true_strings:
+        return True
+    elif lowered in false_strings or not strict:
+        return False
+
+    msg = _(
+        "Unrecognized value '%(value)s'; acceptable values are: %(valid)s"
+    ) % {
+        'value': value,
+        'valid': ', '.join(
+            f"'{s}'" for s in sorted(true_strings + false_strings)
+        ),
+    }
+    raise ValueError(msg)
+
+
+def boolenv(*vars, default=False):
+    """Search for the first defined of possibly many bool-like env vars.
+
+    Returns the first environment variable defined in vars, or returns the
+    default.
+
+    :param vars: Arbitrary strings to search for. Case sensitive.
+    :param default: The default to return if no value found.
+    :returns: A boolean corresponding to the value found, else the default if
+        no value found.
+    """
+    for v in vars:
+        value = os.environ.get(v, None)
+        if value:
+            return bool_from_str(value)
+    return default

openstackclient/common/extension.py

@@ -73,17 +73,9 @@ class ListExtension(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
+        columns: tuple[str, ...] = ('Name', 'Alias', 'Description')
         if parsed_args.long:
-            columns = (
-                'Name',
-                'Alias',
-                'Description',
-                'Namespace',
-                'Updated At',
-                'Links',
-            )
-        else:
-            columns = ('Name', 'Alias', 'Description')
+            columns += ('Namespace', 'Updated At', 'Links')
 
         data = []
 
@@ -106,7 +98,7 @@ class ListExtension(command.Lister):
                 LOG.warning(message)
 
         if parsed_args.compute or show_all:
-            compute_client = self.app.client_manager.sdk_connection.compute
+            compute_client = self.app.client_manager.compute
             try:
                 data += compute_client.extensions()
             except Exception:

openstackclient/common/limits.py

@@ -122,7 +122,7 @@ class ShowLimits(command.Lister):
         volume_limits = None
 
         if self.app.client_manager.is_compute_endpoint_enabled():
-            compute_client = self.app.client_manager.sdk_connection.compute
+            compute_client = self.app.client_manager.compute
             compute_limits = compute_client.get_limits(
                 reserved=parsed_args.is_reserved, tenant_id=project_id
             )

openstackclient/common/project_cleanup.py

@@ -17,6 +17,7 @@ import getpass
 import logging
 import os
 import queue
+import typing as ty
 
 from cliff.formatters import table
 from osc_lib.command import command
@@ -35,7 +36,7 @@ def ask_user_yesno(msg):
     :return bool: User choice
     """
     while True:
-        answer = getpass._raw_input('{} [{}]: '.format(msg, 'y/n'))
+        answer = getpass.getpass('{} [{}]: '.format(msg, 'y/n'))
         if answer in ('y', 'Y', 'yes'):
             return True
         elif answer in ('n', 'N', 'no'):
@@ -100,7 +101,7 @@ class ProjectCleanup(command.Command):
             project_connect = sdk.connect_as_project(project)
 
         if project_connect:
-            status_queue = queue.Queue()
+            status_queue: queue.Queue[ty.Any] = queue.Queue()
             parsed_args.max_width = int(
                 os.environ.get('CLIFF_MAX_TERM_WIDTH', 0)
             )

openstackclient/common/quota.py

@@ -18,6 +18,7 @@ import argparse
 import itertools
 import logging
 import sys
+import typing as ty
 
 from openstack import exceptions as sdk_exceptions
 from osc_lib.command import command
@@ -132,7 +133,7 @@ def get_compute_quotas(
     default=False,
 ):
     try:
-        client = app.client_manager.sdk_connection.compute
+        client = app.client_manager.compute
         if default:
             quota = client.get_quota_set_defaults(project_id)
         else:
@@ -176,25 +177,37 @@ def get_network_quotas(
     default=False,
 ):
     def _network_quota_to_dict(network_quota, detail=False):
-        if not isinstance(network_quota, dict):
-            dict_quota = network_quota.to_dict()
-        else:
-            dict_quota = network_quota
-
-        result = {}
-
+        dict_quota = network_quota.to_dict(computed=False)
+
+        if not detail:
+            return dict_quota
+
+        # Neutron returns quota details in dict which is in format like:
+        # {'resource_name': {'in_use': X, 'limit': Y, 'reserved': Z},
+        #  'resource_name_2': {'in_use': X2, 'limit': Y2, 'reserved': Z2}}
+        #
+        # but Nova and Cinder returns quota in different format, like:
+        # {'resource_name': X,
+        #  'resource_name_2': X2,
+        #  'usage': {
+        #     'resource_name': Y,
+        #     'resource_name_2': Y2
+        #  },
+        #  'reserved': {
+        #     'resource_name': Z,
+        #     'resource_name_2': Z2
+        #  }}
+        #
+        # so we need to make conversion to have data in same format from
+        # all of the services
+        result: dict[str, ty.Any] = {"usage": {}, "reservation": {}}
         for key, values in dict_quota.items():
             if values is None:
                 continue
-
-            # NOTE(slaweq): Neutron returns values with key "used" but Nova for
-            # example returns same data with key "in_use" instead. Because of
-            # that we need to convert Neutron key to the same as is returned
-            # from Nova to make result more consistent
-            if isinstance(values, dict) and 'used' in values:
-                values['in_use'] = values.pop("used")
-
-            result[key] = values
+            if isinstance(values, dict):
+                result[key] = values['limit']
+                result["reservation"][key] = values['reserved']
+                result["usage"][key] = values['used']
 
         return result
 
@@ -243,7 +256,7 @@ class ListQuota(command.Lister):
         return parser
 
     def _list_quota_compute(self, parsed_args, project_ids):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         result = []
 
         for project_id in project_ids:
@@ -278,7 +291,7 @@ class ListQuota(command.Lister):
             if default_result != project_result:
                 result += project_result
 
-        columns = (
+        columns: tuple[str, ...] = (
             'id',
             'cores',
             'injected_files',
@@ -291,7 +304,7 @@ class ListQuota(command.Lister):
             'server_groups',
             'server_group_members',
         )
-        column_headers = (
+        column_headers: tuple[str, ...] = (
             'Project ID',
             'Cores',
             'Injected Files',
@@ -340,7 +353,7 @@ class ListQuota(command.Lister):
             if default_result != project_result:
                 result += project_result
 
-        columns = (
+        columns: tuple[str, ...] = (
             'id',
             'backups',
             'backup_gigabytes',
@@ -349,7 +362,7 @@ class ListQuota(command.Lister):
             'snapshots',
             'volumes',
         )
-        column_headers = (
+        column_headers: tuple[str, ...] = (
             'Project ID',
             'Backups',
             'Backup Gigabytes',
@@ -395,7 +408,7 @@ class ListQuota(command.Lister):
             if default_result != project_result:
                 result += project_result
 
-        columns = (
+        columns: tuple[str, ...] = (
             'id',
             'floating_ips',
             'networks',
@@ -407,7 +420,7 @@ class ListQuota(command.Lister):
             'subnets',
             'subnet_pools',
         )
-        column_headers = (
+        column_headers: tuple[str, ...] = (
             'Project ID',
             'Floating IPs',
             'Networks',
@@ -575,7 +588,7 @@ class SetQuota(common.NetDetectionMixin, command.Command):
         network_kwargs = {}
 
         if self.app.client_manager.is_compute_endpoint_enabled():
-            compute_client = self.app.client_manager.sdk_connection.compute
+            compute_client = self.app.client_manager.compute
 
             for k, v in COMPUTE_QUOTAS.items():
                 value = getattr(parsed_args, k, None)
@@ -756,6 +769,19 @@ and ``server-group-members`` output for a given quota class."""
             )
 
         info = {}
+        if parsed_args.usage:
+            info["reservation"] = compute_quota_info.pop("reservation", {})
+            info["reservation"].update(
+                volume_quota_info.pop("reservation", {})
+            )
+            info["reservation"].update(
+                network_quota_info.pop("reservation", {})
+            )
+
+            info["usage"] = compute_quota_info.pop("usage", {})
+            info["usage"].update(volume_quota_info.pop("usage", {}))
+            info["usage"].update(network_quota_info.pop("usage", {}))
+
         info.update(compute_quota_info)
         info.update(volume_quota_info)
         info.update(network_quota_info)
@@ -798,11 +824,11 @@ and ``server-group-members`` output for a given quota class."""
                 if k not in ('usage', 'reservation')
             ]
 
-        columns = (
+        columns: tuple[str, ...] = (
             'resource',
             'limit',
         )
-        column_headers = (
+        column_headers: tuple[str, ...] = (
             'Resource',
             'Limit',
         )
@@ -881,7 +907,7 @@ class DeleteQuota(command.Command):
 
         # compute quotas
         if parsed_args.service in {'all', 'compute'}:
-            compute_client = self.app.client_manager.sdk_connection.compute
+            compute_client = self.app.client_manager.compute
             compute_client.revert_quota_set(project.id)
 
         # volume quotas

openstackclient/compute/client.py

@@ -11,7 +11,6 @@
 #   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 logging
 
@@ -21,13 +20,11 @@ from openstackclient.i18n import _
 
 LOG = logging.getLogger(__name__)
 
+# global variables used when building the shell
 DEFAULT_API_VERSION = '2.1'
 API_VERSION_OPTION = 'os_compute_api_version'
 API_NAME = 'compute'
-API_VERSIONS = {
-    '2': 'openstack.connection.Connection',
-    '2.1': 'openstack.connection.Connection',
-}
+API_VERSIONS = ('2', '2.1')
 
 
 def make_client(instance):
@@ -49,3 +46,8 @@ def build_option_parser(parser):
         % DEFAULT_API_VERSION,
     )
     return parser
+
+
+def check_api_version(check_version):
+    # SDK supports auto-negotiation for us: always return True
+    return True

openstackclient/compute/v2/agent.py

@@ -56,7 +56,7 @@ class CreateAgent(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         # doing this since openstacksdk has decided not to support this
         # deprecated command
@@ -95,7 +95,7 @@ class DeleteAgent(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         result = 0
         for id in parsed_args.id:
             try:
@@ -114,7 +114,7 @@ class DeleteAgent(command.Command):
 
         if result > 0:
             total = len(parsed_args.id)
-            msg = _("%(result)s of %(total)s agents failed " "to delete.") % {
+            msg = _("%(result)s of %(total)s agents failed to delete.") % {
                 'result': result,
                 'total': total,
             }
@@ -139,7 +139,7 @@ class ListAgent(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         columns = (
             "Agent ID",
             "Hypervisor",
@@ -194,7 +194,7 @@ class SetAgent(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         response = compute_client.get('/os-agents', microversion='2.1')
         sdk_exceptions.raise_from_response(response)

openstackclient/compute/v2/aggregate.py

@@ -17,6 +17,7 @@
 """Compute v2 Aggregate action implementations"""
 
 import logging
+import typing as ty
 
 from openstack import utils as sdk_utils
 from osc_lib.cli import format_columns
@@ -67,7 +68,7 @@ class AddAggregateHost(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         aggregate = compute_client.find_aggregate(
             parsed_args.aggregate, ignore_missing=False
@@ -110,7 +111,7 @@ class CreateAggregate(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         attrs = {'name': parsed_args.name}
 
@@ -146,7 +147,7 @@ class DeleteAggregate(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         result = 0
         for a in parsed_args.aggregate:
             try:
@@ -168,9 +169,10 @@ class DeleteAggregate(command.Command):
 
         if result > 0:
             total = len(parsed_args.aggregate)
-            msg = _(
-                "%(result)s of %(total)s aggregates failed " "to delete."
-            ) % {'result': result, 'total': total}
+            msg = _("%(result)s of %(total)s aggregates failed to delete.") % {
+                'result': result,
+                'total': total,
+            }
             raise exceptions.CommandError(msg)
 
 
@@ -188,13 +190,13 @@ class ListAggregate(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         aggregates = list(compute_client.aggregates())
 
         if sdk_utils.supports_microversion(compute_client, '2.41'):
-            column_headers = ("ID", "UUID")
-            columns = ("id", "uuid")
+            column_headers: tuple[str, ...] = ("ID", "UUID")
+            columns: tuple[str, ...] = ("id", "uuid")
         else:
             column_headers = ("ID",)
             columns = ("id",)
@@ -250,7 +252,7 @@ class RemoveAggregateHost(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         aggregate = compute_client.find_aggregate(
             parsed_args.aggregate, ignore_missing=False
@@ -307,7 +309,7 @@ class SetAggregate(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         aggregate = compute_client.find_aggregate(
             parsed_args.aggregate, ignore_missing=False
         )
@@ -320,7 +322,7 @@ class SetAggregate(command.Command):
         if kwargs:
             compute_client.update_aggregate(aggregate.id, **kwargs)
 
-        properties = {}
+        properties: dict[str, ty.Any] = {}
         if parsed_args.no_property:
             # NOTE(RuiChen): "availability_zone" can not be unset from
             # properties. It is already excluded from show and create output.
@@ -352,7 +354,7 @@ class ShowAggregate(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         aggregate = compute_client.find_aggregate(
             parsed_args.aggregate, ignore_missing=False
         )
@@ -392,7 +394,7 @@ class UnsetAggregate(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         aggregate = compute_client.find_aggregate(
             parsed_args.aggregate, ignore_missing=False
         )
@@ -427,7 +429,7 @@ class CacheImageForAggregate(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         if not sdk_utils.supports_microversion(compute_client, '2.81'):
             msg = _(

openstackclient/compute/v2/console.py

@@ -25,10 +25,9 @@ from openstackclient.i18n import _
 def _get_console_columns(item):
     # To maintain backwards compatibility we need to rename sdk props to
     # whatever OSC was using before
-    column_map = {}
     hidden_columns = ['id', 'links', 'location', 'name']
     return utils.get_osc_show_columns_for_sdk_resource(
-        item, column_map, hidden_columns
+        item, {}, hidden_columns
     )
 
 
@@ -56,7 +55,7 @@ class ShowConsoleLog(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
 
         server = compute_client.find_server(
             name_or_id=parsed_args.server, ignore_missing=False
@@ -107,6 +106,13 @@ class ShowConsoleURL(command.ShowOne):
             const='spice-html5',
             help=_("Show SPICE console URL"),
         )
+        type_group.add_argument(
+            '--spice-direct',
+            dest='url_type',
+            action='store_const',
+            const='spice-direct',
+            help=_("Show SPICE direct protocol native console URL"),
+        )
         type_group.add_argument(
             '--rdp',
             dest='url_type',
@@ -131,7 +137,7 @@ class ShowConsoleURL(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
+        compute_client = self.app.client_manager.compute
         server = compute_client.find_server(
             parsed_args.server, ignore_missing=False
         )

openstackclient/compute/v2/console_connection.py

@@ -0,0 +1,48 @@
+#   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.
+#
+
+"""Compute v2 Console auth token implementations."""
+
+from osc_lib.command import command
+from osc_lib import utils
+
+from openstackclient.i18n import _
+
+
+def _get_console_connection_columns(item):
+    column_map: dict[str, str] = {}
+    hidden_columns = ['id', 'location', 'name']
+    return utils.get_osc_show_columns_for_sdk_resource(
+        item, column_map, hidden_columns
+    )
+
+
+class ShowConsoleConnectionInformation(command.ShowOne):
+    _description = _("Show server's remote console connection information")
+
+    def get_parser(self, prog_name):
+        parser = super().get_parser(prog_name)
+        parser.add_argument(
+            'token',
+            metavar='<token>',
+            help=_("Nova console token to lookup"),
+        )
+        return parser
+
+    def take_action(self, parsed_args):
+        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)
+
+        return (display_columns, data)