Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add back support for --endpoint-url option to s3 #469

Closed
wants to merge 3 commits into from
Closed

Add back support for --endpoint-url option to s3 #469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
99db44b
Add back support for --endpoint-url option to s3
mguillaume Nov 8, 2013
dc14b66
Update S3 unit tests for endpoint_url param
mguillaume Nov 8, 2013
04d386a
Add unit test to ensure endpoint-url is passed to botocore for s3
mguillaume Nov 8, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 22 additions & 4 deletions awscli/customizations/s3/s3.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,7 @@ def _do_command(self, parsed_args, parsed_globals):
params = self._build_call_parameters(parsed_args, {})
cmd_params = CommandParameters(self._session, self._name, params)
cmd_params.check_region(parsed_globals)
cmd_params.check_endpoint_url(parsed_globals)
cmd_params.add_paths(parsed_args.paths)
cmd_params.check_force(parsed_globals)
cmd = CommandArchitecture(self._session, self._name,
Expand Down Expand Up @@ -434,7 +435,8 @@ def __init__(self, session, cmd, parameters):
self.parameters = parameters
self.instructions = []
self._service = self.session.get_service('s3')
self._endpoint = self._service.get_endpoint(self.parameters['region'])
self._endpoint = self._service.get_endpoint(region_name=self.parameters['region'],
endpoint_url=self.parameters['endpoint_url'])

def create_instructions(self):
"""
Expand Down Expand Up @@ -731,15 +733,31 @@ def check_region(self, parsed_globals):
parsed_region = None
if 'region' in parsed_globals:
parsed_region = getattr(parsed_globals, 'region')
if not region and not parsed_region:
if 'endpoint_url' in parsed_globals:
parsed_endpoint_url = getattr(parsed_globals, 'endpoint_url')
else:
parsed_endpoint_url = None
if not region and not parsed_region and parsed_endpoint_url is None:
raise Exception("A region must be specified --region or "
"specifying the region\nin a configuration "
"file or as an environment variable\n")
"file or as an environment variable.\n"
"Alternately, an endpoint can be specified "
"with --endpoint-url")
if parsed_region:
self.parameters['region'] = parsed_region
else:
elif region:
self.parameters['region'] = region
else:
self.parameters['region'] = None

def check_endpoint_url(self, parsed_globals):
"""
Adds endpoint_url to the parameters.
"""
if 'endpoint_url' in parsed_globals:
self.parameters['endpoint_url'] = getattr(parsed_globals, 'endpoint_url')
else:
self.parameters['endpoint_url'] = None

# This is a dictionary useful for automatically adding the different commands,
# the amount of arguments it takes, and the optional parameters that can appear
Expand Down
4 changes: 2 additions & 2 deletions tests/unit/customizations/s3/fake_session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,9 @@ class FakeService(object):
def __init__(self, session):
self.session = session

def get_endpoint(self, region):
def get_endpoint(self, region_name, endpoint_url=None):
endpoint = Mock()
endpoint.region_name = region
endpoint.region_name = region_name
return endpoint

def get_operation(self, name):
Expand Down
28 changes: 17 additions & 11 deletions tests/unit/customizations/s3/test_s3.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,9 +169,9 @@ def test_create_instructions(self):
'mb': ['s3_handler'],
'rb': ['s3_handler']}

params = {'filters': True, 'region': 'us-east-1'}
params = {'filters': True, 'region': 'us-east-1', 'endpoint_url': None}
for cmd in cmds:
cmd_arc = CommandArchitecture(self.session, cmd, {'region': 'us-east-1'})
cmd_arc = CommandArchitecture(self.session, cmd, {'region': 'us-east-1', 'endpoint_url': None})
cmd_arc.create_instructions()
self.assertEqual(cmd_arc.instructions, instructions[cmd])

Expand All @@ -191,7 +191,8 @@ def test_run_cp_put(self):
filters = [['--include', '*']]
params = {'dir_op': False, 'dryrun': True, 'quiet': False,
'src': local_file, 'dest': s3_file, 'filters': filters,
'paths_type': 'locals3', 'region': 'us-east-1'}
'paths_type': 'locals3', 'region': 'us-east-1',
'endpoint_url': None}
cmd_arc = CommandArchitecture(self.session, 'cp', params)
cmd_arc.create_instructions()
cmd_arc.run()
Expand All @@ -208,7 +209,8 @@ def test_run_cp_get(self):
filters = [['--include', '*']]
params = {'dir_op': False, 'dryrun': True, 'quiet': False,
'src': s3_file, 'dest': local_file, 'filters': filters,
'paths_type': 's3local', 'region': 'us-east-1'}
'paths_type': 's3local', 'region': 'us-east-1',
'endpoint_url': None}
cmd_arc = CommandArchitecture(self.session, 'cp', params)
cmd_arc.create_instructions()
cmd_arc.run()
Expand All @@ -223,7 +225,8 @@ def test_run_cp_copy(self):
filters = [['--include', '*']]
params = {'dir_op': False, 'dryrun': True, 'quiet': False,
'src': s3_file, 'dest': s3_file, 'filters': filters,
'paths_type': 's3s3', 'region': 'us-east-1'}
'paths_type': 's3s3', 'region': 'us-east-1',
'endpoint_url': None}
cmd_arc = CommandArchitecture(self.session, 'cp', params)
cmd_arc.create_instructions()
cmd_arc.run()
Expand All @@ -238,7 +241,8 @@ def test_run_mv(self):
filters = [['--include', '*']]
params = {'dir_op': False, 'dryrun': True, 'quiet': False,
'src': s3_file, 'dest': s3_file, 'filters': filters,
'paths_type': 's3s3', 'region': 'us-east-1'}
'paths_type': 's3s3', 'region': 'us-east-1',
'endpoint_url': None}
cmd_arc = CommandArchitecture(self.session, 'mv', params)
cmd_arc.create_instructions()
cmd_arc.run()
Expand All @@ -253,7 +257,8 @@ def test_run_remove(self):
filters = [['--include', '*']]
params = {'dir_op': False, 'dryrun': True, 'quiet': False,
'src': s3_file, 'dest': s3_file, 'filters': filters,
'paths_type': 's3', 'region': 'us-east-1'}
'paths_type': 's3', 'region': 'us-east-1',
'endpoint_url': None}
cmd_arc = CommandArchitecture(self.session, 'rm', params)
cmd_arc.create_instructions()
cmd_arc.run()
Expand All @@ -272,7 +277,8 @@ def test_run_sync(self):
filters = [['--include', '*']]
params = {'dir_op': True, 'dryrun': True, 'quiet': False,
'src': local_dir, 'dest': s3_prefix, 'filters': filters,
'paths_type': 'locals3', 'region': 'us-east-1'}
'paths_type': 'locals3', 'region': 'us-east-1',
'endpoint_url': None}
cmd_arc = CommandArchitecture(self.session, 'sync', params)
cmd_arc.create_instructions()
cmd_arc.run()
Expand All @@ -286,7 +292,7 @@ def test_run_mb(self):
s3_prefix = 's3://' + self.bucket + '/'
params = {'dir_op': True, 'dryrun': True, 'quiet': False,
'src': s3_prefix, 'dest': s3_prefix, 'paths_type': 's3',
'region': 'us-east-1'}
'region': 'us-east-1', 'endpoint_url': None}
cmd_arc = CommandArchitecture(self.session, 'mb', params)
cmd_arc.create_instructions()
cmd_arc.run()
Expand All @@ -300,7 +306,7 @@ def test_run_rb(self):
s3_prefix = 's3://' + self.bucket + '/'
params = {'dir_op': True, 'dryrun': True, 'quiet': False,
'src': s3_prefix, 'dest': s3_prefix, 'paths_type': 's3',
'region': 'us-east-1'}
'region': 'us-east-1', 'endpoint_url': None}
cmd_arc = CommandArchitecture(self.session, 'rb', params)
cmd_arc.create_instructions()
rc = cmd_arc.run()
Expand All @@ -315,7 +321,7 @@ def test_run_rb_nonzero_rc(self):
s3_prefix = 's3://' + self.bucket + '/'
params = {'dir_op': True, 'dryrun': False, 'quiet': False,
'src': s3_prefix, 'dest': s3_prefix, 'paths_type': 's3',
'region': 'us-east-1'}
'region': 'us-east-1', 'endpoint_url': None}
cmd_arc = CommandArchitecture(self.session, 'rb', params)
cmd_arc.create_instructions()
rc = cmd_arc.run()
Expand Down
11 changes: 11 additions & 0 deletions tests/unit/test_clidriver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,17 @@ def test_aws_with_region(self):
endpoint.assert_called_with(region_name='us-east-1',
endpoint_url=None)

def test_s3_with_region_and_endpoint_url(self):
with mock.patch('botocore.service.Service.get_endpoint') as endpoint:
http_response = models.Response()
http_response.status_code = 200
endpoint.return_value.make_request.return_value = (
http_response, {})
self.assert_params_for_cmd(
's3 ls s3://test --region us-east-1 --endpoint-url https://foobar.com/',
expected_rc=0)
endpoint.assert_called_with(region_name='us-east-1',
endpoint_url='https://foobar.com/')

def inject_new_param(self, argument_table, **kwargs):
argument = CustomArgument('unknown-arg', {})
Expand Down