Validate default template.json (aws#2855)

Issue: aws#2355
Added integration tests for `validate` command

Co-authored-by: Slava Senchenko <sencslav@amazon.com>
Co-authored-by: _sam <3804518+aahung@users.noreply.github.com>

samcli/commands/_utils/options.py

@@ -14,7 +14,7 @@
 from samcli.commands._utils.custom_options.option_nargs import OptionNargs
 from samcli.commands._utils.template import get_template_artifacts_format
 
-_TEMPLATE_OPTION_DEFAULT_VALUE = "template.[yaml|yml]"
+_TEMPLATE_OPTION_DEFAULT_VALUE = "template.[yaml|yml|json]"
 DEFAULT_STACK_NAME = "sam-app"
 
 LOG = logging.getLogger(__name__)
@@ -35,15 +35,15 @@ def get_or_default_template_file_name(ctx, param, provided_value, include_build)
 
     original_template_path = os.path.abspath(provided_value)
 
-    search_paths = ["template.yaml", "template.yml"]
+    search_paths = ["template.yaml", "template.yml", "template.json"]
 
     if include_build:
         search_paths.insert(0, os.path.join(".aws-sam", "build", "template.yaml"))
 
     if provided_value == _TEMPLATE_OPTION_DEFAULT_VALUE:
         # "--template" is an alias of "--template-file", however, only the first option name "--template-file" in
         # ctx.default_map is used as default value of provided value. Here we add "--template"'s value as second
-        # default value in this option, so that the command line paramerters from config file can load it.
+        # default value in this option, so that the command line parameters from config file can load it.
         if ctx and ctx.default_map.get("template", None):
             provided_value = ctx.default_map.get("template")
         else:

tests/integration/testdata/validate/default_json/template.json

@@ -0,0 +1,15 @@
+{
+  "AWSTemplateFormatVersion": "2010-09-09",
+  "Transform": "AWS::Serverless-2016-10-31",
+
+  "Resources": {
+    "HelloWorldFunction": {
+      "Type": "AWS::Serverless::Function",
+      "Properties": {
+        "CodeUri": "hello-world/",
+        "Handler": "app.lambdaHandler",
+        "Runtime": "nodejs14.x"
+      }
+    }
+  }
+}

tests/integration/testdata/validate/default_yaml/template.yaml

@@ -0,0 +1,10 @@
+AWSTemplateFormatVersion: '2010-09-09'
+Transform: AWS::Serverless-2016-10-31
+
+Resources:
+  HelloWorldFunction:
+    Type: AWS::Serverless::Function
+    Properties:
+      CodeUri: HelloWorldFunction
+      Handler: app.lambdaHandler
+      Runtime: nodejs14.x

tests/integration/testdata/validate/multiple_files/template.json

@@ -0,0 +1,15 @@
+{
+  "AWSTemplateFormatVersion": "2010-09-09",
+  "Transform": "AWS::Serverless-2016-10-31",
+
+  "Resources": {
+    "HelloWorldFunction": {
+      "Type": "AWS::Serverless::Function",
+      "Properties": {
+        "CodeUri": "hello-world/",
+        "Handler": "app.lambdaHandler",
+        "Runtime": "nodejs14.x"
+      }
+    }
+  }
+}

tests/integration/testdata/validate/multiple_files/template.yaml

@@ -0,0 +1,10 @@
+AWSTemplateFormatVersion: '2010-09-09'
+Transform: AWS::Serverless-2016-10-31
+
+Resources:
+  HelloWorldFunction:
+    Type: AWS::Serverless::Function
+    Properties:
+      CodeUri: HelloWorldFunction
+      Handler: app.lambdaHandler
+      Runtime: nodejs14.x

tests/integration/testdata/validate/with_build/.aws-sam/build/template.yaml

@@ -0,0 +1,10 @@
+AWSTemplateFormatVersion: '2010-09-09'
+Transform: AWS::Serverless-2016-10-31
+
+Resources:
+  HelloWorldFunction:
+    Type: AWS::Serverless::Function
+    Properties:
+      CodeUri: HelloWorldFunction
+      Handler: app.lambdaHandler
+      Runtime: nodejs14.x

tests/integration/testdata/validate/with_build/template.json

@@ -0,0 +1,15 @@
+{
+  "AWSTemplateFormatVersion": "2010-09-09",
+  "Transform": "AWS::Serverless-2016-10-31",
+
+  "Resources": {
+    "HelloWorldFunction": {
+      "Type": "AWS::Serverless::Function",
+      "Properties": {
+        "CodeUri": "hello-world/",
+        "Handler": "app.lambdaHandler",
+        "Runtime": "nodejs14.x"
+      }
+    }
+  }
+}

tests/integration/validate/test_validate_command.py

@@ -0,0 +1,75 @@
+"""
+Integration tests for sam validate
+"""
+
+import os
+import re
+from enum import Enum, auto
+from pathlib import Path
+from typing import List, Optional
+from unittest import TestCase
+from unittest.case import skipIf
+
+from parameterized import parameterized
+from tests.testing_utils import RUN_BY_CANARY, RUNNING_ON_CI, RUNNING_TEST_FOR_MASTER_ON_CI, run_command
+
+# Validate tests require credentials and CI/CD will only add credentials to the env if the PR is from the same repo.
+# This is to restrict package tests to run outside of CI/CD, when the branch is not master or tests are not run by Canary
+SKIP_VALIDATE_TESTS = RUNNING_ON_CI and RUNNING_TEST_FOR_MASTER_ON_CI and not RUN_BY_CANARY
+
+
+class TemplateFileTypes(Enum):
+    JSON = auto()
+    YAML = auto()
+
+
+@skipIf(SKIP_VALIDATE_TESTS, "Skip validate tests in CI/CD only")
+class TestValidate(TestCase):
+    @classmethod
+    def setUpClass(cls):
+        cls.patterns = {
+            TemplateFileTypes.JSON: re.compile(r"^/.+/template[.]json is a valid SAM Template$"),
+            TemplateFileTypes.YAML: re.compile(r"^/.+/template[.]yaml is a valid SAM Template$"),
+        }
+
+    @staticmethod
+    def base_command() -> str:
+        return "samdev" if os.getenv("SAM_CLI_DEV") else "sam"
+
+    def command_list(
+        self,
+        template_file: Optional[Path] = None,
+        profile: Optional[str] = None,
+        region: Optional[str] = None,
+        config_file: Optional[Path] = None,
+    ) -> List[str]:
+        command_list = [self.base_command(), "validate"]
+        if template_file:
+            command_list += ["--template-file", str(template_file)]
+        if profile:
+            command_list += ["--profile", profile]
+        if region:
+            command_list += ["--region", region]
+        if config_file:
+            command_list += ["--config_file", str(config_file)]
+        return command_list
+
+    @parameterized.expand(
+        [
+            ("default_yaml", TemplateFileTypes.YAML),  # project with template.yaml
+            ("default_json", TemplateFileTypes.JSON),  # project with template.json
+            ("multiple_files", TemplateFileTypes.YAML),  # project with both template.yaml and template.json
+            (
+                "with_build",
+                TemplateFileTypes.JSON,
+            ),  # project with template.json and standard build directory .aws-sam/build/template.yaml
+        ]
+    )
+    def test_default_template_file_choice(self, relative_folder: str, expected_file: TemplateFileTypes):
+        test_data_path = Path(__file__).resolve().parents[2] / "integration" / "testdata" / "validate"
+        process_dir = test_data_path / relative_folder
+        command_result = run_command(self.command_list(), cwd=str(process_dir))
+        pattern = self.patterns[expected_file]  # type: ignore
+        output = command_result.stdout.decode("utf-8")
+        self.assertEqual(command_result.process.returncode, 0)
+        self.assertRegex(output, pattern)

tests/unit/commands/_utils/test_options.py

@@ -53,7 +53,18 @@ def test_must_return_yml_extension(self, os_mock):
     def test_must_return_yaml_extension(self, os_mock):
         expected = "template.yaml"
 
-        os_mock.path.exists.return_value = True
+        os_mock.path.exists.side_effect = lambda file_name: file_name == expected
+        os_mock.path.abspath.return_value = "absPath"
+
+        result = get_or_default_template_file_name(None, None, _TEMPLATE_OPTION_DEFAULT_VALUE, include_build=False)
+        self.assertEqual(result, "absPath")
+        os_mock.path.abspath.assert_called_with(expected)
+
+    @patch("samcli.commands._utils.options.os")
+    def test_must_return_json_extension(self, os_mock):
+        expected = "template.json"
+
+        os_mock.path.exists.side_effect = lambda file_name: file_name == expected
         os_mock.path.abspath.return_value = "absPath"
 
         result = get_or_default_template_file_name(None, None, _TEMPLATE_OPTION_DEFAULT_VALUE, include_build=False)