openstack
/
python-tripleoclient
Code Issues Proposed changes

[WALLABY-ONLY] Deprecation of the "openstack tripleo validator" CLI 

This patch deprecates the ``openstack tripleo validator`` CLI in favor
of the new ``validation`` CLI.

* openstack tripleo validator list           -> validation list
* openstack tripleo validator show           -> validation show
* openstack tripleo validator group info     -> validation show group
* openstack tripleo validator show parameter -> validation show parameter
* openstack tripleo validator show history   -> validation history list
* openstack tripleo validator show run       -> validation history get

The above sub commands remain functional but display a warning message
and are going to be removed from stable/xena as soon as possible.

Co-Authored-By: David Peacock <dpeacock@redhat.com>
Co-Authored-By: Mathieu Bultel <mbultel@redhat.com>

Signed-off-by: Gael Chamoulaud (Strider) <gchamoul@redhat.com>
Change-Id: I829f0cf39c25872c8e2816b5fb6398b7d11ead26
This commit is contained in:
Gael Chamoulaud (Strider) 2021-11-18 18:09:56 +01:00
parent f004ede757
commit 7ba9e8b32c
No known key found for this signature in database
GPG Key ID: 4119D0305C651D66
5 changed files with 158 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
releasenotes/notes/deprecation-openstack-tripleo-validator-cli-2612ab3234f506b0.yaml Normal file
View File

@ -0,0 +1,18 @@
---
deprecations:
- |
The ``openstack tripleo validator`` CLI has been deprecated in favor the
``validation`` CLI.
.. code-block:: console
+--------------------------------------------+---------------------------+
| Old CLI sub commands | New CLI sub commands |
+--------------------------------------------+---------------------------+
| openstack tripleo validator list | validation list |
| openstack tripleo validator show | validation show |
| openstack tripleo validator group info | validation show group |
| openstack tripleo validator show parameter | validation show parameter |
| openstack tripleo validator show history | validation history list |
| openstack tripleo validator show run | validation history get |
+--------------------------------------------+---------------------------+

1
releasenotes/source/index.rst
View File

@ -9,6 +9,7 @@ Contents
:maxdepth: 2
unreleased
wallaby
victoria
ussuri
train

6
releasenotes/source/wallaby.rst Normal file
View File

@ -0,0 +1,6 @@
============================
Wallaby Series Release Notes
============================
.. release-notes::
:branch: stable/wallaby

14
setup.cfg
View File

@ -101,13 +101,13 @@ openstack.tripleoclient.v2 =
undercloud_install = tripleoclient.v1.undercloud:InstallUndercloud
undercloud_upgrade = tripleoclient.v1.undercloud:UpgradeUndercloud
undercloud_backup = tripleoclient.v1.undercloud_backup:BackupUndercloud
tripleo_validator_group_info = tripleoclient.v1.tripleo_validator:TripleOValidatorGroupInfo
tripleo_validator_list = tripleoclient.v1.tripleo_validator:TripleOValidatorList
tripleo_validator_run = tripleoclient.v1.tripleo_validator:TripleOValidatorRun
tripleo_validator_show = tripleoclient.v1.tripleo_validator:TripleOValidatorShow
tripleo_validator_show_history = tripleoclient.v1.tripleo_validator:TripleOValidatorShowHistory
tripleo_validator_show_parameter = tripleoclient.v1.tripleo_validator:TripleOValidatorShowParameter
tripleo_validator_show_run = tripleoclient.v1.tripleo_validator:TripleOValidatorShowRun
tripleo_validator_group_info = tripleoclient.v1.tripleo_validator:DeprecatedTripleOValidatorGroupInfo
tripleo_validator_list = tripleoclient.v1.tripleo_validator:DeprecatedTripleOValidatorList
tripleo_validator_run = tripleoclient.v1.tripleo_validator:DeprecatedTripleOValidatorRun
tripleo_validator_show = tripleoclient.v1.tripleo_validator:DeprecatedTripleOValidatorShow
tripleo_validator_show_history = tripleoclient.v1.tripleo_validator:DeprecatedTripleOValidatorShowHistory
tripleo_validator_show_parameter = tripleoclient.v1.tripleo_validator:DeprecatedTripleOValidatorShowParameter
tripleo_validator_show_run = tripleoclient.v1.tripleo_validator:DeprecatedTripleOValidatorShowRun
oslo.config.opts =
undercloud_config = tripleoclient.config.undercloud:list_opts

126
tripleoclient/v1/tripleo_validator.py
View File

@ -36,6 +36,24 @@ class TripleOValidatorList(ValidationList):
return parser
class DeprecatedTripleOValidatorList(TripleOValidatorList):
"""[DEPRECATED]: List the available validations.
Please use "validation list --help" instead.
"""
log = logging.getLogger('deprecated')
def take_action(self, parsed_args):
self.log.warning(
'This command has been deprecated. '
'Please use "validation list" instead.'
)
return super(
DeprecatedTripleOValidatorList, self
).take_action(parsed_args)
class TripleOValidatorShow(Show):
"""Display detailed information about a Validation"""
@ -46,6 +64,24 @@ class TripleOValidatorShow(Show):
return parser
class DeprecatedTripleOValidatorShow(TripleOValidatorShow):
"""[DEPRECATED]: Display detailed information about a Validation.
Please use "validation show --help" instead.
"""
log = logging.getLogger('deprecated')
def take_action(self, parsed_args):
self.log.warning(
'This command has been deprecated. '
'Please use "validation show" instead.'
)
return super(
DeprecatedTripleOValidatorShow, self
).take_action(parsed_args)
class TripleOValidatorGroupInfo(ShowGroup):
"""Display detailed information about a Group"""
@ -56,6 +92,24 @@ class TripleOValidatorGroupInfo(ShowGroup):
return parser
class DeprecatedTripleOValidatorGroupInfo(TripleOValidatorGroupInfo):
"""[DEPRECATED]: Display detailed information about a Group.
Please use "validation show group --help" instead.
"""
log = logging.getLogger('deprecated')
def take_action(self, parsed_args):
self.log.warning(
'This command has been deprecated. '
'Please use "validation show group" instead.'
)
return super(
DeprecatedTripleOValidatorGroupInfo, self
).take_action(parsed_args)
class TripleOValidatorShowParameter(ShowParameter):
"""Display Validations Parameters"""
@ -66,6 +120,24 @@ class TripleOValidatorShowParameter(ShowParameter):
return parser
class DeprecatedTripleOValidatorShowParameter(TripleOValidatorShowParameter):
"""[DEPRECATED]: Display Validations Parameters.
Please use "validation show parameter --help" instead.
"""
log = logging.getLogger('deprecated')
def take_action(self, parsed_args):
self.log.warning(
'This command has been deprecated. '
'Please use "validation show parameter" instead.'
)
return super(
DeprecatedTripleOValidatorShowParameter, self
).take_action(parsed_args)
class TripleOValidatorRun(Run):
"""Run the available validations"""
@ -76,6 +148,24 @@ class TripleOValidatorRun(Run):
return parser
class DeprecatedTripleOValidatorRun(TripleOValidatorRun):
"""[DEPRECATED]: Run the available validations.
Please use "validation run --help" instead.
"""
log = logging.getLogger('deprecated')
def take_action(self, parsed_args):
self.log.warning(
'This command has been deprecated. '
'Please use "validation run" instead.'
)
return super(
DeprecatedTripleOValidatorRun, self
).take_action(parsed_args)
class TripleOValidatorShowHistory(ListHistory):
"""Display Validations execution history"""
@ -86,6 +176,24 @@ class TripleOValidatorShowHistory(ListHistory):
return parser
class DeprecatedTripleOValidatorShowHistory(TripleOValidatorShowHistory):
"""[DEPRECATED]: Display Validations execution history.
Please use "validation history list --help" instead.
"""
log = logging.getLogger('deprecated')
def take_action(self, parsed_args):
self.log.warning(
'This command has been deprecated. '
'Please use "validation history list" instead.'
)
return super(
DeprecatedTripleOValidatorShowHistory, self
).take_action(parsed_args)
class TripleOValidatorShowRun(GetHistory):
"""Display details about a Validation execution"""
@ -94,3 +202,21 @@ class TripleOValidatorShowRun(GetHistory):
def get_parser(self, parser):
parser = super(TripleOValidatorShowRun, self).get_parser(parser)
return parser
class DeprecatedTripleOValidatorShowRun(TripleOValidatorShowRun):
"""[DEPRECATED]: Display details about a Validation execution.
Please use "validation history get --help" instead.
"""
log = logging.getLogger('deprecated')
def take_action(self, parsed_args):
self.log.warning(
'This command has been deprecated. '
'Please use "validation history get" instead.'
)
return super(
DeprecatedTripleOValidatorShowRun, self
).take_action(parsed_args)