refactor: output schema (#29)

* refactor: added output schema

* add tests

Author: ran-isenberg

Pipfile.lock

@@ -25,6 +25,6 @@
     install_requires=[
         'aws-cdk-lib>=2.0.0',
         'constructs>=10.0.0',
-        'aws-cdk.aws-lambda-python-alpha==2.19.0-alpha.0',
+        'aws-cdk.aws-lambda-python-alpha==2.24.1-alpha.0',
     ],
 )

cdk/setup.py

@@ -2,16 +2,16 @@
 -e ./cdk
 attrs==21.4.0
 aws-cdk-lib==2.24.1
-aws-cdk.aws-lambda-python-alpha==2.19.0a0
-boto3==1.22.13
-botocore==1.25.13
+aws-cdk.aws-lambda-python-alpha==2.24.1a0
+boto3==1.23.3
+botocore==1.26.3
 cattrs==1.10.0
-certifi==2021.10.8
+certifi==2022.5.18
 cfgv==3.3.1
 charset-normalizer==2.0.12 ; python_version >= '3'
 click==8.1.3
 colorama==0.4.4 ; python_version > '3.4'
-constructs==10.1.7
+constructs==10.1.11
 coverage[toml]==6.3.3
 distlib==0.3.4
 filelock==3.7.0
@@ -27,15 +27,15 @@ iniconfig==1.1.1
 isort==5.10.1
 jinja2==3.1.2
 jmespath==1.0.0
-jsii==1.58.0
+jsii==1.59.0
 mando==0.6.4
 markdown==3.3.7
 markupsafe==2.1.1
 mccabe==0.6.1
 mergedeep==1.3.4
 mkdocs-git-revision-date-plugin==0.3.2
 mkdocs-material-extensions==1.0.3
-mkdocs-material==8.2.14
+mkdocs-material==8.2.15
 mkdocs==1.3.0
 nodeenv==1.6.0
 packaging==21.3
@@ -68,7 +68,7 @@ tomli==2.0.1
 typing-extensions==4.2.0
 urllib3==1.26.9
 virtualenv==20.14.1
-watchdog==2.1.7
+watchdog==2.1.8
 xenon==0.9.0
 yapf==0.32.0
 zipp==3.8.0

dev_requirements.txt

@@ -13,7 +13,7 @@ All steps can be run locally using the makefile. See details below:
 - Install dev dependencies
 - Run pre-commit checks as defined in `.pre-commit-config.yaml`
 - Lint with flake8 as defined in `.flake8` - run `make lint` in the IDE
-- Verfiy that Python imports are sorted according to standard - run `make sort` in the IDE
+- Verify that Python imports are sorted according to standard - run `make sort` in the IDE
 - Python formatter Yapf as defined in `.style`  - run `make yapf` in the IDE
 - Python complexity checks: radon and xenon  - run `make complex` in the IDE
 - Unit tests. Run `make unit` to run unit tests in the IDE

docs/pipeline.md

@@ -1,8 +1,8 @@
 -i https://pypi.org/simple
 aws-lambda-powertools==1.25.10
 aws-xray-sdk==2.9.0
-boto3==1.22.13
-botocore==1.25.13
+boto3==1.23.3
+botocore==1.26.3
 dnspython==2.2.1
 email-validator==1.2.1
 fastjsonschema==2.15.3

lambda_requirements.txt

@@ -10,14 +10,15 @@
 from service.handlers.schemas.dynamic_configuration import FeatureFlagsNames, MyConfiguration
 from service.handlers.schemas.env_vars import MyHandlerEnvVars
 from service.handlers.schemas.input import Input
+from service.handlers.schemas.output import Output
 from service.handlers.utils.dynamic_configuration import get_dynamic_configuration_store, parse_configuration
 from service.handlers.utils.env_vars_parser import get_environment_variables, init_environment_variables
 from service.handlers.utils.http_responses import build_response
 from service.handlers.utils.observability import logger, metrics, tracer
 
 
 @tracer.capture_method(capture_response=False)
-def inner_function_example(my_name: str, order_item_count: int) -> Dict[str, Any]:
+def inner_function_example(my_name: str, order_item_count: int) -> Output:
     # process input, etc. return output
     config_store = get_dynamic_configuration_store()
     campaign: bool = config_store.evaluate(
@@ -32,7 +33,7 @@ def inner_function_example(my_name: str, order_item_count: int) -> Dict[str, Any
         default=False,
     )
     logger.debug('premium feature flag value', extra={'premium': premium})
-    return {'message': 'success'}
+    return Output(success=True, order_item_count=order_item_count)
 
 
 @init_environment_variables(model=MyHandlerEnvVars)
@@ -60,7 +61,7 @@ def my_handler(event: Dict[str, Any], context: LambdaContext) -> Dict[str, Any]:
         logger.error('event failed input validation', extra={'error': str(exc)})
         return build_response(http_status=HTTPStatus.BAD_REQUEST, body={})
 
-    response: Dict[str, str] = inner_function_example(input.my_name, input.order_item_count)
+    response: Output = inner_function_example(input.my_name, input.order_item_count)
     logger.info('inner_function_example finished successfully')
     metrics.add_metric(name='ValidEvents', unit=MetricUnit.Count, value=1)
-    return build_response(http_status=HTTPStatus.OK, body=response)
+    return build_response(http_status=HTTPStatus.OK, body=response.dict())

service/handlers/my_handler.py

@@ -0,0 +1,6 @@
+from pydantic import BaseModel, PositiveInt
+
+
+class Output(BaseModel):
+    success: bool
+    order_item_count: PositiveInt

service/handlers/schemas/output.py

@@ -14,7 +14,8 @@ def test_handler_200_ok():
     response = requests.post(f'{api_gw_url}/api/{GW_RESOURCE}', data=body.json())
     assert response.status_code == HTTPStatus.OK
     body_dict = json.loads(response.text)
-    assert body_dict['message'] == 'success'
+    assert body_dict['success']
+    assert body_dict['order_item_count'] == 5
 
 
 def test_handler_bad_request():

tests/e2e/test_my_handler.py

@@ -71,7 +71,8 @@ def test_handler_200_ok(mocker):
     response = my_handler(generate_api_gw_event(body.dict()), generate_context())
     assert response['statusCode'] == HTTPStatus.OK
     body_dict = json.loads(response['body'])
-    assert body_dict['message'] == 'success'
+    assert body_dict['success']
+    assert body_dict['order_item_count'] == 5
 
 
 def test_handler_bad_request(mocker):

tests/unit/test_my_handler.py

@@ -0,0 +1,28 @@
+import pytest
+from aws_lambda_powertools.utilities.parser import ValidationError
+
+from service.handlers.schemas.output import Output
+
+
+def test_invalid_success():
+    with pytest.raises(ValidationError):
+        Output(success=4, order_item_count=4)
+
+
+def test_invalid_items():
+    with pytest.raises(ValidationError):
+        Output(success=4, order_item_count=1.1)
+
+
+def test_invalid_items_negative():
+    with pytest.raises(ValidationError):
+        Output(success=4, order_item_count='-1')
+
+
+def test_invalid_items_zero():
+    with pytest.raises(ValidationError):
+        Output(success=4, order_item_count=0)
+
+
+def test_valid_output():
+    Output(success=True, order_item_count=4)