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.

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

S3: Use key_id and key_secret directly #4224

Merged
merged 14 commits into from
Jul 19, 2020
2 changes: 2 additions & 0 deletions dvc/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,8 @@ class RelPath(str):
"profile": str,
"credentialpath": str,
"endpointurl": str,
Optional("s3_key_id", default=""): str,
Optional("s3_key_secret", default=""): str,
farizrahman4u marked this conversation as resolved.
Show resolved Hide resolved
Optional("listobjects", default=False): Bool,
Optional("use_ssl", default=True): Bool,
"sse": str,
Expand Down
14 changes: 11 additions & 3 deletions dvc/tree/s3.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,9 @@ def __init__(self, repo, config):

self._append_aws_grants_to_extra_args(config)

self.key_id = config.get("s3_key_id")
self.key_secret = config.get("s3_key_secret")

farizrahman4u marked this conversation as resolved.
Show resolved Hide resolved
shared_creds = config.get("credentialpath")
if shared_creds:
os.environ.setdefault("AWS_SHARED_CREDENTIALS_FILE", shared_creds)
Expand All @@ -63,9 +66,14 @@ def __init__(self, repo, config):
def s3(self):
import boto3

session = boto3.session.Session(
profile_name=self.profile, region_name=self.region
)
session_opts = dict(profile_name=self.profile, region_name=self.region)

if self.key_id:
session_opts["aws_access_key_id"] = self.key_id
if self.key_secret:
session_opts["aws_secret_access_key"] = self.key_secret

session = boto3.session.Session(**session_opts)

return session.client(
"s3", endpoint_url=self.endpoint_url, use_ssl=self.use_ssl
Expand Down
10 changes: 10 additions & 0 deletions tests/unit/remote/test_s3.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
bucket_name = "bucket-name"
prefix = "some/prefix"
url = f"s3://{bucket_name}/{prefix}"
key_id = "key_id"
key_secret = "key_secret"
efiop marked this conversation as resolved.
Show resolved Hide resolved


@pytest.fixture(autouse=True)
Expand Down Expand Up @@ -57,3 +59,11 @@ def test_grants_mutually_exclusive_acl_error(dvc, grants):
def test_sse_kms_key_id(dvc):
tree = S3RemoteTree(dvc, {"url": url, "sse_kms_key_id": "key"})
assert tree.extra_args["SSEKMSKeyId"] == "key"


def test_key_id_and_secret(dvc):
tree = S3RemoteTree(
dvc, {"url": url, "s3_key_id": key_id, "s3_key_secret": key_secret}
)
assert tree.key_id == key_id
assert tree.key_secret == key_secret