File size: 6,882 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 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 | """
Copyright (c) 2013 Julian Berman
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
SPDX-License-Identifier: MIT
"""
# Code is taken from jsonschema package and adapted CloudFormation use
# https://github.com/python-jsonschema/jsonschema
from __future__ import annotations
from collections import deque
from collections.abc import Mapping
from typing import TYPE_CHECKING, Any, ClassVar, Protocol, Type, runtime_checkable
from cfnlint.jsonschema._filter import FunctionFilter
if TYPE_CHECKING:
from cfnlint.context import Context
from cfnlint.jsonschema._format import FormatChecker
from cfnlint.jsonschema._typing import ResolutionResult, V, ValidationResult
from cfnlint.schema.resolver import RefResolver
from cfnlint.template import Template
@runtime_checkable
class Validator(Protocol):
"""
The protocol to which all validator classes adhere.
Arguments:
schema:
The schema that the validator object will validate with.
It is assumed to be valid, and providing
an invalid schema can lead to undefined behavior.
"""
#: A mapping of validation keywords (`str`\s) to functions that
#: validate the keyword with that name. For more information see
#: `creating-validators`.
validators: ClassVar[Mapping]
format_checker: ClassVar[FormatChecker]
#: The schema that will be used to validate instances
schema: Mapping | bool
resolver: RefResolver
cfn: Template
context: Context
function_filter: FunctionFilter
cfn_path: deque[str]
def __init__(
self,
schema: Mapping | bool,
) -> None: ...
@classmethod
def check_schema(cls, schema: Mapping | bool) -> None:
"""
Validate the given schema against the validator's `META_SCHEMA`.
Raises:
`cfnlint.jsonschema.exceptions.SchemaError`:
if the schema is invalid
"""
def is_type(self, instance: Any, type: str) -> bool:
"""
Check if the instance is of the given (JSON Schema) type.
Arguments:
instance:
the value to check
type:
the name of a known (JSON Schema) type
Returns:
whether the instance is of the given type
Raises:
`cfnlint.jsonschema.exceptions.UnknownType`:
if ``type`` is not a known type
"""
def is_valid(self, instance: Any) -> bool:
"""
Check if the instance is valid under the current `schema`.
Returns:
whether the instance is valid or not
>>> schema = {"maxItems" : 2}
>>> CfnTemplateValidator(schema).is_valid([2, 3, 4])
False
"""
def descend(
self,
instance: Any,
schema: Any,
path: str | int | None = None,
schema_path: str | int | None = None,
property_path: str | int | None = None,
) -> ValidationResult:
"""
Descend into the schema validating the schema for True/False.
It will validate the schema against the instance and append the
path and schema_path as needed.
>>> schema = {
... "type" : "array",
... "items" : {"enum" : [1, 2, 3]},
... "maxItems" : 2,
... }
>>> v = CfnTemplateValidator(schema)
>>> for error in v.descend([2, 3, 4], schema, path=deque(["a"])):
... print(error.message)
"""
def iter_errors(self, instance: Any) -> ValidationResult:
r"""
Lazily yield each of the validation errors in the given instance.
>>> schema = {
... "type" : "array",
... "items" : {"enum" : [1, 2, 3]},
... "maxItems" : 2,
... }
>>> v = CfnTemplateValidator(schema)
>>> for error in sorted(v.iter_errors([2, 3, 4]), key=str):
... print(error.message)
4 is not one of [1, 2, 3]
[2, 3, 4] is too long
.. deprecated:: v4.0.0
Calling this function with a second schema argument is deprecated.
Use `Validator.evolve` instead.
"""
def validate(self, instance: Any) -> None:
"""
Check if the instance is valid under the current `schema`.
Raises:
`jsonschema.exceptions.ValidationError`:
if the instance is invalid
>>> schema = {"maxItems" : 2}
>>> CfnTemplateValidator(schema).validate([2, 3, 4])
Traceback (most recent call last):
...
ValidationError: [2, 3, 4] is too long
"""
def resolve_value(self, instance: Any) -> ResolutionResult:
"""
Resolve the given instance, yielding each of its values.
"""
def evolve(self, **kwargs) -> Validator:
"""
Create a new validator like this one, but with given changes.
Preserves all other attributes, so can be used to e.g. create a
validator with a different schema but with the same :kw:`$ref`
resolution behavior.
>>> validator = CfnTemplateValidator({})
>>> validator.evolve(schema={"type": "number"})
CfnTemplateValidator(schema={'type': 'number'}, format_checker=None)
The returned object satisfies the validator protocol, but may not
be of the same concrete class! In particular this occurs
when a :kw:`$ref` occurs to a schema with a different
:kw:`$schema` than this one (i.e. for a different draft).
>>> validator.evolve(
... schema={"$schema": Draft7Validator.META_SCHEMA["$id"]}
... )
Draft7Validator(schema=..., format_checker=None)
"""
def extend(
self,
validators: dict[str, V] | None,
function_filter: FunctionFilter | None = None,
context: Context | None = None,
) -> Type[Validator]:
"""
Extends the validator with a new set of validators to replace VALIDATORS.
This function recall create with the a merged list of validators from the
current instance merged with the parameters.
>>> validator = CfnTemplateValidator({})
>>> validator.extend(validators={"type": type})
CfnTemplateValidator(schema={'type': 'number'}, format_checker=None)
"""
|