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
|
"""Validate ansiblelint.skip_utils."""
from __future__ import annotations
from pathlib import Path
from typing import TYPE_CHECKING, Any
import pytest
from ansiblelint.constants import SKIPPED_RULES_KEY
from ansiblelint.file_utils import Lintable
from ansiblelint.runner import Runner
from ansiblelint.skip_utils import (
append_skipped_rules,
get_rule_skips_from_line,
is_nested_task,
)
if TYPE_CHECKING:
from ansible.parsing.yaml.objects import AnsibleBaseYAMLObject
from ansiblelint.rules import RulesCollection
from ansiblelint.testing import RunFromText
PLAYBOOK_WITH_NOQA = """\
---
- name: Fixture
hosts: all
vars:
SOME_VAR_NOQA: "Foo" # noqa: var-naming
SOME_VAR: "Bar"
tasks:
- name: "Set the SOME_OTHER_VAR"
ansible.builtin.set_fact:
SOME_OTHER_VAR_NOQA: "Baz" # noqa: var-naming
SOME_OTHER_VAR: "Bat"
"""
@pytest.mark.parametrize(
("line", "expected"),
(
("foo # noqa: bar", "bar"),
("foo # noqa bar", "bar"),
),
)
def test_get_rule_skips_from_line(line: str, expected: str) -> None:
"""Validate get_rule_skips_from_line."""
v = get_rule_skips_from_line(line, lintable=Lintable(""))
assert v == [expected]
def test_playbook_noqa(default_text_runner: RunFromText) -> None:
"""Check that noqa is properly taken into account on vars and tasks."""
results = default_text_runner.run_playbook(PLAYBOOK_WITH_NOQA)
# Should raise error at "SOME_VAR".
assert len(results) == 1
def test_playbook_noqa2(default_text_runner: RunFromText) -> None:
"""Check that noqa is properly taken into account on vars and tasks."""
results = default_text_runner.run_playbook(PLAYBOOK_WITH_NOQA, "test")
# Should raise error at "SOME_VAR".
assert len(results) == 1
@pytest.mark.parametrize(
("lintable", "yaml", "expected_form"),
(
pytest.param(
Lintable("examples/playbooks/noqa.yml", kind="playbook"),
[
{
"hosts": "localhost",
"tasks": [
{
"name": "This would typically fire latest[git] and partial-become",
"become_user": "alice",
"git": "src=/path/to/git/repo dest=checkout",
"__line__": 4,
"__file__": Path("examples/playbooks/noqa.yml"),
},
],
"__line__": 2,
"__file__": Path("examples/playbooks/noqa.yml"),
},
],
[
{
"hosts": "localhost",
"tasks": [
{
"name": "This would typically fire latest[git] and partial-become",
"become_user": "alice",
"git": "src=/path/to/git/repo dest=checkout",
"__line__": 4,
"__file__": Path("examples/playbooks/noqa.yml"),
SKIPPED_RULES_KEY: ["latest[git]", "partial-become"],
},
],
"__line__": 2,
"__file__": Path("examples/playbooks/noqa.yml"),
},
],
),
pytest.param(
Lintable("examples/playbooks/noqa-nested.yml", kind="playbook"),
[
{
"hosts": "localhost",
"tasks": [
{
"name": "Example of multi-level block",
"block": [
{
"name": "2nd level",
"block": [
{
"ansible.builtin.debug": {
"msg": "Test unnamed task in block",
"__line__": 9,
"__file__": Path(
"examples/playbooks/noqa-nested.yml",
),
},
"__line__": 8,
"__file__": Path(
"examples/playbooks/noqa-nested.yml",
),
},
],
"__line__": 6,
"__file__": Path(
"examples/playbooks/noqa-nested.yml",
),
},
],
"__line__": 4,
"__file__": Path("examples/playbooks/noqa-nested.yml"),
},
],
"__line__": 2,
"__file__": Path("examples/playbooks/noqa-nested.yml"),
},
],
[
{
"hosts": "localhost",
"tasks": [
{
"name": "Example of multi-level block",
"block": [
{
"name": "2nd level",
"block": [
{
"ansible.builtin.debug": {
"msg": "Test unnamed task in block",
"__line__": 9,
"__file__": Path(
"examples/playbooks/noqa-nested.yml",
),
},
"__line__": 8,
"__file__": Path(
"examples/playbooks/noqa-nested.yml",
),
SKIPPED_RULES_KEY: ["name[missing]"],
},
],
"__line__": 6,
"__file__": Path(
"examples/playbooks/noqa-nested.yml",
),
SKIPPED_RULES_KEY: ["name[missing]"],
},
],
"__line__": 4,
"__file__": Path("examples/playbooks/noqa-nested.yml"),
SKIPPED_RULES_KEY: ["name[missing]"],
},
],
"__line__": 2,
"__file__": Path("examples/playbooks/noqa-nested.yml"),
},
],
),
),
)
def test_append_skipped_rules(
lintable: Lintable,
yaml: AnsibleBaseYAMLObject,
expected_form: AnsibleBaseYAMLObject,
) -> None:
"""Check that it appends skipped_rules properly."""
assert append_skipped_rules(yaml, lintable) == expected_form
@pytest.mark.parametrize(
("task", "expected"),
(
pytest.param(
{
"name": "ensure apache is at the latest version",
"yum": {"name": "httpd", "state": "latest"},
},
False,
),
pytest.param(
{
"name": "Attempt and graceful roll back",
"block": [
{
"name": "Force a failure",
"ansible.builtin.command": "/bin/false",
},
],
"rescue": [
{
"name": "Force a failure in middle of recovery!",
"ansible.builtin.command": "/bin/false",
},
],
"always": [
{
"name": "Always do this",
"ansible.builtin.debug": {"msg": "This always executes"},
},
],
},
True,
),
),
)
def test_is_nested_task(task: dict[str, Any], expected: bool) -> None:
"""Test is_nested_task() returns expected bool."""
assert is_nested_task(task) == expected
def test_capture_warning_outdated_tag(
default_rules_collection: RulesCollection,
) -> None:
"""Test that exclude paths do work."""
runner = Runner(
"examples/playbooks/capture-warning.yml",
rules=default_rules_collection,
)
matches = runner.run()
assert len(matches) == 1
assert matches[0].rule.id == "warning"
assert matches[0].tag == "warning[outdated-tag]"
assert matches[0].lineno == 8
|
