openstack/python-openstackclient
Code Issues Proposed changes

identity: Migrate 'domain' commands to SDK

Browse Source 
Change-Id: Ide9cb9491334e139482f8cf1ea1874d01da0884f
Depends-On: Id1b7b00fe5b96f0cc922716afabcc678193f0f57
This commit is contained in:
Antonia Gaete
2024-07-09 18:53:55 +00:00
parent 8890981491
commit 4bdd51cbea
3 changed files with 187 additions and 148 deletions
Download Patch File Download Diff File Expand all files Collapse all files

105
openstackclient/identity/v3/domain.py
View File

@@ -17,7 +17,7 @@
import logging import logging
from keystoneauth1 import exceptions as ks_exc from openstack import exceptions as sdk_exceptions
from osc_lib.command import command from osc_lib.command import command
from osc_lib import exceptions from osc_lib import exceptions
from osc_lib import utils from osc_lib import utils
@@ -29,6 +29,31 @@ from openstackclient.identity import common
LOG = logging.getLogger(__name__) LOG = logging.getLogger(__name__)
def _format_domain(domain):
columns = (
'id',
'name',
'is_enabled',
'description',
'options',
)
column_headers = (
'id',
'name',
'enabled',
'description',
'options',
)
return (
column_headers,
utils.get_item_properties(
domain,
columns,
),
)
class CreateDomain(command.ShowOne): class CreateDomain(command.ShowOne):
_description = _("Create new domain") _description = _("Create new domain")
@@ -47,12 +72,15 @@ class CreateDomain(command.ShowOne):
enable_group = parser.add_mutually_exclusive_group() enable_group = parser.add_mutually_exclusive_group()
enable_group.add_argument( enable_group.add_argument(
'--enable', '--enable',
dest='is_enabled',
action='store_true', action='store_true',
default=True,
help=_('Enable domain (default)'), help=_('Enable domain (default)'),
) )
enable_group.add_argument( enable_group.add_argument(
'--disable', '--disable',
action='store_true', dest='is_enabled',
action='store_false',
help=_('Disable domain'), help=_('Disable domain'),
) )
parser.add_argument( parser.add_argument(
@@ -64,32 +92,25 @@ class CreateDomain(command.ShowOne):
return parser return parser
def take_action(self, parsed_args): def take_action(self, parsed_args):
identity_client = self.app.client_manager.identity identity_client = self.app.client_manager.sdk_connection.identity
enabled = True
if parsed_args.disable:
enabled = False
options = common.get_immutable_options(parsed_args) options = common.get_immutable_options(parsed_args)
try: try:
domain = identity_client.domains.create( domain = identity_client.create_domain(
name=parsed_args.name, name=parsed_args.name,
description=parsed_args.description, description=parsed_args.description,
options=options, options=options,
enabled=enabled, is_enabled=parsed_args.is_enabled,
) )
except ks_exc.Conflict: except sdk_exceptions.ConflictException:
if parsed_args.or_show: if parsed_args.or_show:
domain = utils.find_resource( domain = identity_client.find_domain(parsed_args.name)
identity_client.domains, parsed_args.name
)
LOG.info(_('Returning existing domain %s'), domain.name) LOG.info(_('Returning existing domain %s'), domain.name)
else: else:
raise raise
domain._info.pop('links') return _format_domain(domain)
return zip(*sorted(domain._info.items()))
class DeleteDomain(command.Command): class DeleteDomain(command.Command):
@@ -106,12 +127,12 @@ class DeleteDomain(command.Command):
return parser return parser
def take_action(self, parsed_args): def take_action(self, parsed_args):
identity_client = self.app.client_manager.identity identity_client = self.app.client_manager.sdk_connection.identity
result = 0 result = 0
for i in parsed_args.domain: for i in parsed_args.domain:
try: try:
domain = utils.find_resource(identity_client.domains, i) domain = identity_client.find_domain(i, ignore_missing=False)
identity_client.domains.delete(domain.id) identity_client.delete_domain(domain.id)
except Exception as e: except Exception as e:
result += 1 result += 1
LOG.error( LOG.error(
@@ -143,7 +164,7 @@ class ListDomain(command.Lister):
) )
parser.add_argument( parser.add_argument(
'--enabled', '--enabled',
dest='enabled', dest='is_enabled',
action='store_true', action='store_true',
help=_('The domains that are enabled will be returned'), help=_('The domains that are enabled will be returned'),
) )
@@ -153,13 +174,17 @@ class ListDomain(command.Lister):
kwargs = {} kwargs = {}
if parsed_args.name: if parsed_args.name:
kwargs['name'] = parsed_args.name kwargs['name'] = parsed_args.name
if parsed_args.enabled: if parsed_args.is_enabled:
kwargs['enabled'] = True kwargs['is_enabled'] = True
columns = ('id', 'name', 'is_enabled', 'description')
column_headers = ('ID', 'Name', 'Enabled', 'Description')
data = self.app.client_manager.sdk_connection.identity.domains(
**kwargs
)
columns = ('ID', 'Name', 'Enabled', 'Description')
data = self.app.client_manager.identity.domains.list(**kwargs)
return ( return (
columns, column_headers,
( (
utils.get_item_properties( utils.get_item_properties(
s, s,
@@ -194,38 +219,38 @@ class SetDomain(command.Command):
enable_group = parser.add_mutually_exclusive_group() enable_group = parser.add_mutually_exclusive_group()
enable_group.add_argument( enable_group.add_argument(
'--enable', '--enable',
dest='is_enabled',
action='store_true', action='store_true',
default=None,
help=_('Enable domain'), help=_('Enable domain'),
) )
enable_group.add_argument( enable_group.add_argument(
'--disable', '--disable',
action='store_true', dest='is_enabled',
action='store_false',
default=None,
help=_('Disable domain'), help=_('Disable domain'),
) )
common.add_resource_option_to_parser(parser) common.add_resource_option_to_parser(parser)
return parser return parser
def take_action(self, parsed_args): def take_action(self, parsed_args):
identity_client = self.app.client_manager.identity identity_client = self.app.client_manager.sdk_connection.identity
domain = utils.find_resource( domain = identity_client.find_domain(parsed_args.domain)
identity_client.domains, parsed_args.domain
)
kwargs = {} kwargs = {}
if parsed_args.name: if parsed_args.name:
kwargs['name'] = parsed_args.name kwargs['name'] = parsed_args.name
if parsed_args.description: if parsed_args.description:
kwargs['description'] = parsed_args.description kwargs['description'] = parsed_args.description
if parsed_args.enable: if parsed_args.is_enabled is not None:
kwargs['enabled'] = True kwargs['is_enabled'] = parsed_args.is_enabled
if parsed_args.disable:
kwargs['enabled'] = False
options = common.get_immutable_options(parsed_args) options = common.get_immutable_options(parsed_args)
if options: if options:
kwargs['options'] = options kwargs['options'] = options
identity_client.domains.update(domain.id, **kwargs) identity_client.update_domain(domain.id, **kwargs)
class ShowDomain(command.ShowOne): class ShowDomain(command.ShowOne):
@@ -241,13 +266,7 @@ class ShowDomain(command.ShowOne):
return parser return parser
def take_action(self, parsed_args): def take_action(self, parsed_args):
identity_client = self.app.client_manager.identity identity_client = self.app.client_manager.sdk_connection.identity
domain = identity_client.find_domain(parsed_args.domain)
domain_str = common._get_token_resource( return _format_domain(domain)
identity_client, 'domain', parsed_args.domain
)
domain = utils.find_resource(identity_client.domains, domain_str)
domain._info.pop('links')
return zip(*sorted(domain._info.items()))

220
openstackclient/tests/unit/identity/v3/test_domain.py
View File

@@ -10,33 +10,32 @@
# License for the specific language governing permissions and limitations # License for the specific language governing permissions and limitations
# under the License. # under the License.
from openstack.identity.v3 import domain as _domain
from openstack.test import fakes as sdk_fakes
from openstackclient.identity.v3 import domain from openstackclient.identity.v3 import domain
from openstackclient.tests.unit.identity.v3 import fakes as identity_fakes from openstackclient.tests.unit.identity.v3 import fakes as identity_fakes
class TestDomain(identity_fakes.TestIdentityv3): class TestDomainCreate(identity_fakes.TestIdentityv3):
def setUp(self): columns = (
super().setUp() 'id',
'name',
# Get a shortcut to the DomainManager Mock 'enabled',
self.domains_mock = self.identity_client.domains 'description',
self.domains_mock.reset_mock() 'options',
)
class TestDomainCreate(TestDomain):
columns = ('description', 'enabled', 'id', 'name', 'tags')
def setUp(self): def setUp(self):
super().setUp() super().setUp()
self.domain = identity_fakes.FakeDomain.create_one_domain() self.domain = sdk_fakes.generate_fake_resource(_domain.Domain)
self.domains_mock.create.return_value = self.domain self.identity_sdk_client.create_domain.return_value = self.domain
self.datalist = ( self.datalist = (
self.domain.description,
True,
self.domain.id, self.domain.id,
self.domain.name, self.domain.name,
self.domain.tags, self.domain.is_enabled,
self.domain.description,
self.domain.options,
) )
# Get the command object to test # Get the command object to test
@@ -61,9 +60,9 @@ class TestDomainCreate(TestDomain):
'name': self.domain.name, 'name': self.domain.name,
'description': None, 'description': None,
'options': {}, 'options': {},
'enabled': True, 'is_enabled': True,
} }
self.domains_mock.create.assert_called_with(**kwargs) self.identity_sdk_client.create_domain.assert_called_with(**kwargs)
self.assertEqual(self.columns, columns) self.assertEqual(self.columns, columns)
self.assertEqual(self.datalist, data) self.assertEqual(self.datalist, data)
@@ -90,9 +89,9 @@ class TestDomainCreate(TestDomain):
'name': self.domain.name, 'name': self.domain.name,
'description': 'new desc', 'description': 'new desc',
'options': {}, 'options': {},
'enabled': True, 'is_enabled': True,
} }
self.domains_mock.create.assert_called_with(**kwargs) self.identity_sdk_client.create_domain.assert_called_with(**kwargs)
self.assertEqual(self.columns, columns) self.assertEqual(self.columns, columns)
self.assertEqual(self.datalist, data) self.assertEqual(self.datalist, data)
@@ -103,7 +102,7 @@ class TestDomainCreate(TestDomain):
self.domain.name, self.domain.name,
] ]
verifylist = [ verifylist = [
('enable', True), ('is_enabled', True),
('name', self.domain.name), ('name', self.domain.name),
] ]
parsed_args = self.check_parser(self.cmd, arglist, verifylist) parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -118,9 +117,9 @@ class TestDomainCreate(TestDomain):
'name': self.domain.name, 'name': self.domain.name,
'description': None, 'description': None,
'options': {}, 'options': {},
'enabled': True, 'is_enabled': True,
} }
self.domains_mock.create.assert_called_with(**kwargs) self.identity_sdk_client.create_domain.assert_called_with(**kwargs)
self.assertEqual(self.columns, columns) self.assertEqual(self.columns, columns)
self.assertEqual(self.datalist, data) self.assertEqual(self.datalist, data)
@@ -131,7 +130,7 @@ class TestDomainCreate(TestDomain):
self.domain.name, self.domain.name,
] ]
verifylist = [ verifylist = [
('disable', True), ('is_enabled', False),
('name', self.domain.name), ('name', self.domain.name),
] ]
parsed_args = self.check_parser(self.cmd, arglist, verifylist) parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -146,9 +145,9 @@ class TestDomainCreate(TestDomain):
'name': self.domain.name, 'name': self.domain.name,
'description': None, 'description': None,
'options': {}, 'options': {},
'enabled': False, 'is_enabled': False,
} }
self.domains_mock.create.assert_called_with(**kwargs) self.identity_sdk_client.create_domain.assert_called_with(**kwargs)
self.assertEqual(self.columns, columns) self.assertEqual(self.columns, columns)
self.assertEqual(self.datalist, data) self.assertEqual(self.datalist, data)
@@ -174,9 +173,9 @@ class TestDomainCreate(TestDomain):
'name': self.domain.name, 'name': self.domain.name,
'description': None, 'description': None,
'options': {'immutable': True}, 'options': {'immutable': True},
'enabled': True, 'is_enabled': True,
} }
self.domains_mock.create.assert_called_with(**kwargs) self.identity_sdk_client.create_domain.assert_called_with(**kwargs)
self.assertEqual(self.columns, columns) self.assertEqual(self.columns, columns)
self.assertEqual(self.datalist, data) self.assertEqual(self.datalist, data)
@@ -202,23 +201,23 @@ class TestDomainCreate(TestDomain):
'name': self.domain.name, 'name': self.domain.name,
'description': None, 'description': None,
'options': {'immutable': False}, 'options': {'immutable': False},
'enabled': True, 'is_enabled': True,
} }
self.domains_mock.create.assert_called_with(**kwargs) self.identity_sdk_client.create_domain.assert_called_with(**kwargs)
self.assertEqual(self.columns, columns) self.assertEqual(self.columns, columns)
self.assertEqual(self.datalist, data) self.assertEqual(self.datalist, data)
class TestDomainDelete(TestDomain): class TestDomainDelete(identity_fakes.TestIdentityv3):
domain = identity_fakes.FakeDomain.create_one_domain() domain = sdk_fakes.generate_fake_resource(_domain.Domain)
def setUp(self): def setUp(self):
super().setUp() super().setUp()
# This is the return value for utils.find_resource() # This is the return value for utils.find_resource()
self.domains_mock.get.return_value = self.domain self.identity_sdk_client.find_domain.return_value = self.domain
self.domains_mock.delete.return_value = None self.identity_sdk_client.delete_domain.return_value = None
# Get the command object to test # Get the command object to test
self.cmd = domain.DeleteDomain(self.app, None) self.cmd = domain.DeleteDomain(self.app, None)
@@ -234,19 +233,35 @@ class TestDomainDelete(TestDomain):
result = self.cmd.take_action(parsed_args) result = self.cmd.take_action(parsed_args)
self.domains_mock.delete.assert_called_with( self.identity_sdk_client.delete_domain.assert_called_with(
self.domain.id, self.domain.id,
) )
self.assertIsNone(result) self.assertIsNone(result)
class TestDomainList(TestDomain): class TestDomainList(identity_fakes.TestIdentityv3):
domain = identity_fakes.FakeDomain.create_one_domain() domain = sdk_fakes.generate_fake_resource(
resource_type=_domain.Domain, is_enabled=True
)
columns = (
'ID',
'Name',
'Enabled',
'Description',
)
def setUp(self): def setUp(self):
super().setUp() super().setUp()
self.domains_mock.list.return_value = [self.domain] self.identity_sdk_client.domains.return_value = [self.domain]
self.datalist = (
(
self.domain.id,
self.domain.name,
self.domain.is_enabled,
self.domain.description,
),
)
# Get the command object to test # Get the command object to test
self.cmd = domain.ListDomain(self.app, None) self.cmd = domain.ListDomain(self.app, None)
@@ -260,19 +275,10 @@ class TestDomainList(TestDomain):
# returns a tuple containing the column names and an iterable # returns a tuple containing the column names and an iterable
# containing the data to be listed. # containing the data to be listed.
columns, data = self.cmd.take_action(parsed_args) columns, data = self.cmd.take_action(parsed_args)
self.domains_mock.list.assert_called_with() self.identity_sdk_client.domains.assert_called_with()
collist = ('ID', 'Name', 'Enabled', 'Description') self.assertEqual(self.columns, columns)
self.assertEqual(collist, columns) self.assertEqual(self.datalist, tuple(data))
datalist = (
(
self.domain.id,
self.domain.name,
True,
self.domain.description,
),
)
self.assertEqual(datalist, tuple(data))
def test_domain_list_with_option_name(self): def test_domain_list_with_option_name(self):
arglist = ['--name', self.domain.name] arglist = ['--name', self.domain.name]
@@ -285,23 +291,14 @@ class TestDomainList(TestDomain):
columns, data = self.cmd.take_action(parsed_args) columns, data = self.cmd.take_action(parsed_args)
kwargs = {'name': self.domain.name} kwargs = {'name': self.domain.name}
self.domains_mock.list.assert_called_with(**kwargs) self.identity_sdk_client.domains.assert_called_with(**kwargs)
collist = ('ID', 'Name', 'Enabled', 'Description') self.assertEqual(self.columns, columns)
self.assertEqual(collist, columns) self.assertEqual(self.datalist, tuple(data))
datalist = (
(
self.domain.id,
self.domain.name,
True,
self.domain.description,
),
)
self.assertEqual(datalist, tuple(data))
def test_domain_list_with_option_enabled(self): def test_domain_list_with_option_enabled(self):
arglist = ['--enabled'] arglist = ['--enabled']
verifylist = [('enabled', True)] verifylist = [('is_enabled', True)]
parsed_args = self.check_parser(self.cmd, arglist, verifylist) parsed_args = self.check_parser(self.cmd, arglist, verifylist)
# In base command class Lister in cliff, abstract method take_action() # In base command class Lister in cliff, abstract method take_action()
@@ -309,31 +306,22 @@ class TestDomainList(TestDomain):
# containing the data to be listed. # containing the data to be listed.
columns, data = self.cmd.take_action(parsed_args) columns, data = self.cmd.take_action(parsed_args)
kwargs = {'enabled': True} kwargs = {'is_enabled': True}
self.domains_mock.list.assert_called_with(**kwargs) self.identity_sdk_client.domains.assert_called_with(**kwargs)
collist = ('ID', 'Name', 'Enabled', 'Description') self.assertEqual(self.columns, columns)
self.assertEqual(collist, columns) self.assertEqual(self.datalist, tuple(data))
datalist = (
(
self.domain.id,
self.domain.name,
True,
self.domain.description,
),
)
self.assertEqual(datalist, tuple(data))
class TestDomainSet(TestDomain): class TestDomainSet(identity_fakes.TestIdentityv3):
domain = identity_fakes.FakeDomain.create_one_domain() domain = sdk_fakes.generate_fake_resource(_domain.Domain)
def setUp(self): def setUp(self):
super().setUp() super().setUp()
self.domains_mock.get.return_value = self.domain self.identity_sdk_client.find_domain.return_value = self.domain
self.domains_mock.update.return_value = self.domain self.identity_sdk_client.update_domain.return_value = self.domain
# Get the command object to test # Get the command object to test
self.cmd = domain.SetDomain(self.app, None) self.cmd = domain.SetDomain(self.app, None)
@@ -350,7 +338,9 @@ class TestDomainSet(TestDomain):
result = self.cmd.take_action(parsed_args) result = self.cmd.take_action(parsed_args)
kwargs = {} kwargs = {}
self.domains_mock.update.assert_called_with(self.domain.id, **kwargs) self.identity_sdk_client.update_domain.assert_called_with(
self.domain.id, **kwargs
)
self.assertIsNone(result) self.assertIsNone(result)
def test_domain_set_name(self): def test_domain_set_name(self):
@@ -371,7 +361,9 @@ class TestDomainSet(TestDomain):
kwargs = { kwargs = {
'name': 'qwerty', 'name': 'qwerty',
} }
self.domains_mock.update.assert_called_with(self.domain.id, **kwargs) self.identity_sdk_client.update_domain.assert_called_with(
self.domain.id, **kwargs
)
self.assertIsNone(result) self.assertIsNone(result)
def test_domain_set_description(self): def test_domain_set_description(self):
@@ -392,7 +384,9 @@ class TestDomainSet(TestDomain):
kwargs = { kwargs = {
'description': 'new desc', 'description': 'new desc',
} }
self.domains_mock.update.assert_called_with(self.domain.id, **kwargs) self.identity_sdk_client.update_domain.assert_called_with(
self.domain.id, **kwargs
)
self.assertIsNone(result) self.assertIsNone(result)
def test_domain_set_enable(self): def test_domain_set_enable(self):
@@ -401,7 +395,7 @@ class TestDomainSet(TestDomain):
self.domain.id, self.domain.id,
] ]
verifylist = [ verifylist = [
('enable', True), ('is_enabled', True),
('domain', self.domain.id), ('domain', self.domain.id),
] ]
parsed_args = self.check_parser(self.cmd, arglist, verifylist) parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -410,9 +404,11 @@ class TestDomainSet(TestDomain):
# Set expected values # Set expected values
kwargs = { kwargs = {
'enabled': True, 'is_enabled': True,
} }
self.domains_mock.update.assert_called_with(self.domain.id, **kwargs) self.identity_sdk_client.update_domain.assert_called_with(
self.domain.id, **kwargs
)
self.assertIsNone(result) self.assertIsNone(result)
def test_domain_set_disable(self): def test_domain_set_disable(self):
@@ -421,7 +417,7 @@ class TestDomainSet(TestDomain):
self.domain.id, self.domain.id,
] ]
verifylist = [ verifylist = [
('disable', True), ('is_enabled', False),
('domain', self.domain.id), ('domain', self.domain.id),
] ]
parsed_args = self.check_parser(self.cmd, arglist, verifylist) parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -430,9 +426,11 @@ class TestDomainSet(TestDomain):
# Set expected values # Set expected values
kwargs = { kwargs = {
'enabled': False, 'is_enabled': False,
} }
self.domains_mock.update.assert_called_with(self.domain.id, **kwargs) self.identity_sdk_client.update_domain.assert_called_with(
self.domain.id, **kwargs
)
self.assertIsNone(result) self.assertIsNone(result)
def test_domain_set_immutable_option(self): def test_domain_set_immutable_option(self):
@@ -452,7 +450,9 @@ class TestDomainSet(TestDomain):
kwargs = { kwargs = {
'options': {'immutable': True}, 'options': {'immutable': True},
} }
self.domains_mock.update.assert_called_with(self.domain.id, **kwargs) self.identity_sdk_client.update_domain.assert_called_with(
self.domain.id, **kwargs
)
self.assertIsNone(result) self.assertIsNone(result)
def test_domain_set_no_immutable_option(self): def test_domain_set_no_immutable_option(self):
@@ -472,16 +472,34 @@ class TestDomainSet(TestDomain):
kwargs = { kwargs = {
'options': {'immutable': False}, 'options': {'immutable': False},
} }
self.domains_mock.update.assert_called_with(self.domain.id, **kwargs) self.identity_sdk_client.update_domain.assert_called_with(
self.domain.id, **kwargs
)
self.assertIsNone(result) self.assertIsNone(result)
class TestDomainShow(TestDomain): class TestDomainShow(identity_fakes.TestIdentityv3):
columns = (
'id',
'name',
'enabled',
'description',
'options',
)
def setUp(self): def setUp(self):
super().setUp() super().setUp()
self.domain = identity_fakes.FakeDomain.create_one_domain() self.domain = sdk_fakes.generate_fake_resource(_domain.Domain)
self.domains_mock.get.return_value = self.domain self.identity_sdk_client.find_domain.return_value = self.domain
self.datalist = (
self.domain.id,
self.domain.name,
self.domain.is_enabled,
self.domain.description,
self.domain.options,
)
# Get the command object to test # Get the command object to test
self.cmd = domain.ShowDomain(self.app, None) self.cmd = domain.ShowDomain(self.app, None)
@@ -501,17 +519,9 @@ class TestDomainShow(TestDomain):
# returns a two-part tuple with a tuple of column names and a tuple of # returns a two-part tuple with a tuple of column names and a tuple of
# data to be shown. # data to be shown.
columns, data = self.cmd.take_action(parsed_args) columns, data = self.cmd.take_action(parsed_args)
self.domains_mock.get.assert_called_with( self.identity_sdk_client.find_domain.assert_called_with(
self.domain.id, self.domain.id,
) )
collist = ('description', 'enabled', 'id', 'name', 'tags') self.assertEqual(self.columns, columns)
self.assertEqual(collist, columns) self.assertEqual(self.datalist, data)
datalist = (
self.domain.description,
True,
self.domain.id,
self.domain.name,
self.domain.tags,
)
self.assertEqual(datalist, data)

10
releasenotes/notes/migrate-domain-to-sdk-da6ec38221e79a37.yaml Normal file
View File

@@ -0,0 +1,10 @@
---
upgrade:
- |
The following commands have been migrated to SDK:
- ``domain create``
- ``domain delete``
- ``domain list``
- ``domain set``
- ``domain show``