openstack/python-cinderclient
Code Issues Proposed changes

Drop support for OS_TENANT_NAME and OS_TENANT_ID

Browse Source 
These have been deprecated for a very long time now. Switch to only
support the current OS_PROJECT_NAME and OS_PROJECT_ID.

Change-Id: I2fb78768b4308a3aaf12764edadb58d4a307adaa
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
This commit is contained in:
Sean McGinnis 2019-04-18 11:57:24 -05:00
parent e98585c03d
commit dce8a8ed10
3 changed files with 12 additions and 22 deletions
cinderclient
shell.py
tests/unit
test_shell.py
releasenotes/notes
cinderclient-5-de0508ce5a221d21.yaml

24
cinderclient/shell.py

@ -255,24 +255,14 @@ class OpenStackCinderShell(object):
parser.add_argument('--os_password',
help=argparse.SUPPRESS)
# tenant_name is deprecated by project_name in keystoneauth
parser.set_defaults(os_project_name=utils.env('OS_PROJECT_NAME',
'OS_TENANT_NAME',
'CINDER_PROJECT_ID'))
parser.add_argument('--os_tenant_name',
dest='os_project_name',
help=argparse.SUPPRESS)
parser.add_argument(
'--os_project_name',
help=argparse.SUPPRESS)
# tenant_id is deprecated by project_id in keystoneauth
parser.set_defaults(os_project_id=utils.env('OS_PROJECT_ID',
'OS_TENANT_ID',
'CINDER_TENANT_ID'))
parser.add_argument('--os_tenant_id',
dest='os_project_id',
help=argparse.SUPPRESS)
'CINDER_PROJECT_ID'))
parser.add_argument(
'--os_project_id',
help=argparse.SUPPRESS)
@ -635,11 +625,8 @@ class OpenStackCinderShell(object):
if not project_info_provided:
raise exc.CommandError(_(
"You must provide a tenant_name, tenant_id, "
"project_id or project_name (with "
"You must provide a project_id or project_name (with "
"project_domain_name or project_domain_id) via "
" --os-tenant-name (env[OS_TENANT_NAME]),"
" --os-tenant-id (env[OS_TENANT_ID]),"
" --os-project-id (env[OS_PROJECT_ID])"
" --os-project-name (env[OS_PROJECT_NAME]),"
" --os-project-domain-id "
@ -655,11 +642,8 @@ class OpenStackCinderShell(object):
if not project_info_provided:
raise exc.CommandError(_(
"You must provide a tenant_name, tenant_id, "
"project_id or project_name (with "
"You must provide a project_id or project_name (with "
"project_domain_name or project_domain_id) via "
" --os-tenant-name (env[OS_TENANT_NAME]),"
" --os-tenant-id (env[OS_TENANT_ID]),"
" --os-project-id (env[OS_PROJECT_ID])"
" --os-project-name (env[OS_PROJECT_NAME]),"
" --os-project-domain-id "
@ -976,7 +960,7 @@ class OpenStackHelpFormatter(argparse.HelpFormatter):
def start_section(self, heading):
# Title-case the headings
heading = '%s%s' % (heading[0].upper(), heading[1:])
heading = heading.title()
super(OpenStackHelpFormatter, self).start_section(heading)

4
cinderclient/tests/unit/test_shell.py

@ -43,7 +43,7 @@ class ShellTest(utils.TestCase):
FAKE_ENV = {
'OS_USERNAME': 'username',
'OS_PASSWORD': 'password',
'OS_TENANT_NAME': 'tenant_name',
'OS_PROJECT_NAME': 'tenant_name',
'OS_AUTH_URL': 'http://no.where/v2.0',
}
@ -227,7 +227,7 @@ class ShellTest(utils.TestCase):
self.FAKE_ENV['OS_AUTH_URL'],
password=mock_getpass.return_value,
tenant_id='',
tenant_name=self.FAKE_ENV['OS_TENANT_NAME'],
tenant_name=self.FAKE_ENV['OS_PROJECT_NAME'],
username=self.FAKE_ENV['OS_USERNAME'])
@requests_mock.Mocker()

6
releasenotes/notes/cinderclient-5-de0508ce5a221d21.yaml

@ -16,3 +16,9 @@ upgrade:
- |
The ``cinder credentials`` command was deprecated and has now been removed.
The command ``openstack token issue`` should be used instead.
- |
The use of ``--os_tenant_name``, ``--os_tenant_id`` and the environment
variables ``OS_TENANT_NAME`` and ``OS_TENANT_ID`` have been deprecated
for several releases and have now been removed. After upgrading, use the
equivalent ``--os_project_name``, ``--os_project_id``, ``OS_PROJECT_NAME``
and ``OS_PROJECT_ID``.