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
|
"""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 pathlib import Path
from typing import TYPE_CHECKING, Any
from ansiblelint.constants import ROLE_IMPORT_ACTION_NAMES
from ansiblelint.file_utils import Lintable
from ansiblelint.rules import AnsibleLintRule
from ansiblelint.utils import parse_yaml_from_file
if TYPE_CHECKING:
from ansiblelint.errors import MatchError
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):
# Unable to use f-strings due to flake8 bug with AST parsing
"""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"
def matchtask(
self, task: dict[str, Any], 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,
linenumber=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 == "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,
linenumber=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:
pass
return default
if "pytest" in sys.modules:
import pytest
from ansiblelint.rules import RulesCollection # pylint: disable=ungrouped-imports
from ansiblelint.runner import Runner # pylint: disable=ungrouped-imports
@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
|
