File size: 9,772 Bytes
26e6f31 | 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 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 | """
Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: MIT-0
"""
from __future__ import annotations
import fnmatch
import json
import os
import pathlib
from typing import Any, List
from unittest import TestCase
import pytest
import regex as re
import cfnlint
from cfnlint.helpers import REGIONS, ensure_list, load_plugins, load_resource
from cfnlint.jsonschema import StandardValidator, ValidationError
from cfnlint.schema.resolver import RefResolutionError, RefResolver
@pytest.mark.data
class TestSchemaFiles(TestCase):
"""Test schema files"""
_found_keywords: List[str] = [
"*",
"Conditions",
"Description",
"Mappings",
"Metadata",
"Metadata/AWS::CloudFormation::Interface",
"Metadata/cfn-lint",
"Outputs",
"Outputs/*",
"Outputs/*/Condition",
"Outputs/*/Export/Name",
"Outputs/*/Value",
"Parameters",
"Parameters/*",
"Resources",
"Resources/*",
"Resources/*/Condition",
"Resources/*/CreationPolicy",
"Resources/*/DeletionPolicy",
"Resources/*/DependsOn",
"Resources/*/DependsOn/*",
"Resources/*/Metadata",
"Resources/*/Metadata/AWS::CloudFormation::Init",
"Resources/*/Type",
"Resources/*/UpdatePolicy",
"Resources/*/UpdateReplacePolicy",
"Rules",
"Rules/*/Assertions/*/Assert",
"Rules/*/RuleCondition",
"Transform",
]
def setUp(self) -> None:
schema_path = os.path.join(os.path.dirname(cfnlint.__file__), "data", "schemas")
self.paths = {
"extensions": os.path.join(schema_path, "extensions"),
"providers": os.path.join(schema_path, "providers"),
"other": os.path.join(schema_path, "other"),
"fixtures": os.path.join(
os.path.dirname(__file__),
"..",
"fixtures",
"schemas",
"providers",
),
}
filename = os.path.join(
self.paths["fixtures"], "..", "json_schema", "draft7.json"
)
with open(filename, "r") as fh:
d = json.load(fh)
self.schema_draft7 = d
super().setUp()
def get_files(self, dir):
for dirpath, _, filenames in os.walk(dir):
for filename in fnmatch.filter(filenames, "*.json"):
yield dirpath, filename
def pattern(self, validator, patrn, instance, schema):
try:
re.compile(patrn)
except Exception:
yield ValidationError(f"Pattern doesn't compile: {patrn}")
def validate_basic_schema_details(
self, schema_resolver: RefResolver, filepath: str
):
"""
Validate that readOnly, writeOnly, etc are valid
"""
sections = [
"readOnlyProperties",
"writeOnlyProperties",
"conditionalCreateOnlyProperties",
"nonPublicProperties",
"nonPublicDefinitions",
"createOnlyProperties",
"deprecatedProperties",
"primaryIdentifier",
]
for section in sections:
for prop in schema_resolver.referrer.get(section, []):
try:
self.assertIsNotNone(schema_resolver.resolve_cfn_pointer(prop))
except RefResolutionError:
self.fail(f"Can't find prop {prop} for {section} in {filepath}")
def _build_keywords(self, obj: Any, schema_resolver: RefResolver, refs: list[str]):
if not isinstance(obj, dict):
yield []
return
if "$ref" in obj:
ref = obj["$ref"]
if ref in refs:
yield []
return
_, resolved_schema = schema_resolver.resolve(ref)
yield from self._build_keywords(
resolved_schema, schema_resolver, refs + [ref]
)
if "type" in obj:
if "object" in ensure_list(obj["type"]):
if "properties" in obj:
for k, v in obj["properties"].items():
for item in self._build_keywords(v, schema_resolver, refs):
yield [k] + item
if "array" in ensure_list(obj["type"]):
if "items" in obj:
for item in self._build_keywords(
obj["items"], schema_resolver, refs
):
yield ["*"] + item
yield []
def build_keywords(self, schema_resolver):
self._found_keywords.append(
"/".join(["Resources", schema_resolver.referrer["typeName"], "Properties"])
)
for k, v in schema_resolver.referrer.get("properties").items():
for item in self._build_keywords(v, schema_resolver, []):
self._found_keywords.append(
"/".join(
[
"Resources",
schema_resolver.referrer["typeName"],
"Properties",
k,
]
+ item
)
)
def test_data_module_specs(self):
"""Test data file formats"""
draft7_schema = load_resource(
"cfnlint.data.schemas.other.draft7", "schema.json"
)
store = {"http://json-schema.org/draft-07/schema": draft7_schema}
dir = self.paths["fixtures"]
for dirpath, filename in self.get_files(dir):
with open(os.path.join(dirpath, filename), "r", encoding="utf8") as fh:
store[filename] = json.load(fh)
resolver = RefResolver.from_schema(
store["provider.definition.schema.v1.json"], store=store
)
validator = (
StandardValidator({})
.extend(
validators={
"cfnLint": self.cfn_lint,
"pattern": self.pattern,
},
)(schema=store["provider.definition.schema.v1.json"])
.evolve(resolver=resolver)
)
for region in REGIONS:
dir = os.path.join(
self.paths["providers"],
region.replace("-", "_"),
)
for dirpath, filename in self.get_files(dir):
with open(os.path.join(dirpath, filename), "r", encoding="utf8") as fh:
d = json.load(fh)
# not allowed but true with this resource
if filename == "aws-cloudformation-customresource.json":
d["additionalProperties"] = False
if filename == "module.json":
continue
errs = list(validator.iter_errors(d))
self.assertListEqual(
errs, [], f"Error with {dirpath}/{filename}: {errs}"
)
schema_resolver = RefResolver(d)
self.validate_basic_schema_details(
schema_resolver, f"{dirpath}/{filename}"
)
if region == "us-east-1":
self.build_keywords(schema_resolver)
def cfn_lint(self, validator, _, keywords, schema):
keywords = ensure_list(keywords)
self._found_keywords.extend(keywords)
def test_other_specs(self):
"""Test data file formats"""
draft7_schema = load_resource(
"cfnlint.data.schemas.other.draft7", "schema.json"
)
store = {"http://json-schema.org/draft-07/schema": draft7_schema}
dir = self.paths["fixtures"]
for dirpath, filename in self.get_files(dir):
with open(os.path.join(dirpath, filename), "r", encoding="utf8") as fh:
store[filename] = json.load(fh)
resolver = RefResolver.from_schema(
store["http://json-schema.org/draft-07/schema"], store=store
)
validator = (
StandardValidator({})
.extend(
validators={
"cfnLint": self.cfn_lint,
"pattern": self.pattern,
},
)(schema=store["http://json-schema.org/draft-07/schema"])
.evolve(resolver=resolver)
)
for dir_name in ["extensions", "other"]:
dir = self.paths[dir_name]
for dirpath, filename in self.get_files(dir):
with open(os.path.join(dirpath, filename), "r", encoding="utf8") as fh:
d = json.load(fh)
errs = list(validator.iter_errors(d))
self.assertListEqual(
errs, [], f"Error with {dirpath}/{filename}: {errs}"
)
schema_resolver = RefResolver(d)
self.validate_basic_schema_details(
schema_resolver, f"{dirpath}/{filename}"
)
def test_x_keywords(self):
root_dir = pathlib.Path(__file__).parent.parent.parent / "src/cfnlint/rules"
rules = load_plugins(
str(root_dir),
"CfnLintKeyword",
"cfnlint.rules.jsonschema.CfnLintKeyword",
)
rules.extend(
load_plugins(
str(root_dir),
"CfnLintJsonSchema",
"cfnlint.rules.jsonschema.CfnLintJsonSchema",
)
)
for rule in rules:
for keyword in rule.keywords:
self.assertIn(keyword, self._found_keywords, f"{keyword} not found")
|