python-openstackclient 7.0.0__py3-none-any.whl → 7.1.1__py3-none-any.whl

openstackclient/common/clientmanager.py

@@ -116,7 +116,6 @@ class ClientManager(clientmanager.ClientManager):
 
     def is_network_endpoint_enabled(self):
         """Check if the network endpoint is enabled"""
-
         # NOTE(dtroyer): is_service_available() can also return None if
         #                there is no Service Catalog, callers here are
         #                not expecting that so fold None into True to
@@ -125,43 +124,37 @@ class ClientManager(clientmanager.ClientManager):
 
     def is_compute_endpoint_enabled(self):
         """Check if Compute endpoint is enabled"""
-
         return self.is_service_available('compute') is not False
 
-    def is_volume_endpoint_enabled(self, volume_client):
+    # TODO(stephenfin): Drop volume_client argument in OSC 8.0 or later.
+    def is_volume_endpoint_enabled(self, volume_client=None):
         """Check if volume endpoint is enabled"""
-        # NOTE(jcross): Cinder did some interesting things with their service
-        #               name so we need to figure out which version to look
-        #               for when calling is_service_available()
-        endpoint_data = volume_client.get_endpoint_data()
-        # Not sure how endpoint data stores the api version for v2 API,
-        # for v3 it is a tuple (3, 0)
-        if endpoint_data.api_version and isinstance(
-            endpoint_data.api_version, tuple
-        ):
-            volume_version = endpoint_data.api_version[0]
-        else:
-            # Setting volume_version as 2 here if it doesn't satisfy the
-            # conditions for version 3
-            volume_version = 2
-        if (
-            self.is_service_available("volumev%s" % volume_version)
-            is not False
-        ):
-            return True
-        elif self.is_service_available('volume') is not False:
-            return True
-        else:
-            return False
+        return (
+            self.is_service_available('volume') is not False
+            or self.is_service_available('volumev3') is not False
+            or self.is_service_available('volumev2') is not False
+        )
 
 
 # Plugin Support
 
 
+def _on_load_failure_callback(
+    manager: stevedore.ExtensionManager,
+    ep: importlib.metadata.EntryPoint,
+    err: Exception,
+) -> None:
+    sys.stderr.write(
+        f"WARNING: Failed to import plugin {ep.group}:{ep.name}: {err}.\n"
+    )
+
+
 def get_plugin_modules(group):
     """Find plugin entry points"""
     mod_list = []
-    mgr = stevedore.ExtensionManager(group)
+    mgr = stevedore.ExtensionManager(
+        group, on_load_failure_callback=_on_load_failure_callback
+    )
     for ep in mgr:
         LOG.debug('Found plugin %s', ep.name)
 
@@ -180,9 +173,8 @@ def get_plugin_modules(group):
             module = importlib.import_module(module_name)
         except Exception as err:
             sys.stderr.write(
-                "WARNING: Failed to import plugin {}: {}.\n".format(
-                    ep.name, err
-                )
+                f"WARNING: Failed to import plugin {ep.group}:{ep.name}: "
+                f"{err}.\n"
             )
             continue
 

openstackclient/common/limits.py

@@ -101,9 +101,6 @@ class ShowLimits(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
-        compute_client = self.app.client_manager.sdk_connection.compute
-        volume_client = self.app.client_manager.sdk_connection.volume
-
         project_id = None
         if parsed_args.project is not None:
             identity_client = self.app.client_manager.identity
@@ -125,11 +122,13 @@ 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_limits = compute_client.get_limits(
                 reserved=parsed_args.is_reserved, tenant_id=project_id
             )
 
-        if self.app.client_manager.is_volume_endpoint_enabled(volume_client):
+        if self.app.client_manager.is_volume_endpoint_enabled():
+            volume_client = self.app.client_manager.sdk_connection.volume
             volume_limits = volume_client.get_limits(
                 project_id=project_id,
             )

openstackclient/common/quota.py

@@ -565,33 +565,42 @@ class SetQuota(common.NetDetectionMixin, command.Command):
             msg = _('--force cannot be used with --class or --default')
             raise exceptions.CommandError(msg)
 
-        compute_client = self.app.client_manager.sdk_connection.compute
-        volume_client = self.app.client_manager.sdk_connection.volume
-
         compute_kwargs = {}
-        for k, v in COMPUTE_QUOTAS.items():
-            value = getattr(parsed_args, k, None)
-            if value is not None:
-                compute_kwargs[k] = value
+        volume_kwargs = {}
+        network_kwargs = {}
 
-        if compute_kwargs and parsed_args.force is True:
-            compute_kwargs['force'] = parsed_args.force
+        if self.app.client_manager.is_compute_endpoint_enabled():
+            compute_client = self.app.client_manager.sdk_connection.compute
 
-        volume_kwargs = {}
-        for k, v in VOLUME_QUOTAS.items():
-            value = getattr(parsed_args, k, None)
-            if value is not None:
-                if parsed_args.volume_type and k in IMPACT_VOLUME_TYPE_QUOTAS:
-                    k = k + '_%s' % parsed_args.volume_type
-                volume_kwargs[k] = value
+            for k, v in COMPUTE_QUOTAS.items():
+                value = getattr(parsed_args, k, None)
+                if value is not None:
+                    compute_kwargs[k] = value
+
+            if compute_kwargs and parsed_args.force is True:
+                compute_kwargs['force'] = parsed_args.force
+
+        if self.app.client_manager.is_volume_endpoint_enabled():
+            volume_client = self.app.client_manager.sdk_connection.volume
+
+            for k, v in VOLUME_QUOTAS.items():
+                value = getattr(parsed_args, k, None)
+                if value is not None:
+                    if (
+                        parsed_args.volume_type
+                        and k in IMPACT_VOLUME_TYPE_QUOTAS
+                    ):
+                        k = k + '_%s' % parsed_args.volume_type
+                    volume_kwargs[k] = value
 
-        network_kwargs = {}
         if self.app.client_manager.is_network_endpoint_enabled():
+            network_client = self.app.client_manager.network
+
             for k, v in NETWORK_QUOTAS.items():
                 value = getattr(parsed_args, k, None)
                 if value is not None:
                     network_kwargs[k] = value
-        else:
+        elif self.app.client_manager.is_compute_endpoint_enabled():
             for k, v in NOVA_NETWORK_QUOTAS.items():
                 value = getattr(parsed_args, k, None)
                 if value is not None:
@@ -632,11 +641,7 @@ class SetQuota(common.NetDetectionMixin, command.Command):
             compute_client.update_quota_set(project, **compute_kwargs)
         if volume_kwargs:
             volume_client.update_quota_set(project, **volume_kwargs)
-        if (
-            network_kwargs
-            and self.app.client_manager.is_network_endpoint_enabled()
-        ):
-            network_client = self.app.client_manager.network
+        if network_kwargs:
             network_client.update_quota(project, **network_kwargs)
 
 

openstackclient/compute/v2/aggregate.py

@@ -192,40 +192,46 @@ class ListAggregate(command.Lister):
 
         aggregates = list(compute_client.aggregates())
 
+        if sdk_utils.supports_microversion(compute_client, '2.41'):
+            column_headers = ("ID", "UUID")
+            columns = ("id", "uuid")
+        else:
+            column_headers = ("ID",)
+            columns = ("id",)
+
+        column_headers += (
+            "Name",
+            "Availability Zone",
+        )
+        columns += (
+            "name",
+            "availability_zone",
+        )
+
         if parsed_args.long:
             # Remove availability_zone from metadata because Nova doesn't
             for aggregate in aggregates:
                 if 'availability_zone' in aggregate.metadata:
                     aggregate.metadata.pop('availability_zone')
-            # This is the easiest way to change column headers
-            column_headers = (
-                "ID",
-                "Name",
-                "Availability Zone",
+
+            column_headers += (
                 "Properties",
                 "Hosts",
             )
-            columns = (
-                "ID",
-                "Name",
-                "Availability Zone",
-                "Metadata",
-                "Hosts",
-            )
-        else:
-            column_headers = columns = (
-                "ID",
-                "Name",
-                "Availability Zone",
+            columns += (
+                "metadata",
+                "hosts",
             )
 
-        data = (
-            utils.get_item_properties(
-                s, columns, formatters=_aggregate_formatters
-            )
-            for s in aggregates
+        return (
+            column_headers,
+            (
+                utils.get_item_properties(
+                    s, columns, formatters=_aggregate_formatters
+                )
+                for s in aggregates
+            ),
         )
-        return (column_headers, data)
 
 
 class RemoveAggregateHost(command.ShowOne):

openstackclient/compute/v2/hypervisor.py

@@ -165,9 +165,11 @@ class ShowHypervisor(command.ShowOne):
 
     def take_action(self, parsed_args):
         compute_client = self.app.client_manager.sdk_connection.compute
-        hypervisor = compute_client.find_hypervisor(
-            parsed_args.hypervisor, ignore_missing=False
-        ).copy()
+
+        hypervisor_id = compute_client.find_hypervisor(
+            parsed_args.hypervisor, ignore_missing=False, details=False
+        ).id
+        hypervisor = compute_client.get_hypervisor(hypervisor_id).copy()
 
         # Some of the properties in the hypervisor object need to be processed
         # before they get reported to the user. We spend this section

openstackclient/compute/v2/server.py

@@ -3587,6 +3587,9 @@ class RebuildServer(command.ShowOne):
         if parsed_args.name is not None:
             kwargs['name'] = parsed_args.name
 
+        if parsed_args.password is not None:
+            kwargs['admin_password'] = parsed_args.password
+
         if parsed_args.preserve_ephemeral is not None:
             kwargs['preserve_ephemeral'] = parsed_args.preserve_ephemeral
 
@@ -3725,9 +3728,7 @@ class RebuildServer(command.ShowOne):
             msg = _("The server status is not ACTIVE, SHUTOFF or ERROR.")
             raise exceptions.CommandError(msg)
 
-        server = compute_client.rebuild_server(
-            server, image, admin_password=parsed_args.password, **kwargs
-        )
+        server = compute_client.rebuild_server(server, image, **kwargs)
 
         if parsed_args.wait:
             if utils.wait_for_status(
@@ -3839,7 +3840,7 @@ host."""
 
         kwargs = {
             'host': parsed_args.host,
-            'password': parsed_args.password,
+            'admin_password': parsed_args.password,
         }
 
         if not sdk_utils.supports_microversion(compute_client, '2.14'):

openstackclient/identity/v3/application_credential.py

@@ -186,15 +186,15 @@ class CreateApplicationCredential(command.ShowOne):
             application_credential['roles'] = msg
 
         columns = (
-            'ID',
-            'Name',
-            'Description',
-            'Project ID',
-            'Roles',
-            'Unrestricted',
-            'Access Rules',
-            'Expires At',
-            'Secret',
+            'id',
+            'name',
+            'description',
+            'project_id',
+            'roles',
+            'unrestricted',
+            'access_rules',
+            'expires_at',
+            'secret',
         )
         return (
             columns,
@@ -337,14 +337,14 @@ class ShowApplicationCredential(command.ShowOne):
         app_cred['roles'] = msg
 
         columns = (
-            'ID',
-            'Name',
-            'Description',
-            'Project ID',
-            'Roles',
-            'Unrestricted',
-            'Access Rules',
-            'Expires At',
+            'id',
+            'name',
+            'description',
+            'project_id',
+            'roles',
+            'unrestricted',
+            'access_rules',
+            'expires_at',
         )
         return (
             columns,

openstackclient/identity/v3/service.py

@@ -37,11 +37,11 @@ def _format_service(service):
         'description',
     )
     column_headers = (
-        'ID',
-        'Name',
-        'Type',
-        'Enabled',
-        'Description',
+        'id',
+        'name',
+        'type',
+        'enabled',
+        'description',
     )
 
     return (

openstackclient/releasenotes/notes/volume-backup-created-at-list-b49ec893ae1f6b0d.yaml

@@ -0,0 +1,4 @@
+---
+features:
+  - |
+    Listing volume backups now shows the created_at column.

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

@@ -48,7 +48,7 @@ class IdentityTests(base.TestCase):
         'parent_id',
     ]
     ROLE_FIELDS = ['id', 'name', 'domain_id', 'description']
-    SERVICE_FIELDS = ['ID', 'Enabled', 'Name', 'Type', 'Description']
+    SERVICE_FIELDS = ['id', 'enabled', 'name', 'type', 'description']
     REGION_FIELDS = ['description', 'enabled', 'parent_region', 'region']
     ENDPOINT_FIELDS = [
         'id',
@@ -376,7 +376,7 @@ class IdentityTests(base.TestCase):
         if add_clean_up:
             service = self.parse_show_as_object(raw_output)
             self.addCleanup(
-                self.openstack, 'service delete %s' % service['ID']
+                self.openstack, 'service delete %s' % service['id']
             )
         items = self.parse_show(raw_output)
         self.assert_show_fields(items, self.SERVICE_FIELDS)

openstackclient/tests/functional/identity/v3/test_application_credential.py

@@ -21,13 +21,13 @@ from openstackclient.tests.functional.identity.v3 import common
 
 class ApplicationCredentialTests(common.IdentityTests):
     APPLICATION_CREDENTIAL_FIELDS = [
-        'ID',
-        'Name',
-        'Project ID',
-        'Description',
-        'Roles',
-        'Expires At',
-        'Unrestricted',
+        'id',
+        'name',
+        'project_id',
+        'description',
+        'roles',
+        'expires_at',
+        'unrestricted',
     ]
     APPLICATION_CREDENTIAL_LIST_HEADERS = [
         'ID',

openstackclient/tests/functional/identity/v3/test_limit.py

@@ -32,7 +32,7 @@ class LimitTestCase(common.IdentityTests):
 
         raw_output = self.openstack('service show %s' % service_id)
         items = self.parse_show(raw_output)
-        service_name = self._extract_value_from_items('Name', items)
+        service_name = self._extract_value_from_items('name', items)
 
         project_name = self._create_dummy_project()
         raw_output = self.openstack('project show %s' % project_name)
@@ -73,7 +73,7 @@ class LimitTestCase(common.IdentityTests):
 
         raw_output = self.openstack('service show %s' % service_id)
         items = self.parse_show(raw_output)
-        service_name = self._extract_value_from_items('Name', items)
+        service_name = self._extract_value_from_items('name', items)
 
         project_name = self._create_dummy_project()
 

openstackclient/tests/functional/identity/v3/test_registered_limit.py

@@ -29,7 +29,7 @@ class RegisteredLimitTestCase(common.IdentityTests):
             'service show' ' %(service_name)s' % {'service_name': service_name}
         )
         service_items = self.parse_show(raw_output)
-        service_id = self._extract_value_from_items('ID', service_items)
+        service_id = self._extract_value_from_items('id', service_items)
 
         raw_output = self.openstack(
             'registered limit create'

openstackclient/tests/functional/identity/v3/test_service.py

@@ -61,9 +61,9 @@ class ServiceTests(common.IdentityTests):
         raw_output = self.openstack('service show %s' % new_service_name)
         # assert service details
         service = self.parse_show_as_object(raw_output)
-        self.assertEqual(new_service_type, service['Type'])
-        self.assertEqual(new_service_name, service['Name'])
-        self.assertEqual(new_service_description, service['Description'])
+        self.assertEqual(new_service_type, service['type'])
+        self.assertEqual(new_service_name, service['name'])
+        self.assertEqual(new_service_description, service['description'])
 
     def test_service_show(self):
         service_name = self._create_dummy_service()

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

@@ -227,44 +227,6 @@ class TestAggregateDelete(TestAggregate):
 
 
 class TestAggregateList(TestAggregate):
-    list_columns = (
-        "ID",
-        "Name",
-        "Availability Zone",
-    )
-
-    list_columns_long = (
-        "ID",
-        "Name",
-        "Availability Zone",
-        "Properties",
-        "Hosts",
-    )
-
-    list_data = (
-        (
-            TestAggregate.fake_ag.id,
-            TestAggregate.fake_ag.name,
-            TestAggregate.fake_ag.availability_zone,
-        ),
-    )
-
-    list_data_long = (
-        (
-            TestAggregate.fake_ag.id,
-            TestAggregate.fake_ag.name,
-            TestAggregate.fake_ag.availability_zone,
-            format_columns.DictColumn(
-                {
-                    key: value
-                    for key, value in TestAggregate.fake_ag.metadata.items()
-                    if key != 'availability_zone'
-                }
-            ),
-            format_columns.ListColumn(TestAggregate.fake_ag.hosts),
-        ),
-    )
-
     def setUp(self):
         super().setUp()
 
@@ -272,13 +234,54 @@ class TestAggregateList(TestAggregate):
         self.cmd = aggregate.ListAggregate(self.app, None)
 
     def test_aggregate_list(self):
+        self.set_compute_api_version('2.41')
+
+        parsed_args = self.check_parser(self.cmd, [], [])
+        columns, data = self.cmd.take_action(parsed_args)
+
+        expected_columns = (
+            "ID",
+            "UUID",
+            "Name",
+            "Availability Zone",
+        )
+        expected_data = (
+            (
+                self.fake_ag.id,
+                self.fake_ag.uuid,
+                self.fake_ag.name,
+                self.fake_ag.availability_zone,
+            ),
+        )
+
+        self.assertEqual(expected_columns, columns)
+        self.assertCountEqual(expected_data, tuple(data))
+
+    def test_aggregate_list_pre_v241(self):
+        self.set_compute_api_version('2.40')
+
         parsed_args = self.check_parser(self.cmd, [], [])
         columns, data = self.cmd.take_action(parsed_args)
 
-        self.assertEqual(self.list_columns, columns)
-        self.assertCountEqual(self.list_data, tuple(data))
+        expected_columns = (
+            "ID",
+            "Name",
+            "Availability Zone",
+        )
+        expected_data = (
+            (
+                self.fake_ag.id,
+                self.fake_ag.name,
+                self.fake_ag.availability_zone,
+            ),
+        )
+
+        self.assertEqual(expected_columns, columns)
+        self.assertCountEqual(expected_data, tuple(data))
 
     def test_aggregate_list_with_long(self):
+        self.set_compute_api_version('2.41')
+
         arglist = [
             '--long',
         ]
@@ -288,8 +291,33 @@ class TestAggregateList(TestAggregate):
         parsed_args = self.check_parser(self.cmd, arglist, vertifylist)
         columns, data = self.cmd.take_action(parsed_args)
 
-        self.assertEqual(self.list_columns_long, columns)
-        self.assertCountEqual(self.list_data_long, tuple(data))
+        expected_columns = (
+            "ID",
+            "UUID",
+            "Name",
+            "Availability Zone",
+            "Properties",
+            "Hosts",
+        )
+        expected_data = (
+            (
+                self.fake_ag.id,
+                self.fake_ag.uuid,
+                self.fake_ag.name,
+                self.fake_ag.availability_zone,
+                format_columns.DictColumn(
+                    {
+                        key: value
+                        for key, value in self.fake_ag.metadata.items()
+                        if key != 'availability_zone'
+                    }
+                ),
+                format_columns.ListColumn(self.fake_ag.hosts),
+            ),
+        )
+
+        self.assertEqual(expected_columns, columns)
+        self.assertCountEqual(expected_data, tuple(data))
 
 
 class TestAggregateRemoveHost(TestAggregate):

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

@@ -296,13 +296,11 @@ class TestHypervisorShow(compute_fakes.TestComputev2):
             }
         )
 
-        # Return value of compute_client.find_hypervisor
         self.compute_sdk_client.find_hypervisor.return_value = self.hypervisor
+        self.compute_sdk_client.get_hypervisor.return_value = self.hypervisor
 
-        # Return value of compute_client.aggregates()
         self.compute_sdk_client.aggregates.return_value = []
 
-        # Return value of compute_client.get_hypervisor_uptime()
         uptime_info = {
             'status': self.hypervisor.status,
             'state': self.hypervisor.state,
@@ -429,6 +427,13 @@ class TestHypervisorShow(compute_fakes.TestComputev2):
         self.assertEqual(self.columns_v288, columns)
         self.assertCountEqual(self.data_v288, data)
 
+        self.compute_sdk_client.find_hypervisor.assert_called_once_with(
+            self.hypervisor.name, ignore_missing=False, details=False
+        )
+        self.compute_sdk_client.get_hypervisor.assert_called_once_with(
+            self.hypervisor.id
+        )
+
     def test_hypervisor_show_pre_v288(self):
         self.set_compute_api_version('2.87')
 
@@ -448,6 +453,13 @@ class TestHypervisorShow(compute_fakes.TestComputev2):
         self.assertEqual(self.columns, columns)
         self.assertCountEqual(self.data, data)
 
+        self.compute_sdk_client.find_hypervisor.assert_called_once_with(
+            self.hypervisor.name, ignore_missing=False, details=False
+        )
+        self.compute_sdk_client.get_hypervisor.assert_called_once_with(
+            self.hypervisor.id
+        )
+
     def test_hypervisor_show_pre_v228(self):
         self.set_compute_api_version('2.27')
 
@@ -472,6 +484,13 @@ class TestHypervisorShow(compute_fakes.TestComputev2):
         self.assertEqual(self.columns, columns)
         self.assertCountEqual(self.data, data)
 
+        self.compute_sdk_client.find_hypervisor.assert_called_once_with(
+            self.hypervisor.name, ignore_missing=False, details=False
+        )
+        self.compute_sdk_client.get_hypervisor.assert_called_once_with(
+            self.hypervisor.id
+        )
+
     def test_hypervisor_show_uptime_not_implemented(self):
         self.set_compute_api_version('2.87')
 
@@ -543,3 +562,10 @@ class TestHypervisorShow(compute_fakes.TestComputev2):
 
         self.assertEqual(expected_columns, columns)
         self.assertCountEqual(expected_data, data)
+
+        self.compute_sdk_client.find_hypervisor.assert_called_once_with(
+            self.hypervisor.name, ignore_missing=False, details=False
+        )
+        self.compute_sdk_client.get_hypervisor.assert_called_once_with(
+            self.hypervisor.id
+        )