openstack/python-openstackclient
Code Issues Proposed changes

Identity: Migrate 'limit' commands to SDK

Browse Source 
Depends-On: https://review.opendev.org/c/openstack/openstacksdk/+/937397
Depends-On: https://review.opendev.org/c/openstack/openstacksdk/+/942818
Change-Id: I3b9833d5cbb1f7275ceee56cb2599b76e878e98e
Signed-off-by: 0weng <oweng@osuosl.org>
This commit is contained in:
0weng
2024-11-26 08:37:38 -08:00
parent f7c78b8b74
commit 911e643f2c
3 changed files with 275 additions and 229 deletions
Download Patch File Download Diff File Expand all files Collapse all files

161
openstackclient/identity/v3/limit.py
View File

@@ -25,6 +25,28 @@ from openstackclient.identity import common as common_utils
LOG = logging.getLogger(__name__)
def _format_limit(limit):
columns = (
"description",
"id",
"project_id",
"region_id",
"resource_limit",
"resource_name",
"service_id",
)
column_headers = (
"description",
"id",
"project_id",
"region_id",
"resource_limit",
"resource_name",
"service_id",
)
return (column_headers, utils.get_item_properties(limit, columns))
class CreateLimit(command.ShowOne):
_description = _("Create a limit")
@@ -67,47 +89,33 @@ class CreateLimit(command.ShowOne):
return parser
def take_action(self, parsed_args):
identity_client = self.app.client_manager.identity
identity_client = self.app.client_manager.sdk_connection.identity
project = common_utils.find_project(
identity_client, parsed_args.project
kwargs = {
"resource_name": parsed_args.resource_name,
"resource_limit": parsed_args.resource_limit,
}
if parsed_args.description:
kwargs["description"] = parsed_args.description
# TODO(0weng): Add --project-domain option
# to support filtering project domain
kwargs["project_id"] = common_utils._find_sdk_id(
identity_client.find_project,
name_or_id=parsed_args.project,
)
service = common_utils.find_service(
kwargs["service_id"] = common_utils.find_service_sdk(
identity_client, parsed_args.service
)
region = None
).id
if parsed_args.region:
if 'None' not in parsed_args.region:
# NOTE (vishakha): Due to bug #1799153 and for any another
# related case where GET resource API does not support the
# filter by name, osc_lib.utils.find_resource() method cannot
# be used because that method try to fall back to list all the
# resource if requested resource cannot be get via name. Which
# ends up with NoUniqueMatch error.
# So osc_lib.utils.find_resource() function cannot be used for
# 'regions', using common_utils.get_resource() instead.
region = common_utils.get_resource(
identity_client.regions, parsed_args.region
)
else:
self.log.warning(
_(
"Passing 'None' to indicate no region is deprecated. "
"Instead, don't pass --region."
)
)
kwargs["region_id"] = identity_client.get_region(
parsed_args.region
).id
limit = identity_client.limits.create(
project,
service,
parsed_args.resource_name,
parsed_args.resource_limit,
description=parsed_args.description,
region=region,
)
limit = identity_client.create_limit(**kwargs)
limit._info.pop('links', None)
return zip(*sorted(limit._info.items()))
return _format_limit(limit)
class ListLimit(command.Lister):
@@ -139,47 +147,31 @@ class ListLimit(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
service = None
kwargs = {}
if parsed_args.service:
service = common_utils.find_service(
kwargs["service_id"] = common_utils.find_service_sdk(
identity_client, parsed_args.service
)
region = None
if parsed_args.region:
if 'None' not in parsed_args.region:
# NOTE (vishakha): Due to bug #1799153 and for any another
# related case where GET resource API does not support the
# filter by name, osc_lib.utils.find_resource() method cannot
# be used because that method try to fall back to list all the
# resource if requested resource cannot be get via name. Which
# ends up with NoUniqueMatch error.
# So osc_lib.utils.find_resource() function cannot be used for
# 'regions', using common_utils.get_resource() instead.
region = common_utils.get_resource(
identity_client.regions, parsed_args.region
)
else:
self.log.warning(
_(
"Passing 'None' to indicate no region is deprecated. "
"Instead, don't pass --region."
)
)
project = None
if parsed_args.region:
kwargs["region_id"] = identity_client.get_region(
parsed_args.region
).id
# TODO(0weng): Add --project-domain option
# to support filtering project domain
if parsed_args.project:
project = utils.find_resource(
identity_client.projects, parsed_args.project
kwargs["project_id"] = common_utils._find_sdk_id(
identity_client.find_project,
name_or_id=parsed_args.project,
)
limits = identity_client.limits.list(
service=service,
resource_name=parsed_args.resource_name,
region=region,
project=project,
)
if parsed_args.resource_name:
kwargs["resource_name"] = parsed_args.resource_name
limits = identity_client.limits(**kwargs)
columns = (
'ID',
@@ -209,10 +201,9 @@ class ShowLimit(command.ShowOne):
return parser
def take_action(self, parsed_args):
identity_client = self.app.client_manager.identity
limit = identity_client.limits.get(parsed_args.limit_id)
limit._info.pop('links', None)
return zip(*sorted(limit._info.items()))
identity_client = self.app.client_manager.sdk_connection.identity
limit = identity_client.get_limit(parsed_args.limit_id)
return _format_limit(limit)
class SetLimit(command.ShowOne):
@@ -240,17 +231,16 @@ class SetLimit(command.ShowOne):
return parser
def take_action(self, parsed_args):
identity_client = self.app.client_manager.identity
identity_client = self.app.client_manager.sdk_connection.identity
limit = identity_client.limits.update(
parsed_args.limit_id,
description=parsed_args.description,
resource_limit=parsed_args.resource_limit,
)
kwargs = {}
if parsed_args.description:
kwargs["description"] = parsed_args.description
if parsed_args.resource_limit:
kwargs["resource_limit"] = parsed_args.resource_limit
limit = identity_client.update_limit(parsed_args.limit_id, **kwargs)
limit._info.pop('links', None)
return zip(*sorted(limit._info.items()))
return _format_limit(limit)
class DeleteLimit(command.Command):
@@ -262,17 +252,20 @@ class DeleteLimit(command.Command):
'limit_id',
metavar='<limit-id>',
nargs="+",
help=_('Limit to delete (ID)'),
help=_(
'Limit to delete (ID) '
'(repeat option to remove multiple limits)'
),
)
return parser
def take_action(self, parsed_args):
identity_client = self.app.client_manager.identity
identity_client = self.app.client_manager.sdk_connection.identity
errors = 0
for limit_id in parsed_args.limit_id:
try:
identity_client.limits.delete(limit_id)
identity_client.delete_limit(limit_id)
except Exception as e:
errors += 1
LOG.error(

334
openstackclient/tests/unit/identity/v3/test_limit.py
View File

@@ -10,87 +10,80 @@
# License for the specific language governing permissions and limitations
# under the License.
import copy
from keystoneauth1.exceptions import http as ksa_exceptions
from openstack import exceptions as sdk_exc
from openstack.identity.v3 import limit as _limit
from openstack.identity.v3 import project as _project
from openstack.identity.v3 import region as _region
from openstack.identity.v3 import service as _service
from openstack.test import fakes as sdk_fakes
from osc_lib import exceptions
from openstackclient.identity.v3 import limit
from openstackclient.tests.unit import fakes
from openstackclient.tests.unit.identity.v3 import fakes as identity_fakes
class TestLimit(identity_fakes.TestIdentityv3):
class TestLimitCreate(identity_fakes.TestIdentityv3):
def setUp(self):
super().setUp()
identity_manager = self.identity_client
self.project = sdk_fakes.generate_fake_resource(_project.Project)
self.region = sdk_fakes.generate_fake_resource(_region.Region)
self.service = sdk_fakes.generate_fake_resource(_service.Service)
self.limit_mock = identity_manager.limits
self.resource_limit = 15
self.services_mock = identity_manager.services
self.services_mock.reset_mock()
self.identity_sdk_client.find_service.return_value = self.service
self.identity_sdk_client.get_region.return_value = self.region
self.identity_sdk_client.find_project.return_value = self.project
self.projects_mock = identity_manager.projects
self.projects_mock.reset_mock()
self.regions_mock = identity_manager.regions
self.regions_mock.reset_mock()
class TestLimitCreate(TestLimit):
def setUp(self):
super().setUp()
self.service = fakes.FakeResource(
None, copy.deepcopy(identity_fakes.SERVICE), loaded=True
self.limit = sdk_fakes.generate_fake_resource(
resource_type=_limit.Limit,
project_id=self.project.id,
service_id=self.service.id,
resource_name='foobars',
description=None,
resource_limit=self.resource_limit,
region_id=None,
)
self.services_mock.get.return_value = self.service
self.project = fakes.FakeResource(
None, copy.deepcopy(identity_fakes.PROJECT), loaded=True
self.limit_with_options = sdk_fakes.generate_fake_resource(
resource_type=_limit.Limit,
project_id=self.project.id,
service_id=self.service.id,
resource_limit=self.resource_limit,
resource_name='foobars',
description='test description',
region_id=self.region.id,
)
self.projects_mock.get.return_value = self.project
self.region = fakes.FakeResource(
None, copy.deepcopy(identity_fakes.REGION), loaded=True
)
self.regions_mock.get.return_value = self.region
self.cmd = limit.CreateLimit(self.app, None)
def test_limit_create_without_options(self):
self.limit_mock.create.return_value = fakes.FakeResource(
None, copy.deepcopy(identity_fakes.LIMIT), loaded=True
)
self.identity_sdk_client.create_limit.return_value = self.limit
resource_limit = 15
arglist = [
'--project',
identity_fakes.project_id,
self.project.id,
'--service',
identity_fakes.service_id,
self.service.id,
'--resource-limit',
str(resource_limit),
identity_fakes.limit_resource_name,
str(self.resource_limit),
self.limit.resource_name,
]
verifylist = [
('project', identity_fakes.project_id),
('service', identity_fakes.service_id),
('resource_name', identity_fakes.limit_resource_name),
('resource_limit', resource_limit),
('project', self.project.id),
('service', self.service.id),
('resource_name', self.limit.resource_name),
('resource_limit', self.resource_limit),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
kwargs = {'description': None, 'region': None}
self.limit_mock.create.assert_called_with(
self.project,
self.service,
identity_fakes.limit_resource_name,
resource_limit,
**kwargs,
self.identity_sdk_client.create_limit.assert_called_with(
project_id=self.project.id,
service_id=self.service.id,
resource_name=self.limit.resource_name,
resource_limit=self.resource_limit,
)
collist = (
@@ -105,55 +98,55 @@ class TestLimitCreate(TestLimit):
self.assertEqual(collist, columns)
datalist = (
None,
identity_fakes.limit_id,
identity_fakes.project_id,
self.limit.id,
self.project.id,
None,
resource_limit,
identity_fakes.limit_resource_name,
identity_fakes.service_id,
self.resource_limit,
self.limit.resource_name,
self.service.id,
)
self.assertEqual(datalist, data)
def test_limit_create_with_options(self):
self.limit_mock.create.return_value = fakes.FakeResource(
None, copy.deepcopy(identity_fakes.LIMIT_OPTIONS), loaded=True
self.identity_sdk_client.create_limit.return_value = (
self.limit_with_options
)
resource_limit = 15
arglist = [
'--project',
identity_fakes.project_id,
self.project.id,
'--service',
identity_fakes.service_id,
self.service.id,
'--resource-limit',
str(resource_limit),
'--region',
identity_fakes.region_id,
self.region.id,
'--description',
identity_fakes.limit_description,
identity_fakes.limit_resource_name,
self.limit_with_options.description,
self.limit_with_options.resource_name,
]
verifylist = [
('project', identity_fakes.project_id),
('service', identity_fakes.service_id),
('resource_name', identity_fakes.limit_resource_name),
('project', self.project.id),
('service', self.service.id),
('resource_name', self.limit_with_options.resource_name),
('resource_limit', resource_limit),
('region', identity_fakes.region_id),
('description', identity_fakes.limit_description),
('region', self.region.id),
('description', self.limit_with_options.description),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
kwargs = {
'description': identity_fakes.limit_description,
'region': self.region,
'project_id': self.project.id,
'service_id': self.service.id,
'region_id': self.region.id,
'resource_name': self.limit_with_options.resource_name,
'resource_limit': resource_limit,
'description': self.limit_with_options.description,
}
self.limit_mock.create.assert_called_with(
self.project,
self.service,
identity_fakes.limit_resource_name,
resource_limit,
self.identity_sdk_client.create_limit.assert_called_with(
**kwargs,
)
@@ -168,37 +161,41 @@ class TestLimitCreate(TestLimit):
)
self.assertEqual(collist, columns)
datalist = (
identity_fakes.limit_description,
identity_fakes.limit_id,
identity_fakes.project_id,
identity_fakes.region_id,
self.limit_with_options.description,
self.limit_with_options.id,
self.project.id,
self.region.id,
resource_limit,
identity_fakes.limit_resource_name,
identity_fakes.service_id,
self.limit_with_options.resource_name,
self.service.id,
)
self.assertEqual(datalist, data)
class TestLimitDelete(TestLimit):
class TestLimitDelete(identity_fakes.TestIdentityv3):
def setUp(self):
super().setUp()
self.cmd = limit.DeleteLimit(self.app, None)
def test_limit_delete(self):
self.limit_mock.delete.return_value = None
self.limit = sdk_fakes.generate_fake_resource(
resource_type=_limit.Limit
)
self.identity_sdk_client.delete_limit.return_value = None
arglist = [identity_fakes.limit_id]
verifylist = [('limit_id', [identity_fakes.limit_id])]
arglist = [self.limit.id]
verifylist = [('limit_id', [self.limit.id])]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
result = self.cmd.take_action(parsed_args)
self.limit_mock.delete.assert_called_with(identity_fakes.limit_id)
self.identity_sdk_client.delete_limit.assert_called_with(self.limit.id)
self.assertIsNone(result)
def test_limit_delete_with_exception(self):
return_value = ksa_exceptions.NotFound()
self.limit_mock.delete.side_effect = return_value
self.identity_sdk_client.delete_limit.side_effect = (
sdk_exc.ResourceNotFound
)
arglist = ['fake-limit-id']
verifylist = [('limit_id', ['fake-limit-id'])]
@@ -211,24 +208,42 @@ class TestLimitDelete(TestLimit):
self.assertEqual('1 of 1 limits failed to delete.', str(e))
class TestLimitShow(TestLimit):
class TestLimitShow(identity_fakes.TestIdentityv3):
def setUp(self):
super().setUp()
self.limit_mock.get.return_value = fakes.FakeResource(
None, copy.deepcopy(identity_fakes.LIMIT), loaded=True
self.project = sdk_fakes.generate_fake_resource(_project.Project)
self.region = sdk_fakes.generate_fake_resource(_region.Region)
self.service = sdk_fakes.generate_fake_resource(_service.Service)
self.resource_limit = 15
self.identity_sdk_client.find_service.return_value = self.service
self.identity_sdk_client.get_region.return_value = self.region
self.identity_sdk_client.find_project.return_value = self.project
self.limit = sdk_fakes.generate_fake_resource(
resource_type=_limit.Limit,
project_id=self.project.id,
service_id=self.service.id,
resource_name='foobars',
description=None,
resource_limit=self.resource_limit,
region_id=None,
)
self.identity_sdk_client.get_limit.return_value = self.limit
self.cmd = limit.ShowLimit(self.app, None)
def test_limit_show(self):
arglist = [identity_fakes.limit_id]
verifylist = [('limit_id', identity_fakes.limit_id)]
arglist = [self.limit.id]
verifylist = [('limit_id', self.limit.id)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
self.limit_mock.get.assert_called_with(identity_fakes.limit_id)
self.identity_sdk_client.get_limit.assert_called_with(self.limit.id)
collist = (
'description',
@@ -242,45 +257,61 @@ class TestLimitShow(TestLimit):
self.assertEqual(collist, columns)
datalist = (
None,
identity_fakes.limit_id,
identity_fakes.project_id,
self.limit.id,
self.project.id,
None,
identity_fakes.limit_resource_limit,
identity_fakes.limit_resource_name,
identity_fakes.service_id,
self.resource_limit,
self.limit.resource_name,
self.service.id,
)
self.assertEqual(datalist, data)
class TestLimitSet(TestLimit):
class TestLimitSet(identity_fakes.TestIdentityv3):
def setUp(self):
super().setUp()
self.project = sdk_fakes.generate_fake_resource(_project.Project)
self.region = sdk_fakes.generate_fake_resource(_region.Region)
self.service = sdk_fakes.generate_fake_resource(_service.Service)
self.resource_limit = 15
self.identity_sdk_client.find_service.return_value = self.service
self.identity_sdk_client.get_region.return_value = self.region
self.identity_sdk_client.find_project.return_value = self.project
self.cmd = limit.SetLimit(self.app, None)
def test_limit_set_description(self):
limit = copy.deepcopy(identity_fakes.LIMIT)
limit['description'] = identity_fakes.limit_description
self.limit_mock.update.return_value = fakes.FakeResource(
None, limit, loaded=True
description = 'limit of foobars'
limit = sdk_fakes.generate_fake_resource(
resource_type=_limit.Limit,
project_id=self.project.id,
service_id=self.service.id,
resource_name='foobars',
description=description,
resource_limit=self.resource_limit,
region_id=None,
)
self.identity_sdk_client.update_limit.return_value = limit
arglist = [
'--description',
identity_fakes.limit_description,
identity_fakes.limit_id,
description,
limit.id,
]
verifylist = [
('description', identity_fakes.limit_description),
('limit_id', identity_fakes.limit_id),
('description', description),
('limit_id', limit.id),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
self.limit_mock.update.assert_called_with(
identity_fakes.limit_id,
description=identity_fakes.limit_description,
resource_limit=None,
self.identity_sdk_client.update_limit.assert_called_with(
limit.id,
description=description,
)
collist = (
@@ -294,40 +325,44 @@ class TestLimitSet(TestLimit):
)
self.assertEqual(collist, columns)
datalist = (
identity_fakes.limit_description,
identity_fakes.limit_id,
identity_fakes.project_id,
description,
limit.id,
self.project.id,
None,
identity_fakes.limit_resource_limit,
identity_fakes.limit_resource_name,
identity_fakes.service_id,
limit.resource_limit,
limit.resource_name,
self.service.id,
)
self.assertEqual(datalist, data)
def test_limit_set_resource_limit(self):
resource_limit = 20
limit = copy.deepcopy(identity_fakes.LIMIT)
limit['resource_limit'] = resource_limit
self.limit_mock.update.return_value = fakes.FakeResource(
None, limit, loaded=True
limit = sdk_fakes.generate_fake_resource(
resource_type=_limit.Limit,
project_id=self.project.id,
service_id=self.service.id,
resource_name='foobars',
description=None,
resource_limit=resource_limit,
region_id=None,
)
self.identity_sdk_client.update_limit.return_value = limit
arglist = [
'--resource-limit',
str(resource_limit),
identity_fakes.limit_id,
limit.id,
]
verifylist = [
('resource_limit', resource_limit),
('limit_id', identity_fakes.limit_id),
('limit_id', limit.id),
]
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
columns, data = self.cmd.take_action(parsed_args)
self.limit_mock.update.assert_called_with(
identity_fakes.limit_id,
description=None,
self.identity_sdk_client.update_limit.assert_called_with(
limit.id,
resource_limit=resource_limit,
)
@@ -343,25 +378,36 @@ class TestLimitSet(TestLimit):
self.assertEqual(collist, columns)
datalist = (
None,
identity_fakes.limit_id,
identity_fakes.project_id,
limit.id,
self.project.id,
None,
resource_limit,
identity_fakes.limit_resource_name,
identity_fakes.service_id,
limit.resource_name,
self.service.id,
)
self.assertEqual(datalist, data)
class TestLimitList(TestLimit):
class TestLimitList(identity_fakes.TestIdentityv3):
def setUp(self):
super().setUp()
self.limit_mock.list.return_value = [
fakes.FakeResource(
None, copy.deepcopy(identity_fakes.LIMIT), loaded=True
)
]
self.project = sdk_fakes.generate_fake_resource(_project.Project)
self.region = sdk_fakes.generate_fake_resource(_region.Region)
self.service = sdk_fakes.generate_fake_resource(_service.Service)
self.resource_limit = 15
self.limit = sdk_fakes.generate_fake_resource(
resource_type=_limit.Limit,
project_id=self.project.id,
service_id=self.service.id,
resource_name='foobars',
description=None,
resource_limit=self.resource_limit,
region_id=None,
)
self.identity_sdk_client.limits.return_value = [self.limit]
self.cmd = limit.ListLimit(self.app, None)
@@ -372,9 +418,7 @@ class TestLimitList(TestLimit):
columns, data = self.cmd.take_action(parsed_args)
self.limit_mock.list.assert_called_with(
service=None, resource_name=None, region=None, project=None
)
self.identity_sdk_client.limits.assert_called_with()
collist = (
'ID',
@@ -388,11 +432,11 @@ class TestLimitList(TestLimit):
self.assertEqual(collist, columns)
datalist = (
(
identity_fakes.limit_id,
identity_fakes.project_id,
identity_fakes.service_id,
identity_fakes.limit_resource_name,
identity_fakes.limit_resource_limit,
self.limit.id,
self.project.id,
self.service.id,
self.limit.resource_name,
self.limit.resource_limit,
None,
None,
),

9
releasenotes/notes/migrate-limit-to-sdk-378037ec2b79e302.yaml Normal file
View File

@@ -0,0 +1,9 @@
---
features:
- |
Migrate ``limit`` commands from keystoneclient to SDK.
upgrade:
- |
Filtering in ``limit`` commands is now case sensitive.
- |
Specifying ``--region None`` is no longer supported for ``limit`` commands.