authv1: Modernize returned service catalog

Keystone has only been returning v3 catalogs for a while now, so many
client libraries have dropped support for the old v2 catalogs. We should
switch to the new format so we stop causing KeyErrors like

    File ".../cliff/formatters/table.py", line 109, in add_rows
      table.add_row(_format_row(first_row))
                    ^^^^^^^^^^^^^^^^^^^^^^
    File ".../cliff/formatters/table.py", line 38, in _format_row
      r = r.human_readable()
          ^^^^^^^^^^^^^^^^^^
    File ".../openstackclient/identity/v3/catalog.py", line 37, in human_readable
      ret += "  {}: {}\n".format(ep['interface'], ep['url'])
                                 ~~^^^^^^^^^^^^^
  KeyError: 'interface'

(Previously seen while trying to run `openstack catalog show` with latest
python-openstackclient/osc-lib/openstacksdk -- but this used to work!)

Change-Id: Ie8726b97e1dde7d7bfd8e4215af6af52e1fd870e
Signed-off-by: Tim Burke <tim.burke@gmail.com>

Author: tipabu

swiftclient/authv1.py

@@ -70,13 +70,15 @@ def catalog(self):
         # openstackclient wants this for the `catalog list` and
         # `catalog show` commands
         endpoints = [{
+            'interface': 'public',
             'region': 'default',
-            'publicURL': self._storage_url,
+            'url': self._storage_url,
         }]
         if self.storage_url != self._storage_url:
             endpoints.insert(0, {
+                'interface': 'public',
                 'region': 'override',
-                'publicURL': self.storage_url,
+                'url': self.storage_url,
             })
 
         return [
@@ -89,8 +91,9 @@ def catalog(self):
                 'name': 'auth',
                 'type': 'identity',
                 'endpoints': [{
+                    'interface': 'public',
                     'region': 'default',
-                    'publicURL': self.auth_url,
+                    'url': self.auth_url,
                 }],
             }
         ]
@@ -151,6 +154,8 @@ def __init__(self, auth_url, storage_url, account, username, auth_token,
             self._expires = None
         # following is used by openstackclient
         self.project_id = None
+        self.domain_id = 'default'
+        self.system_scoped = False
 
     @property
     def expires(self):

swiftclient/client.py

@@ -577,7 +577,7 @@ def get_auth_keystone(auth_url, user, key, os_options, **kwargs):
 
     filter_kwargs = {}
     service_type = os_options.get('service_type') or 'object-store'
-    endpoint_type = os_options.get('endpoint_type') or 'publicURL'
+    endpoint_type = os_options.get('endpoint_type') or 'public'
     if os_options.get('region_name'):
         filter_kwargs['attr'] = 'region'
         filter_kwargs['filter_value'] = os_options['region_name']

test-requirements.txt

@@ -5,3 +5,4 @@ python-keystoneclient>=0.7.0
 keystoneauth1>=3.4.0  # Apache-2.0
 stestr>=2.0.0,!=3.0.0 # Apache-2.0
 openstacksdk>=0.11.0  # Apache-2.0
+python-openstackclient>=3.12.0  # Apache-2.0

test/functional/test_openstackclient.py

@@ -0,0 +1,62 @@
+# Copyright (c) 2025 NVIDIA
+#
+# 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
+import subprocess
+import unittest
+
+from . import TEST_CONFIG
+
+
+class TestOpenStackClient(unittest.TestCase):
+    @classmethod
+    def setUpClass(cls):
+        # NB: Only runs for v1 auth, to exercise our keystoneauth plugin
+        cls.skip_tests = (TEST_CONFIG is None or
+                          TEST_CONFIG['auth_version'] != '1')
+        cls.env = {
+            'OS_AUTH_TYPE': 'v1password',
+            'OS_AUTH_URL': TEST_CONFIG['auth_url'] or '',
+            'OS_USERNAME': TEST_CONFIG['account_username'] or '',
+            'OS_PASSWORD': TEST_CONFIG['password'] or '',
+            'OS_CACERT': TEST_CONFIG['cacert'] or '',
+        }
+        if 'PATH' in os.environ:
+            cls.env['PATH'] = os.environ['PATH']
+
+    def setUp(self):
+        if self.skip_tests:
+            raise unittest.SkipTest('SKIPPING V1-AUTH TESTS')
+
+    def _run(self, *args):
+        subprocess.run(args, env=self.env, check=True)
+
+    def test_token_issue(self):
+        self._run('openstack', 'token', 'issue')
+
+    def test_catalog_list(self):
+        self._run('openstack', 'catalog', 'list')
+
+    def test_catalog_show(self):
+        self._run('openstack', 'catalog', 'show', 'swift')
+        self._run('openstack', 'catalog', 'show', 'object-store')
+        self._run('openstack', 'catalog', 'show', 'auth')
+
+    def test_account_show(self):
+        self._run('openstack', 'object', 'store', 'account', 'show')
+        # If account show works and the openstacksdk tests work, presumably
+        # container/object commands work, too
+
+    # service list? endpoint list?

test/unit/test_authv1.py

@@ -163,7 +163,7 @@ def test_get_access(self):
         self.assertEqual('object-store', catalog[0].get('type'))
         self.assertIn('endpoints', catalog[0])
         self.assertIn(self.storage_url, [
-            e.get('publicURL') for e in catalog[0]['endpoints']])
+            e.get('url') for e in catalog[0]['endpoints']])
 
     def test_get_access_with_expiry(self):
         auth_plugin = authv1.PasswordPlugin(**self.options)

test/unit/test_shell.py

@@ -3365,7 +3365,7 @@ class TestKeystoneOptions(MockHttpTest):
     # options that are given default values in code if missing from CLI
     defaults = {'auth-version': '2.0',
                 'service-type': 'object-store',
-                'endpoint-type': 'publicURL'}
+                'endpoint-type': 'public'}
 
     def _build_os_opts(self, keys):
         os_opts = {}