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
|
"""Rule definition for JSON Schema Validations."""
from __future__ import annotations
import logging
import sys
from typing import Any
from ansiblelint.errors import MatchError
from ansiblelint.file_utils import Lintable
from ansiblelint.rules import AnsibleLintRule
from ansiblelint.schemas import JSON_SCHEMAS, validate_file_schema
_logger = logging.getLogger(__name__)
DESCRIPTION_MD = """ Returned errors will not include exact line numbers, but they will mention
the schema name being used as a tag, like ``schema[playbook]``,
``schema[tasks]``.
This rule is not skippable and stops further processing of the file.
If incorrect schema was picked, you might want to either:
* move the file to standard location, so its file is detected correctly.
* use ``kinds:`` option in linter config to help it pick correct file type.
"""
pre_checks = {
"task": {
"with_flattened": {
"msg": "with_flattened was moved to with_community.general.flattened in 2.10",
"tag": "moves",
},
"with_filetree": {
"msg": "with_filetree was moved to with_community.general.flattened in 2.10",
"tag": "moves",
},
"with_cartesian": {
"msg": "with_cartesian was moved to with_community.general.flattened in 2.10",
"tag": "moves",
},
}
}
class ValidateSchemaRule(AnsibleLintRule):
"""Perform JSON Schema Validation for known lintable kinds."""
description = DESCRIPTION_MD
id = "schema"
severity = "VERY_HIGH"
tags = ["core"]
version_added = "v6.1.0"
def matchtask(
self, task: dict[str, Any], file: Lintable | None = None
) -> bool | str | MatchError | list[MatchError]:
result = []
for key in pre_checks["task"]:
if key in task:
msg = pre_checks["task"][key]["msg"]
tag = pre_checks["task"][key]["tag"]
result.append(
MatchError(
message=msg,
filename=file,
rule=ValidateSchemaRule(),
details=ValidateSchemaRule.description,
tag=f"schema[{tag}]",
)
)
return result
def matchyaml(self, file: Lintable) -> list[MatchError]:
"""Return JSON validation errors found as a list of MatchError(s)."""
result = []
if file.kind not in JSON_SCHEMAS:
return []
errors = validate_file_schema(file)
if errors:
if errors[0].startswith("Failed to load YAML file"):
_logger.debug(
"Ignored failure to load %s for schema validation, as !vault may cause it."
)
return []
result.append(
MatchError(
message=errors[0],
filename=file,
rule=ValidateSchemaRule(),
details=ValidateSchemaRule.description,
tag=f"schema[{file.kind}]",
)
)
return result
# testing code to be loaded only with pytest or when executed the rule file
if "pytest" in sys.modules:
import pytest
# pylint: disable=ungrouped-imports
from ansiblelint.config import options
from ansiblelint.rules import RulesCollection
from ansiblelint.runner import Runner
@pytest.mark.parametrize(
("file", "expected_kind", "expected"),
(
(
"examples/collection/galaxy.yml",
"galaxy",
["'GPL' is not one of"],
),
(
"examples/roles/invalid_requirements_schema/meta/requirements.yml",
"requirements",
["{'foo': 'bar'} is not valid under any of the given schemas"],
),
(
"examples/roles/invalid_meta_schema/meta/main.yml",
"meta",
["False is not of type 'string'"],
),
(
"examples/playbooks/vars/invalid_vars_schema.yml",
"vars",
["'123' does not match any of the regexes"],
),
(
"examples/execution-environment.yml",
"execution-environment",
[],
),
(
"examples/ee_broken/execution-environment.yml",
"execution-environment",
["Additional properties are not allowed ('foo' was unexpected)"],
),
("examples/meta/runtime.yml", "meta-runtime", []),
(
"examples/broken_collection_meta_runtime/meta/runtime.yml",
"meta-runtime",
["Additional properties are not allowed ('foo' was unexpected)"],
),
(
"examples/inventory/production.yml",
"inventory",
[],
),
(
"examples/inventory/broken_dev_inventory.yml",
"inventory",
["Additional properties are not allowed ('foo' was unexpected)"],
),
(
".ansible-lint",
"ansible-lint-config",
[],
),
(
"examples/.config/ansible-lint.yml",
"ansible-lint-config",
[],
),
(
"examples/broken/.ansible-lint",
"ansible-lint-config",
["Additional properties are not allowed ('foo' was unexpected)"],
),
(
"examples/ansible-navigator.yml",
"ansible-navigator-config",
[],
),
(
"examples/broken/ansible-navigator.yml",
"ansible-navigator-config",
["Additional properties are not allowed ('ansible' was unexpected)"],
),
(
"examples/roles/hello/meta/argument_specs.yml",
"arg_specs",
[],
),
(
"examples/roles/broken_argument_specs/meta/argument_specs.yml",
"arg_specs",
["Additional properties are not allowed ('foo' was unexpected)"],
),
),
ids=(
# "playbook-fail",
"galaxy",
"requirements",
"meta",
"vars",
"ee",
"ee-broken",
"meta-runtime",
"meta-runtime-broken",
"inventory",
"inventory-broken",
"lint-config",
"lint-config2",
"lint-config-broken",
"navigator",
"navigator-broken",
"argspecs",
"argspecs-broken",
),
)
def test_schema(file: str, expected_kind: str, expected: list[str]) -> None:
"""Validate parsing of ansible output."""
lintable = Lintable(file)
assert lintable.kind == expected_kind
rules = RulesCollection(options=options)
rules.register(ValidateSchemaRule())
results = Runner(lintable, rules=rules).run()
assert len(results) == len(expected), results
for idx, result in enumerate(results):
assert result.filename.endswith(file)
assert expected[idx] in result.message
assert result.tag == f"schema[{expected_kind}]"
@pytest.mark.parametrize(
("file", "expected_kind", "expected_tag", "count"),
(
pytest.param(
"examples/playbooks/rule-syntax-moves.yml",
"playbook",
"schema[moves]",
3,
id="playbook",
),
),
)
def test_schema_moves(
file: str, expected_kind: str, expected_tag: str, count: int
) -> None:
"""Validate ability to detect schema[moves]."""
lintable = Lintable(file)
assert lintable.kind == expected_kind
rules = RulesCollection(options=options)
rules.register(ValidateSchemaRule())
results = Runner(lintable, rules=rules).run()
assert len(results) == count, results
for result in results:
assert result.filename.endswith(file)
assert result.tag == expected_tag
|
