Skip to content

fix(parameters): Respect POWERTOOLS_PARAMETERS_SSM_DECRYPT environment variable when getting multiple ssm parameters. #3241

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

Merged
merged 1 commit into from
Oct 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 7 additions & 1 deletion aws_lambda_powertools/utilities/parameters/ssm.py
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,7 @@ def _get(self, name: str, decrypt: bool = False, **sdk_options) -> str:

return self.client.get_parameter(**sdk_options)["Parameter"]["Value"]

def _get_multiple(self, path: str, decrypt: bool = False, recursive: bool = False, **sdk_options) -> Dict[str, str]:
def _get_multiple(self, path: str, decrypt: Optional[bool] = None, recursive: bool = False, **sdk_options) -> Dict[str, str]:
"""
Retrieve multiple parameter values from AWS Systems Manager Parameter Store

Expand All @@ -204,6 +204,12 @@ def _get_multiple(self, path: str, decrypt: bool = False, recursive: bool = Fals
Dictionary of options that will be passed to the Parameter Store get_parameters_by_path API call
"""

# If decrypt is not set, resolve it from the environment variable, defaulting to False
decrypt = resolve_truthy_env_var_choice(
env=os.getenv(constants.PARAMETERS_SSM_DECRYPT_ENV, "false"),
choice=decrypt,
)

# Explicit arguments will take precedence over keyword arguments
sdk_options["Path"] = path
sdk_options["WithDecryption"] = decrypt
Expand Down
47 changes: 47 additions & 0 deletions tests/functional/test_utilities_parameters.py
Original file line number Diff line number Diff line change
Expand Up @@ -960,6 +960,53 @@ def test_ssm_provider_get_sdk_options_overwrite(mock_name, mock_value, mock_vers
stubber.deactivate()


def test_ssm_provider_get_multiple_with_decrypt_environment_variable(monkeypatch, mock_name, mock_value, mock_version, config):
"""
Test SSMProvider.get_multiple() with decrypt value replaced by environment variable
"""

# Setting environment variable to override the default value
monkeypatch.setenv("POWERTOOLS_PARAMETERS_SSM_DECRYPT", "true")

mock_param_names = ["A", "B", "C"]

# Create a new provider
provider = parameters.SSMProvider(config=config)

# Stub the boto3 client
stubber = stub.Stubber(provider.client)
response = {
"Parameters": [
{
"Name": f"{mock_name}/{name}",
"Type": "String",
"Value": f"{mock_value}/{name}",
"Version": mock_version,
"Selector": f"{mock_name}/{name}:{mock_version}",
"SourceResult": "string",
"LastModifiedDate": datetime(2015, 1, 1),
"ARN": f"arn:aws:ssm:us-east-2:111122223333:parameter/{mock_name}/{name}",
}
for name in mock_param_names
],
}
expected_params = {"Path": mock_name, "Recursive": False, "WithDecryption": True}
stubber.add_response("get_parameters_by_path", response, expected_params)
stubber.activate()

try:
values = provider.get_multiple(mock_name)

stubber.assert_no_pending_responses()

assert len(values) == len(mock_param_names)
for name in mock_param_names:
assert name in values
assert values[name] == f"{mock_value}/{name}"
finally:
stubber.deactivate()


def test_ssm_provider_get_multiple(mock_name, mock_value, mock_version, config):
"""
Test SSMProvider.get_multiple() with a non-cached path
Expand Down