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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
"""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 os
import sys
from typing import TYPE_CHECKING, Any
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
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: dict[str, Any], 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 = os.path.basename(first_cmd_arg)
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: # noqa: C901
import pytest
from ansiblelint.testing import RunFromText # pylint: disable=ungrouped-imports
APT_GET = """
- hosts: all
tasks:
- name: Run apt-get update
command: apt-get update
"""
GIT_COMMANDS_OK = """
- hosts: all
tasks:
- name: Print current git branch
command: git branch
- name: Print git log
command: git log
- name: Install git lfs support
command: git lfs install
"""
RESTART_SSHD = """
- hosts: all
tasks:
- name: Restart sshd
command: systemctl restart sshd
"""
SYSTEMCTL_STATUS = """
- hosts: all
tasks:
- name: Show systemctl service status
command: systemctl status systemd-timesyncd
"""
SYSTEMD_ENVIRONMENT = """
- hosts: all
tasks:
- name: Show systemd environment
command: systemctl show-environment
"""
SYSTEMD_RUNLEVEL = """
- hosts: all
tasks:
- name: Set systemd runlevel
command: systemctl set-default multi-user.target
"""
SYSTEMD_KILL = """
- hosts: all
tasks:
- name: Kill service using SIGUSR1
command: systemctl kill --signal=SIGUSR1 sshd
"""
YUM_UPDATE = """
- hosts: all
tasks:
- name: Run yum update
command: yum update
"""
YUM_CLEAN = """
- hosts: all
tasks:
- name: Clear yum cache
command: yum clean all
"""
NO_COMMAND = """
- hosts: all
tasks:
- name: Clear yum cache
command: ""
"""
@pytest.mark.parametrize(
"rule_runner", (CommandsInsteadOfModulesRule,), indirect=["rule_runner"]
)
def test_apt_get(rule_runner: RunFromText) -> None:
"""The apt module supports update."""
results = rule_runner.run_playbook(APT_GET)
assert len(results) == 1
@pytest.mark.parametrize(
"rule_runner", (CommandsInsteadOfModulesRule,), indirect=["rule_runner"]
)
def test_restart_sshd(rule_runner: RunFromText) -> None:
"""Restarting services is supported by the systemd module."""
results = rule_runner.run_playbook(RESTART_SSHD)
assert len(results) == 1
@pytest.mark.parametrize(
"rule_runner", (CommandsInsteadOfModulesRule,), indirect=["rule_runner"]
)
def test_git_commands_ok(rule_runner: RunFromText) -> None:
"""Check the git commands not supported by the git module do not trigger rule."""
results = rule_runner.run_playbook(GIT_COMMANDS_OK)
assert len(results) == 0
@pytest.mark.parametrize(
"rule_runner", (CommandsInsteadOfModulesRule,), indirect=["rule_runner"]
)
def test_systemd_status(rule_runner: RunFromText) -> None:
"""Set-default is not supported by the systemd module."""
results = rule_runner.run_playbook(SYSTEMCTL_STATUS)
assert len(results) == 0
@pytest.mark.parametrize(
"rule_runner", (CommandsInsteadOfModulesRule,), indirect=["rule_runner"]
)
def test_systemd_environment(rule_runner: RunFromText) -> None:
"""Showing the environment is not supported by the systemd module."""
results = rule_runner.run_playbook(SYSTEMD_ENVIRONMENT)
assert len(results) == 0
@pytest.mark.parametrize(
"rule_runner", (CommandsInsteadOfModulesRule,), indirect=["rule_runner"]
)
def test_systemd_runlevel(rule_runner: RunFromText) -> None:
"""Set-default is not supported by the systemd module."""
results = rule_runner.run_playbook(SYSTEMD_RUNLEVEL)
assert len(results) == 0
@pytest.mark.parametrize(
"rule_runner", (CommandsInsteadOfModulesRule,), indirect=["rule_runner"]
)
def test_systemd_kill(rule_runner: RunFromText) -> None:
"""Kill is not supported by the systemd module."""
results = rule_runner.run_playbook(SYSTEMD_KILL)
assert len(results) == 0
@pytest.mark.parametrize(
"rule_runner", (CommandsInsteadOfModulesRule,), indirect=["rule_runner"]
)
def test_yum_update(rule_runner: RunFromText) -> None:
"""Using yum update should fail."""
results = rule_runner.run_playbook(YUM_UPDATE)
assert len(results) == 1
@pytest.mark.parametrize(
"rule_runner", (CommandsInsteadOfModulesRule,), indirect=["rule_runner"]
)
def test_yum_clean(rule_runner: RunFromText) -> None:
"""The yum module does not support clearing yum cache."""
results = rule_runner.run_playbook(YUM_CLEAN)
assert len(results) == 0
@pytest.mark.parametrize(
"rule_runner", (CommandsInsteadOfModulesRule,), indirect=["rule_runner"]
)
def test_no_command(rule_runner: RunFromText) -> None:
"""If no command is passed it should return 0."""
results = rule_runner.run_playbook(NO_COMMAND)
assert len(results) == 0
|
