Skip to content

fix(parameters): appconfig transform and return types #877

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 4 commits into from
Dec 9, 2021
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
6 changes: 4 additions & 2 deletions aws_lambda_powertools/metrics/metric.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import json
import logging
from contextlib import contextmanager
from typing import Dict, Optional, Union, Generator
from typing import Dict, Generator, Optional, Union

from .base import MetricManager, MetricUnit

Expand Down Expand Up @@ -61,7 +61,9 @@ def add_metric(self, name: str, unit: Union[MetricUnit, str], value: float) -> N


@contextmanager
def single_metric(name: str, unit: MetricUnit, value: float, namespace: Optional[str] = None) -> Generator[SingleMetric, None, None]:
def single_metric(
name: str, unit: MetricUnit, value: float, namespace: Optional[str] = None
) -> Generator[SingleMetric, None, None]:
"""Context manager to simplify creation of a single metric

Example
Expand Down
4 changes: 3 additions & 1 deletion aws_lambda_powertools/utilities/parameters/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -93,14 +93,16 @@ def get(
raise GetParameterError(str(exc))

if transform is not None:
if isinstance(value, bytes):
value = value.decode("utf-8")
value = transform_value(value, transform)

self.store[key] = ExpirableValue(value, datetime.now() + timedelta(seconds=max_age))

return value

@abstractmethod
def _get(self, name: str, **sdk_options) -> str:
def _get(self, name: str, **sdk_options) -> Union[str, bytes]:
"""
Retrieve parameter value from the underlying parameter store
"""
Expand Down
31 changes: 28 additions & 3 deletions tests/functional/test_utilities_parameters.py
Original file line number Diff line number Diff line change
Expand Up @@ -1503,7 +1503,7 @@ def test_appconf_provider_get_configuration_no_transform(mock_name, config):
stubber.activate()

try:
value = provider.get(mock_name)
value: str = provider.get(mock_name)
str_value = value.decode("utf-8")
assert str_value == json.dumps(mock_body_json)
stubber.assert_no_pending_responses()
Expand All @@ -1516,11 +1516,12 @@ def test_appconf_get_app_config_no_transform(monkeypatch, mock_name):
Test get_app_config()
"""
mock_body_json = {"myenvvar1": "Black Panther", "myenvvar2": 3}
mock_body_bytes = str.encode(json.dumps(mock_body_json))

class TestProvider(BaseProvider):
def _get(self, name: str, **kwargs) -> str:
def _get(self, name: str, **kwargs) -> bytes:
assert name == mock_name
return json.dumps(mock_body_json).encode("utf-8")
return mock_body_bytes

def _get_multiple(self, path: str, **kwargs) -> Dict[str, str]:
raise NotImplementedError()
Expand All @@ -1532,6 +1533,30 @@ def _get_multiple(self, path: str, **kwargs) -> Dict[str, str]:
value = parameters.get_app_config(mock_name, environment=environment, application=application)
str_value = value.decode("utf-8")
assert str_value == json.dumps(mock_body_json)
assert value == mock_body_bytes


def test_appconf_get_app_config_transform_json(monkeypatch, mock_name):
"""
Test get_app_config()
"""
mock_body_json = {"myenvvar1": "Black Panther", "myenvvar2": 3}
mock_body_bytes = str.encode(json.dumps(mock_body_json))

class TestProvider(BaseProvider):
def _get(self, name: str, **kwargs) -> str:
assert name == mock_name
return mock_body_bytes

def _get_multiple(self, path: str, **kwargs) -> Dict[str, str]:
raise NotImplementedError()

monkeypatch.setitem(parameters.base.DEFAULT_PROVIDERS, "appconfig", TestProvider())

environment = "dev"
application = "myapp"
value = parameters.get_app_config(mock_name, environment=environment, application=application, transform="json")
assert value == mock_body_json


def test_appconf_get_app_config_new(monkeypatch, mock_name, mock_value):
Expand Down