fix: type-hinting compliance

Author: jgfranco17

tests/features/environment.py

@@ -1,21 +1,22 @@
+from behave.model import Scenario
 from fastapi.testclient import TestClient
 
 from api.service import app
+from tests.features.stubs import TestContext
 
 
-def before_all(context):
-    print("\nSetting up resources for the entire test run...")
+def before_all(context: TestContext):
+    print("Setting up resources for the entire test run...")
     context.mock_server = TestClient(app)
     context.setup_complete = True
     print("Loaded mock server, ready for feature tests!\n")
 
 
-def after_all(context):
+def after_all(context: TestContext):
     if context.setup_complete:
         print("Tearing down resources for the entire test run...")
-        # Perform teardown activities here
         context.teardown_complete = True
 
 
-def before_scenario(context, scenario):
+def before_scenario(context: TestContext, scenario: Scenario):
     context.response = None

tests/features/steps/api_steps.py

@@ -1,6 +1,6 @@
 from typing import Dict
 
-from behave import given, then, when
+from behave import given, then, when  # type: ignore
 
 from tests.features.stubs import TestContext
 
@@ -15,7 +15,7 @@
 def __parse_keyword(keyword: str):
     keyword = keyword.lower()
     if keyword not in ("fizz", "buzz", "fizzbuzz"):
-        raise ValueError(f"Invalid keyword")
+        raise AssertionError(f"Invalid keyword")
     return keyword
 
 
@@ -38,24 +38,27 @@ def step_get_request(context: TestContext, endpoint_name: str):
     assert (
         endpoint_name in ENDPOINT_MAP.keys()
     ), f"Endpoint '{endpoint_name}' is not recognized."
-    endpoint = ENDPOINT_MAP.get(endpoint_name)
+    endpoint = ENDPOINT_MAP[endpoint_name]
     context.response = context.mock_server.get(endpoint)
 
 
 @then("the response is returned with status code {status_code:d}")
 def step_evaluate_request_status(context: TestContext, status_code: int):
+    assert context.response is not None, "Last response was null"
     assert (
         context.response.status_code == status_code
     ), f"Expected status code {status_code} but got {context.response.status_code}"
 
 
 @then('the response JSON contains "{message:S}" in keys')
 def step_evaluate_response_message(context: TestContext, message: str):
+    assert context.response is not None, "Last response was null"
     assert message in context.response.json()
 
 
 @then('the sequence contains {count:d} instances of "{word:S}"')
 def step_check_count(context: TestContext, count: int, word: str):
+    assert context.response is not None, "Last response was null"
     key = __parse_keyword(word)
     instance_count = context.response.json()[key]
     assert (
@@ -65,6 +68,7 @@ def step_check_count(context: TestContext, count: int, word: str):
 
 @then('an error is raised with "{message}" in "{key:S}"')
 def step_check_error_output(context: TestContext, message: str, key: str):
+    assert context.response is not None, "Last response was null"
     response = context.response.json()["message"][key]
     assert (
         message in response

tests/features/stubs.py

@@ -1,10 +1,16 @@
-from typing import Optional
+from typing import Optional, Protocol
 
 from behave.runner import Context
-from fastapi import Response
 from fastapi.testclient import TestClient
 
 
+class ResponseData(Protocol):
+    status_code: int
+
+    def json(self) -> dict:
+        ...
+
+
 class TestContext(Context):
     """Custom Fizzbuzz API context type stub.
 
@@ -23,4 +29,4 @@ class TestContext(Context):
     mock_server: TestClient
     setup_complete: bool
     teardown_complete: bool
-    response: Optional[Response]
+    response: Optional[ResponseData]