openstack/manila
Code Issues Proposed changes

Replace glanceclient with openstacksdk

Browse Source 
The glance client will be deprecated one day. Projects using it should
switch to using the OpenStack SDK instead.

Change-Id: I61a670462c123bc68c4b6c938afad3b233ecbf74
Signed-off-by: Cyril Roelandt <cyril@redhat.com>
This commit is contained in:
Cyril Roelandt
2025-10-08 02:01:51 +02:00
parent 40107f9616
commit 3a65fee8ef
3 changed files with 38 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files
manila/image/glance.py
+13 -16
View File
@@ -16,8 +16,8 @@
Handles all requests to Glance.
"""
from glanceclient import client as glance_client
from keystoneauth1 import loading as ks_loading
import openstack
from oslo_config import cfg
from manila.common import client_auth
@@ -25,7 +25,6 @@ from manila.common.config import core_opts
from manila.db import base
GLANCE_GROUP = 'glance'
AUTH_OBJ = None
glance_opts = [
@@ -53,22 +52,20 @@ def list_opts():
return client_auth.AuthClientLoader.list_opts(GLANCE_GROUP)
def glanceclient(context):
global AUTH_OBJ
if not AUTH_OBJ:
AUTH_OBJ = client_auth.AuthClientLoader(
client_class=glance_client.Client, cfg_group=GLANCE_GROUP)
return AUTH_OBJ.get_client(context,
version=CONF[GLANCE_GROUP].api_microversion,
interface=CONF[GLANCE_GROUP].endpoint_type,
region_name=CONF[GLANCE_GROUP].region_name)
def openstackclient(context):
auth = ks_loading.load_auth_from_conf_options(CONF, 'glance')
session = ks_loading.load_session_from_conf_options(
CONF, 'glance', auth=auth)
return openstack.connection.Connection(
session=session,
context=context,
image_version=CONF[GLANCE_GROUP].api_microversion,
image_interface=CONF[GLANCE_GROUP].endpoint_type,
region_name=CONF[GLANCE_GROUP].region_name)
class API(base.Base):
"""API for interacting with glanceclient."""
def image_list(self, context):
client = glanceclient(context)
if hasattr(client, 'images'):
return client.images.list()
return client.glance.list()
client = openstackclient(context)
return client.image.images()
manila/tests/image/test_image.py
+24 -71
View File
@@ -21,11 +21,11 @@ from manila import test
from manila.tests import utils as test_utils
class FakeGlanceClient(object):
class FakeImageClient:
class Image(object):
class Image:
def list(self, *args, **kwargs):
def images(self, *args, **kwargs):
return [{'id': 'id1'}, {'id': 'id2'}]
def __getattr__(self, item):
@@ -35,16 +35,12 @@ class FakeGlanceClient(object):
self.image = self.Image()
def get_fake_auth_obj():
return type('FakeAuthObj', (object, ), {'get_client': mock.Mock()})
class OpenStackClientTestCase(test.TestCase):
class GlanceClientTestCase(test.TestCase):
@mock.patch('manila.image.glance.AUTH_OBJ', None)
def test_no_auth_obj(self):
mock_client_loader = self.mock_object(
glance.client_auth, 'AuthClientLoader')
@mock.patch('manila.image.glance.openstack.connection.Connection')
@mock.patch('manila.image.glance.ks_loading.load_session_from_conf_options') # noqa
def test_auth(self, mock_load_session, mock_connection):
mock_load_session.return_value = 'fake_session'
fake_context = 'fake_context'
data = {
'glance': {
@@ -55,79 +51,36 @@ class GlanceClientTestCase(test.TestCase):
}
with test_utils.create_temp_config_with_opts(data):
glance.glanceclient(fake_context)
glance.openstackclient(fake_context)
mock_client_loader.assert_called_once_with(
client_class=glance.glance_client.Client,
cfg_group=glance.GLANCE_GROUP
)
mock_client_loader.return_value.get_client.assert_called_once_with(
fake_context,
version=data['glance']['api_microversion'],
interface=data['glance']['endpoint_type'],
region_name=data['glance']['region_name']
)
@mock.patch('manila.image.glance.AUTH_OBJ', get_fake_auth_obj())
def test_with_auth_obj(self):
fake_context = 'fake_context'
data = {
'glance': {
'api_microversion': 'foo_api_microversion',
'endpoint_type': 'internal',
'region_name': 'foo_region_name'
}
}
with test_utils.create_temp_config_with_opts(data):
glance.glanceclient(fake_context)
glance.AUTH_OBJ.get_client.assert_called_once_with(
fake_context,
version=data['glance']['api_microversion'],
interface=data['glance']['endpoint_type'],
region_name=data['glance']['region_name']
mock_connection.assert_called_once_with(
session='fake_session',
context=fake_context,
image_version=data['glance']['api_microversion'],
image_interface=data['glance']['endpoint_type'],
region_name=data['glance']['region_name'],
)
class GlanceApiTestCase(test.TestCase):
class ImageApiTestCase(test.TestCase):
def setUp(self):
super(GlanceApiTestCase, self).setUp()
super().setUp()
self.api = glance.API()
self.glanceclient = FakeGlanceClient()
self.imageclient = FakeImageClient()
self.ctx = context.get_admin_context()
self.mock_object(glance, 'glanceclient',
mock.Mock(return_value=self.glanceclient))
self.mock_object(glance, 'openstackclient',
mock.Mock(return_value=self.imageclient))
def test_image_list_glanceclient_has_no_proxy(self):
def test_image_list(self):
image_list = ['fake', 'image', 'list']
class FakeGlanceClient(object):
def list(self):
class FakeImageClient(object):
def images(self):
return image_list
self.glanceclient.glance = FakeGlanceClient()
self.imageclient.image = FakeImageClient()
result = self.api.image_list(self.ctx)
self.assertEqual(image_list, result)
def test_image_list_glanceclient_has_proxy(self):
image_list1 = ['fake', 'image', 'list1']
image_list2 = ['fake', 'image', 'list2']
class FakeImagesClient(object):
def list(self):
return image_list1
class FakeGlanceClient(object):
def list(self):
return image_list2
self.glanceclient.images = FakeImagesClient()
self.glanceclient.glance = FakeGlanceClient()
result = self.api.image_list(self.ctx)
self.assertEqual(image_list1, result)
requirements.txt
+1 -1
View File
@@ -45,8 +45,8 @@ stevedore>=3.2.2 # Apache-2.0
tooz>=2.7.1 # Apache-2.0
python-cinderclient>=4.0.1 # Apache-2.0
python-novaclient>=17.2.1 # Apache-2.0
python-glanceclient>=3.2.2 # Apache-2.0
WebOb>=1.8.6 # MIT
cachetools>=4.2.1 # MIT
packaging>=20.9 # Apache-2.0
jsonschema>=4.17 # MIT
openstacksdk>=4.1.0 # Apache-2.0