fix: tests should be more BDD-aligned

Author: jgfranco17

tests/features/feature_tests/api_features/functionality.feature

@@ -4,18 +4,13 @@ Feature: API Operation Testing
         Given I start the API
 
     Scenario: Access numeric endpoint
-        When I send a request to "/v0/fizzbuzz?number=15"
+        When I send a request to the fizzbuzz endpoint with value 15
         Then the response is returned with status code 200
         And the sequence contains 4 instances of "fizz"
         And the sequence contains 2 instances of "buzz"
         And the sequence contains 1 instances of "fizzbuzz"
 
     Scenario: Invalid input raises error
-        When I send a request to "/v0/fizzbuzz?number=0"
+        When I send a request to the fizzbuzz endpoint with value 0
         Then the response is returned with status code 400
         And an error is raised with "number must a positive integer" in "message"
-
-    Scenario: Attempt non-existent route
-        When I send a request to "/fake-endpoint"
-        Then the response is returned with status code 404
-        And an error is raised with "Not Found" in "detail"

tests/features/feature_tests/api_features/system.feature

@@ -4,14 +4,14 @@ Feature: Basic Configuration Testing
         Given I start the API
 
     Scenario: Access root endpoint
-        When I send a request to "/"
+        When I send a request to the index endpoint
         Then the response is returned with status code 200
         And the response JSON contains "message" in keys
 
     Scenario: Access health-check endpoint
-        When I send a request to "/healthz"
+        When I send a request to the health-check endpoint
         Then the response is returned with status code 200
 
     Scenario: Access metrics endpoint
-        When I send a request to "/metrics"
+        When I send a request to the metrics endpoint
         Then the response is returned with status code 200

tests/features/steps/api_steps.py

@@ -1,7 +1,16 @@
+from typing import Dict
+
 from behave import given, then, when
 
 from tests.features.stubs import TestContext
 
+ENDPOINT_MAP: Dict[str, str] = {
+    "index": "/",
+    "health-check": "/healthz",
+    "service info": "/service-info",
+    "metrics": "/metrics",
+}
+
 
 def __parse_keyword(keyword: str):
     keyword = keyword.lower()
@@ -13,12 +22,23 @@ def __parse_keyword(keyword: str):
 @given("I start the API")
 def step_prelaunch_checks(context: TestContext):
     assert context.setup_complete, "Setup was not successful."
-    assert context.response is None, "Response was not reset to None."
+    assert context.response is None, "Response was not reset to null."
+
+
+@given("I send a request to the fizzbuzz endpoint with value {value:d}")
+@when("I send a request to the fizzbuzz endpoint with value {value:d}")
+def step_get_request(context: TestContext, value: int):
+    endpoint = f"/v0/fizzbuzz?number={value}"
+    context.response = context.mock_server.get(endpoint)
 
 
-@given('I send a request to "{endpoint:S}"')
-@when('I send a request to "{endpoint:S}"')
-def step_get_request(context: TestContext, endpoint: str):
+@given("I send a request to the {endpoint_name:S} endpoint")
+@when("I send a request to the {endpoint_name:S} endpoint")
+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)
     context.response = context.mock_server.get(endpoint)