Skip to content

Commit 246aa01

Browse files
authored
fix(parameters): support version and label selectors in get_parameters_by_name (#8620)
* fix(parameters): support version and label selectors in get_parameters_by_name SSM GetParameters returns the bare parameter name in Name and the requested name in Selector when a version or label selector is used (e.g. /a:prod). Looking up Name in the requested parameters raised KeyError. Use Selector when it matches a requested name, for both the response and the cache key. * fix(parameters): build the requested name from Name and the Selector suffix SSM returns only the selector suffix (e.g. ":prod") in Selector, not the full requested name. Rebuild the key as Name + Selector, and update the test stubs to the real response shape: no Selector for names requested without one, and only the suffix otherwise.
1 parent 04c55fe commit 246aa01

2 files changed

Lines changed: 110 additions & 2 deletions

File tree

‎aws_lambda_powertools/utilities/parameters/ssm.py‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -649,7 +649,9 @@ def _transform_and_cache_get_parameters_response(
649649
response: dict[str, Any] = {}
650650

651651
for parameter in api_response["Parameters"]:
652-
name = parameter["Name"]
652+
# For names with a version or label selector (e.g. "/a:prod"), SSM returns the bare name
653+
# in "Name" and only the selector suffix (e.g. ":prod") in "Selector"
654+
name = parameter["Name"] + parameter.get("Selector", "")
653655
value = parameter["Value"]
654656
options = parameters[name]
655657
transform = options["transform"]

‎tests/functional/parameters/_boto3/test_utilities_parameters.py‎

Lines changed: 107 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ def build_get_parameters_stub(
6767
"Type": "String",
6868
"Value": value,
6969
"Version": version,
70-
"Selector": f"{param}:{version}",
70+
# SSM only returns "Selector" for names requested with a version or label selector
7171
"SourceResult": "string",
7272
"LastModifiedDate": datetime(2015, 1, 1),
7373
"ARN": f"arn:aws:ssm:us-east-2:111122223333:parameter/{param.lstrip('/')}",
@@ -1358,6 +1358,112 @@ def test_ssm_provider_get_parameters_by_name_does_not_mutate_input_and_honors_ne
13581358
stubber.deactivate()
13591359

13601360

1361+
def build_get_parameters_selector_stub(
1362+
params: dict[str, Any],
1363+
invalid_parameters: list[str],
1364+
) -> dict[str, list]:
1365+
# SSM returns the bare name in "Name" and only the selector suffix (e.g. ":prod") in "Selector".
1366+
# Names requested without a selector come back without "Selector".
1367+
parameters_out = []
1368+
for requested, value in params.items():
1369+
name, sep, suffix = requested.partition(":")
1370+
parameter = {
1371+
"Name": name,
1372+
"Type": "String",
1373+
"Value": value,
1374+
"Version": 3,
1375+
"ARN": f"arn:aws:ssm:us-east-2:111122223333:parameter/{name.lstrip('/')}",
1376+
"DataType": "text",
1377+
}
1378+
if sep:
1379+
parameter["Selector"] = f":{suffix}"
1380+
parameters_out.append(parameter)
1381+
1382+
return {"Parameters": parameters_out, "InvalidParameters": invalid_parameters}
1383+
1384+
1385+
@pytest.mark.parametrize("decrypt", [False, True])
1386+
def test_ssm_provider_get_parameters_by_name_with_selector(mock_name, mock_value, config, decrypt):
1387+
# GIVEN parameter names with a label and a version selector
1388+
param_label = f"/a/{mock_name}:prod"
1389+
param_version = f"/b/{mock_name}:3"
1390+
fail = "/does_not_exist" # stub model doesn't support all-success yet
1391+
1392+
all_params = {param_label: {}, param_version: {}, fail: {}}
1393+
expected_param_values = {param_label: mock_value, param_version: f"{mock_value}-v3"}
1394+
expected_stub_response = build_get_parameters_selector_stub(params=expected_param_values, invalid_parameters=[fail])
1395+
expected_stub_params: dict[str, Any] = {"Names": list(all_params.keys())}
1396+
if decrypt:
1397+
expected_stub_params["WithDecryption"] = True
1398+
1399+
provider = parameters.SSMProvider(boto_config=config)
1400+
stubber = stub.Stubber(provider.client)
1401+
stubber.add_response("get_parameters", expected_stub_response, expected_stub_params)
1402+
stubber.activate()
1403+
1404+
# WHEN get_parameters_by_name is called
1405+
try:
1406+
ret = provider.get_parameters_by_name(parameters=all_params, decrypt=decrypt, raise_on_error=False)
1407+
stubber.assert_no_pending_responses()
1408+
finally:
1409+
stubber.deactivate()
1410+
1411+
# THEN values should be keyed by the requested names, including the selector
1412+
assert ret == {**expected_param_values, "_errors": [fail]}
1413+
1414+
1415+
def test_ssm_provider_get_parameters_by_name_with_selector_and_bare_name(mock_name, config):
1416+
# GIVEN the same parameter requested by label, by version and without a selector
1417+
param = f"/p/{mock_name}"
1418+
fail = "/does_not_exist" # stub model doesn't support all-success yet
1419+
1420+
all_params = {f"{param}:prod": {}, f"{param}:1": {}, param: {}, fail: {}}
1421+
expected_param_values = {f"{param}:prod": "label", f"{param}:1": "version-1", param: "latest"}
1422+
expected_stub_response = build_get_parameters_selector_stub(params=expected_param_values, invalid_parameters=[fail])
1423+
1424+
provider = parameters.SSMProvider(boto_config=config)
1425+
stubber = stub.Stubber(provider.client)
1426+
stubber.add_response("get_parameters", expected_stub_response, {"Names": list(all_params.keys())})
1427+
stubber.activate()
1428+
1429+
# WHEN get_parameters_by_name is called
1430+
try:
1431+
ret = provider.get_parameters_by_name(parameters=all_params, raise_on_error=False)
1432+
stubber.assert_no_pending_responses()
1433+
finally:
1434+
stubber.deactivate()
1435+
1436+
# THEN each requested name keeps its own value, and the bare name gets the latest version
1437+
assert ret == {**expected_param_values, "_errors": [fail]}
1438+
1439+
1440+
def test_ssm_provider_get_parameters_by_name_with_selector_cache(mock_name, mock_value, config):
1441+
# GIVEN a parameter name with a label selector
1442+
param_label = f"/a/{mock_name}:prod"
1443+
fail = "/does_not_exist" # stub model doesn't support all-success yet
1444+
1445+
expected_stub_response = build_get_parameters_selector_stub(
1446+
params={param_label: mock_value},
1447+
invalid_parameters=[fail],
1448+
)
1449+
1450+
provider = parameters.SSMProvider(boto_config=config)
1451+
stubber = stub.Stubber(provider.client)
1452+
stubber.add_response("get_parameters", expected_stub_response, {"Names": [param_label, fail]})
1453+
stubber.activate()
1454+
1455+
# WHEN get_parameters_by_name is called twice for the selector
1456+
try:
1457+
provider.get_parameters_by_name(parameters={param_label: {}, fail: {}}, raise_on_error=False)
1458+
ret = provider.get_parameters_by_name(parameters={param_label: {}})
1459+
stubber.assert_no_pending_responses()
1460+
finally:
1461+
stubber.deactivate()
1462+
1463+
# THEN the second call should be served from the cache under the requested name
1464+
assert ret == {param_label: mock_value}
1465+
1466+
13611467
def test_dynamodb_provider_clear_cache(mock_name, mock_value, config):
13621468
# GIVEN a provider is initialized with a cached value
13631469
provider = parameters.DynamoDBProvider(table_name="test", boto_config=config)

0 commit comments

Comments
 (0)