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
|
"""Implementation of role-name rule."""
# Copyright (c) 2020 Gael Chamoulaud <gchamoul@redhat.com>
# Copyright (c) 2020 Sorin Sbarnea <ssbarnea@redhat.com>
#
# 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.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
from __future__ import annotations
import re
import sys
from functools import cache
from typing import TYPE_CHECKING
from ansiblelint.constants import ROLE_IMPORT_ACTION_NAMES
from ansiblelint.rules import AnsibleLintRule
from ansiblelint.utils import parse_yaml_from_file
if TYPE_CHECKING:
from pathlib import Path
from ansiblelint.errors import MatchError
from ansiblelint.file_utils import Lintable
from ansiblelint.utils import Task
ROLE_NAME_REGEX = re.compile(r"^[a-z][a-z0-9_]*$")
def _remove_prefix(text: str, prefix: str) -> str:
return re.sub(rf"^{re.escape(prefix)}", "", text)
@cache
def _match_role_name_regex(role_name: str) -> bool:
return ROLE_NAME_REGEX.match(role_name) is not None
class RoleNames(AnsibleLintRule):
"""Role name {0} does not match ``^[a-z][a-z0-9_]*$`` pattern."""
id = "role-name"
description = (
"Role names are now limited to contain only lowercase alphanumeric "
"characters, plus underline and start with an alpha character."
)
link = "https://docs.ansible.com/ansible/devel/dev_guide/developing_collections_structure.html#roles-directory"
severity = "HIGH"
tags = ["deprecations", "metadata"]
version_added = "v6.8.5"
_ids = {
"role-name[path]": "Avoid using paths when importing roles.",
}
def matchtask(
self,
task: Task,
file: Lintable | None = None,
) -> list[MatchError]:
results = []
if task["action"]["__ansible_module__"] in ROLE_IMPORT_ACTION_NAMES:
name = task["action"].get("name", "")
if "/" in name:
results.append(
self.create_matcherror(
f"Avoid using paths when importing roles. ({name})",
filename=file,
lineno=task["action"].get("__line__", task["__line__"]),
tag=f"{self.id}[path]",
),
)
return results
def matchdir(self, lintable: Lintable) -> list[MatchError]:
return self.matchyaml(lintable)
def matchyaml(self, file: Lintable) -> list[MatchError]:
result: list[MatchError] = []
if file.kind not in ("meta", "role", "playbook"):
return result
if file.kind == "meta":
for role in file.data.get("dependencies", []):
if isinstance(role, dict):
role_name = role["role"]
elif isinstance(role, str):
role_name = role
else:
msg = "Role dependency has unexpected type."
raise TypeError(msg)
if "/" in role_name:
result.append(
self.create_matcherror(
f"Avoid using paths when importing roles. ({role_name})",
filename=file,
lineno=role_name.ansible_pos[1],
tag=f"{self.id}[path]",
),
)
return result
if file.kind == "playbook":
for play in file.data:
if "roles" in play:
line = play["__line__"]
for role in play["roles"]:
if isinstance(role, dict):
line = role["__line__"]
role_name = role["role"]
elif isinstance(role, str):
role_name = role
if "/" in role_name:
result.append(
self.create_matcherror(
f"Avoid using paths when importing roles. ({role_name})",
filename=file,
lineno=line,
tag=f"{self.id}[path]",
),
)
return result
if file.kind == "role":
role_name = self._infer_role_name(
meta=file.path / "meta" / "main.yml",
default=file.path.name,
)
else:
role_name = self._infer_role_name(
meta=file.path,
default=file.path.resolve().parents[1].name,
)
role_name = _remove_prefix(role_name, "ansible-role-")
if role_name and not _match_role_name_regex(role_name):
result.append(
self.create_matcherror(
filename=file,
message=self.shortdesc.format(role_name),
),
)
return result
@staticmethod
def _infer_role_name(meta: Path, default: str) -> str:
if meta.is_file():
meta_data = parse_yaml_from_file(str(meta))
if meta_data:
try:
return str(meta_data["galaxy_info"]["role_name"])
except (KeyError, TypeError):
pass
return default
if "pytest" in sys.modules:
import pytest
# pylint: disable=ungrouped-imports
from ansiblelint.rules import RulesCollection
from ansiblelint.runner import Runner
@pytest.mark.parametrize(
("test_file", "failure"),
(pytest.param("examples/playbooks/rule-role-name-path.yml", 3, id="fail"),),
)
def test_role_name_path(
default_rules_collection: RulesCollection,
test_file: str,
failure: int,
) -> None:
"""Test rule matches."""
results = Runner(test_file, rules=default_rules_collection).run()
for result in results:
assert result.tag == "role-name[path]"
assert len(results) == failure
@pytest.mark.parametrize(
("test_file", "failure"),
(pytest.param("examples/roles/role_with_deps_paths", 3, id="fail"),),
)
def test_role_deps_path_names(
default_rules_collection: RulesCollection,
test_file: str,
failure: int,
) -> None:
"""Test rule matches."""
results = Runner(
test_file,
rules=default_rules_collection,
).run()
expected_errors = (
("role-name[path]", 3),
("role-name[path]", 9),
("role-name[path]", 10),
)
assert len(expected_errors) == failure
for idx, result in enumerate(results):
assert result.tag == expected_errors[idx][0]
assert result.lineno == expected_errors[idx][1]
assert len(results) == failure
@pytest.mark.parametrize(
("test_file", "failure"),
(pytest.param("examples/roles/test-no-deps-role", 0, id="no_deps"),),
)
def test_role_no_deps(
default_rules_collection: RulesCollection,
test_file: str,
failure: int,
) -> None:
"""Test role if no dependencies are present in meta/main.yml."""
results = Runner(
test_file,
rules=default_rules_collection,
).run()
assert len(results) == failure
|
