chore: add given then when and minor refactors (#741)

Author: ran-isenberg

Makefile

@@ -10,6 +10,10 @@ dev:
 	poetry install
 	npm ci
 
+format-fix:
+	poetry run isort .
+	poetry run yapf -vv --style=./.style -r --in-place .
+
 format:
 	poetry run isort .
 	poetry run yapf -d -vv --style=./.style -r .
@@ -68,3 +72,7 @@ docs:
 
 lint-docs:
 	docker run -v ${PWD}:/markdown 06kellyjac/markdownlint-cli --fix "docs"
+
+
+watch:
+	npx cdk watch

cdk.json

@@ -1,3 +1,16 @@
 {
-  "app": "poetry run python app.py"
+  "app": "poetry run python app.py",
+  "watch": {
+    "include": [
+      "service/**",
+      "cdk/service/**"
+    ],
+    "exclude": [
+      "service/**/*.pyc",
+      "service/**/__pycache__",
+      "cdk/**/*.pyc",
+      "cdk/**/__pycache__"
+    ]
+  },
+  "build": "make build"
 }

cdk/service/api_construct.py

@@ -87,7 +87,7 @@ def _add_post_lambda_integration(self, api_name: aws_apigateway.Resource, role:
             constants.CREATE_LAMBDA,
             runtime=_lambda.Runtime.PYTHON_3_11,
             code=_lambda.Code.from_asset(constants.BUILD_FOLDER),
-            handler='service.handlers.create_order.create_order',
+            handler='service.handlers.create_order.lambda_handler',
             environment={
                 constants.POWERTOOLS_SERVICE_NAME: constants.SERVICE_NAME,  # for logger, tracer and metrics
                 constants.POWER_TOOLS_LOG_LEVEL: 'DEBUG',  # for logger

cdk/service/service_stack.py

@@ -1,4 +1,4 @@
-import os
+import getpass
 from pathlib import Path
 
 from aws_cdk import Aspects, Stack, Tags
@@ -13,7 +13,7 @@
 
 def get_username() -> str:
     try:
-        return os.getlogin().replace('.', '-')
+        return getpass.getuser().replace('.', '-')
     except Exception:
         return 'github'
 
@@ -22,8 +22,11 @@ def get_stack_name() -> str:
     repo = Repo(Path.cwd())
     username = get_username()
     try:
-        return f'{username}-{repo.active_branch}-{SERVICE_NAME}'
+        branch_name = f'{repo.active_branch}'.replace('/', '-').replace('_', '-')
+        return f'{username}-{branch_name}-{SERVICE_NAME}'
     except TypeError:
+        # we're running in detached mode (HEAD)
+        # see https://github.com/gitpython-developers/GitPython/issues/633
         return f'{username}-{SERVICE_NAME}'
 
 

mypy.ini

@@ -7,7 +7,12 @@ warn_unused_ignores=True
 show_column_numbers = True
 show_error_codes = True
 show_error_context = True
+plugins = pydantic.mypy
 
+[pydantic-mypy]
+init_forbid_extra = true
+init_typed = true
+warn_required_dynamic_aliases = true
 
 # Disable specific error codes in the 'tests' package
 [mypy-tests.*]

package-lock.json

@@ -1,5 +1,5 @@
 {
     "dependencies": {
-        "aws-cdk": "^2.97.0"
+        "aws-cdk": "^2.99.1"
     }
 }

package.json

@@ -28,11 +28,11 @@ aws-lambda-env-modeler = "*"
 [tool.poetry.dev-dependencies]
 # CDK
 service-cdk = {path = "cdk", develop = true}
-aws-cdk-lib = ">=2.93.0"
+aws-cdk-lib = ">=2.99.0"
 constructs = ">=10.0.0"
 cdk-nag = ">2.0.0"
-"aws-cdk.aws-lambda-python-alpha" = "^2.93.0-alpha.0"
-"aws-cdk.aws-appconfig-alpha" = "^2.93.0-alpha.0"
+"aws-cdk.aws-lambda-python-alpha" = "^2.99.0-alpha.0"
+"aws-cdk.aws-appconfig-alpha" = "^2.99.0-alpha.0"
 # DEV
 pytest = "*"
 pytest-mock = "*"
@@ -74,3 +74,6 @@ skip = [
 
 [tool.yapfignore]
 ignore_patterns = [".git", ".venv", ".build", "cdk.out", "node_modules"]
+
+[tool.pytest.ini_options]
+testpaths = "tests"

poetry.lock

@@ -13,7 +13,7 @@
 from service.handlers.utils.dynamic_configuration import parse_configuration
 from service.handlers.utils.http_responses import build_response
 from service.handlers.utils.observability import logger, metrics, tracer
-from service.logic.handle_create_request import handle_create_request
+from service.logic.create_order import create_order
 from service.schemas.exceptions import InternalServerException
 from service.schemas.input import CreateOrderRequest
 from service.schemas.output import CreateOrderOutput
@@ -22,7 +22,7 @@
 @init_environment_variables(model=MyHandlerEnvVars)
 @metrics.log_metrics
 @tracer.capture_lambda_handler(capture_response=False)
-def create_order(event: Dict[str, Any], context: LambdaContext) -> Dict[str, Any]:
+def lambda_handler(event: Dict[str, Any], context: LambdaContext) -> Dict[str, Any]:
     logger.set_correlation_id(context.aws_request_id)
 
     env_vars: MyHandlerEnvVars = get_environment_variables(model=MyHandlerEnvVars)
@@ -45,7 +45,7 @@ def create_order(event: Dict[str, Any], context: LambdaContext) -> Dict[str, Any
 
     metrics.add_metric(name='ValidCreateOrderEvents', unit=MetricUnit.Count, value=1)
     try:
-        response: CreateOrderOutput = handle_create_request(
+        response: CreateOrderOutput = create_order(
             order_request=create_input,
             table_name=env_vars.TABLE_NAME,
             context=context,

pyproject.toml

@@ -20,7 +20,7 @@
     output_serializer=PydanticSerializer,
 )
 @tracer.capture_method(capture_response=False)
-def handle_create_request(order_request: CreateOrderRequest, table_name: str, context: LambdaContext) -> CreateOrderOutput:
+def create_order(order_request: CreateOrderRequest, table_name: str, context: LambdaContext) -> CreateOrderOutput:
     IDEMPOTENCY_CONFIG.register_lambda_context(context)  # see Lambda timeouts section
 
     logger.info('starting to handle create request', extra={

service/handlers/create_order.py

@@ -48,8 +48,8 @@ def call_create_order(body: Dict[str, Any]) -> Dict[str, Any]:
     # important is done here since idempotency decorator requires an env. variable during import time
     # conf.test sets that env. variable (table name) but it runs after imports
     # this way, idempotency import runs after conftest sets the values already
-    from service.handlers.create_order import create_order
-    return create_order(body, generate_context())
+    from service.handlers.create_order import lambda_handler
+    return lambda_handler(body, generate_context())
 
 
 def test_handler_200_ok(mocker, table_name: str):

service/logic/handle_create_request.py renamed to service/logic/create_order.py

@@ -60,8 +60,8 @@ def call_create_order(body: Dict[str, Any]) -> Dict[str, Any]:
     # important is done here since idempotency decorator requires an env. variable during import time
     # conf.test sets that env. variable (table name) but it runs after imports
     # this way, idempotency import runs after conftest sets the values already
-    from service.handlers.create_order import create_order
-    return create_order(body, generate_context())
+    from service.handlers.create_order import lambda_handler
+    return lambda_handler(body, generate_context())
 
 
 def assert_response(response: Dict[str, Any], expected_response_code: HTTPStatus, expected_customer_name: str, expected_order_item_count: int):
@@ -74,12 +74,12 @@ def assert_response(response: Dict[str, Any], expected_response_code: HTTPStatus
 
 
 def spy_on_campaign_logic(mocker):
-    import service.logic.handle_create_request as cr
+    import service.logic.create_order as cr
     return mocker.spy(cr, 'handle_campaign')
 
 
 def spy_on_premium_logic(mocker):
-    import service.logic.handle_create_request as cr
+    import service.logic.create_order as cr
     return mocker.spy(cr, 'apply_premium_user_discount')
 
 

tests/integration/test_create_order.py

@@ -3,27 +3,53 @@
 
 from service.schemas.input import CreateOrderRequest
 
+# ... potentially more imports based on your project ...
+
 
 def test_invalid_name():
+    # Given: An empty customer_name
+    customer_name = ''
+    order_item_count = 4
+
+    # When & Then: CreateOrderRequest is initialized, expect a ValidationError
     with pytest.raises(ValidationError):
-        CreateOrderRequest(customer_name='', order_item_count=4)
+        CreateOrderRequest(customer_name=customer_name, order_item_count=order_item_count)
 
 
 def test_invalid_name_too_long():
+    # Given: A too long customer_name
+    customer_name = '1' * 33  # or '1234567890112123423232323232323' based on your original code
+    order_item_count = 4
+
+    # When & Then: CreateOrderRequest is initialized, expect a ValidationError
     with pytest.raises(ValidationError):
-        CreateOrderRequest(customer_name='1234567890112123423232323232323', order_item_count=4)
+        CreateOrderRequest(customer_name=customer_name, order_item_count=order_item_count)
 
 
 def test_missing_mandatory_fields():
+    # Given: A missing order_item_count
+    customer_name = 'a'
+
+    # When & Then: CreateOrderRequest is initialized, expect a ValidationError
     with pytest.raises(ValidationError):
-        CreateOrderRequest(customer_name='a')
+        CreateOrderRequest(customer_name=customer_name)
 
 
 def test_invalid_order_number():
+    # Given: An invalid negative order_item_count
+    customer_name = 'a'
+    order_item_count = -1
+
+    # When & Then: CreateOrderRequest is initialized, expect a ValidationError
     with pytest.raises(ValidationError):
-        CreateOrderRequest(customer_name='a', order_item_count=-1)
+        CreateOrderRequest(customer_name=customer_name, order_item_count=order_item_count)
 
 
 def test_invalid_order_number_type():
+    # Given: A non-integer order_item_count
+    customer_name = 'a'
+    order_item_count = 'a'
+
+    # When & Then: CreateOrderRequest is initialized, expect a ValidationError
     with pytest.raises(ValidationError):
-        CreateOrderRequest(customer_name='a', order_item_count='a')
+        CreateOrderRequest(customer_name=customer_name, order_item_count=order_item_count)

tests/integration/test_feature_flags.py

@@ -9,24 +9,51 @@
 
 
 def test_invalid_items_type():
+    # Given: An invalid non-integer order_item_count
+    customer_name = '3333'
+    order_item_count = 'a'
+
+    # When & Then: CreateOrderOutput is initialized, expect a ValidationError
     with pytest.raises(ValidationError):
-        CreateOrderOutput(order_id=order_id, customer_name='3333', order_item_count='a')
+        CreateOrderOutput(order_id=order_id, customer_name=customer_name, order_item_count=order_item_count)
 
 
 def test_invalid_items_negative():
+    # Given: An invalid negative order_item_count
+    customer_name = '3333'
+    order_item_count = -1
+
+    # When & Then: CreateOrderOutput is initialized, expect a ValidationError
     with pytest.raises(ValidationError):
-        CreateOrderOutput(order_id=order_id, customer_name='3333', order_item_count=-1)
+        CreateOrderOutput(order_id=order_id, customer_name=customer_name, order_item_count=order_item_count)
 
 
 def test_invalid_items_zero():
+    # Given: An invalid zero order_item_count
+    customer_name = '3333'
+    order_item_count = 0
+
+    # When & Then: CreateOrderOutput is initialized, expect a ValidationError
     with pytest.raises(ValidationError):
-        CreateOrderOutput(order_id=order_id, customer_name='3333', order_item_count=0)
+        CreateOrderOutput(order_id=order_id, customer_name=customer_name, order_item_count=order_item_count)
 
 
 def test_invalid_order_id():
+    # Given: An invalid order_id
+    order_id_invalid = '2'
+    customer_name = '3333'
+    order_item_count = 2
+
+    # When & Then: CreateOrderOutput is initialized, expect a ValidationError
     with pytest.raises(ValidationError):
-        CreateOrderOutput(order_id='2', customer_name='3333', order_item_count=2)
+        CreateOrderOutput(order_id=order_id_invalid, customer_name=customer_name, order_item_count=order_item_count)
 
 
 def test_valid_output():
-    CreateOrderOutput(customer_name='222', order_item_count=4, order_id=order_id)
+    # Given: Valid inputs
+    customer_name = '222'
+    order_item_count = 4
+
+    # When: CreateOrderOutput is initialized
+    # Then: No exception should be raised
+    CreateOrderOutput(order_id=order_id, customer_name=customer_name, order_item_count=order_item_count)

tests/unit/test_create_order_input.py

@@ -9,24 +9,51 @@
 
 
 def test_invalid_items_type():
+    # Given: An invalid non-integer order_item_count
+    customer_name = '3333'
+    order_item_count = 'a'
+
+    # When & Then: OrderEntry is initialized, expect a ValidationError
     with pytest.raises(ValidationError):
-        OrderEntry(order_id=order_id, customer_name='3333', order_item_count='a')
+        OrderEntry(order_id=order_id, customer_name=customer_name, order_item_count=order_item_count)
 
 
 def test_invalid_items_negative():
+    # Given: An invalid negative order_item_count
+    customer_name = '3333'
+    order_item_count = -1
+
+    # When & Then: OrderEntry is initialized, expect a ValidationError
     with pytest.raises(ValidationError):
-        OrderEntry(order_id=order_id, customer_name='3333', order_item_count=-1)
+        OrderEntry(order_id=order_id, customer_name=customer_name, order_item_count=order_item_count)
 
 
 def test_invalid_items_zero():
+    # Given: An invalid zero order_item_count
+    customer_name = '3333'
+    order_item_count = 0
+
+    # When & Then: OrderEntry is initialized, expect a ValidationError
     with pytest.raises(ValidationError):
-        OrderEntry(order_id=order_id, customer_name='3333', order_item_count=0)
+        OrderEntry(order_id=order_id, customer_name=customer_name, order_item_count=order_item_count)
 
 
 def test_invalid_order_id():
+    # Given: An invalid order_id
+    order_id_invalid = '2'
+    customer_name = '3333'
+    order_item_count = 2
+
+    # When & Then: OrderEntry is initialized, expect a ValidationError
     with pytest.raises(ValidationError):
-        OrderEntry(order_id='2', customer_name='3333', order_item_count=2)
+        OrderEntry(order_id=order_id_invalid, customer_name=customer_name, order_item_count=order_item_count)
 
 
 def test_valid_output():
-    OrderEntry(customer_name='222', order_item_count=4, order_id=order_id)
+    # Given: Valid inputs
+    customer_name = '222'
+    order_item_count = 4
+
+    # When: OrderEntry is initialized
+    # Then: No exception should be raised
+    OrderEntry(order_id=order_id, customer_name=customer_name, order_item_count=order_item_count)