diff options
author | Jenkins <jenkins@review.openstack.org> | 2014-11-12 21:12:58 +0000 |
---|---|---|
committer | Gerrit Code Review <review@openstack.org> | 2014-11-12 21:12:58 +0000 |
commit | efb0f37f8ded8365a1e6b75b259b5e3d9a01a943 (patch) | |
tree | 8fdef98131dd636cbc0ca2c778809441ba25b803 | |
parent | f159c7f07dd661dc9542d34c7a6f0fe80881fb3f (diff) | |
parent | d4c28878549967258bf7a0ad5dc0ebdde9ff4ddd (diff) | |
download | python-troveclient-efb0f37f8ded8365a1e6b75b259b5e3d9a01a943.tar.gz |
Merge "Reverse fix for 1323866 as it regressed trove CLI"
-rw-r--r-- | requirements.txt | 1 | ||||
-rw-r--r-- | troveclient/client.py | 105 | ||||
-rw-r--r-- | troveclient/shell.py | 187 | ||||
-rw-r--r-- | troveclient/tests/test_shell.py | 170 | ||||
-rw-r--r-- | troveclient/v1/client.py | 21 |
5 files changed, 92 insertions, 392 deletions
diff --git a/requirements.txt b/requirements.txt index 1ce2c2b..c90a404 100644 --- a/requirements.txt +++ b/requirements.txt @@ -6,6 +6,5 @@ argparse PrettyTable>=0.7,<0.8 requests>=2.2.0,!=2.4.0 simplejson>=2.2.0 -python-keystoneclient>=0.11.1 Babel>=1.3 six>=1.7.0 diff --git a/troveclient/client.py b/troveclient/client.py index 8280ae2..25a2235 100644 --- a/troveclient/client.py +++ b/troveclient/client.py @@ -25,7 +25,6 @@ import logging import os import requests -from keystoneclient import adapter from troveclient.openstack.common.apiclient import client from troveclient.openstack.common.apiclient import exceptions from troveclient import service_catalog @@ -51,21 +50,7 @@ if not hasattr(urlparse, 'parse_qsl'): urlparse.parse_qsl = cgi.parse_qsl -class TroveClientMixin(object): - - def get_database_api_version_from_endpoint(self): - magic_tuple = urlparse.urlsplit(self.management_url) - scheme, netloc, path, query, frag = magic_tuple - v = path.split("/")[1] - valid_versions = ['v1.0'] - if v not in valid_versions: - msg = "Invalid client version '%s'. must be one of: %s" % ( - (v, ', '.join(valid_versions))) - raise exceptions.UnsupportedVersion(msg) - return v[1:] - - -class HTTPClient(TroveClientMixin): +class HTTPClient(object): USER_AGENT = 'python-troveclient' @@ -74,17 +59,7 @@ class HTTPClient(TroveClientMixin): proxy_token=None, region_name=None, endpoint_type='publicURL', service_type=None, service_name=None, database_service_name=None, retries=None, - http_log_debug=False, cacert=None, bypass_url=None, - auth_system='keystone', auth_plugin=None): - - if auth_system and auth_system != 'keystone' and not auth_plugin: - raise exceptions.AuthSystemNotFound(auth_system) - - if not auth_url and auth_system and auth_system != 'keystone': - auth_url = auth_plugin.get_auth_url() - if not auth_url: - raise exceptions.EndpointNotFound() - + http_log_debug=False, cacert=None, bypass_url=None): self.user = user self.password = password self.projectid = projectid @@ -114,9 +89,6 @@ class HTTPClient(TroveClientMixin): else: self.verify_cert = True - self.auth_system = auth_system - self.auth_plugin = auth_plugin - self._logger = logging.getLogger(__name__) if self.http_log_debug and not self._logger.handlers: ch = logging.StreamHandler() @@ -279,6 +251,7 @@ class HTTPClient(TroveClientMixin): except exceptions.EndpointNotFound: print("Could not find any suitable endpoint. Correct region?") raise + elif resp.status_code == 305: return resp['location'] else: @@ -340,7 +313,6 @@ class HTTPClient(TroveClientMixin): # with the endpoints any more, we need to replace # our service account token with the user token. self.auth_token = self.proxy_token - else: try: while auth_url: @@ -416,67 +388,16 @@ class HTTPClient(TroveClientMixin): return self._extract_service_catalog(url, resp, body) - -class SessionClient(adapter.LegacyJsonAdapter): - - def request(self, url, method, **kwargs): - # NOTE(jamielennox): The standard call raises errors from - # keystoneclient, where we need to raise the novaclient errors. - raise_exc = kwargs.pop('raise_exc', True) - resp, body = super(SessionClient, self).request(url, - method, - raise_exc=False, - **kwargs) - - if raise_exc and resp.status_code >= 400: - raise exceptions.from_response(resp, body, url, method) - - return resp, body - - -def _construct_http_client(username=None, password=None, project_id=None, - auth_url=None, insecure=False, timeout=None, - proxy_tenant_id=None, proxy_token=None, - region_name=None, endpoint_type='publicURL', - service_type='database', - service_name=None, database_service_name=None, - retries=None, - http_log_debug=False, - auth_system='keystone', auth_plugin=None, - cacert=None, tenant_id=None, - session=None, - auth=None): - if session: - return SessionClient(session=session, - auth=auth, - interface=endpoint_type, - service_type=service_type, - service_name=service_name, - region_name=region_name, - http_log_debug=http_log_debug) - - # FIXME(jamielennox): username and password are now optional. Need - # to test that they were provided in this mode. - return HTTPClient(username, - password, - projectid=project_id, - auth_url=auth_url, - insecure=insecure, - timeout=timeout, - tenant_id=tenant_id, - proxy_token=proxy_token, - proxy_tenant_id=proxy_tenant_id, - region_name=region_name, - endpoint_type=endpoint_type, - service_type=service_type, - service_name=service_name, - database_service_name=database_service_name, - retries=retries, - http_log_debug=http_log_debug, - cacert=cacert, - auth_system=auth_system, - auth_plugin=auth_plugin, - ) + def get_database_api_version_from_endpoint(self): + magic_tuple = urlparse.urlsplit(self.management_url) + scheme, netloc, path, query, frag = magic_tuple + v = path.split("/")[1] + valid_versions = ['v1.0'] + if v not in valid_versions: + msg = "Invalid client version '%s'. must be one of: %s" % ( + (v, ', '.join(valid_versions))) + raise exceptions.UnsupportedVersion(msg) + return v[1:] def get_version_map(): diff --git a/troveclient/shell.py b/troveclient/shell.py index 95a9697..e03a2e9 100644 --- a/troveclient/shell.py +++ b/troveclient/shell.py @@ -32,23 +32,16 @@ import sys import pkg_resources import six -from keystoneclient.auth.identity.generic import password -from keystoneclient.auth.identity.generic import token -from keystoneclient.auth.identity import v3 as identity -from keystoneclient import session as ks_session - import troveclient import troveclient.extension from troveclient import client from troveclient.openstack.common.apiclient import exceptions as exc from troveclient.openstack.common import gettextutils as gtu -from troveclient.openstack.common.gettextutils import _ # noqa from troveclient.openstack.common import strutils from troveclient import utils from troveclient.v1 import shell as shell_v1 - DEFAULT_OS_DATABASE_API_VERSION = "1.0" DEFAULT_TROVE_ENDPOINT_TYPE = 'publicURL' DEFAULT_TROVE_SERVICE_TYPE = 'database' @@ -105,9 +98,53 @@ class OpenStackTroveShell(object): default=False), help="Print debugging output.") - parser.add_argument('--os-auth-system', - metavar='<auth-system>', - default=utils.env('OS_AUTH_SYSTEM')) + parser.add_argument('--os-username', + metavar='<auth-user-name>', + default=utils.env('OS_USERNAME', + 'TROVE_USERNAME'), + help='Defaults to env[OS_USERNAME].') + parser.add_argument('--os_username', + help=argparse.SUPPRESS) + + parser.add_argument('--os-password', + metavar='<auth-password>', + default=utils.env('OS_PASSWORD', + 'TROVE_PASSWORD'), + help='Defaults to env[OS_PASSWORD].') + parser.add_argument('--os_password', + help=argparse.SUPPRESS) + + parser.add_argument('--os-tenant-name', + metavar='<auth-tenant-name>', + default=utils.env('OS_TENANT_NAME', + 'TROVE_PROJECT_ID'), + help='Defaults to env[OS_TENANT_NAME].') + parser.add_argument('--os_tenant_name', + help=argparse.SUPPRESS) + + parser.add_argument('--os-tenant-id', + metavar='<auth-tenant-id>', + default=utils.env('OS_TENANT_ID', + 'TROVE_TENANT_ID'), + help='Defaults to env[OS_TENANT_ID].') + parser.add_argument('--os_tenant_id', + help=argparse.SUPPRESS) + + parser.add_argument('--os-auth-url', + metavar='<auth-url>', + default=utils.env('OS_AUTH_URL', + 'TROVE_URL'), + help='Defaults to env[OS_AUTH_URL].') + parser.add_argument('--os_auth_url', + help=argparse.SUPPRESS) + + parser.add_argument('--os-region-name', + metavar='<region-name>', + default=utils.env('OS_REGION_NAME', + 'TROVE_REGION_NAME'), + help='Defaults to env[OS_REGION_NAME].') + parser.add_argument('--os_region_name', + help=argparse.SUPPRESS) parser.add_argument('--service-type', metavar='<service-type>', @@ -159,6 +196,19 @@ class OpenStackTroveShell(object): parser.add_argument('--os_database_api_version', help=argparse.SUPPRESS) + parser.add_argument('--os-cacert', + metavar='<ca-certificate>', + default=utils.env('OS_CACERT', default=None), + help='Specify a CA bundle file to use in ' + 'verifying a TLS (https) server certificate. ' + 'Defaults to env[OS_CACERT].') + + parser.add_argument('--insecure', + default=utils.env('TROVECLIENT_INSECURE', + default=False), + action='store_true', + help=argparse.SUPPRESS) + parser.add_argument('--retries', metavar='<retries>', type=int, @@ -173,45 +223,8 @@ class OpenStackTroveShell(object): help='Output JSON instead of prettyprint. ' 'Defaults to env[OS_JSON_OUTPUT].') - self._append_global_identity_args(parser) - return parser - def _append_global_identity_args(self, parser): - # Register CLI identity related arguments - - # Use Keystoneclient API to register common V3 CLI arguments - ks_session.Session.register_cli_options(parser) - identity.Password.register_argparse_arguments(parser) - - parser.add_argument('--os-tenant-name', - metavar='<auth-tenant-name>', - default=utils.env('OS_TENANT_NAME'), - help='Tenant to request authorization on. ' - 'Defaults to env[OS_TENANT_NAME].') - parser.add_argument('--os_tenant_name', - help=argparse.SUPPRESS) - - parser.add_argument('--os-tenant-id', - metavar='<tenant-id>', - default=utils.env('OS_TENANT_ID'), - help='Tenant to request authorization on. ' - 'Defaults to env[OS_TENANT_ID].') - parser.add_argument('--os_tenant_id', - help=argparse.SUPPRESS) - - parser.add_argument('--os-auth-token', - default=utils.env('OS_AUTH_TOKEN'), - help='Defaults to env[OS_AUTH_TOKEN]') - - parser.add_argument('--os-region-name', - metavar='<region-name>', - default=utils.env('OS_REGION_NAME'), - help='Specify the region to use. ' - 'Defaults to env[OS_REGION_NAME].') - parser.add_argument('--os_region_name', - help=argparse.SUPPRESS) - def get_subcommand_parser(self, version): parser = self.get_base_parser() @@ -332,7 +345,6 @@ class OpenStackTroveShell(object): parser = self.get_base_parser() (options, args) = parser.parse_known_args(argv) self.setup_debugging(options.debug) - self.options = options # build available subcommands based on version self.extensions = self._discover_extensions( @@ -361,19 +373,14 @@ class OpenStackTroveShell(object): (os_username, os_password, os_tenant_name, os_auth_url, os_region_name, os_tenant_id, endpoint_type, insecure, service_type, service_name, database_service_name, - cacert, bypass_url, os_auth_system) = ( + cacert, bypass_url) = ( args.os_username, args.os_password, args.os_tenant_name, args.os_auth_url, args.os_region_name, args.os_tenant_id, args.endpoint_type, args.insecure, args.service_type, args.service_name, args.database_service_name, - args.os_cacert, args.bypass_url, args.os_auth_system) - - if os_auth_system and os_auth_system != "keystone": - auth_plugin = troveclient.auth_plugin.load_plugin(os_auth_system) - else: - auth_plugin = None + args.os_cacert, args.bypass_url) if not endpoint_type: endpoint_type = DEFAULT_TROVE_ENDPOINT_TYPE @@ -396,60 +403,26 @@ class OpenStackTroveShell(object): "via either --os-password or via " "env[OS_PASSWORD]") + if not (os_tenant_name or os_tenant_id): + raise exc.CommandError("You must provide a tenant_id " + "via either --os-tenant-id or " + "env[OS_TENANT_ID]") + if not os_auth_url: raise exc.CommandError( "You must provide an auth url " "via either --os-auth-url or env[OS_AUTH_URL]") - # V3 stuff - project_info_provided = (self.options.os_tenant_name or - self.options.os_tenant_id or - (self.options.os_project_name and - (self.options.os_project_domain_name or - self.options.os_project_domain_id)) or - self.options.os_project_id) - - if (not project_info_provided): + if not (os_tenant_name or os_tenant_id): raise exc.CommandError( - _("You must provide a tenant_name, tenant_id, " - "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 " - "(env[OS_PROJECT_DOMAIN_ID])" - " --os-project-domain-name " - "(env[OS_PROJECT_DOMAIN_NAME])")) + "You must provide a tenant_id " + "via either --os-tenant-id or env[OS_TENANT_ID]") if not os_auth_url: raise exc.CommandError( "You must provide an auth url " "via either --os-auth-url or env[OS_AUTH_URL]") - keystone_session = None - keystone_auth = None - if not auth_plugin: - project_id = args.os_project_id or args.os_tenant_id - project_name = args.os_project_name or args.os_tenant_name - - keystone_session = (ks_session.Session. - load_from_cli_options(args)) - keystone_auth = self._get_keystone_auth( - keystone_session, - args.os_auth_url, - username=args.os_username, - user_id=args.os_user_id, - user_domain_id=args.os_user_domain_id, - user_domain_name=args.os_user_domain_name, - password=args.os_password, - auth_token=args.os_auth_token, - project_id=project_id, - project_name=project_name, - project_domain_id=args.os_project_domain_id, - project_domain_name=args.os_project_domain_name) - self.cs = client.Client(options.os_database_api_version, os_username, os_password, os_tenant_name, os_auth_url, insecure, region_name=os_region_name, @@ -462,11 +435,7 @@ class OpenStackTroveShell(object): retries=options.retries, http_log_debug=args.debug, cacert=cacert, - bypass_url=bypass_url, - auth_system=os_auth_system, - auth_plugin=auth_plugin, - session=keystone_session, - auth=keystone_auth) + bypass_url=bypass_url) try: if not utils.isunauthenticated(args.func): @@ -529,20 +498,6 @@ class OpenStackTroveShell(object): else: self.parser.print_help() - def _get_keystone_auth(self, session, auth_url, **kwargs): - auth_token = kwargs.pop('auth_token', None) - if auth_token: - return token.Token(auth_url, auth_token, **kwargs) - else: - return password.Password( - auth_url, - username=kwargs.pop('username'), - user_id=kwargs.pop('user_id'), - password=kwargs.pop('password'), - user_domain_id=kwargs.pop('user_domain_id'), - user_domain_name=kwargs.pop('user_domain_name'), - **kwargs) - # I'm picky about my shell help. class OpenStackHelpFormatter(argparse.HelpFormatter): diff --git a/troveclient/tests/test_shell.py b/troveclient/tests/test_shell.py deleted file mode 100644 index b2776d1..0000000 --- a/troveclient/tests/test_shell.py +++ /dev/null @@ -1,170 +0,0 @@ -# -# Licensed under the Apache License, Version 2.0 (the "License"); you may -# not use this file except in compliance with the License. You may obtain -# a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations -# under the License. - -import re -import sys - -import fixtures -import mock -import six -import testtools - -import troveclient.client -from troveclient import exceptions -import troveclient.shell - -FAKE_V2_ENV = {'OS_USERNAME': 'user_id', - 'OS_PASSWORD': 'password', - 'OS_TENANT_ID': 'tenant_id', - 'OS_AUTH_URL': 'http://no.where/v2.0'} - -FAKE_V3_ENV = {'OS_USERNAME': 'xyz', - 'OS_PASSWORD': 'password', - 'OS_PROJECT_ID': 'project_id', - 'OS_USER_DOMAIN_NAME': 'user_domain_name', - 'OS_AUTH_URL': 'http://no.where/v3'} - - -class ShellTest(testtools.TestCase): - - def make_env(self, exclude=None, fake_env=FAKE_V2_ENV): - env = dict((k, v) for k, v in fake_env.items() if k != exclude) - self.useFixture(fixtures.MonkeyPatch('os.environ', env)) - - def setUp(self): - super(ShellTest, self).setUp() - self.useFixture(fixtures.MonkeyPatch( - 'troveclient.client.get_client_class', - mock.MagicMock)) - - def shell(self, argstr, exitcodes=(0,)): - orig = sys.stdout - orig_stderr = sys.stderr - try: - sys.stdout = six.StringIO() - sys.stderr = six.StringIO() - _shell = troveclient.shell.OpenStackTroveShell() - _shell.main(argstr.split()) - except SystemExit: - exc_type, exc_value, exc_traceback = sys.exc_info() - self.assertIn(exc_value.code, exitcodes) - finally: - stdout = sys.stdout.getvalue() - sys.stdout.close() - sys.stdout = orig - stderr = sys.stderr.getvalue() - sys.stderr.close() - sys.stderr = orig_stderr - return (stdout, stderr) - - def test_help_unknown_command(self): - self.assertRaises(exceptions.CommandError, self.shell, 'help foofoo') - - def test_help(self): - required = [ - '.*?^usage: ', - '.*?^See "trove help COMMAND" for help on a specific command', - ] - stdout, stderr = self.shell('help') - for r in required: - self.assertThat( - (stdout + stderr), - testtools.matchers.MatchesRegex(r, re.DOTALL | re.MULTILINE)) - - def test_no_username(self): - required = ('You must provide a username' - ' via either --os-username or' - ' env[OS_USERNAME]') - self.make_env(exclude='OS_USERNAME') - try: - self.shell('list') - except exceptions.CommandError as message: - self.assertEqual(required, message.args[0]) - else: - self.fail('CommandError not raised') - - def test_no_auth_url(self): - required = ('You must provide an auth url' - ' via either --os-auth-url or env[OS_AUTH_URL]',) - self.make_env(exclude='OS_AUTH_URL') - try: - self.shell('list') - except exceptions.CommandError as message: - self.assertEqual(required, message.args) - else: - self.fail('CommandError not raised') - - -class ShellTestKeystoneV3(ShellTest): - - version_id = u'v3' - links = [{u'href': u'http://no.where/v3', u'rel': u'self'}] - - def make_env(self, exclude=None, fake_env=FAKE_V3_ENV): - if 'OS_AUTH_URL' in fake_env: - fake_env.update({'OS_AUTH_URL': 'http://no.where/v3'}) - env = dict((k, v) for k, v in fake_env.items() if k != exclude) - self.useFixture(fixtures.MonkeyPatch('os.environ', env)) - - def test_no_project_id(self): - required = ( - u'You must provide a tenant_name, tenant_id, ' - u'project_id or project_name (with ' - u'project_domain_name or project_domain_id) via ' - u' --os-tenant-name (env[OS_TENANT_NAME]),' - u' --os-tenant-id (env[OS_TENANT_ID]),' - u' --os-project-id (env[OS_PROJECT_ID])' - u' --os-project-name (env[OS_PROJECT_NAME]),' - u' --os-project-domain-id ' - u'(env[OS_PROJECT_DOMAIN_ID])' - u' --os-project-domain-name ' - u'(env[OS_PROJECT_DOMAIN_NAME])' - ) - self.make_env(exclude='OS_PROJECT_ID') - try: - self.shell('list') - except exceptions.CommandError as message: - self.assertEqual(required, message.args[0]) - else: - self.fail('CommandError not raised') - - @mock.patch('sys.stdin', side_effect=mock.MagicMock) - @mock.patch('keystoneclient._discover.get_version_data', - return_value=[{u'status': u'stable', u'id': version_id, - u'links': links}]) - @mock.patch('troveclient.v1.datastores.DatastoreVersions.list', - return_value='foobar') - def test_datastore_version_list(self, mock_stdin, mock_discovery, - mock_dataversion): - mock_stdin.encoding = "utf-8" - expected = '\n'.join([ - '+----+------+', - '| ID | Name |', - '+----+------+', - '| | |', - '| | |', - '| | |', - '| | |', - '| | |', - '| | |', - '+----+------+', - '' - ]) - - with mock.patch('troveclient.client.SessionClient') as mock_session: - mock_stdin.encoding = "utf-8" - ms = mock_session.return_value - ms.get_database_api_version_from_endpoint.return_value = '1.0' - self.make_env() - stdout, stderr = self.shell('datastore-version-list XXX') - self.assertEqual((stdout + stderr), expected) diff --git a/troveclient/v1/client.py b/troveclient/v1/client.py index 13d1a37..7afb754 100644 --- a/troveclient/v1/client.py +++ b/troveclient/v1/client.py @@ -47,13 +47,11 @@ class Client(object): def __init__(self, username, password, project_id=None, auth_url='', insecure=False, timeout=None, tenant_id=None, proxy_tenant_id=None, proxy_token=None, region_name=None, - endpoint_type=None, extensions=None, + endpoint_type='publicURL', extensions=None, service_type='database', service_name=None, database_service_name=None, retries=None, http_log_debug=False, - cacert=None, bypass_url=None, - auth_system='keystone', auth_plugin=None, session=None, - auth=None): + cacert=None, bypass_url=None): # self.limits = limits.LimitsManager(self) # extensions @@ -93,11 +91,11 @@ class Client(object): setattr(self, extension.name, extension.manager_class(self)) - self.client = trove_client._construct_http_client( - username=username, - password=password, - project_id=project_id, - auth_url=auth_url, + self.client = trove_client.HTTPClient( + username, + password, + project_id, + auth_url, insecure=insecure, timeout=timeout, tenant_id=tenant_id, @@ -111,10 +109,7 @@ class Client(object): retries=retries, http_log_debug=http_log_debug, cacert=cacert, - auth_system=auth_system, - auth_plugin=auth_plugin, - session=session, - auth=auth) + bypass_url=bypass_url) def authenticate(self): """Authenticate against the server. |