Release/v1.39.0

.github/PULL_REQUEST_TEMPLATE.md

@@ -6,7 +6,10 @@
 
 *Checklist:*
 
-- [ ] Write/update tests
+- [ ] Add/update tests using:
+    - [ ] Correct values
+    - [ ] Bad/wrong values (None, empty, wrong type, length, etc.)
+    - [ ] [Intrinsic Functions](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference.html)
 - [ ] `make pr` passes
 - [ ] Update documentation
 - [ ] Verify transformed template deploys and application functions as expected

Makefile

@@ -8,6 +8,9 @@ init:
 test:
 	pytest --cov samtranslator --cov-report term-missing --cov-fail-under 95 tests/*
 
+test-cov-report:
+	pytest --cov samtranslator --cov-report term-missing --cov-report html --cov-fail-under 95 tests/*
+
 integ-test:
 	pytest --no-cov integration/*
 

README.md

@@ -52,7 +52,7 @@ environment that lets you locally build, test, debug, and deploy applications de
 
 ## What is this Github repository? 💻
 
-This GitHub repository contains the SAM Specification, the Python code that translates SAM templates into AWS CloudFormation stacks and lots of examples applications.
+This GitHub repository contains the SAM Specification, the Python code that translates SAM templates into AWS CloudFormation stacks and lots of example applications.
 In the words of SAM developers:
 
 > SAM Translator is the Python code that deploys SAM templates via AWS CloudFormation. Source code is high quality (95% unit test coverage),

docs/internals/generated_resources.rst

@@ -129,7 +129,7 @@ AWS::Lambda::Permission            MyFunction\ **ThumbnailApi**\ Permission\ **P
   NOTE: ``ServerlessRestApi*`` resources are generated one per stack.
 
 HTTP API
-^^^
+^^^^
 This is called an "Implicit HTTP API". There can be many functions in the template that define these APIs. Behind the 
 scenes, SAM will collect all implicit HTTP APIs from all Functions in the template, generate an OpenApi doc, and create an 
 implicit ``AWS::Serverless::HttpApi`` using this OpenApi. This API defaults to a StageName called "$default" that cannot be

integration/combination/test_api_settings.py

@@ -0,0 +1,181 @@
+import hashlib
+
+try:
+    from pathlib import Path
+except ImportError:
+    from pathlib2 import Path
+
+import requests
+from parameterized import parameterized
+
+from integration.helpers.base_test import BaseTest
+
+
+class TestApiSettings(BaseTest):
+    def test_method_settings(self):
+        self.create_and_verify_stack("combination/api_with_method_settings")
+
+        rest_api_id = self.get_physical_id_by_type("AWS::ApiGateway::RestApi")
+        apigw_client = self.client_provider.api_client
+        response = apigw_client.get_stage(restApiId=rest_api_id, stageName="Prod")
+
+        wildcard_path = "*/*"
+
+        method_settings = response["methodSettings"]
+        self.assertTrue(wildcard_path in method_settings, "MethodSettings for the wildcard path must be present")
+
+        wildcard_path_setting = method_settings[wildcard_path]
+
+        self.assertTrue(wildcard_path_setting["metricsEnabled"], "Metrics must be enabled")
+        self.assertTrue(wildcard_path_setting["dataTraceEnabled"], "DataTrace must be enabled")
+        self.assertEqual(wildcard_path_setting["loggingLevel"], "INFO", "LoggingLevel must be INFO")
+
+    @parameterized.expand(
+        [
+            "combination/api_with_binary_media_types",
+            "combination/api_with_binary_media_types_with_definition_body",
+        ]
+    )
+    def test_binary_media_types(self, file_name):
+        self.create_and_verify_stack(file_name, self.get_default_test_template_parameters())
+
+        rest_api_id = self.get_physical_id_by_type("AWS::ApiGateway::RestApi")
+        apigw_client = self.client_provider.api_client
+
+        response = apigw_client.get_rest_api(restApiId=rest_api_id)
+        self.assertEqual(set(response["binaryMediaTypes"]), {"image/jpg", "image/png", "image/gif"})
+
+    @parameterized.expand(
+        [
+            "combination/api_with_request_models",
+            "combination/api_with_request_models_openapi",
+        ]
+    )
+    def test_request_models(self, file_name):
+        self.create_and_verify_stack(file_name)
+
+        rest_api_id = self.get_physical_id_by_type("AWS::ApiGateway::RestApi")
+        apigw_client = self.client_provider.api_client
+
+        response = apigw_client.get_models(restApiId=rest_api_id)
+        request_models = response["items"]
+
+        self.assertEqual(request_models[0]["name"], "user")
+        self.assertEqual(
+            request_models[0]["schema"],
+            '{\n  "type" : "object",\n'
+            + '  "properties" : {\n    "username" : {\n      "type" : "string"\n    }\n'
+            + "  }\n}",
+        )
+
+    def test_request_parameters_open_api(self):
+        self.create_and_verify_stack("combination/api_with_request_parameters_openapi")
+
+        rest_api_id = self.get_physical_id_by_type("AWS::ApiGateway::RestApi")
+        apigw_client = self.client_provider.api_client
+
+        # Test if the request parameters got set on the method
+        resources_response = apigw_client.get_resources(restApiId=rest_api_id)
+        resources = resources_response["items"]
+
+        resource = get_resource_by_path(resources, "/one")
+        method = apigw_client.get_method(restApiId=rest_api_id, resourceId=resource["id"], httpMethod="GET")
+        expected = {"method.request.querystring.type": True}
+        self.assertEqual(expected, method["requestParameters"])
+
+        # Test that the method settings got applied on the method
+        stage_response = apigw_client.get_stage(restApiId=rest_api_id, stageName="Prod")
+        method_settings = stage_response["methodSettings"]
+
+        path = "one/GET"
+        self.assertTrue(path in method_settings, "MethodSettings for the path must be present")
+
+        path_settings = method_settings[path]
+        self.assertEqual(path_settings["cacheTtlInSeconds"], 15)
+        self.assertTrue(path_settings["cachingEnabled"], "Caching must be enabled")
+
+    def test_binary_media_types_with_definition_body_openapi(self):
+        parameters = self.get_default_test_template_parameters()
+        binary_media = {
+            "ParameterKey": "BinaryMediaCodeKey",
+            "ParameterValue": "binary-media.zip",
+            "UsePreviousValue": False,
+            "ResolvedValue": "string",
+        }
+        parameters.append(binary_media)
+
+        self.create_and_verify_stack("combination/api_with_binary_media_types_with_definition_body_openapi", parameters)
+
+        rest_api_id = self.get_physical_id_by_type("AWS::ApiGateway::RestApi")
+        apigw_client = self.client_provider.api_client
+
+        response = apigw_client.get_rest_api(restApiId=rest_api_id)
+        self.assertEqual(
+            set(response["binaryMediaTypes"]), {"image/jpg", "image/png", "image/gif", "application/octet-stream"}
+        )
+        base_url = self.get_stack_output("ApiUrl")["OutputValue"]
+        self.verify_binary_media_request(base_url + "none", 200)
+
+    @parameterized.expand(
+        [
+            "combination/api_with_endpoint_configuration",
+            "combination/api_with_endpoint_configuration_dict",
+        ]
+    )
+    def test_end_point_configuration(self, file_name):
+        self.create_and_verify_stack(file_name, self.get_default_test_template_parameters())
+
+        rest_api_id = self.get_physical_id_by_type("AWS::ApiGateway::RestApi")
+        apigw_client = self.client_provider.api_client
+
+        response = apigw_client.get_rest_api(restApiId=rest_api_id)
+        endpoint_config = response["endpointConfiguration"]
+        self.assertEqual(endpoint_config["types"], ["REGIONAL"])
+
+    def test_implicit_api_settings(self):
+        self.create_and_verify_stack("combination/implicit_api_with_settings")
+
+        rest_api_id = self.get_physical_id_by_type("AWS::ApiGateway::RestApi")
+        apigw_client = self.client_provider.api_client
+
+        response = apigw_client.get_stage(restApiId=rest_api_id, stageName="Prod")
+
+        wildcard_path = "*/*"
+
+        method_settings = response["methodSettings"]
+        self.assertTrue(wildcard_path in method_settings, "MethodSettings for the wildcard path must be present")
+
+        wildcard_path_setting = method_settings[wildcard_path]
+
+        self.assertTrue(wildcard_path_setting["metricsEnabled"], "Metrics must be enabled")
+        self.assertTrue(wildcard_path_setting["dataTraceEnabled"], "DataTrace must be enabled")
+        self.assertEqual(wildcard_path_setting["loggingLevel"], "INFO", "LoggingLevel must be INFO")
+
+        response = apigw_client.get_rest_api(restApiId=rest_api_id)
+        endpoint_config = response["endpointConfiguration"]
+        self.assertEqual(endpoint_config["types"], ["REGIONAL"])
+        self.assertEqual(set(response["binaryMediaTypes"]), {"image/jpg", "image/png"})
+
+    def verify_binary_media_request(self, url, expected_status_code):
+        headers = {"accept": "image/png"}
+        response = requests.get(url, headers=headers)
+
+        status = response.status_code
+        expected_file_path = str(Path(self.code_dir, "AWS_logo_RGB.png"))
+
+        with open(expected_file_path, mode="rb") as file:
+            expected_file_content = file.read()
+        expected_hash = hashlib.sha1(expected_file_content).hexdigest()
+
+        if 200 <= status <= 299:
+            actual_hash = hashlib.sha1(response.content).hexdigest()
+            self.assertEqual(expected_hash, actual_hash)
+
+        self.assertEqual(status, expected_status_code, " must return HTTP " + str(expected_status_code))
+
+
+def get_resource_by_path(resources, path):
+    for resource in resources:
+        if resource["path"] == path:
+            return resource
+    return None