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
|
"""Implementation of command-instead-of-shell rule."""
# Copyright (c) 2016 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 typing import TYPE_CHECKING, Any
from ansiblelint.rules import AnsibleLintRule
if TYPE_CHECKING:
from ansiblelint.file_utils import Lintable
FAIL_PLAY = """---
- name: Fixture
hosts: localhost
tasks:
- name: Shell no pipe
ansible.builtin.shell:
cmd: echo hello
changed_when: false
- name: Shell with jinja filter
ansible.builtin.shell:
cmd: echo {{ "hello" | upper }}
changed_when: false
- name: Shell with jinja filter (fqcn)
ansible.builtin.shell:
cmd: echo {{ "hello" | upper }}
changed_when: false
- name: Command with executable parameter
ansible.builtin.shell:
cmd: clear
args:
executable: /bin/bash
changed_when: false
"""
SUCCESS_PLAY = """---
- name: Fixture
hosts: localhost
tasks:
- name: Shell with pipe
ansible.builtin.shell:
cmd: echo hello | true # noqa: risky-shell-pipe
changed_when: false
- name: Shell with redirect
ansible.builtin.shell:
cmd: echo hello > /tmp/hello
changed_when: false
- name: Chain two shell commands
ansible.builtin.shell:
cmd: echo hello && echo goodbye
changed_when: false
- name: Run commands in succession
ansible.builtin.shell:
cmd: echo hello ; echo goodbye
changed_when: false
- name: Use variables
ansible.builtin.shell:
cmd: echo $HOME $USER
changed_when: false
- name: Use * for globbing
ansible.builtin.shell:
cmd: ls foo*
changed_when: false
- name: Use ? for globbing
ansible.builtin.shell:
cmd: ls foo?
changed_when: false
- name: Use [] for globbing
ansible.builtin.shell:
cmd: ls foo[1,2,3]
changed_when: false
- name: Use shell generator
ansible.builtin.shell:
cmd: ls foo{.txt,.xml}
changed_when: false
- name: Use backticks
ansible.builtin.shell:
cmd: ls `ls foo*`
changed_when: false
- name: Use shell with cmd
ansible.builtin.shell:
cmd: |
set -x
ls foo?
changed_when: false
"""
class UseCommandInsteadOfShellRule(AnsibleLintRule):
"""Use shell only when shell functionality is required."""
id = "command-instead-of-shell"
description = (
"Shell should only be used when piping, redirecting "
"or chaining commands (and Ansible would be preferred "
"for some of those!)"
)
severity = "HIGH"
tags = ["command-shell", "idiom"]
version_added = "historic"
def matchtask(
self, task: dict[str, Any], file: Lintable | None = None
) -> bool | str:
# Use unjinja so that we don't match on jinja filters
# rather than pipes
if task["action"]["__ansible_module__"] in ["shell", "ansible.builtin.shell"]:
# Since Ansible 2.4, the `command` module does not accept setting
# the `executable`. If the user needs to set it, they have to use
# the `shell` module.
if "executable" in task["action"]:
return False
if "cmd" in task["action"]:
jinja_stripped_cmd = self.unjinja(task["action"].get("cmd", []))
else:
jinja_stripped_cmd = self.unjinja(
" ".join(task["action"].get("__ansible_arguments__", []))
)
return not any(ch in jinja_stripped_cmd for ch in "&|<>;$\n*[]{}?`")
return False
# testing code to be loaded only with pytest or when executed the rule file
if "pytest" in sys.modules:
import pytest
from ansiblelint.testing import RunFromText # pylint: disable=ungrouped-imports
@pytest.mark.parametrize(
("text", "expected"),
(
pytest.param(SUCCESS_PLAY, 0, id="good"),
pytest.param(FAIL_PLAY, 3, id="bad"),
),
)
def test_rule_command_instead_of_shell(
default_text_runner: RunFromText, text: str, expected: int
) -> None:
"""Validate that rule works as intended."""
results = default_text_runner.run_playbook(text)
for result in results:
assert result.rule.id == UseCommandInsteadOfShellRule.id, result
assert len(results) == expected
|
