Skip to content

Commit f18f264

Browse files
author
Dean Troyer
committed
Command docs: domain
Change the implementation of --enable|--disable on domain create and set commands to our usual style. Change-Id: I10f2b96281a114fa3cf3b001394844770b2a8632
1 parent be8cac9 commit f18f264

4 files changed

Lines changed: 22 additions & 22 deletions

File tree

‎doc/source/command-objects/domain.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Create new domain
3636

3737
If the domain already exists, return the existing domain data and do not fail.
3838

39-
.. option:: <domain-name>
39+
.. describe:: <domain-name>
4040

4141
New domain name
4242

@@ -51,7 +51,7 @@ Delete domain
5151
os domain delete
5252
<domain>
5353
54-
.. option:: <domain>
54+
.. describe:: <domain>
5555

5656
Domain to delete (name or ID)
5757

@@ -95,7 +95,7 @@ Set domain properties
9595

9696
Disable domain
9797

98-
.. option:: <domain>
98+
.. describe:: <domain>
9999

100100
Domain to modify (name or ID)
101101

@@ -110,6 +110,6 @@ Show domain details
110110
os domain show
111111
<domain>
112112
113-
.. option:: <domain>
113+
.. describe:: <domain>
114114

115115
Domain to display (name or ID)

‎doc/source/commands.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ referring to both Compute and Volume quotas.
7878
* ``consumer``: Identity - OAuth-based delegatee
7979
* ``container``: Object Store - a grouping of objects
8080
* ``credentials``: (**Identity**) specific to identity providers
81-
* ``domain``: Identity - a grouping of projects
81+
* ``domain``: (**Identity**) a grouping of projects
8282
* ``endpoint``: (**Identity**) the base URL used to contact a specific service
8383
* ``extension``: (**Compute**, **Identity**, **Volume**) OpenStack server API extensions
8484
* ``flavor``: Compute - pre-defined configurations of servers: ram, root disk, etc

‎openstackclient/identity/v3/domain.py‎

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -48,15 +48,14 @@ def get_parser(self, prog_name):
4848
enable_group = parser.add_mutually_exclusive_group()
4949
enable_group.add_argument(
5050
'--enable',
51-
dest='enabled',
5251
action='store_true',
53-
default=True,
54-
help='Enable domain')
52+
help='Enable domain (default)',
53+
)
5554
enable_group.add_argument(
5655
'--disable',
57-
dest='enabled',
58-
action='store_false',
59-
help='Disable domain')
56+
action='store_true',
57+
help='Disable domain',
58+
)
6059
parser.add_argument(
6160
'--or-show',
6261
action='store_true',
@@ -68,11 +67,15 @@ def take_action(self, parsed_args):
6867
self.log.debug('take_action(%s)', parsed_args)
6968
identity_client = self.app.client_manager.identity
7069

70+
enabled = True
71+
if parsed_args.disable:
72+
enabled = False
73+
7174
try:
7275
domain = identity_client.domains.create(
7376
name=parsed_args.name,
7477
description=parsed_args.description,
75-
enabled=parsed_args.enabled,
78+
enabled=enabled,
7679
)
7780
except ksc_exc.Conflict as e:
7881
if parsed_args.or_show:
@@ -150,13 +153,11 @@ def get_parser(self, prog_name):
150153
enable_group = parser.add_mutually_exclusive_group()
151154
enable_group.add_argument(
152155
'--enable',
153-
dest='enabled',
154156
action='store_true',
155157
help='Enable domain',
156158
)
157159
enable_group.add_argument(
158160
'--disable',
159-
dest='disabled',
160161
action='store_true',
161162
help='Disable domain',
162163
)
@@ -172,9 +173,10 @@ def take_action(self, parsed_args):
172173
kwargs['name'] = parsed_args.name
173174
if parsed_args.description:
174175
kwargs['description'] = parsed_args.description
175-
if parsed_args.enabled:
176+
177+
if parsed_args.enable:
176178
kwargs['enabled'] = True
177-
if parsed_args.disabled:
179+
if parsed_args.disable:
178180
kwargs['enabled'] = False
179181

180182
if not kwargs:

‎openstackclient/tests/identity/v3/test_domain.py‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,6 @@ def test_domain_create_no_options(self):
4646
identity_fakes.domain_name,
4747
]
4848
verifylist = [
49-
('enabled', True),
5049
('name', identity_fakes.domain_name),
5150
]
5251
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -81,7 +80,6 @@ def test_domain_create_description(self):
8180
]
8281
verifylist = [
8382
('description', 'new desc'),
84-
('enabled', True),
8583
('name', identity_fakes.domain_name),
8684
]
8785
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -115,7 +113,7 @@ def test_domain_create_enable(self):
115113
identity_fakes.domain_name,
116114
]
117115
verifylist = [
118-
('enabled', True),
116+
('enable', True),
119117
('name', identity_fakes.domain_name),
120118
]
121119
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -149,7 +147,7 @@ def test_domain_create_disable(self):
149147
identity_fakes.domain_name,
150148
]
151149
verifylist = [
152-
('enabled', False),
150+
('disable', True),
153151
('name', identity_fakes.domain_name),
154152
]
155153
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -333,7 +331,7 @@ def test_domain_set_enable(self):
333331
identity_fakes.domain_id,
334332
]
335333
verifylist = [
336-
('enabled', True),
334+
('enable', True),
337335
('domain', identity_fakes.domain_id),
338336
]
339337
parsed_args = self.check_parser(self.cmd, arglist, verifylist)
@@ -356,7 +354,7 @@ def test_domain_set_disable(self):
356354
identity_fakes.domain_id,
357355
]
358356
verifylist = [
359-
('disabled', True),
357+
('disable', True),
360358
('domain', identity_fakes.domain_id),
361359
]
362360
parsed_args = self.check_parser(self.cmd, arglist, verifylist)

0 commit comments

Comments
 (0)