File size: 2,014 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 | """
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: MIT-0
"""
from __future__ import annotations
from typing import List
from cfnlint.config import ConfigMixIn, ManualArgs
from cfnlint.decode.decode import decode_str
from cfnlint.helpers import REGION_PRIMARY, REGIONS
from cfnlint.rules import Match, RulesCollection
from cfnlint.runner import Runner, TemplateRunner
Matches = List[Match]
def lint(
s: str,
rules: RulesCollection | None = None,
regions: list[str] | None = None,
config: ManualArgs | None = None,
) -> list[Match]:
"""Validate a string template using the specified rules and regions.
Parameters
----------
s : str
the template string
rules : RulesCollection
The rules to run against s
regions : list[str]
The regions to test against s
Returns
-------
list
a list of errors if any were found, else an empty list
"""
template, errors = decode_str(s)
if errors:
return errors
if template is None:
return []
if not regions:
regions = [REGION_PRIMARY]
if not config:
config_mixin = ConfigMixIn(
regions=regions,
)
else:
config_mixin = ConfigMixIn(**config)
if isinstance(rules, RulesCollection):
template_runner = TemplateRunner(None, template, config_mixin, rules) # type: ignore # noqa: E501
return list(template_runner.run())
runner = Runner(config_mixin)
return list(runner.validate_template(None, template))
def lint_all(s: str) -> list[Match]:
"""Validate a string template against all regions and rules.
Parameters
----------
s : str
the template string
Returns
-------
list
a list of errors if any were found, else an empty list
"""
return lint(
s=s,
config=ManualArgs(
include_checks=["I"], include_experimental=True, regions=REGIONS
),
)
|