Polishing the PR with best practicies - Tests

Author: leandrodamascena

tests/functional/event_handler/_pydantic/test_openapi_extensions.py

@@ -12,24 +12,28 @@
 
 
 def test_openapi_extension_root_level():
+    # GIVEN an APIGatewayRestResolver instance
     app = APIGatewayRestResolver()
 
     cors_config = {
         "maxAge": 0,
         "allowCredentials": False,
     }
 
+    # WHEN we get the OpenAPI JSON schema with CORS extension in the Root Level
     schema = json.loads(
         app.get_openapi_json_schema(
             openapi_extensions={"x-amazon-apigateway-cors": cors_config},
         ),
     )
 
+    # THEN the OpenAPI schema must contain the "x-amazon-apigateway-cors" extension
     assert "x-amazon-apigateway-cors" in schema
     assert schema["x-amazon-apigateway-cors"] == cors_config
 
 
 def test_openapi_extension_server_level():
+    # GIVEN an APIGatewayRestResolver instance
     app = APIGatewayRestResolver()
 
     endpoint_config = {
@@ -42,6 +46,7 @@ def test_openapi_extension_server_level():
         "description": "Example website",
     }
 
+    # WHEN we get the OpenAPI JSON schema with a server-level openapi extension
     schema = json.loads(
         app.get_openapi_json_schema(
             title="Hello API",
@@ -57,11 +62,13 @@ def test_openapi_extension_server_level():
         ),
     )
 
+    # THEN the OpenAPI schema must contain the "x-amazon-apigateway-endpoint-configuration" at the server level
     assert "x-amazon-apigateway-endpoint-configuration" in schema["servers"][0]
     assert schema["servers"][0]["x-amazon-apigateway-endpoint-configuration"] == endpoint_config
 
 
 def test_openapi_extension_security_scheme_level_with_api_key():
+    # GIVEN an APIGatewayRestResolver instance
     app = APIGatewayRestResolver()
 
     authorizer_config = {
@@ -76,6 +83,7 @@ def test_openapi_extension_security_scheme_level_with_api_key():
         "in_": APIKeyIn.header,
     }
 
+    # WHEN we get the OpenAPI JSON schema with a security scheme-level extension for a custom auth
     schema = json.loads(
         app.get_openapi_json_schema(
             security_schemes={
@@ -90,12 +98,14 @@ def test_openapi_extension_security_scheme_level_with_api_key():
         ),
     )
 
+    # THEN the OpenAPI schema must contain the "x-amazon-apigateway-authtype" extension at the security scheme level
     assert "x-amazon-apigateway-authtype" in schema["components"]["securitySchemes"]["apiKey"]
     assert schema["components"]["securitySchemes"]["apiKey"]["x-amazon-apigateway-authtype"] == "custom"
     assert schema["components"]["securitySchemes"]["apiKey"]["x-amazon-apigateway-authorizer"] == authorizer_config
 
 
 def test_openapi_extension_security_scheme_level_with_oauth2():
+    # GIVEN an APIGatewayRestResolver instance
     app = APIGatewayRestResolver()
 
     authorizer_config = {
@@ -115,6 +125,7 @@ def test_openapi_extension_security_scheme_level_with_oauth2():
         ),
     }
 
+    # WHEN we get the OpenAPI JSON schema with a security scheme-level extension for a custom auth
     schema = json.loads(
         app.get_openapi_json_schema(
             security_schemes={
@@ -128,19 +139,24 @@ def test_openapi_extension_security_scheme_level_with_oauth2():
         ),
     )
 
+    # THEN the OpenAPI schema must contain the "x-amazon-apigateway-authorizer" extension at the security scheme level
     assert "x-amazon-apigateway-authorizer" in schema["components"]["securitySchemes"]["oauth2"]
     assert schema["components"]["securitySchemes"]["oauth2"]["x-amazon-apigateway-authorizer"] == authorizer_config
 
 
 def test_openapi_extension_operation_level(openapi_extension_integration_detail):
+    # GIVEN an APIGatewayRestResolver instance
     app = APIGatewayRestResolver()
 
+    # WHEN we define an integration extension at operation level
+    # AND get the schema
     @app.get("/test", openapi_extensions={"x-amazon-apigateway-integration": openapi_extension_integration_detail})
     def lambda_handler():
         pass
 
     schema = json.loads(app.get_openapi_json_schema())
 
+    # THEN the OpenAPI schema must contain the "x-amazon-apigateway-integration" extension at the operation level
     assert "x-amazon-apigateway-integration" in schema["paths"]["/test"]["get"]
     assert schema["paths"]["/test"]["get"]["x-amazon-apigateway-integration"] == openapi_extension_integration_detail
 
@@ -149,8 +165,11 @@ def test_openapi_extension_operation_level_multiple_paths(
     openapi_extension_integration_detail,
     openapi_extension_validator_detail,
 ):
+    # GIVEN an APIGatewayRestResolver instance
     app = APIGatewayRestResolver()
 
+    # WHEN we define multiple routes with integration extension at operation level
+    # AND get the schema
     @app.get("/test", openapi_extensions={"x-amazon-apigateway-integration": openapi_extension_integration_detail})
     def lambda_handler_get():
         pass
@@ -161,6 +180,7 @@ def lambda_handler_post():
 
     schema = json.loads(app.get_openapi_json_schema())
 
+    # THEN each route must contain only your extension
     assert "x-amazon-apigateway-integration" in schema["paths"]["/test"]["get"]
     assert schema["paths"]["/test"]["get"]["x-amazon-apigateway-integration"] == openapi_extension_integration_detail
 
@@ -172,9 +192,12 @@ def lambda_handler_post():
 
 
 def test_openapi_extension_operation_level_with_router(openapi_extension_integration_detail):
+    # GIVEN an APIGatewayRestResolver and Router instance
     app = APIGatewayRestResolver()
     router = Router()
 
+    # WHEN we define an integration extension at operation level using Router
+    # AND get the schema
     @router.get("/test", openapi_extensions={"x-amazon-apigateway-integration": openapi_extension_integration_detail})
     def lambda_handler():
         pass
@@ -183,6 +206,7 @@ def lambda_handler():
 
     schema = json.loads(app.get_openapi_json_schema())
 
+    # THEN the OpenAPI schema must contain the "x-amazon-apigateway-integration" extension at the operation level
     assert "x-amazon-apigateway-integration" in schema["paths"]["/test"]["get"]
     assert schema["paths"]["/test"]["get"]["x-amazon-apigateway-integration"] == openapi_extension_integration_detail
 
@@ -191,9 +215,12 @@ def test_openapi_extension_operation_level_multiple_paths_with_router(
     openapi_extension_integration_detail,
     openapi_extension_validator_detail,
 ):
+    # GIVEN an APIGatewayRestResolver and Router instance
     app = APIGatewayRestResolver()
     router = Router()
 
+    # WHEN we define multiple routes using extensions at operation level using Router
+    # AND get the schema
     @router.get("/test", openapi_extensions={"x-amazon-apigateway-integration": openapi_extension_integration_detail})
     def lambda_handler_get():
         pass
@@ -209,6 +236,7 @@ def lambda_handler_post():
 
     schema = json.loads(app.get_openapi_json_schema())
 
+    # THEN each route must contain only your extension
     assert "x-amazon-apigateway-integration" in schema["paths"]["/test"]["get"]
     assert schema["paths"]["/test"]["get"]["x-amazon-apigateway-integration"] == openapi_extension_integration_detail