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
|
"""Tests for syntax-check rule."""
from typing import Any
import pytest
from ansiblelint.file_utils import Lintable
from ansiblelint.rules import RulesCollection
from ansiblelint.runner import Runner
@pytest.mark.parametrize(
("filename", "expected_results"),
(
pytest.param(
"examples/playbooks/conflicting_action.yml",
[
(
"syntax-check[specific]",
4,
7,
"conflicting action statements: ansible.builtin.debug, ansible.builtin.command",
),
],
id="0",
),
pytest.param(
"examples/playbooks/conflicting_action2.yml",
[
(
"parser-error",
1,
None,
"conflicting action statements: block, include_role",
),
(
"syntax-check[specific]",
5,
7,
"'include_role' is not a valid attribute for a Block",
),
],
id="1",
),
),
)
def test_get_ansible_syntax_check_matches(
default_rules_collection: RulesCollection,
filename: str,
expected_results: list[tuple[str, int, int, str]],
) -> None:
"""Validate parsing of ansible output."""
lintable = Lintable(
filename,
kind="playbook",
)
result = sorted(Runner(lintable, rules=default_rules_collection).run())
assert len(result) == len(expected_results)
for index, expected in enumerate(expected_results):
assert result[index].tag == expected[0]
assert result[index].lineno == expected[1]
assert result[index].column == expected[2]
assert str(expected[3]) in result[index].message
# We internally convert absolute paths returned by ansible into paths
# relative to current directory.
# assert result[index].filename.endswith("/conflicting_action.yml")
def test_empty_playbook(default_rules_collection: RulesCollection) -> None:
"""Validate detection of empty-playbook."""
lintable = Lintable("examples/playbooks/empty_playbook.yml", kind="playbook")
result = Runner(lintable, rules=default_rules_collection).run()
assert result[0].lineno == 1
# We internally convert absolute paths returned by ansible into paths
# relative to current directory.
assert result[0].filename.endswith("/empty_playbook.yml")
assert result[0].tag == "syntax-check[empty-playbook]"
assert result[0].message == "Empty playbook, nothing to do"
assert len(result) == 1
def test_extra_vars_passed_to_command(
default_rules_collection: RulesCollection,
config_options: Any,
) -> None:
"""Validate `extra-vars` are passed to syntax check command."""
config_options.extra_vars = {
"foo": "bar",
"complex_variable": ":{;\t$()",
}
lintable = Lintable("examples/playbooks/extra_vars.yml", kind="playbook")
result = Runner(lintable, rules=default_rules_collection).run()
assert not result
def test_syntax_check_role(default_rules_collection: RulesCollection) -> None:
"""Validate syntax check of a broken role."""
lintable = Lintable("examples/playbooks/roles/invalid_due_syntax", kind="role")
result = Runner(lintable, rules=default_rules_collection).run()
assert len(result) == 1, result
assert result[0].lineno == 2
assert result[0].filename == "examples/roles/invalid_due_syntax/tasks/main.yml"
assert result[0].tag == "syntax-check[specific]"
assert result[0].message == "no module/action detected in task."
|
