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
|
"""Implementation of command-instead-of-module rule."""
# Copyright (c) 2013-2014 Will Thames <will@thames.id.au>
#
# 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 sys
from pathlib import Path
from typing import TYPE_CHECKING
from ansiblelint.rules import AnsibleLintRule
from ansiblelint.utils import convert_to_boolean, get_first_cmd_arg, get_second_cmd_arg
if TYPE_CHECKING:
from ansiblelint.file_utils import Lintable
from ansiblelint.utils import Task
class CommandsInsteadOfModulesRule(AnsibleLintRule):
"""Using command rather than module."""
id = "command-instead-of-module"
description = (
"Executing a command when there is an Ansible module is generally a bad idea"
)
severity = "HIGH"
tags = ["command-shell", "idiom"]
version_added = "historic"
_commands = ["command", "shell"]
_modules = {
"apt-get": "apt-get",
"chkconfig": "service",
"curl": "get_url or uri",
"git": "git",
"hg": "hg",
"letsencrypt": "acme_certificate",
"mktemp": "tempfile",
"mount": "mount",
"patch": "patch",
"rpm": "yum or rpm_key",
"rsync": "synchronize",
"sed": "template, replace or lineinfile",
"service": "service",
"supervisorctl": "supervisorctl",
"svn": "subversion",
"systemctl": "systemd",
"tar": "unarchive",
"unzip": "unarchive",
"wget": "get_url or uri",
"yum": "yum",
}
_executable_options = {
"git": ["branch", "log", "lfs"],
"systemctl": ["--version", "kill", "set-default", "show-environment", "status"],
"yum": ["clean"],
"rpm": ["--nodeps"],
}
def matchtask(
self,
task: Task,
file: Lintable | None = None,
) -> bool | str:
if task["action"]["__ansible_module__"] not in self._commands:
return False
first_cmd_arg = get_first_cmd_arg(task)
second_cmd_arg = get_second_cmd_arg(task)
if not first_cmd_arg:
return False
executable = Path(first_cmd_arg).name
if (
second_cmd_arg
and executable in self._executable_options
and second_cmd_arg in self._executable_options[executable]
):
return False
if executable in self._modules and convert_to_boolean(
task["action"].get("warn", True),
):
message = "{0} used in place of {1} module"
return message.format(executable, self._modules[executable])
return False
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(
("file", "expected"),
(
pytest.param(
"examples/playbooks/rule-command-instead-of-module-pass.yml",
0,
id="pass",
),
pytest.param(
"examples/playbooks/rule-command-instead-of-module-fail.yml",
3,
id="fail",
),
),
)
def test_command_instead_of_module(
default_rules_collection: RulesCollection,
file: str,
expected: int,
) -> None:
"""Validate that rule works as intended."""
results = Runner(file, rules=default_rules_collection).run()
for result in results:
assert result.rule.id == CommandsInsteadOfModulesRule.id, result
assert len(results) == expected
|
