Merge "trivial: Replace references to private _proxy modules"

Author: Zuul

openstackclient/common/clientmanager.py

@@ -20,25 +20,21 @@
 import importlib
 import logging
 import sys
-from typing import TYPE_CHECKING, Any, Protocol, TypeVar, runtime_checkable
+from typing import Any, Protocol, TypeVar, runtime_checkable
 
+from keystoneauth1 import access as ksa_access
+from openstack.compute import v2 as compute_v2
+from openstack.image import v2 as image_v2
+from openstack.network import v2 as network_v2
 from osc_lib.cli import client_config
 from osc_lib import clientmanager
 from osc_lib import shell
 import stevedore
 
-if TYPE_CHECKING:
-    from keystoneauth1 import access as ksa_access
-    from openstack.compute.v2 import _proxy as compute_proxy
-    from openstack.image.v2 import _proxy as image_proxy
-    from openstack.network.v2 import _proxy as network_proxy
-
-    from openstackclient.api import object_store_v1
+from openstackclient.api import object_store_v1
 
 LOG = logging.getLogger(__name__)
-
 PLUGIN_MODULES: list[Any] = []
-
 USER_AGENT = 'python-openstackclient'
 
 
@@ -50,23 +46,19 @@ class ClientManager(clientmanager.ClientManager):
     in osc-lib so we need to maintain a transition period.
     """
 
-    if TYPE_CHECKING:
-        # we know this will be set by us and will not be nullable
-        auth_ref: ksa_access.AccessInfo
-
-        # this is a hack to keep mypy happy: the actual attributes are set in
-        # get_plugin_modules below
-        # TODO(stephenfin): Change the types of identity and volume once we've
-        # migrated everything to SDK. Hopefully by then we'll have figured out
-        # how to statically distinguish between the v2 and v3 versions of both
-        # services...
-        # TODO(stephenfin): We also need to migrate object storage...
-        compute: compute_proxy.Proxy
-        identity: Any
-        image: image_proxy.Proxy
-        network: network_proxy.Proxy
-        object_store: object_store_v1.APIv1
-        volume: Any
+    # we know this will be set by us and will not be nullable
+    auth_ref: ksa_access.AccessInfo
+
+    # this is a hack to keep mypy happy: the actual attributes are set in
+    # get_plugin_modules below
+    # TODO(stephenfin): Change the types of identity, object store and volume
+    # once we've migrated everything to SDK
+    compute: compute_v2.Proxy
+    identity: Any
+    image: image_v2.Proxy
+    network: network_v2.Proxy
+    object_store: object_store_v1.APIv1
+    volume: Any
 
     def __init__(
         self,

openstackclient/tests/unit/api/test_compute_v2.py

@@ -17,7 +17,7 @@
 from unittest import mock
 import uuid
 
-from openstack.compute.v2 import _proxy
+from openstack.compute import v2 as compute_v2
 from osc_lib import exceptions as osc_lib_exceptions
 
 from openstackclient.api import compute_v2 as compute
@@ -29,7 +29,10 @@ class TestSecurityGroup(utils.TestCase):
     def setUp(self):
         super().setUp()
 
-        self.compute_client = mock.Mock(_proxy.Proxy)
+        # TODO(stephenfin): Switch to spec_set once keystoneauth exposes
+        # instance attributes as class attributes
+        # https://review.opendev.org/c/openstack/keystoneauth/+/994090
+        self.compute_client = mock.Mock(spec=compute_v2.Proxy)
 
     def test_create_security_group(self):
         sg_name = 'name-' + uuid.uuid4().hex
@@ -223,7 +226,7 @@ class TestSecurityGroupRule(utils.TestCase):
     def setUp(self):
         super().setUp()
 
-        self.compute_client = mock.Mock(_proxy.Proxy)
+        self.compute_client = mock.Mock(spec=compute_v2.Proxy)
 
     def test_create_security_group_rule(self):
         sg_id = uuid.uuid4().hex
@@ -281,7 +284,7 @@ class TestNetwork(utils.TestCase):
     def setUp(self):
         super().setUp()
 
-        self.compute_client = mock.Mock(_proxy.Proxy)
+        self.compute_client = mock.Mock(spec=compute_v2.Proxy)
 
     def test_create_network(self):
         net_name = 'name-' + uuid.uuid4().hex
@@ -443,7 +446,7 @@ class TestFloatingIP(utils.TestCase):
     def setUp(self):
         super().setUp()
 
-        self.compute_client = mock.Mock(_proxy.Proxy)
+        self.compute_client = mock.Mock(spec=compute_v2.Proxy)
 
     def test_create_floating_ip(self):
         network = 'network-' + uuid.uuid4().hex
@@ -528,7 +531,7 @@ class TestFloatingIPPool(utils.TestCase):
     def setUp(self):
         super().setUp()
 
-        self.compute_client = mock.Mock(_proxy.Proxy)
+        self.compute_client = mock.Mock(spec=compute_v2.Proxy)
 
     def test_list_floating_ip_pools(self):
         data = {

openstackclient/tests/unit/api/test_volume_v2.py

@@ -17,7 +17,7 @@
 from unittest import mock
 import uuid
 
-from openstack.block_storage.v2 import _proxy
+from openstack.block_storage import v2 as block_storage_v2
 from osc_lib import exceptions as osc_lib_exceptions
 
 from openstackclient.api import volume_v2 as volume
@@ -29,7 +29,10 @@ class TestConsistencyGroup(utils.TestCase):
     def setUp(self):
         super().setUp()
 
-        self.volume_sdk_client = mock.Mock(_proxy.Proxy)
+        # TODO(stephenfin): Switch to spec_set once keystoneauth exposes
+        # instance attributes as class attributes
+        # https://review.opendev.org/c/openstack/keystoneauth/+/994090
+        self.volume_sdk_client = mock.Mock(spec=block_storage_v2.Proxy)
 
     def test_find_consistency_group_by_id(self):
         cg_id = uuid.uuid4().hex

openstackclient/tests/unit/api/test_volume_v3.py

@@ -17,7 +17,7 @@
 from unittest import mock
 import uuid
 
-from openstack.block_storage.v3 import _proxy
+from openstack.block_storage import v3 as block_storage_v3
 from osc_lib import exceptions as osc_lib_exceptions
 
 from openstackclient.api import volume_v3 as volume
@@ -29,7 +29,10 @@ class TestConsistencyGroup(utils.TestCase):
     def setUp(self):
         super().setUp()
 
-        self.volume_sdk_client = mock.Mock(_proxy.Proxy)
+        # TODO(stephenfin): Switch to spec_set once keystoneauth exposes
+        # instance attributes as class attributes
+        # https://review.opendev.org/c/openstack/keystoneauth/+/994090
+        self.volume_sdk_client = mock.Mock(spec=block_storage_v3.Proxy)
 
     def test_find_consistency_group_by_id(self):
         cg_id = uuid.uuid4().hex

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

@@ -19,7 +19,7 @@
 import uuid
 
 from keystoneauth1 import discover
-from openstack.compute.v2 import _proxy
+from openstack.compute import v2 as compute_v2
 from openstack.compute.v2 import availability_zone as _availability_zone
 from openstack.compute.v2 import extension as _extension
 from openstack.compute.v2 import flavor as _flavor
@@ -44,7 +44,10 @@ class FakeClientMixin:
     def setUp(self):
         super().setUp()
 
-        self.app.client_manager.compute = mock.Mock(_proxy.Proxy)
+        # TODO(stephenfin): Switch to spec_set once keystoneauth exposes
+        # instance attributes as class attributes
+        # https://review.opendev.org/c/openstack/keystoneauth/+/994090
+        self.app.client_manager.compute = mock.Mock(spec=compute_v2.Proxy)
         self.compute_client = self.app.client_manager.compute
         self.set_compute_api_version()  # default to the lowest
 

openstackclient/tests/unit/identity/v2_0/fakes.py

@@ -19,7 +19,7 @@
 
 from keystoneauth1 import access
 from keystoneauth1 import fixture
-from openstack.identity.v2 import _proxy
+from openstack.identity import v2 as identity_v2
 
 from openstackclient.tests.unit import fakes
 from openstackclient.tests.unit import utils
@@ -193,7 +193,7 @@ def setUp(self):
         # TODO(stephenfin): Rename to 'identity_client' once all commands are
         # migrated to SDK
         self.app.client_manager.sdk_connection.identity = mock.Mock(
-            _proxy.Proxy
+            identity_v2.Proxy
         )
         self.identity_sdk_client = (
             self.app.client_manager.sdk_connection.identity

openstackclient/tests/unit/identity/v3/fakes.py

@@ -20,7 +20,7 @@
 
 from keystoneauth1 import access
 from keystoneauth1 import fixture
-from openstack.identity.v3 import _proxy
+from openstack.identity import v3 as identity_v3
 from osc_lib.cli import format_columns
 
 from openstackclient.tests.unit import fakes
@@ -647,7 +647,7 @@ def setUp(self):
         # TODO(stephenfin): Rename to 'identity_client' once all commands are
         # migrated to SDK
         self.app.client_manager.sdk_connection.identity = mock.Mock(
-            _proxy.Proxy
+            identity_v3.Proxy
         )
         self.app.client_manager.sdk_connection.identity.api_version = '3'
         self.identity_sdk_client = (
@@ -682,7 +682,7 @@ def setUp(self):
         # TODO(stephenfin): Rename to 'identity_client' once all commands are
         # migrated to SDK
         self.app.client_manager.sdk_connection.identity = mock.Mock(
-            _proxy.Proxy
+            identity_v3.Proxy
         )
         self.app.client_manager.sdk_connection.identity.api_version = '3'
         self.identity_sdk_client = (
@@ -703,7 +703,7 @@ def setUp(self):
         # TODO(stephenfin): Rename to 'identity_client' once all commands are
         # migrated to SDK
         self.app.client_manager.sdk_connection.identity = mock.Mock(
-            _proxy.Proxy
+            identity_v3.Proxy
         )
         self.app.client_manager.sdk_connection.identity.api_version = '3'
         self.identity_sdk_client = (

openstackclient/tests/unit/image/v1/fakes.py

@@ -15,8 +15,8 @@
 from unittest import mock
 import uuid
 
-from openstack.block_storage.v2 import _proxy as block_storage_v2_proxy
-from openstack.image.v1 import _proxy
+from openstack.block_storage import v2 as block_storage_v2
+from openstack.image import v1 as image_v1
 from openstack.image.v1 import image
 
 from openstackclient.tests.unit import fakes
@@ -28,7 +28,10 @@ class FakeClientMixin:
     def setUp(self):
         super().setUp()
 
-        self.app.client_manager.image = mock.Mock(spec=_proxy.Proxy)
+        # TODO(stephenfin): Switch to spec_set once keystoneauth exposes
+        # instance attributes as class attributes
+        # https://review.opendev.org/c/openstack/keystoneauth/+/994090
+        self.app.client_manager.image = mock.Mock(spec=image_v1.Proxy)
         self.image_client = self.app.client_manager.image
 
 
@@ -43,7 +46,7 @@ def setUp(self):
         self.volume_client = self.app.client_manager.volume
 
         self.app.client_manager.sdk_connection.volume = mock.Mock(
-            spec=block_storage_v2_proxy.Proxy,
+            spec=block_storage_v2.Proxy
         )
         self.app.client_manager.sdk_connection.volume.api_version = '2'
         self.volume_sdk_client = self.app.client_manager.sdk_connection.volume

openstackclient/tests/unit/image/v2/fakes.py

@@ -16,7 +16,7 @@
 from unittest import mock
 import uuid
 
-from openstack.image.v2 import _proxy
+from openstack.image import v2 as image_v2
 from openstack.image.v2 import cache
 from openstack.image.v2 import image
 from openstack.image.v2 import member
@@ -35,7 +35,10 @@ class FakeClientMixin:
     def setUp(self):
         super().setUp()
 
-        self.app.client_manager.image = mock.Mock(spec=_proxy.Proxy)
+        # TODO(stephenfin): Switch to spec_set once keystoneauth exposes
+        # instance attributes as class attributes
+        # https://review.opendev.org/c/openstack/keystoneauth/+/994090
+        self.app.client_manager.image = mock.Mock(spec=image_v2.Proxy)
         self.image_client = self.app.client_manager.image
 
 

openstackclient/tests/unit/network/v2/fakes.py

@@ -16,7 +16,7 @@
 from unittest import mock
 import uuid
 
-from openstack.network.v2 import _proxy
+from openstack.network import v2 as network_v2
 from openstack.network.v2 import address_group as _address_group
 from openstack.network.v2 import address_scope as _address_scope
 from openstack.network.v2 import agent as network_agent
@@ -99,7 +99,10 @@ class FakeClientMixin:
     def setUp(self):
         super().setUp()
 
-        self.app.client_manager.network = mock.Mock(spec=_proxy.Proxy)
+        # TODO(stephenfin): Switch to spec_set once keystoneauth exposes
+        # instance attributes as class attributes
+        # https://review.opendev.org/c/openstack/keystoneauth/+/994090
+        self.app.client_manager.network = mock.Mock(spec=network_v2.Proxy)
         self.network_client = self.app.client_manager.network