python-openstackclient 7.2.1__tar.gz → 7.3.0__tar.gz

{python-openstackclient-7.2.1 → python_openstackclient-7.3.0}/.zuul.yaml

@@ -6,6 +6,11 @@
       Run unit tests for OpenStackClient with master branch of important libs.
 
       Takes advantage of the base tox job's install-siblings feature.
+    irrelevant-files: &common-irrelevant-files
+      - ^.*\.rst$
+      - ^doc/.*$
+      - ^releasenotes/.*$
+      - ^\.pre-commit-config\.yaml$
     required-projects:
       - openstack/cliff
       - openstack/keystoneauth
@@ -81,13 +86,6 @@
         # NOTE(amotoki): Some neutron features are enabled by devstack plugin
         neutron: https://opendev.org/openstack/neutron
       devstack_services:
-        ceilometer-acentral: false
-        ceilometer-acompute: false
-        ceilometer-alarm-evaluator: false
-        ceilometer-alarm-notifier: false
-        ceilometer-anotification: false
-        ceilometer-api: false
-        ceilometer-collector: false
         s-account: true
         s-container: true
         s-object: true

{python-openstackclient-7.2.1 → python_openstackclient-7.3.0}/AUTHORS

@@ -128,6 +128,7 @@ Fan Zhang <zh.f@outlook.com>
 Fang Zhen <zhen.fang@easystack.cn>
 Fei Long Wang <flwang@catalyst.net.nz>
 Felix Yan <felixonmars@archlinux.org>
+Fernando Royo <froyo@redhat.com>
 Flavio Percoco <flaper87@gmail.com>
 Florent Flament <florent.flament-ext@cloudwatt.com>
 Florian Streibelt <florian.streibelt@sap.com>
@@ -439,6 +440,7 @@ Yi Zhao <zhaoyi@cmss.chinamobile.com>
 Yongli He <yongli.he@intel.com>
 YoonSoo LIM <msdbtjd123@naver.com>
 Yoonsoo Lim <msdbtjd123@naver.com>
+Yosef Salmalian <flaslnm@gmail.com>
 Youngjun <yj.yoo@okestro.com>
 YuehuiLei <leiyuehui@inspur.com>
 Yunpeng Li <yunpeng.li@live.cn>

{python-openstackclient-7.2.1 → python_openstackclient-7.3.0}/ChangeLog

@@ -1,10 +1,51 @@
 CHANGES
 =======
 
+7.3.0
+-----
+
+* Add "qinq-vlan" and "no-qinq-vlan" params to the "network create" cmd
+* Temporary ignore "is\_vlan\_qinq" column in the output
+* Identity: Deprecate \`--region None\` in limits/registered limits
+* Get "security\_groups" when port list
+* Show final image state after image create
+* Identity: Migrate 'role' commands to SDK
+* Add the trunk subports information to the port list command
+* Fix: Volume backup restore output
+* identity: Migrate 'trust' commands to SDK
+* tests: Stop setting attributes on class
+* Adopt sdk\_fakes for compute.test\_server\_volume
+* Adopt sdk\_fakes for compute.test\_server\_group
+* Adopt sdk\_fakes for compute.test\_hypervisor
+* Adopt sdk\_fakes for compute.test\_usage
+* Adopt sdk\_fakes for compute.test\_service
+* Adopt sdk\_fakes for compute.test\_keypair
+* Adopt sdk\_fakes for compute.test\_console
+* Adopt sdk\_fakes for compute.aggregate
+* identity: Migrate 'service provider' commands to SDK
+* quota: Catch correct exception type for Compute quotas
+* tests: Add functional test for adding, removing SGs
+* compute: Workaround bug #2089821
+* network: Make better use of argparse
+* compute: Add server create --no-security-group option
+* Remove ceilometer service overrides
+* identity: Migrate \`region\` commands to SDK
+* reno: Update master for unmaintained/2023.1
+* identity: Migrate 'credential' commands to SDK
+* Replace deprecated datetime.utcnow()
+* requirements: Remove unused test deps
+* Skip tips jobs on pre-commit config update
+* common: Use correct argument for volume limits
+* Add "trusted" attribute to the "port"
+* Fix ignored --user-domain in role assignment list
+* Show Created At column for volume backups in v3
+* remove project from network flavor profile
+
 7.2.1
 -----
 
 * clientmanager: Check for 'block-storage' service type
+* Fix volume backup show by name
 
 7.2.0
 -----

python_openstackclient-7.3.0/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.1
+Name: python-openstackclient
+Version: 7.3.0
+Summary: OpenStack Command-line Client
+Home-page: https://docs.openstack.org/python-openstackclient/latest/
+Author: OpenStack
+Author-email: openstack-discuss@lists.openstack.org
+Classifier: Environment :: OpenStack
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+License-File: LICENSE
+Requires-Dist: pbr!=2.1.0,>=2.0.0
+Requires-Dist: cryptography>=2.7
+Requires-Dist: cliff>=3.5.0
+Requires-Dist: iso8601>=0.1.11
+Requires-Dist: openstacksdk>=3.3.0
+Requires-Dist: osc-lib>=2.3.0
+Requires-Dist: oslo.i18n>=3.15.3
+Requires-Dist: python-keystoneclient>=3.22.0
+Requires-Dist: python-cinderclient>=3.3.0
+Requires-Dist: requests>=2.27.0
+Requires-Dist: stevedore>=2.0.1
+
+========================
+Team and repository tags
+========================
+
+.. image:: https://governance.openstack.org/tc/badges/python-openstackclient.svg
+    :target: https://governance.openstack.org/tc/reference/tags/index.html
+
+.. Change things from this point on
+
+===============
+OpenStackClient
+===============
+
+.. image:: https://img.shields.io/pypi/v/python-openstackclient.svg
+    :target: https://pypi.org/project/python-openstackclient/
+    :alt: Latest Version
+
+OpenStackClient (aka OSC) is a command-line client for OpenStack that brings
+the command set for Compute, Identity, Image, Network, Object Store and Block
+Storage APIs together in a single shell with a uniform command structure.
+
+The primary goal is to provide a unified shell command structure and a common
+language to describe operations in OpenStack.
+
+* `PyPi`_ - package installation
+* `Online Documentation`_
+* `Launchpad project`_ - bugs and feature requests
+* `Blueprints`_ - feature specifications (historical only)
+* `Source`_
+* `Developer`_ - getting started as a developer
+* `Contributing`_ - contributing code
+* `Testing`_ - testing code
+* IRC: #openstack-sdks on OFTC (irc.oftc.net)
+* License: Apache 2.0
+
+.. _PyPi: https://pypi.org/project/python-openstackclient
+.. _Online Documentation: https://docs.openstack.org/python-openstackclient/latest/
+.. _Blueprints: https://blueprints.launchpad.net/python-openstackclient
+.. _`Launchpad project`: https://bugs.launchpad.net/python-openstackclient
+.. _Source: https://opendev.org/openstack/python-openstackclient
+.. _Developer: https://docs.openstack.org/project-team-guide/project-setup/python.html
+.. _Contributing: https://docs.openstack.org/infra/manual/developers.html
+.. _Testing: https://docs.openstack.org/python-openstackclient/latest/contributor/developing.html#testing
+.. _Release Notes: https://docs.openstack.org/releasenotes/python-openstackclient
+
+Getting Started
+===============
+
+OpenStack Client can be installed from PyPI using pip::
+
+    pip install python-openstackclient
+
+There are a few variants on getting help.  A list of global options and supported
+commands is shown with ``--help``::
+
+   openstack --help
+
+There is also a ``help`` command that can be used to get help text for a specific
+command::
+
+    openstack help
+    openstack help server create
+
+If you want to make changes to the OpenStackClient for testing and contribution,
+make any changes and then run::
+
+    python setup.py develop
+
+or::
+
+    pip install -e .
+
+Configuration
+=============
+
+The CLI is configured via environment variables and command-line
+options as listed in  https://docs.openstack.org/python-openstackclient/latest/cli/authentication.html.
+
+Authentication using username/password is most commonly used:
+
+- For a local user, your configuration will look like the one below::
+
+    export OS_AUTH_URL=<url-to-openstack-identity>
+    export OS_IDENTITY_API_VERSION=3
+    export OS_PROJECT_NAME=<project-name>
+    export OS_PROJECT_DOMAIN_NAME=<project-domain-name>
+    export OS_USERNAME=<username>
+    export OS_USER_DOMAIN_NAME=<user-domain-name>
+    export OS_PASSWORD=<password>  # (optional)
+
+  The corresponding command-line options look very similar::
+
+    --os-auth-url <url>
+    --os-identity-api-version 3
+    --os-project-name <project-name>
+    --os-project-domain-name <project-domain-name>
+    --os-username <username>
+    --os-user-domain-name <user-domain-name>
+    [--os-password <password>]
+
+- For a federated user, your configuration will look the so::
+
+    export OS_PROJECT_NAME=<project-name>
+    export OS_PROJECT_DOMAIN_NAME=<project-domain-name>
+    export OS_AUTH_URL=<url-to-openstack-identity>
+    export OS_IDENTITY_API_VERSION=3
+    export OS_AUTH_PLUGIN=openid
+    export OS_AUTH_TYPE=v3oidcpassword
+    export OS_USERNAME=<username-in-idp>
+    export OS_PASSWORD=<password-in-idp>
+    export OS_IDENTITY_PROVIDER=<the-desired-idp-in-keystone>
+    export OS_CLIENT_ID=<the-client-id-configured-in-the-idp>
+    export OS_CLIENT_SECRET=<the-client-secred-configured-in-the-idp>
+    export OS_OPENID_SCOPE=<the-scopes-of-desired-attributes-to-claim-from-idp>
+    export OS_PROTOCOL=<the-protocol-used-in-the-apache2-oidc-proxy>
+    export OS_ACCESS_TOKEN_TYPE=<the-access-token-type-used-by-your-idp>
+    export OS_DISCOVERY_ENDPOINT=<the-well-known-endpoint-of-the-idp>
+
+  The corresponding command-line options look very similar::
+
+    --os-project-name <project-name>
+    --os-project-domain-name <project-domain-name>
+    --os-auth-url <url-to-openstack-identity>
+    --os-identity-api-version 3
+    --os-auth-plugin openid
+    --os-auth-type v3oidcpassword
+    --os-username <username-in-idp>
+    --os-password <password-in-idp>
+    --os-identity-provider <the-desired-idp-in-keystone>
+    --os-client-id <the-client-id-configured-in-the-idp>
+    --os-client-secret <the-client-secred-configured-in-the-idp>
+    --os-openid-scope <the-scopes-of-desired-attributes-to-claim-from-idp>
+    --os-protocol <the-protocol-used-in-the-apache2-oidc-proxy>
+    --os-access-token-type <the-access-token-type-used-by-your-idp>
+    --os-discovery-endpoint <the-well-known-endpoint-of-the-idp>
+
+If a password is not provided above (in plaintext), you will be interactively
+prompted to provide one securely.
+

{python-openstackclient-7.2.1 → python_openstackclient-7.3.0}/openstackclient/common/limits.py

@@ -130,7 +130,7 @@ class ShowLimits(command.Lister):
         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,
+                project=project_id,
             )
 
         if parsed_args.is_absolute:

{python-openstackclient-7.2.1 → python_openstackclient-7.3.0}/openstackclient/common/quota.py

@@ -249,9 +249,14 @@ class ListQuota(command.Lister):
         for project_id in project_ids:
             try:
                 project_data = compute_client.get_quota_set(project_id)
+            # NOTE(stephenfin): Unfortunately, Nova raises a HTTP 400 (Bad
+            # Request) if the project ID is invalid, even though the project
+            # ID is actually the resource's identifier which would normally
+            # lead us to expect a HTTP 404 (Not Found).
             except (
-                sdk_exceptions.NotFoundException,
+                sdk_exceptions.BadRequestException,
                 sdk_exceptions.ForbiddenException,
+                sdk_exceptions.NotFoundException,
             ) as exc:
                 # Project not found, move on to next one
                 LOG.warning(f"Project {project_id} not found: {exc}")
@@ -312,8 +317,8 @@ class ListQuota(command.Lister):
             try:
                 project_data = volume_client.get_quota_set(project_id)
             except (
-                sdk_exceptions.NotFoundException,
                 sdk_exceptions.ForbiddenException,
+                sdk_exceptions.NotFoundException,
             ) as exc:
                 # Project not found, move on to next one
                 LOG.warning(f"Project {project_id} not found: {exc}")

{python-openstackclient-7.2.1 → python_openstackclient-7.3.0}/openstackclient/compute/v2/server.py

@@ -714,7 +714,8 @@ class AddServerSecurityGroup(command.Command):
         for security_group in security_groups:
             try:
                 compute_client.add_security_group_to_server(
-                    server, security_group
+                    server,
+                    {'name': security_group},
                 )
             except sdk_exceptions.HttpException as e:
                 errors += 1
@@ -1356,14 +1357,26 @@ class CreateServer(command.ShowOne):
                 'This option requires cloud support.'
             ),
         )
-        parser.add_argument(
+        secgroups = parser.add_mutually_exclusive_group()
+        secgroups.add_argument(
+            '--no-security-group',
+            dest='security_groups',
+            action='store_const',
+            const=[],
+            help=_(
+                'Do not associate a security group with ports attached to '
+                'this server. This does not affect the security groups '
+                'associated with pre-existing ports.'
+            ),
+        )
+        secgroups.add_argument(
             '--security-group',
             metavar='<security-group>',
             action='append',
-            default=[],
             dest='security_groups',
             help=_(
-                'Security group to assign to this server (name or ID) '
+                'Security group to associate with ports attached to this '
+                'server (name or ID) '
                 '(repeat option to set multiple groups)'
             ),
         )
@@ -1980,22 +1993,24 @@ class CreateServer(command.ShowOne):
             networks = 'auto'
 
         # Check security group(s) exist and convert ID to name
-        security_groups = []
-        if self.app.client_manager.is_network_endpoint_enabled():
-            network_client = self.app.client_manager.network
-            for security_group in parsed_args.security_groups:
-                sg = network_client.find_security_group(
-                    security_group, ignore_missing=False
-                )
-                # Use security group ID to avoid multiple security group have
-                # same name in neutron networking backend
-                security_groups.append({'name': sg.id})
-        else:  # nova-network
-            for security_group in parsed_args.security_groups:
-                sg = compute_v2.find_security_group(
-                    compute_client, security_group
-                )
-                security_groups.append({'name': sg['name']})
+        security_groups = None
+        if parsed_args.security_groups is not None:
+            security_groups = []
+            if self.app.client_manager.is_network_endpoint_enabled():
+                network_client = self.app.client_manager.network
+                for security_group in parsed_args.security_groups:
+                    sg = network_client.find_security_group(
+                        security_group, ignore_missing=False
+                    )
+                    # Use security group ID to avoid multiple security group
+                    # have same name in neutron networking backend
+                    security_groups.append({'name': sg.id})
+            else:  # nova-network
+                for security_group in parsed_args.security_groups:
+                    sg = compute_v2.find_security_group(
+                        compute_client, security_group
+                    )
+                    security_groups.append({'name': sg['name']})
 
         hints = {}
         for key, values in parsed_args.hints.items():
@@ -2058,7 +2073,7 @@ class CreateServer(command.ShowOne):
         if files:
             kwargs['personality'] = files
 
-        if security_groups:
+        if security_groups is not None:
             kwargs['security_groups'] = security_groups
 
         if block_device_mapping_v2:
@@ -4083,7 +4098,8 @@ class RemoveServerSecurityGroup(command.Command):
         for security_group in security_groups:
             try:
                 compute_client.remove_security_group_from_server(
-                    server, security_group
+                    server,
+                    {'name': security_group},
                 )
             except sdk_exceptions.HttpException as e:
                 errors += 1

{python-openstackclient-7.2.1 → python_openstackclient-7.3.0}/openstackclient/compute/v2/usage.py

@@ -153,7 +153,7 @@ class ListUsage(command.Lister):
         )
 
         date_cli_format = "%Y-%m-%d"
-        now = datetime.datetime.utcnow()
+        now = datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None)
 
         if parsed_args.start:
             start = datetime.datetime.strptime(
@@ -238,7 +238,7 @@ class ShowUsage(command.ShowOne):
         identity_client = self.app.client_manager.identity
         compute_client = self.app.client_manager.sdk_connection.compute
         date_cli_format = "%Y-%m-%d"
-        now = datetime.datetime.utcnow()
+        now = datetime.datetime.now(datetime.timezone.utc).replace(tzinfo=None)
 
         if parsed_args.start:
             start = datetime.datetime.strptime(

{python-openstackclient-7.2.1 → python_openstackclient-7.3.0}/openstackclient/identity/common.py

@@ -184,13 +184,6 @@ def _get_token_resource(client, resource, parsed_name, parsed_domain=None):
         return parsed_name
 
 
-def _get_domain_id_if_requested(identity_client, domain_name_or_id):
-    if not domain_name_or_id:
-        return None
-    domain = find_domain(identity_client, domain_name_or_id)
-    return domain.id
-
-
 def find_domain(identity_client, name_or_id):
     return _find_identity_resource(
         identity_client.domains, name_or_id, domains.Domain
@@ -198,48 +191,43 @@ def find_domain(identity_client, name_or_id):
 
 
 def find_group(identity_client, name_or_id, domain_name_or_id=None):
-    domain_id = _get_domain_id_if_requested(identity_client, domain_name_or_id)
-    if not domain_id:
+    if domain_name_or_id is None:
         return _find_identity_resource(
             identity_client.groups, name_or_id, groups.Group
         )
-    else:
-        domain_id = find_domain(identity_client, domain_id).id
-        return _find_identity_resource(
-            identity_client.groups,
-            name_or_id,
-            groups.Group,
-            domain_id=domain_id,
-        )
+
+    domain_id = find_domain(identity_client, domain_name_or_id).id
+    return _find_identity_resource(
+        identity_client.groups,
+        name_or_id,
+        groups.Group,
+        domain_id=domain_id,
+    )
 
 
 def find_project(identity_client, name_or_id, domain_name_or_id=None):
-    domain_id = _get_domain_id_if_requested(identity_client, domain_name_or_id)
-    if not domain_id:
+    if domain_name_or_id is None:
         return _find_identity_resource(
             identity_client.projects, name_or_id, projects.Project
         )
-    else:
-        domain_id = find_domain(identity_client, domain_id).id
-        return _find_identity_resource(
-            identity_client.projects,
-            name_or_id,
-            projects.Project,
-            domain_id=domain_id,
-        )
+    domain_id = find_domain(identity_client, domain_name_or_id).id
+    return _find_identity_resource(
+        identity_client.projects,
+        name_or_id,
+        projects.Project,
+        domain_id=domain_id,
+    )
 
 
 def find_user(identity_client, name_or_id, domain_name_or_id=None):
-    domain_id = _get_domain_id_if_requested(identity_client, domain_name_or_id)
-    if not domain_id:
+    if domain_name_or_id is None:
         return _find_identity_resource(
             identity_client.users, name_or_id, users.User
         )
-    else:
-        domain_id = find_domain(identity_client, domain_id).id
-        return _find_identity_resource(
-            identity_client.users, name_or_id, users.User, domain_id=domain_id
-        )
+    domain_id = find_domain(identity_client, domain_name_or_id).id
+    return _find_identity_resource(
+        identity_client.users, name_or_id, users.User, domain_id=domain_id
+    )
 
 
 def _find_identity_resource(

{python-openstackclient-7.2.1 → python_openstackclient-7.3.0}/openstackclient/identity/v3/credential.py

@@ -28,6 +28,23 @@ from openstackclient.identity import common
 LOG = logging.getLogger(__name__)
 
 
+def _format_credential(credential):
+    columns = (
+        'blob',
+        'id',
+        'project_id',
+        'type',
+        'user_id',
+    )
+    return (
+        columns,
+        utils.get_item_properties(
+            credential,
+            columns,
+        ),
+    )
+
+
 class CreateCredential(command.ShowOne):
     _description = _("Create new credential")
 
@@ -60,25 +77,24 @@ class CreateCredential(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
-        user_id = utils.find_resource(
-            identity_client.users, parsed_args.user
+        identity_client = self.app.client_manager.sdk_connection.identity
+        user_id = identity_client.find_user(
+            parsed_args.user, ignore_missing=False
         ).id
         if parsed_args.project:
-            project = utils.find_resource(
-                identity_client.projects, parsed_args.project
+            project = identity_client.find_project(
+                parsed_args.project, ignore_missing=False
             ).id
         else:
             project = None
-        credential = identity_client.credentials.create(
+        credential = identity_client.create_credential(
             user=user_id,
             type=parsed_args.type,
             blob=parsed_args.data,
             project=project,
         )
 
-        credential._info.pop('links')
-        return zip(*sorted(credential._info.items()))
+        return _format_credential(credential)
 
 
 class DeleteCredential(command.Command):
@@ -95,11 +111,11 @@ class DeleteCredential(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
         result = 0
         for i in parsed_args.credential:
             try:
-                identity_client.credentials.delete(i)
+                identity_client.delete_credential(i)
             except Exception as e:
                 result += 1
                 LOG.error(
@@ -137,14 +153,17 @@ class ListCredential(command.Lister):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
         kwargs = {}
         if parsed_args.user:
-            user_id = common.find_user(
-                identity_client,
-                parsed_args.user,
-                parsed_args.user_domain,
+            domain_id = None
+            if parsed_args.user_domain:
+                domain_id = identity_client.find_domain(
+                    parsed_args.user_domain, ignore_missing=False
+                )
+            user_id = identity_client.find_user(
+                parsed_args.user, domain_id=domain_id, ignore_missing=False
             ).id
             kwargs["user_id"] = user_id
 
@@ -153,7 +172,8 @@ class ListCredential(command.Lister):
 
         columns = ('ID', 'Type', 'User ID', 'Blob', 'Project ID')
         column_headers = ('ID', 'Type', 'User ID', 'Data', 'Project ID')
-        data = self.app.client_manager.identity.credentials.list(**kwargs)
+        data = identity_client.credentials(**kwargs)
+
         return (
             column_headers,
             (
@@ -206,20 +226,20 @@ class SetCredential(command.Command):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
+        identity_client = self.app.client_manager.sdk_connection.identity
 
-        user_id = utils.find_resource(
-            identity_client.users, parsed_args.user
+        user_id = identity_client.find_user(
+            parsed_args.user, ignore_missing=False
         ).id
 
         if parsed_args.project:
-            project = utils.find_resource(
-                identity_client.projects, parsed_args.project
+            project = identity_client.find_project(
+                parsed_args.project, ignore_missing=False
             ).id
         else:
             project = None
 
-        identity_client.credentials.update(
+        identity_client.update_credential(
             parsed_args.credential,
             user=user_id,
             type=parsed_args.type,
@@ -241,10 +261,7 @@ class ShowCredential(command.ShowOne):
         return parser
 
     def take_action(self, parsed_args):
-        identity_client = self.app.client_manager.identity
-        credential = utils.find_resource(
-            identity_client.credentials, parsed_args.credential
-        )
+        identity_client = self.app.client_manager.sdk_connection.identity
+        credential = identity_client.get_credential(parsed_args.credential)
 
-        credential._info.pop('links')
-        return zip(*sorted(credential._info.items()))
+        return _format_credential(credential)