File size: 4,410 Bytes
b40c49c | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 | """
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: MIT-0
"""
import json
import subprocess
import unittest
from copy import deepcopy
from io import StringIO
from pathlib import Path
from typing import Any, Dict, List
from unittest.mock import patch
from cfnlint.config import configure_logging
from cfnlint.decode import cfn_yaml
from cfnlint.formatters import JsonFormatter
from cfnlint.runner import Runner
class BaseCliTestCase(unittest.TestCase):
"""Used for Testing CLI"""
scenarios: List[Dict[str, Any]] = []
def setUp(self):
"""Common Settings"""
self.maxDiff = None
def run_scenarios(self, extra_params=None):
"""Success test"""
extra_params = extra_params or []
for scenario in self.scenarios:
filename = scenario.get("filename")
results_filename = scenario.get("results_filename")
expected_results = scenario.get("results", [])
exit_code = scenario.get("exit_code")
if results_filename and not expected_results:
with open(results_filename, encoding="utf-8") as json_data:
expected_results = json.load(json_data)
for result in expected_results:
result["Filename"] = str(Path(result.get("Filename")))
try:
result = subprocess.check_output(
["cfn-lint"] + extra_params + ["--format", "json", "--", filename]
)
self.assertEqual(
0,
exit_code,
"Expected {} exit code, got {} on {}".format(
exit_code, 0, filename
),
)
if isinstance(result, bytes):
result = result.decode("utf8")
matches = json.loads(result)
self.assertCountEqual(
expected_results,
matches,
"Expected {} failures, got {} on {}".format(
len(expected_results), len(matches), filename
),
)
except subprocess.CalledProcessError as error:
self.assertEqual(
error.returncode,
exit_code,
"Expected {} exit code, got {} on {}".format(
exit_code, error.returncode, filename
),
)
if isinstance(error.output, bytes):
error.output = error.output.decode("utf8")
matches = json.loads(error.output)
self.assertCountEqual(
expected_results,
matches,
"Expected {} failures, got {} on {}".format(
len(expected_results), len(matches), filename
),
)
def run_module_integration_scenarios(self, config):
"""Test using cfnlint as a module integrated into another package"""
configure_logging(None, False)
for scenario in self.scenarios:
filename = scenario.get("filename")
results_filename = scenario.get("results_filename")
expected_results = scenario.get("results", [])
if results_filename and not expected_results:
with open(results_filename, encoding="utf-8") as json_data:
expected_results = json.load(json_data)
for result in expected_results:
result["Filename"] = str(Path(result.get("Filename")))
# template = cfn_yaml.load(filename)
scenario_config = deepcopy(config)
scenario_config.cli_args.template_alt = [filename]
scenario_config.cli_args.format = "json"
runner = Runner(scenario_config)
with patch("sys.exit") as exit:
with patch("sys.stdout", new=StringIO()) as out:
runner.cli()
exit.assert_called_once_with(scenario.get("exit_code", 0))
output = json.loads(out.getvalue())
self.assertEqual(
expected_results,
output,
f"Test for {filename!r} got results: {output!r}",
)
|