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
|
"""Tests for Transformer."""
from __future__ import annotations
import os
import shutil
from pathlib import Path
from typing import TYPE_CHECKING
import pytest
# noinspection PyProtectedMember
from ansiblelint.runner import LintResult, _get_matches
from ansiblelint.transformer import Transformer
if TYPE_CHECKING:
from argparse import Namespace
from collections.abc import Iterator
from ansiblelint.config import Options
from ansiblelint.rules import RulesCollection
@pytest.fixture(name="copy_examples_dir")
def fixture_copy_examples_dir(
tmp_path: Path,
config_options: Namespace,
) -> Iterator[tuple[Path, Path]]:
"""Fixture that copies the examples/ dir into a tmpdir."""
examples_dir = Path("examples")
shutil.copytree(examples_dir, tmp_path / "examples")
old_cwd = Path.cwd()
try:
os.chdir(tmp_path)
config_options.cwd = tmp_path
yield old_cwd, tmp_path
finally:
os.chdir(old_cwd)
@pytest.fixture(name="runner_result")
def fixture_runner_result(
config_options: Options,
default_rules_collection: RulesCollection,
playbook: str,
) -> LintResult:
"""Fixture that runs the Runner to populate a LintResult for a given file."""
config_options.lintables = [playbook]
result = _get_matches(rules=default_rules_collection, options=config_options)
return result
@pytest.mark.parametrize(
("playbook", "matches_count", "transformed"),
(
# reuse TestRunner::test_runner test cases to ensure transformer does not mangle matches
pytest.param(
"examples/playbooks/nomatchestest.yml",
0,
False,
id="nomatchestest",
),
pytest.param("examples/playbooks/unicode.yml", 1, False, id="unicode"),
pytest.param(
"examples/playbooks/lots_of_warnings.yml",
992,
False,
id="lots_of_warnings",
),
pytest.param("examples/playbooks/become.yml", 0, False, id="become"),
pytest.param(
"examples/playbooks/contains_secrets.yml",
0,
False,
id="contains_secrets",
),
pytest.param(
"examples/playbooks/vars/empty_vars.yml",
0,
False,
id="empty_vars",
),
pytest.param("examples/playbooks/vars/strings.yml", 0, True, id="strings"),
pytest.param("examples/playbooks/vars/empty.yml", 1, False, id="empty"),
pytest.param("examples/playbooks/name-case.yml", 1, True, id="name_case"),
pytest.param("examples/playbooks/fqcn.yml", 3, True, id="fqcn"),
),
)
def test_transformer( # pylint: disable=too-many-arguments, too-many-locals
config_options: Options,
copy_examples_dir: tuple[Path, Path],
playbook: str,
runner_result: LintResult,
transformed: bool,
matches_count: int,
) -> None:
"""Test that transformer can go through any corner cases.
Based on TestRunner::test_runner
"""
config_options.write_list = ["all"]
transformer = Transformer(result=runner_result, options=config_options)
transformer.run()
matches = runner_result.matches
assert len(matches) == matches_count
orig_dir, tmp_dir = copy_examples_dir
orig_playbook = orig_dir / playbook
expected_playbook = orig_dir / playbook.replace(".yml", ".transformed.yml")
transformed_playbook = tmp_dir / playbook
orig_playbook_content = orig_playbook.read_text()
expected_playbook_content = expected_playbook.read_text()
transformed_playbook_content = transformed_playbook.read_text()
if transformed:
assert orig_playbook_content != transformed_playbook_content
else:
assert orig_playbook_content == transformed_playbook_content
assert transformed_playbook_content == expected_playbook_content
@pytest.mark.parametrize(
("write_list", "expected"),
(
# 1 item
(["all"], {"all"}),
(["none"], {"none"}),
(["rule-id"], {"rule-id"}),
# 2 items
(["all", "all"], {"all"}),
(["all", "none"], {"none"}),
(["all", "rule-id"], {"all"}),
(["none", "all"], {"all"}),
(["none", "none"], {"none"}),
(["none", "rule-id"], {"rule-id"}),
(["rule-id", "all"], {"all"}),
(["rule-id", "none"], {"none"}),
(["rule-id", "rule-id"], {"rule-id"}),
# 3 items
(["all", "all", "all"], {"all"}),
(["all", "all", "none"], {"none"}),
(["all", "all", "rule-id"], {"all"}),
(["all", "none", "all"], {"all"}),
(["all", "none", "none"], {"none"}),
(["all", "none", "rule-id"], {"rule-id"}),
(["all", "rule-id", "all"], {"all"}),
(["all", "rule-id", "none"], {"none"}),
(["all", "rule-id", "rule-id"], {"all"}),
(["none", "all", "all"], {"all"}),
(["none", "all", "none"], {"none"}),
(["none", "all", "rule-id"], {"all"}),
(["none", "none", "all"], {"all"}),
(["none", "none", "none"], {"none"}),
(["none", "none", "rule-id"], {"rule-id"}),
(["none", "rule-id", "all"], {"all"}),
(["none", "rule-id", "none"], {"none"}),
(["none", "rule-id", "rule-id"], {"rule-id"}),
(["rule-id", "all", "all"], {"all"}),
(["rule-id", "all", "none"], {"none"}),
(["rule-id", "all", "rule-id"], {"all"}),
(["rule-id", "none", "all"], {"all"}),
(["rule-id", "none", "none"], {"none"}),
(["rule-id", "none", "rule-id"], {"rule-id"}),
(["rule-id", "rule-id", "all"], {"all"}),
(["rule-id", "rule-id", "none"], {"none"}),
(["rule-id", "rule-id", "rule-id"], {"rule-id"}),
),
)
def test_effective_write_set(write_list: list[str], expected: set[str]) -> None:
"""Make sure effective_write_set handles all/none keywords correctly."""
actual = Transformer.effective_write_set(write_list)
assert actual == expected
|
