# Copyright (c) 2014 Christian Schwede # # 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 mock import os import tempfile import unittest from testtools import ExpectedException import six import swiftclient from swiftclient.service import SwiftError import swiftclient.shell import swiftclient.utils from os.path import basename, dirname from tests.unit.test_swiftclient import MockHttpTest from tests.unit.utils import CaptureOutput, fake_get_auth_keystone if six.PY2: BUILTIN_OPEN = '__builtin__.open' else: BUILTIN_OPEN = 'builtins.open' mocked_os_environ = { 'ST_AUTH': 'http://localhost:8080/auth/v1.0', 'ST_USER': 'test:tester', 'ST_KEY': 'testing' } clean_os_environ = {} environ_prefixes = ('ST_', 'OS_') for key in os.environ: if any(key.startswith(m) for m in environ_prefixes): clean_os_environ[key] = '' def _make_args(cmd, opts, os_opts, separator='-', flags=None, cmd_args=None): """ Construct command line arguments for given options. """ args = [""] flags = flags or [] for k, v in opts.items(): arg = "--" + k.replace("_", "-") args = args + [arg, v] for k, v in os_opts.items(): arg = "--os" + separator + k.replace("_", separator) args = args + [arg, v] for flag in flags: args.append('--%s' % flag) args = args + [cmd] if cmd_args: args = args + cmd_args return args def _make_env(opts, os_opts): """ Construct a dict of environment variables for given options. """ env = {} for k, v in opts.items(): key = 'ST_' + k.upper().replace('-', '_') env[key] = v for k, v in os_opts.items(): key = 'OS_' + k.upper().replace('-', '_') env[key] = v return env @mock.patch.dict(os.environ, mocked_os_environ) class TestShell(unittest.TestCase): def __init__(self, *args, **kwargs): super(TestShell, self).__init__(*args, **kwargs) tmpfile = tempfile.NamedTemporaryFile(delete=False) self.tmpfile = tmpfile.name def tearDown(self): try: os.remove(self.tmpfile) except OSError: pass @mock.patch('swiftclient.service.Connection') def test_stat_account(self, connection): argv = ["", "stat"] return_headers = { 'x-account-container-count': '1', 'x-account-object-count': '2', 'x-account-bytes-used': '3', 'content-length': 0, 'date': ''} connection.return_value.head_account.return_value = return_headers connection.return_value.url = 'http://127.0.0.1/v1/AUTH_account' with CaptureOutput() as output: swiftclient.shell.main(argv) self.assertEquals(output.out, ' Account: AUTH_account\n' 'Containers: 1\n' ' Objects: 2\n' ' Bytes: 3\n') @mock.patch('swiftclient.service.Connection') def test_stat_container(self, connection): return_headers = { 'x-container-object-count': '1', 'x-container-bytes-used': '2', 'x-container-read': 'test2:tester2', 'x-container-write': 'test3:tester3', 'x-container-sync-to': 'other', 'x-container-sync-key': 'secret', } argv = ["", "stat", "container"] connection.return_value.head_container.return_value = return_headers connection.return_value.url = 'http://127.0.0.1/v1/AUTH_account' with CaptureOutput() as output: swiftclient.shell.main(argv) self.assertEquals(output.out, ' Account: AUTH_account\n' 'Container: container\n' ' Objects: 1\n' ' Bytes: 2\n' ' Read ACL: test2:tester2\n' 'Write ACL: test3:tester3\n' ' Sync To: other\n' ' Sync Key: secret\n') @mock.patch('swiftclient.service.Connection') def test_stat_object(self, connection): return_headers = { 'x-object-manifest': 'manifest', 'etag': 'md5', 'last-modified': 'yesterday', 'content-type': 'text/plain', 'content-length': 42, } argv = ["", "stat", "container", "object"] connection.return_value.head_object.return_value = return_headers connection.return_value.url = 'http://127.0.0.1/v1/AUTH_account' with CaptureOutput() as output: swiftclient.shell.main(argv) self.assertEquals(output.out, ' Account: AUTH_account\n' ' Container: container\n' ' Object: object\n' ' Content Type: text/plain\n' 'Content Length: 42\n' ' Last Modified: yesterday\n' ' ETag: md5\n' ' Manifest: manifest\n') @mock.patch('swiftclient.service.Connection') def test_list_account(self, connection): # Test account listing connection.return_value.get_account.side_effect = [ [None, [{'name': 'container'}]], [None, []], ] argv = ["", "list"] with CaptureOutput() as output: swiftclient.shell.main(argv) calls = [mock.call(marker='', prefix=None), mock.call(marker='container', prefix=None)] connection.return_value.get_account.assert_has_calls(calls) self.assertEquals(output.out, 'container\n') @mock.patch('swiftclient.service.Connection') def test_list_account_long(self, connection): # Test account listing connection.return_value.get_account.side_effect = [ [None, [{'name': 'container', 'bytes': 0, 'count': 0}]], [None, []], ] argv = ["", "list", "--lh"] with CaptureOutput() as output: swiftclient.shell.main(argv) calls = [mock.call(marker='', prefix=None), mock.call(marker='container', prefix=None)] connection.return_value.get_account.assert_has_calls(calls) self.assertEquals(output.out, ' 0 0 1970-01-01 00:00:01 container\n' ' 0 0\n') # Now test again, this time without returning metadata connection.return_value.head_container.return_value = {} # Test account listing connection.return_value.get_account.side_effect = [ [None, [{'name': 'container', 'bytes': 0, 'count': 0}]], [None, []], ] argv = ["", "list", "--lh"] with CaptureOutput() as output: swiftclient.shell.main(argv) calls = [mock.call(marker='', prefix=None), mock.call(marker='container', prefix=None)] connection.return_value.get_account.assert_has_calls(calls) self.assertEquals(output.out, ' 0 0 ????-??-?? ??:??:?? container\n' ' 0 0\n') def test_list_account_totals_error(self): # No --lh provided: expect info message about incorrect --totals use argv = ["", "list", "--totals"] with CaptureOutput() as output: self.assertRaises(SystemExit, swiftclient.shell.main, argv) self.assertEqual(output.err, "Listing totals only works with -l or --lh.\n") @mock.patch('swiftclient.service.Connection') def test_list_account_totals(self, connection): # Test account listing, only total count and size connection.return_value.get_account.side_effect = [ [None, [{'name': 'container1', 'bytes': 1, 'count': 2}, {'name': 'container2', 'bytes': 2, 'count': 4}]], [None, []], ] argv = ["", "list", "--lh", "--totals"] with CaptureOutput() as output: swiftclient.shell.main(argv) calls = [mock.call(marker='', prefix=None)] connection.return_value.get_account.assert_has_calls(calls) self.assertEqual(output.out, ' 6 3\n') @mock.patch('swiftclient.service.Connection') def test_list_container(self, connection): connection.return_value.get_container.side_effect = [ [None, [{'name': 'object_a'}]], [None, []], ] argv = ["", "list", "container"] with CaptureOutput() as output: swiftclient.shell.main(argv) calls = [ mock.call('container', marker='', delimiter=None, prefix=None), mock.call('container', marker='object_a', delimiter=None, prefix=None)] connection.return_value.get_container.assert_has_calls(calls) self.assertEquals(output.out, 'object_a\n') # Test container listing with --long connection.return_value.get_container.side_effect = [ [None, [{'name': 'object_a', 'bytes': 0, 'last_modified': '123T456'}]], [None, []], ] argv = ["", "list", "container", "--long"] with CaptureOutput() as output: swiftclient.shell.main(argv) calls = [ mock.call('container', marker='', delimiter=None, prefix=None), mock.call('container', marker='object_a', delimiter=None, prefix=None)] connection.return_value.get_container.assert_has_calls(calls) self.assertEquals(output.out, ' 0 123 456 object_a\n' ' 0\n') @mock.patch('swiftclient.service.makedirs') @mock.patch('swiftclient.service.Connection') def test_download(self, connection, makedirs): connection.return_value.get_object.return_value = [ {'content-type': 'text/plain', 'etag': 'd41d8cd98f00b204e9800998ecf8427e'}, ''] # Test downloading whole container connection.return_value.get_container.side_effect = [ [None, [{'name': 'object'}]], [None, [{'name': 'pseudo/'}]], [None, []], ] connection.return_value.auth_end_time = 0 connection.return_value.attempts = 0 with mock.patch(BUILTIN_OPEN) as mock_open: argv = ["", "download", "container"] swiftclient.shell.main(argv) calls = [mock.call('container', 'object', headers={}, resp_chunk_size=65536, response_dict={}), mock.call('container', 'pseudo/', headers={}, resp_chunk_size=65536, response_dict={})] connection.return_value.get_object.assert_has_calls( calls, any_order=True) mock_open.assert_called_once_with('object', 'wb') # Test downloading single object with mock.patch(BUILTIN_OPEN) as mock_open: argv = ["", "download", "container", "object"] swiftclient.shell.main(argv) connection.return_value.get_object.assert_called_with( 'container', 'object', headers={}, resp_chunk_size=65536, response_dict={}) mock_open.assert_called_with('object', 'wb') @mock.patch('swiftclient.service.Connection') def test_download_no_content_type(self, connection): connection.return_value.get_object.return_value = [ {'etag': 'd41d8cd98f00b204e9800998ecf8427e'}, ''] # Test downloading whole container connection.return_value.get_container.side_effect = [ [None, [{'name': 'object'}]], [None, [{'name': 'pseudo/'}]], [None, []], ] connection.return_value.auth_end_time = 0 connection.return_value.attempts = 0 with mock.patch(BUILTIN_OPEN) as mock_open: argv = ["", "download", "container"] swiftclient.shell.main(argv) calls = [mock.call('container', 'object', headers={}, resp_chunk_size=65536, response_dict={}), mock.call('container', 'pseudo/', headers={}, resp_chunk_size=65536, response_dict={})] connection.return_value.get_object.assert_has_calls( calls, any_order=True) mock_open.assert_called_once_with('object', 'wb') @mock.patch('swiftclient.shell.walk') @mock.patch('swiftclient.service.Connection') def test_upload(self, connection, walk): connection.return_value.head_object.return_value = { 'content-length': '0'} connection.return_value.attempts = 0 argv = ["", "upload", "container", self.tmpfile, "-H", "X-Storage-Policy:one"] swiftclient.shell.main(argv) connection.return_value.put_container.assert_called_once_with( 'container', {'X-Storage-Policy': mock.ANY}, response_dict={}) connection.return_value.put_object.assert_called_with( 'container', self.tmpfile.lstrip('/'), mock.ANY, content_length=0, headers={'x-object-meta-mtime': mock.ANY, 'X-Storage-Policy': 'one'}, response_dict={}) # Upload whole directory argv = ["", "upload", "container", "/tmp"] _tmpfile = self.tmpfile _tmpfile_dir = dirname(_tmpfile) _tmpfile_base = basename(_tmpfile) walk.return_value = [(_tmpfile_dir, [], [_tmpfile_base])] swiftclient.shell.main(argv) connection.return_value.put_object.assert_called_with( 'container', self.tmpfile.lstrip('/'), mock.ANY, content_length=0, headers={'x-object-meta-mtime': mock.ANY}, response_dict={}) # Upload in segments connection.return_value.head_container.return_value = { 'x-storage-policy': 'one'} argv = ["", "upload", "container", self.tmpfile, "-S", "10"] with open(self.tmpfile, "wb") as fh: fh.write(b'12345678901234567890') swiftclient.shell.main(argv) expected_calls = [mock.call('container', {'X-Storage-Policy': mock.ANY}, response_dict={}), mock.call('container_segments', {'X-Storage-Policy': mock.ANY}, response_dict={})] connection.return_value.put_container.has_calls(expected_calls) connection.return_value.put_object.assert_called_with( 'container', self.tmpfile.lstrip('/'), '', content_length=0, headers={'x-object-manifest': mock.ANY, 'x-object-meta-mtime': mock.ANY}, response_dict={}) @mock.patch('swiftclient.service.Connection') def test_delete_account(self, connection): connection.return_value.get_account.side_effect = [ [None, [{'name': 'container'}]], [None, []], ] connection.return_value.get_container.side_effect = [ [None, [{'name': 'object'}]], [None, []], ] connection.return_value.attempts = 0 argv = ["", "delete", "--all"] connection.return_value.head_object.return_value = {} swiftclient.shell.main(argv) connection.return_value.delete_container.assert_called_with( 'container', response_dict={}) connection.return_value.delete_object.assert_called_with( 'container', 'object', query_string=None, response_dict={}) @mock.patch('swiftclient.service.Connection') def test_delete_container(self, connection): connection.return_value.get_container.side_effect = [ [None, [{'name': 'object'}]], [None, []], ] connection.return_value.attempts = 0 argv = ["", "delete", "container"] connection.return_value.head_object.return_value = {} swiftclient.shell.main(argv) connection.return_value.delete_container.assert_called_with( 'container', response_dict={}) connection.return_value.delete_object.assert_called_with( 'container', 'object', query_string=None, response_dict={}) @mock.patch('swiftclient.service.Connection') def test_delete_object(self, connection): argv = ["", "delete", "container", "object"] connection.return_value.head_object.return_value = {} connection.return_value.attempts = 0 swiftclient.shell.main(argv) connection.return_value.delete_object.assert_called_with( 'container', 'object', query_string=None, response_dict={}) def test_delete_verbose_output(self): del_obj_res = {'success': True, 'response_dict': {}, 'attempts': 2, 'container': 'test_c', 'action': 'delete_object', 'object': 'test_o'} del_seg_res = del_obj_res.copy() del_seg_res.update({'action': 'delete_segment'}) del_con_res = del_obj_res.copy() del_con_res.update({'action': 'delete_container', 'object': None}) test_exc = Exception('test_exc') error_res = del_obj_res.copy() error_res.update({'success': False, 'error': test_exc, 'object': None}) mock_delete = mock.Mock() base_argv = ['', '--verbose', 'delete'] with mock.patch('swiftclient.shell.SwiftService.delete', mock_delete): with CaptureOutput() as out: mock_delete.return_value = [del_obj_res] swiftclient.shell.main(base_argv + ['test_c', 'test_o']) mock_delete.assert_called_once_with(container='test_c', objects=['test_o']) self.assertTrue(out.out.find( 'test_o [after 2 attempts]') >= 0) with CaptureOutput() as out: mock_delete.return_value = [del_seg_res] swiftclient.shell.main(base_argv + ['test_c', 'test_o']) mock_delete.assert_called_with(container='test_c', objects=['test_o']) self.assertTrue(out.out.find( 'test_c/test_o [after 2 attempts]') >= 0) with CaptureOutput() as out: mock_delete.return_value = [del_con_res] swiftclient.shell.main(base_argv + ['test_c']) mock_delete.assert_called_with(container='test_c') self.assertTrue(out.out.find( 'test_c [after 2 attempts]') >= 0) with CaptureOutput() as out: mock_delete.return_value = [error_res] self.assertRaises(SystemExit, swiftclient.shell.main, base_argv + ['test_c']) mock_delete.assert_called_with(container='test_c') self.assertTrue(out.err.find( 'Error Deleting: test_c: test_exc') >= 0) @mock.patch('swiftclient.service.Connection') def test_post_account(self, connection): argv = ["", "post"] swiftclient.shell.main(argv) connection.return_value.post_account.assert_called_with( headers={}, response_dict={}) @mock.patch('swiftclient.service.Connection') def test_post_account_bad_auth(self, connection): argv = ["", "post"] connection.return_value.post_account.side_effect = \ swiftclient.ClientException('bad auth') with CaptureOutput() as output: with ExpectedException(SystemExit): swiftclient.shell.main(argv) self.assertEquals(output.err, 'bad auth\n') @mock.patch('swiftclient.service.Connection') def test_post_account_not_found(self, connection): argv = ["", "post"] connection.return_value.post_account.side_effect = \ swiftclient.ClientException('test', http_status=404) with CaptureOutput() as output: with ExpectedException(SystemExit): swiftclient.shell.main(argv) self.assertEquals(output.err, 'Account not found\n') @mock.patch('swiftclient.service.Connection') def test_post_container(self, connection): argv = ["", "post", "container"] swiftclient.shell.main(argv) connection.return_value.post_container.assert_called_with( 'container', headers={}, response_dict={}) @mock.patch('swiftclient.service.Connection') def test_post_container_bad_auth(self, connection): argv = ["", "post", "container"] connection.return_value.post_container.side_effect = \ swiftclient.ClientException('bad auth') with CaptureOutput() as output: with ExpectedException(SystemExit): swiftclient.shell.main(argv) self.assertEquals(output.err, 'bad auth\n') @mock.patch('swiftclient.service.Connection') def test_post_container_not_found_causes_put(self, connection): argv = ["", "post", "container"] connection.return_value.post_container.side_effect = \ swiftclient.ClientException('test', http_status=404) swiftclient.shell.main(argv) self.assertEqual('container', connection.return_value.put_container.call_args[0][0]) def test_post_container_with_bad_name(self): argv = ["", "post", "conta/iner"] with CaptureOutput() as output: with ExpectedException(SystemExit): swiftclient.shell.main(argv) self.assertTrue(output.err != '') self.assertTrue(output.err.startswith('WARNING: / in')) @mock.patch('swiftclient.service.Connection') def test_post_container_with_options(self, connection): argv = ["", "post", "container", "--read-acl", "test2:tester2", "--write-acl", "test3:tester3 test4", "--sync-to", "othersite", "--sync-key", "secret", ] swiftclient.shell.main(argv) connection.return_value.post_container.assert_called_with( 'container', headers={ 'X-Container-Write': 'test3:tester3 test4', 'X-Container-Read': 'test2:tester2', 'X-Container-Sync-Key': 'secret', 'X-Container-Sync-To': 'othersite'}, response_dict={}) @mock.patch('swiftclient.service.Connection') def test_post_object(self, connection): argv = ["", "post", "container", "object", "--meta", "Color:Blue", "--header", "content-type:text/plain" ] swiftclient.shell.main(argv) connection.return_value.post_object.assert_called_with( 'container', 'object', headers={ 'Content-Type': 'text/plain', 'X-Object-Meta-Color': 'Blue'}, response_dict={}) @mock.patch('swiftclient.service.Connection') def test_post_object_bad_auth(self, connection): argv = ["", "post", "container", "object"] connection.return_value.post_object.side_effect = \ swiftclient.ClientException("bad auth") with CaptureOutput() as output: with ExpectedException(SystemExit): swiftclient.shell.main(argv) self.assertEquals(output.err, 'bad auth\n') def test_post_object_too_many_args(self): argv = ["", "post", "container", "object", "bad_arg"] with CaptureOutput() as output: with ExpectedException(SystemExit): swiftclient.shell.main(argv) self.assertTrue(output.err != '') self.assertTrue(output.err.startswith('Usage')) @mock.patch('swiftclient.shell.generate_temp_url') def test_temp_url(self, temp_url): argv = ["", "tempurl", "GET", "60", "/v1/AUTH_account/c/o", "secret_key" ] temp_url.return_value = "" swiftclient.shell.main(argv) temp_url.assert_called_with( '/v1/AUTH_account/c/o', 60, 'secret_key', 'GET') @mock.patch('swiftclient.service.Connection') def test_capabilities(self, connection): argv = ["", "capabilities"] connection.return_value.get_capabilities.return_value = {'swift': None} swiftclient.shell.main(argv) connection.return_value.get_capabilities.assert_called_with(None) def test_human_readable_upload_segment_size(self): def _check_expected(x, expected): actual = x.call_args_list[-1][1]["options"]["segment_size"] self.assertEqual(int(actual), expected) mock_swift = mock.MagicMock(spec=swiftclient.shell.SwiftService) with mock.patch("swiftclient.shell.SwiftService", mock_swift): with CaptureOutput(suppress_systemexit=True) as output: # Test new behaviour with both upper and lower case # trailing characters argv = ["", "upload", "-S", "1B", "container", "object"] swiftclient.shell.main(argv) _check_expected(mock_swift, 1) argv = ["", "upload", "-S", "1K", "container", "object"] swiftclient.shell.main(argv) _check_expected(mock_swift, 1024) argv = ["", "upload", "-S", "1m", "container", "object"] swiftclient.shell.main(argv) _check_expected(mock_swift, 1048576) argv = ["", "upload", "-S", "1G", "container", "object"] swiftclient.shell.main(argv) _check_expected(mock_swift, 1073741824) # Test old behaviour is not affected argv = ["", "upload", "-S", "12345", "container", "object"] swiftclient.shell.main(argv) _check_expected(mock_swift, 12345) with CaptureOutput() as output: with ExpectedException(SystemExit): # Test invalid states argv = ["", "upload", "-S", "1234X", "container", "object"] swiftclient.shell.main(argv) self.assertEquals(output.err, "Invalid segment size\n") output.clear() with ExpectedException(SystemExit): argv = ["", "upload", "-S", "K1234", "container", "object"] swiftclient.shell.main(argv) self.assertEquals(output.err, "Invalid segment size\n") output.clear() with ExpectedException(SystemExit): argv = ["", "upload", "-S", "K", "container", "object"] swiftclient.shell.main(argv) self.assertEquals(output.err, "Invalid segment size\n") class TestSubcommandHelp(unittest.TestCase): def test_subcommand_help(self): for command in swiftclient.shell.commands: help_var = 'st_%s_help' % command self.assertTrue(help_var in vars(swiftclient.shell)) with CaptureOutput() as out: argv = ['', command, '--help'] self.assertRaises(SystemExit, swiftclient.shell.main, argv) expected = vars(swiftclient.shell)[help_var] self.assertEqual(out.strip('\n'), expected) def test_no_help(self): with CaptureOutput() as out: argv = ['', 'bad_command', '--help'] self.assertRaises(SystemExit, swiftclient.shell.main, argv) expected = 'no help for bad_command' self.assertEqual(out.strip('\n'), expected) class TestParsing(unittest.TestCase): def setUp(self): super(TestParsing, self).setUp() self._environ_vars = {} keys = list(os.environ.keys()) for k in keys: if (k in ('ST_KEY', 'ST_USER', 'ST_AUTH') or k.startswith('OS_')): self._environ_vars[k] = os.environ.pop(k) def tearDown(self): os.environ.update(self._environ_vars) def _make_fake_command(self, result): def fake_command(parser, args, thread_manager): result[0], result[1] = swiftclient.shell.parse_args(parser, args) return fake_command def _verify_opts(self, actual_opts, opts, os_opts={}, os_opts_dict={}): """ Check parsed options are correct. :param opts: v1 style options. :param os_opts: openstack style options. :param os_opts_dict: openstack options that should be found in the os_options dict. """ # check the expected opts are set for key, v in opts.items(): actual = getattr(actual_opts, key) self.assertEqual(v, actual, 'Expected %s for key %s, found %s' % (v, key, actual)) for key, v in os_opts.items(): actual = getattr(actual_opts, "os_" + key) self.assertEqual(v, actual, 'Expected %s for key %s, found %s' % (v, key, actual)) # check the os_options dict values are set self.assertTrue(hasattr(actual_opts, 'os_options')) actual_os_opts_dict = getattr(actual_opts, 'os_options') expected_os_opts_keys = ['project_name', 'region_name', 'tenant_name', 'user_domain_name', 'endpoint_type', 'object_storage_url', 'project_domain_id', 'user_id', 'user_domain_id', 'tenant_id', 'service_type', 'project_id', 'auth_token', 'project_domain_name'] for key in expected_os_opts_keys: self.assertTrue(key in actual_os_opts_dict) cli_key = key if key == 'object_storage_url': # exceptions to the pattern... cli_key = 'storage_url' if cli_key in os_opts_dict: expect = os_opts_dict[cli_key] else: expect = None actual = actual_os_opts_dict[key] self.assertEqual(expect, actual, 'Expected %s for %s, got %s' % (expect, key, actual)) for key in actual_os_opts_dict: self.assertTrue(key in expected_os_opts_keys) # check that equivalent keys have equal values equivalents = [('os_username', 'user'), ('os_auth_url', 'auth'), ('os_password', 'key')] for pair in equivalents: self.assertEqual(getattr(actual_opts, pair[0]), getattr(actual_opts, pair[1])) def test_minimum_required_args_v3(self): opts = {"auth_version": "3"} os_opts = {"password": "secret", "username": "user", "auth_url": "http://example.com:5000/v3"} # username with domain is sufficient in args because keystone will # assume user is in default domain args = _make_args("stat", opts, os_opts, '-') result = [None, None] fake_command = self._make_fake_command(result) with mock.patch('swiftclient.shell.st_stat', fake_command): swiftclient.shell.main(args) self._verify_opts(result[0], opts, os_opts, {}) # check its ok to have user_id instead of username os_opts = {"password": "secret", "auth_url": "http://example.com:5000/v3"} os_opts_dict = {"user_id": "user_ID"} all_os_opts = os_opts.copy() all_os_opts.update(os_opts_dict) args = _make_args("stat", opts, all_os_opts, '-') result = [None, None] fake_command = self._make_fake_command(result) with mock.patch('swiftclient.shell.st_stat', fake_command): swiftclient.shell.main(args) self._verify_opts(result[0], opts, os_opts, os_opts_dict) # check no user credentials required if token and url supplied os_opts = {} os_opts_dict = {"storage_url": "http://example.com:8080/v1", "auth_token": "0123abcd"} args = _make_args("stat", opts, os_opts_dict, '-') result = [None, None] fake_command = self._make_fake_command(result) with mock.patch('swiftclient.shell.st_stat', fake_command): swiftclient.shell.main(args) self._verify_opts(result[0], opts, os_opts, os_opts_dict) def test_args_v3(self): opts = {"auth_version": "3"} os_opts = {"password": "secret", "username": "user", "auth_url": "http://example.com:5000/v3"} os_opts_dict = {"user_id": "user_ID", "project_id": "project_ID", "tenant_id": "tenant_ID", "project_domain_id": "project_domain_ID", "user_domain_id": "user_domain_ID", "tenant_name": "tenant", "project_name": "project", "project_domain_name": "project_domain", "user_domain_name": "user_domain", "auth_token": "token", "storage_url": "http://example.com:8080/v1", "region_name": "region", "service_type": "service", "endpoint_type": "endpoint"} all_os_opts = os_opts.copy() all_os_opts.update(os_opts_dict) # check using hyphen separator args = _make_args("stat", opts, all_os_opts, '-') result = [None, None] fake_command = self._make_fake_command(result) with mock.patch('swiftclient.shell.st_stat', fake_command): swiftclient.shell.main(args) self._verify_opts(result[0], opts, os_opts, os_opts_dict) # check using underscore separator args = _make_args("stat", opts, all_os_opts, '_') result = [None, None] fake_command = self._make_fake_command(result) with mock.patch('swiftclient.shell.st_stat', fake_command): swiftclient.shell.main(args) self._verify_opts(result[0], opts, os_opts, os_opts_dict) # check using environment variables args = _make_args("stat", {}, {}) env = _make_env(opts, all_os_opts) result = [None, None] fake_command = self._make_fake_command(result) with mock.patch.dict(os.environ, env): with mock.patch('swiftclient.shell.st_stat', fake_command): swiftclient.shell.main(args) self._verify_opts(result[0], opts, os_opts, os_opts_dict) # check again using OS_AUTH_VERSION instead of ST_AUTH_VERSION env = _make_env({}, all_os_opts) env.update({'OS_AUTH_VERSION': '3'}) result = [None, None] fake_command = self._make_fake_command(result) with mock.patch.dict(os.environ, env): with mock.patch('swiftclient.shell.st_stat', fake_command): swiftclient.shell.main(args) self._verify_opts(result[0], opts, os_opts, os_opts_dict) def test_command_args_v3(self): result = [None, None] fake_command = self._make_fake_command(result) opts = {"auth_version": "3"} os_opts = {"password": "secret", "username": "user", "auth_url": "http://example.com:5000/v3"} args = _make_args("stat", opts, os_opts) with mock.patch('swiftclient.shell.st_stat', fake_command): swiftclient.shell.main(args) self.assertEqual(['stat'], result[1]) with mock.patch('swiftclient.shell.st_stat', fake_command): args = args + ["container_name"] swiftclient.shell.main(args) self.assertEqual(["stat", "container_name"], result[1]) def test_insufficient_args_v3(self): opts = {"auth_version": "3"} os_opts = {"password": "secret", "auth_url": "http://example.com:5000/v3"} args = _make_args("stat", opts, os_opts) self.assertRaises(SystemExit, swiftclient.shell.main, args) os_opts = {"username": "user", "auth_url": "http://example.com:5000/v3"} args = _make_args("stat", opts, os_opts) self.assertRaises(SystemExit, swiftclient.shell.main, args) os_opts = {"username": "user", "password": "secret"} args = _make_args("stat", opts, os_opts) self.assertRaises(SystemExit, swiftclient.shell.main, args) def test_no_tenant_name_or_id_v2(self): os_opts = {"password": "secret", "username": "user", "auth_url": "http://example.com:5000/v3", "tenant_name": "", "tenant_id": ""} with CaptureOutput() as output: args = _make_args("stat", {}, os_opts) self.assertRaises(SystemExit, swiftclient.shell.main, args) self.assertEqual(output.err.strip(), 'No tenant specified') with CaptureOutput() as output: args = _make_args("stat", {}, os_opts, cmd_args=["testcontainer"]) self.assertRaises(SystemExit, swiftclient.shell.main, args) self.assertEqual(output.err.strip(), 'No tenant specified') def test_no_tenant_name_or_id_v3(self): os_opts = {"password": "secret", "username": "user", "auth_url": "http://example.com:5000/v3", "tenant_name": "", "tenant_id": ""} with CaptureOutput() as output: args = _make_args("stat", {"auth_version": "3"}, os_opts) self.assertRaises(SystemExit, swiftclient.shell.main, args) self.assertEqual(output.err.strip(), 'No project name or project id specified.') with CaptureOutput() as output: args = _make_args("stat", {"auth_version": "3"}, os_opts, cmd_args=["testcontainer"]) self.assertRaises(SystemExit, swiftclient.shell.main, args) self.assertEqual(output.err.strip(), 'No project name or project id specified.') def test_insufficient_env_vars_v3(self): args = _make_args("stat", {}, {}) opts = {"auth_version": "3"} os_opts = {"password": "secret", "auth_url": "http://example.com:5000/v3"} env = _make_env(opts, os_opts) with mock.patch.dict(os.environ, env): self.assertRaises(SystemExit, swiftclient.shell.main, args) os_opts = {"username": "user", "auth_url": "http://example.com:5000/v3"} env = _make_env(opts, os_opts) with mock.patch.dict(os.environ, env): self.assertRaises(SystemExit, swiftclient.shell.main, args) os_opts = {"username": "user", "password": "secret"} env = _make_env(opts, os_opts) with mock.patch.dict(os.environ, env): self.assertRaises(SystemExit, swiftclient.shell.main, args) def test_help(self): # --help returns condensed help message opts = {"help": ""} os_opts = {} args = _make_args("stat", opts, os_opts) with CaptureOutput() as out: self.assertRaises(SystemExit, swiftclient.shell.main, args) self.assertTrue(out.find('[--key ]') > 0) self.assertEqual(-1, out.find('--os-username=')) # --help returns condensed help message, overrides --os-help opts = {"help": ""} os_opts = {"help": ""} # "password": "secret", # "username": "user", # "auth_url": "http://example.com:5000/v3"} args = _make_args("", opts, os_opts) with CaptureOutput() as out: self.assertRaises(SystemExit, swiftclient.shell.main, args) self.assertTrue(out.find('[--key ]') > 0) self.assertEqual(-1, out.find('--os-username=')) ## --os-help return os options help opts = {} args = _make_args("", opts, os_opts) with CaptureOutput() as out: self.assertRaises(SystemExit, swiftclient.shell.main, args) self.assertTrue(out.find('[--key ]') > 0) self.assertTrue(out.find('--os-username=') > 0) class FakeKeystone(object): ''' Fake keystone client module. Returns given endpoint url and auth token. ''' def __init__(self, endpoint, token): self.calls = [] self.auth_version = None self.endpoint = endpoint self.token = token class _Client(): def __init__(self, endpoint, token, **kwargs): self.auth_token = token self.endpoint = endpoint self.service_catalog = self.ServiceCatalog(endpoint) class ServiceCatalog(object): def __init__(self, endpoint): self.calls = [] self.endpoint_url = endpoint def url_for(self, **kwargs): self.calls.append(kwargs) return self.endpoint_url def Client(self, **kwargs): self.calls.append(kwargs) self.client = self._Client(endpoint=self.endpoint, token=self.token, **kwargs) return self.client class Unauthorized(Exception): pass class AuthorizationFailure(Exception): pass class EndpointNotFound(Exception): pass def _make_fake_import_keystone_client(fake_import): def _fake_import_keystone_client(auth_version): fake_import.auth_version = auth_version return fake_import, fake_import return _fake_import_keystone_client class TestKeystoneOptions(MockHttpTest): """ Tests to check that options are passed from the command line or environment variables through to the keystone client interface. """ all_os_opts = {'password': 'secret', 'username': 'user', 'auth-url': 'http://example.com:5000/v3', 'user-domain-name': 'userdomain', 'user-id': 'userid', 'user-domain-id': 'userdomainid', 'tenant-name': 'tenantname', 'tenant-id': 'tenantid', 'project-name': 'projectname', 'project-id': 'projectid', 'project-domain-id': 'projectdomainid', 'project-domain-name': 'projectdomain', 'cacert': 'foo'} catalog_opts = {'service-type': 'my-object-store', 'endpoint-type': 'public', 'region-name': 'my-region'} flags = ['insecure', 'debug'] # options that are given default values in code if missing from CLI defaults = {'auth-version': '2.0', 'service-type': 'object-store', 'endpoint-type': 'publicURL'} def _build_os_opts(self, keys): os_opts = {} for k in keys: os_opts[k] = self.all_os_opts.get(k, self.catalog_opts.get(k)) return os_opts def _test_options_passed_to_keystone(self, cmd, opts, os_opts, flags=None, use_env=False, cmd_args=None, no_auth=False): flags = flags or [] if use_env: # set up fake environment variables and make a minimal command line env = _make_env(opts, os_opts) args = _make_args(cmd, {}, {}, separator='-', flags=flags, cmd_args=cmd_args) else: # set up empty environment and make full command line env = {} args = _make_args(cmd, opts, os_opts, separator='-', flags=flags, cmd_args=cmd_args) ks_endpoint = 'http://example.com:8080/v1/AUTH_acc' ks_token = 'fake_auth_token' fake_ks = FakeKeystone(endpoint=ks_endpoint, token=ks_token) # fake_conn will check that storage_url and auth_token are as expected endpoint = os_opts.get('storage-url', ks_endpoint) token = os_opts.get('auth-token', ks_token) fake_conn = self.fake_http_connection(204, headers={}, storage_url=endpoint, auth_token=token) with mock.patch('swiftclient.client._import_keystone_client', _make_fake_import_keystone_client(fake_ks)): with mock.patch('swiftclient.client.http_connection', fake_conn): with mock.patch.dict(os.environ, env, clear=True): try: swiftclient.shell.main(args) except SystemExit as e: self.fail('Unexpected SystemExit: %s' % e) except SwiftError as err: self.fail('Unexpected SwiftError: %s' % err) if no_auth: # check that keystone client was not used and terminate tests self.assertIsNone(getattr(fake_ks, 'auth_version')) self.assertEqual(len(fake_ks.calls), 0) return # check correct auth version was passed to _import_keystone_client key = 'auth-version' expected = opts.get(key, self.defaults.get(key)) self.assertEqual(expected, fake_ks.auth_version) # check args passed to keystone Client __init__ self.assertEqual(len(fake_ks.calls), 1) actual_args = fake_ks.calls[0] for key in self.all_os_opts.keys(): expected = os_opts.get(key, self.defaults.get(key)) key = key.replace('-', '_') self.assertTrue(key in actual_args, 'Expected key %s not found in args %s' % (key, actual_args)) self.assertEqual(expected, actual_args[key], 'Expected %s for key %s, found %s' % (expected, key, actual_args[key])) for flag in flags: self.assertTrue(flag in actual_args) self.assertTrue(actual_args[flag]) # check args passed to ServiceCatalog.url_for() method self.assertEqual(len(fake_ks.client.service_catalog.calls), 1) actual_args = fake_ks.client.service_catalog.calls[0] for key in self.catalog_opts.keys(): expected = os_opts.get(key, self.defaults.get(key)) key = key.replace('-', '_') if key == 'region_name': key = 'filter_value' self.assertTrue(key in actual_args, 'Expected key %s not found in args %s' % (key, actual_args)) self.assertEqual(expected, actual_args[key], 'Expected %s for key %s, found %s' % (expected, key, actual_args[key])) key, v = 'attr', 'region' self.assertTrue(key in actual_args, 'Expected key %s not found in args %s' % (key, actual_args)) self.assertEqual(v, actual_args[key], 'Expected %s for key %s, found %s' % (v, key, actual_args[key])) def _test_options(self, opts, os_opts, flags=None, no_auth=False): # repeat test for different commands using env and command line options for cmd in ('stat', 'post'): self._test_options_passed_to_keystone(cmd, opts, os_opts, flags=flags, no_auth=no_auth) self._test_options_passed_to_keystone(cmd, opts, os_opts, flags=flags, use_env=True, no_auth=no_auth) def test_all_args_passed_to_keystone(self): # check that all possible command line args are passed to keystone opts = {'auth-version': '3'} os_opts = dict(self.all_os_opts) os_opts.update(self.catalog_opts) self._test_options(opts, os_opts, flags=self.flags) opts = {'auth-version': '2.0'} self._test_options(opts, os_opts, flags=self.flags) opts = {} self._test_options(opts, os_opts, flags=self.flags) def test_catalog_options_and_flags_not_required_v3(self): # check that all possible command line args are passed to keystone opts = {'auth-version': '3'} os_opts = dict(self.all_os_opts) self._test_options(opts, os_opts, flags=None) def test_ok_option_combinations_v3(self): opts = {'auth-version': '3'} keys = ('username', 'password', 'tenant-name', 'auth-url') os_opts = self._build_os_opts(keys) self._test_options(opts, os_opts) keys = ('user-id', 'password', 'tenant-name', 'auth-url') os_opts = self._build_os_opts(keys) self._test_options(opts, os_opts) keys = ('user-id', 'password', 'tenant-id', 'auth-url') os_opts = self._build_os_opts(keys) self._test_options(opts, os_opts) keys = ('user-id', 'password', 'project-name', 'auth-url') os_opts = self._build_os_opts(keys) self._test_options(opts, os_opts) keys = ('user-id', 'password', 'project-id', 'auth-url') os_opts = self._build_os_opts(keys) self._test_options(opts, os_opts) def test_ok_option_combinations_v2(self): opts = {'auth-version': '2.0'} keys = ('username', 'password', 'tenant-name', 'auth-url') os_opts = self._build_os_opts(keys) self._test_options(opts, os_opts) keys = ('username', 'password', 'tenant-id', 'auth-url') os_opts = self._build_os_opts(keys) self._test_options(opts, os_opts) # allow auth_version to default to 2.0 opts = {} keys = ('username', 'password', 'tenant-name', 'auth-url') os_opts = self._build_os_opts(keys) self._test_options(opts, os_opts) keys = ('username', 'password', 'tenant-id', 'auth-url') os_opts = self._build_os_opts(keys) self._test_options(opts, os_opts) def test_url_and_token_provided_on_command_line(self): endpoint = 'http://alternate.com:8080/v1/AUTH_another' token = 'alternate_auth_token' os_opts = {'auth-token': token, 'storage-url': endpoint} opts = {'auth-version': '3'} self._test_options(opts, os_opts, no_auth=True) opts = {'auth-version': '2.0'} self._test_options(opts, os_opts, no_auth=True) def test_url_provided_on_command_line(self): endpoint = 'http://alternate.com:8080/v1/AUTH_another' os_opts = {'username': 'username', 'password': 'password', 'project-name': 'projectname', 'auth-url': 'http://example.com:5000/v3', 'storage-url': endpoint} opts = {'auth-version': '3'} self._test_options(opts, os_opts) opts = {'auth-version': '2.0'} self._test_options(opts, os_opts) @mock.patch.dict(os.environ, clean_os_environ) class TestAuth(MockHttpTest): def test_pre_authed_request(self): url = 'https://swift.storage.example.com/v1/AUTH_test' token = 'AUTH_tk5b6b12' pre_auth_env = { 'OS_STORAGE_URL': url, 'OS_AUTH_TOKEN': token, } fake_conn = self.fake_http_connection(200) with mock.patch('swiftclient.client.http_connection', new=fake_conn): with mock.patch.dict(os.environ, pre_auth_env): argv = ['', 'stat'] swiftclient.shell.main(argv) self.assertRequests([ ('HEAD', url, '', {'x-auth-token': token}), ]) # and again with re-auth pre_auth_env.update(mocked_os_environ) pre_auth_env['OS_AUTH_TOKEN'] = 'expired' fake_conn = self.fake_http_connection(401, 200, 200, headers={ 'x-auth-token': token + '_new', 'x-storage-url': url + '_not_used', }) with mock.patch.multiple('swiftclient.client', http_connection=fake_conn, sleep=mock.DEFAULT): with mock.patch.dict(os.environ, pre_auth_env): argv = ['', 'stat'] swiftclient.shell.main(argv) self.assertRequests([ ('HEAD', url, '', { 'x-auth-token': 'expired', }), ('GET', mocked_os_environ['ST_AUTH'], '', { 'x-auth-user': mocked_os_environ['ST_USER'], 'x-auth-key': mocked_os_environ['ST_KEY'], }), ('HEAD', url, '', { 'x-auth-token': token + '_new', }), ]) def test_os_pre_authed_request(self): url = 'https://swift.storage.example.com/v1/AUTH_test' token = 'AUTH_tk5b6b12' pre_auth_env = { 'OS_STORAGE_URL': url, 'OS_AUTH_TOKEN': token, } fake_conn = self.fake_http_connection(200) with mock.patch('swiftclient.client.http_connection', new=fake_conn): with mock.patch.dict(os.environ, pre_auth_env): argv = ['', 'stat'] swiftclient.shell.main(argv) self.assertRequests([ ('HEAD', url, '', {'x-auth-token': token}), ]) # and again with re-auth os_environ = { 'OS_AUTH_URL': 'https://keystone.example.com/v2.0/', 'OS_TENANT_NAME': 'demo', 'OS_USERNAME': 'demo', 'OS_PASSWORD': 'admin', } os_environ.update(pre_auth_env) os_environ['OS_AUTH_TOKEN'] = 'expired' fake_conn = self.fake_http_connection(401, 200) fake_keystone = fake_get_auth_keystone(storage_url=url + '_not_used', token=token + '_new') with mock.patch.multiple('swiftclient.client', http_connection=fake_conn, get_auth_keystone=fake_keystone, sleep=mock.DEFAULT): with mock.patch.dict(os.environ, os_environ): argv = ['', 'stat'] swiftclient.shell.main(argv) self.assertRequests([ ('HEAD', url, '', { 'x-auth-token': 'expired', }), ('HEAD', url, '', { 'x-auth-token': token + '_new', }), ])