# Copyright 2013 OpenStack Foundation # Copyright (C) 2013 Yahoo! Inc. # All Rights Reserved. # # 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 argparse try: from collections import OrderedDict except ImportError: from ordereddict import OrderedDict import hashlib import json import logging import os import sys import traceback import uuid import fixtures from keystoneclient import exceptions as ks_exc from keystoneclient import fixture as ks_fixture import mock import requests from requests_mock.contrib import fixture as rm_fixture import six from bileanclient.common import utils from bileanclient import exc from bileanclient import shell as openstack_shell from bileanclient.tests.unit import utils as testutils DEFAULT_BILEAN_URL = 'http://127.0.0.1:5000/' DEFAULT_USERNAME = 'username' DEFAULT_PASSWORD = 'password' DEFAULT_TENANT_ID = 'tenant_id' DEFAULT_TENANT_NAME = 'tenant_name' DEFAULT_PROJECT_ID = '0123456789' DEFAULT_USER_DOMAIN_NAME = 'user_domain_name' DEFAULT_UNVERSIONED_AUTH_URL = 'http://127.0.0.1:5000/' DEFAULT_V2_AUTH_URL = '%sv2.0' % DEFAULT_UNVERSIONED_AUTH_URL DEFAULT_V3_AUTH_URL = '%sv3' % DEFAULT_UNVERSIONED_AUTH_URL DEFAULT_AUTH_TOKEN = 'ba5501a434914768824374764adb8014' TEST_SERVICE_URL = 'http://127.0.0.1:5000/' FAKE_V2_ENV = {'OS_USERNAME': DEFAULT_USERNAME, 'OS_PASSWORD': DEFAULT_PASSWORD, 'OS_TENANT_NAME': DEFAULT_TENANT_NAME, 'OS_AUTH_URL': DEFAULT_V2_AUTH_URL, 'OS_IMAGE_URL': DEFAULT_BILEAN_URL} FAKE_V3_ENV = {'OS_USERNAME': DEFAULT_USERNAME, 'OS_PASSWORD': DEFAULT_PASSWORD, 'OS_PROJECT_ID': DEFAULT_PROJECT_ID, 'OS_USER_DOMAIN_NAME': DEFAULT_USER_DOMAIN_NAME, 'OS_AUTH_URL': DEFAULT_V3_AUTH_URL, 'OS_IMAGE_URL': DEFAULT_BILEAN_URL} TOKEN_ID = uuid.uuid4().hex V2_TOKEN = ks_fixture.V2Token(token_id=TOKEN_ID) V2_TOKEN.set_scope() _s = V2_TOKEN.add_service('billing', name='bilean') _s.add_endpoint(DEFAULT_BILEAN_URL) V3_TOKEN = ks_fixture.V3Token() V3_TOKEN.set_project_scope() _s = V3_TOKEN.add_service('billing', name='bilean') _s.add_standard_endpoints(public=DEFAULT_BILEAN_URL) class ShellTest(testutils.TestCase): # auth environment to use auth_env = FAKE_V2_ENV.copy() # expected auth plugin to invoke token_url = DEFAULT_V2_AUTH_URL + '/tokens' # Patch os.environ to avoid required auth info def make_env(self, exclude=None): env = dict((k, v) for k, v in self.auth_env.items() if k != exclude) self.useFixture(fixtures.MonkeyPatch('os.environ', env)) def setUp(self): super(ShellTest, self).setUp() global _old_env _old_env, os.environ = os.environ, self.auth_env self.requests = self.useFixture(rm_fixture.Fixture()) json_list = ks_fixture.DiscoveryList(DEFAULT_UNVERSIONED_AUTH_URL) self.requests.get(DEFAULT_BILEAN_URL, json=json_list, status_code=300) json_v2 = {'version': ks_fixture.V2Discovery(DEFAULT_V2_AUTH_URL)} self.requests.get(DEFAULT_V2_AUTH_URL, json=json_v2) json_v3 = {'version': ks_fixture.V3Discovery(DEFAULT_V3_AUTH_URL)} self.requests.get(DEFAULT_V3_AUTH_URL, json=json_v3) self.v2_auth = self.requests.post(DEFAULT_V2_AUTH_URL + '/tokens', json=V2_TOKEN) headers = {'X-Subject-Token': TOKEN_ID} self.v3_auth = self.requests.post(DEFAULT_V3_AUTH_URL + '/auth/tokens', headers=headers, json=V3_TOKEN) global shell, _shell, assert_called, assert_called_anytime _shell = openstack_shell.BileanShell() shell = lambda cmd: _shell.main(cmd.split()) def tearDown(self): super(ShellTest, self).tearDown() global _old_env os.environ = _old_env def shell(self, argstr, exitcodes=(0,)): orig = sys.stdout orig_stderr = sys.stderr try: sys.stdout = six.StringIO() sys.stderr = six.StringIO() _shell = openstack_shell.BileanShell() _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): shell = openstack_shell.BileanShell() argstr = 'help foofoo' self.assertRaises(exc.CommandError, shell.main, argstr.split()) @mock.patch('sys.stdout', six.StringIO()) @mock.patch('sys.stderr', six.StringIO()) @mock.patch('sys.argv', ['bilean', 'help', 'foofoo']) def test_no_stacktrace_when_debug_disabled(self): with mock.patch.object(traceback, 'print_exc') as mock_print_exc: try: openstack_shell.main() except SystemExit: pass self.assertFalse(mock_print_exc.called) @mock.patch('sys.stdout', six.StringIO()) @mock.patch('sys.stderr', six.StringIO()) @mock.patch('sys.argv', ['bilean', 'help', 'foofoo']) def test_stacktrace_when_debug_enabled_by_env(self): old_environment = os.environ.copy() os.environ = {'BILEANCLIENT_DEBUG': '1'} try: with mock.patch.object(traceback, 'print_exc') as mock_print_exc: try: openstack_shell.main() except SystemExit: pass self.assertTrue(mock_print_exc.called) finally: os.environ = old_environment @mock.patch('sys.stdout', six.StringIO()) @mock.patch('sys.stderr', six.StringIO()) @mock.patch('sys.argv', ['bilean', '--debug', 'help', 'foofoo']) def test_stacktrace_when_debug_enabled(self): with mock.patch.object(traceback, 'print_exc') as mock_print_exc: try: openstack_shell.main() except SystemExit: pass self.assertTrue(mock_print_exc.called) def test_help(self): shell = openstack_shell.BileanShell() argstr = 'help' with mock.patch.object(shell, '_get_keystone_session') as et_mock: actual = shell.main(argstr.split()) self.assertEqual(0, actual) self.assertFalse(et_mock.called) def test_blank_call(self): shell = openstack_shell.BileanShell() with mock.patch.object(shell, '_get_keystone_session') as et_mock: actual = shell.main('') self.assertEqual(0, actual) self.assertFalse(et_mock.called) def test_help_on_subcommand_error(self): self.assertRaises(exc.CommandError, shell, 'help bad') def test_get_base_parser(self): test_shell = openstack_shell.BileanShell() actual_parser = test_shell.get_base_parser() description = 'Command-line interface to the OpenStack Bilean API.' expected = argparse.ArgumentParser( prog='bilean', usage=None, description=description, conflict_handler='error', add_help=False, formatter_class=openstack_shell.HelpFormatter,) self.assertEqual(str(expected), str(actual_parser)) @mock.patch.object(openstack_shell.BileanShell, '_get_versioned_client') def test_cert_and_key_args_interchangeable(self, mock_versioned_client): # make sure --os-cert and --os-key are passed correctly args = ('--os-cert mycert ' '--os-key mykey user-list') shell(args) assert mock_versioned_client.called ((api_version, args), kwargs) = mock_versioned_client.call_args self.assertEqual('mycert', args.os_cert) self.assertEqual('mykey', args.os_key) # make sure we get the same thing with --cert-file and --key-file args = ('--cert-file mycertfile ' '--key-file mykeyfile user-list') bilean_shell = openstack_shell.BileanShell() bilean_shell.main(args.split()) assert mock_versioned_client.called ((api_version, args), kwargs) = mock_versioned_client.call_args self.assertEqual('mycertfile', args.os_cert) self.assertEqual('mykeyfile', args.os_key) @mock.patch('bileanclient.v1.client.Client') def test_no_auth_with_token_and_bilean_url(self, mock_client): # test no authentication is required if both token and endpoint url # are specified args = ('--os-auth-token mytoken ' '--os-bilean-url http://host:1234/v1 user-list') bilean_shell = openstack_shell.BileanShell() bilean_shell.main(args.split()) assert mock_client.called (args, kwargs) = mock_client.call_args self.assertEqual('mytoken', kwargs['token']) self.assertEqual('http://host:1234', args[0]) def _assert_auth_plugin_args(self): # make sure our auth plugin is invoked with the correct args self.assertFalse(self.v3_auth.called) body = json.loads(self.v2_auth.last_request.body) self.assertEqual(self.auth_env['OS_TENANT_NAME'], body['auth']['tenantName']) self.assertEqual(self.auth_env['OS_USERNAME'], body['auth']['passwordCredentials']['username']) self.assertEqual(self.auth_env['OS_PASSWORD'], body['auth']['passwordCredentials']['password']) @mock.patch('bileanclient.v1.client.Client') def test_auth_plugin_invocation(self, v1_client): args = 'user-list' bilean_shell = openstack_shell.BileanShell() bilean_shell.main(args.split()) self.assertEqual(0, self.v2_auth.call_count) @mock.patch('bileanclient.v1.client.Client') def test_auth_plugin_invocation_with_unversioned_auth_url( self, v1_client): args = ('--os-auth-url %s user-list' % DEFAULT_UNVERSIONED_AUTH_URL) bilean_shell = openstack_shell.BileanShell() bilean_shell.main(args.split()) @mock.patch('bileanclient.Client') def test_endpoint_token_no_auth_req(self, mock_client): def verify_input(version=None, endpoint=None, *args, **kwargs): self.assertIn('token', kwargs) self.assertEqual(TOKEN_ID, kwargs['token']) self.assertEqual(DEFAULT_BILEAN_URL, endpoint) return mock.MagicMock() mock_client.side_effect = verify_input bilean_shell = openstack_shell.BileanShell() args = ['--os-auth-token', TOKEN_ID, '--os-bilean-url', DEFAULT_BILEAN_URL, 'user-list'] bilean_shell.main(args) self.assertEqual(1, mock_client.call_count) @mock.patch('sys.stdin', side_effect=mock.MagicMock) @mock.patch('getpass.getpass', side_effect=EOFError) @mock.patch('bileanclient.v1.client.Client') def test_password_prompted_ctrlD(self, v1_client, mock_getpass, mock_stdin): cli = mock.MagicMock() v1_client.return_value = cli cli.http_client.get.return_value = (None, {'versions': []}) bilean_shell = openstack_shell.BileanShell() self.make_env(exclude='OS_PASSWORD') # We should get Command Error because we mock Ctl-D. self.assertRaises(exc.CommandError, bilean_shell.main, ['user-list']) # Make sure we are actually prompted. mock_getpass.assert_called_with('OS Password: ') @mock.patch( 'bileanclient.shell.BileanShell._get_keystone_session') def test_no_auth_with_proj_name(self, session): with mock.patch('bileanclient.v1.client.Client'): args = ('--os-project-name myname ' '--os-project-domain-name mydomain ' '--os-project-domain-id myid user-list') bilean_shell = openstack_shell.BileanShell() bilean_shell.main(args.split()) ((args), kwargs) = session.call_args self.assertEqual('myname', kwargs['project_name']) self.assertEqual('mydomain', kwargs['project_domain_name']) self.assertEqual('myid', kwargs['project_domain_id']) @mock.patch.object(openstack_shell.BileanShell, 'main') def test_shell_keyboard_interrupt(self, mock_bilean_shell): # Ensure that exit code is 130 for KeyboardInterrupt try: mock_bilean_shell.side_effect = KeyboardInterrupt() openstack_shell.main() except SystemExit as ex: self.assertEqual(130, ex.code) @mock.patch('bileanclient.common.utils.exit', side_effect=utils.exit) def test_shell_illegal_version(self, mock_exit): # Only int versions are allowed on cli shell = openstack_shell.BileanShell() argstr = '--os-bilean-api-version 1.1 user-list' try: shell.main(argstr.split()) except SystemExit as ex: self.assertEqual(1, ex.code) msg = ("Invalid API version parameter. " "Supported values are %s" % openstack_shell.SUPPORTED_VERSIONS) mock_exit.assert_called_with(msg=msg) @mock.patch('bileanclient.common.utils.exit', side_effect=utils.exit) def test_shell_unsupported_version(self, mock_exit): # Test an integer version which is not supported (-1) shell = openstack_shell.BileanShell() argstr = '--os-bilean-api-version -1 user-list' try: shell.main(argstr.split()) except SystemExit as ex: self.assertEqual(1, ex.code) msg = ("Invalid API version parameter. " "Supported values are %s" % openstack_shell.SUPPORTED_VERSIONS) mock_exit.assert_called_with(msg=msg) @mock.patch.object(openstack_shell.BileanShell, 'get_subcommand_parser') def test_shell_import_error_with_mesage(self, mock_parser): msg = 'Unable to import module xxx' mock_parser.side_effect = ImportError('%s' % msg) shell = openstack_shell.BileanShell() argstr = '--os-bilean-api-version 1 user-list' try: shell.main(argstr.split()) self.fail('No import error returned') except ImportError as e: self.assertEqual(msg, str(e)) @mock.patch.object(openstack_shell.BileanShell, 'get_subcommand_parser') def test_shell_import_error_default_message(self, mock_parser): mock_parser.side_effect = ImportError shell = openstack_shell.BileanShell() argstr = '--os-bilean-api-version 1 user-list' try: shell.main(argstr.split()) self.fail('No import error returned') except ImportError as e: msg = 'Unable to import module. Re-run with --debug for more info.' self.assertEqual(msg, str(e)) @mock.patch('bileanclient.v1.client.Client') def test_auth_plugin_invocation_without_username(self, v1_client): self.make_env(exclude='OS_USERNAME') args = '--os-bilean-api-version 1 user-list' bilean_shell = openstack_shell.BileanShell() self.assertRaises(exc.CommandError, bilean_shell.main, args.split()) @mock.patch('bileanclient.v1.client.Client') def test_auth_plugin_invocation_without_auth_url(self, v1_client): self.make_env(exclude='OS_AUTH_URL') args = '--os-bilean-api-version 1 user-list' bilean_shell = openstack_shell.BileanShell() self.assertRaises(exc.CommandError, bilean_shell.main, args.split()) @mock.patch('bileanclient.v1.client.Client') def test_auth_plugin_invocation_without_tenant(self, v1_client): if 'OS_TENANT_NAME' in os.environ: self.make_env(exclude='OS_TENANT_NAME') if 'OS_PROJECT_ID' in os.environ: self.make_env(exclude='OS_PROJECT_ID') args = '--os-bilean-api-version 1 user-list' bilean_shell = openstack_shell.BileanShell() self.assertRaises(exc.CommandError, bilean_shell.main, args.split()) @mock.patch('sys.argv', ['bilean']) @mock.patch('sys.stdout', six.StringIO()) @mock.patch('sys.stderr', six.StringIO()) def test_main_noargs(self): # Ensure that main works with no command-line arguments try: openstack_shell.main() except SystemExit: self.fail('Unexpected SystemExit') # We expect the normal usage as a result expected = ['Command-line interface to the OpenStack Bilean API', 'user-list', 'rule-list'] for output in expected: self.assertIn(output, sys.stdout.getvalue()) @mock.patch('bileanclient.v1.client.Client') @mock.patch('bileanclient.v1.shell.do_user_list') @mock.patch('bileanclient.shell.logging.basicConfig') def test_setup_debug(self, conf, func, v1_client): cli = mock.MagicMock() v1_client.return_value = cli cli.http_client.get.return_value = (None, {'versions': []}) args = '--debug user-list' bilean_shell = openstack_shell.BileanShell() bilean_shell.main(args.split()) bilean_logger = logging.getLogger('bileanclient') self.assertEqual(bilean_logger.getEffectiveLevel(), logging.DEBUG) conf.assert_called_with(level=logging.DEBUG) class ShellTestWithKeystoneV3Auth(ShellTest): # auth environment to use auth_env = FAKE_V3_ENV.copy() token_url = DEFAULT_V3_AUTH_URL + '/auth/tokens' def _assert_auth_plugin_args(self): self.assertFalse(self.v2_auth.called) body = json.loads(self.v3_auth.last_request.body) user = body['auth']['identity']['password']['user'] self.assertEqual(self.auth_env['OS_USERNAME'], user['name']) self.assertEqual(self.auth_env['OS_PASSWORD'], user['password']) self.assertEqual(self.auth_env['OS_USER_DOMAIN_NAME'], user['domain']['name']) self.assertEqual(self.auth_env['OS_PROJECT_ID'], body['auth']['scope']['project']['id']) @mock.patch('bileanclient.v1.client.Client') def test_auth_plugin_invocation(self, v1_client): args = '--os-bilean-api-version 1 user-list' bilean_shell = openstack_shell.BileanShell() bilean_shell.main(args.split()) self.assertEqual(0, self.v3_auth.call_count) @mock.patch('keystoneclient.discover.Discover', side_effect=ks_exc.ClientException()) def test_api_discovery_failed_with_unversioned_auth_url(self, discover): args = ('--os-bilean-api-version 1 --os-auth-url %s user-list' % DEFAULT_UNVERSIONED_AUTH_URL) bilean_shell = openstack_shell.BileanShell() self.assertRaises(exc.CommandError, bilean_shell.main, args.split()) def test_bash_completion(self): stdout, stderr = self.shell('--os-bilean-api-version 1 bash_completion') # just check we have some output required = [ '--value', 'rule-create', 'help', '--limit'] for r in required: self.assertIn(r, stdout.split()) avoided = [ 'bash_completion', 'bash-completion'] for r in avoided: self.assertNotIn(r, stdout.split())