blob: f766cf1c778b69607ae4d175498408b7ce50be51 (
plain)
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
|
"""Implementation of risky-shell-pipe rule."""
from __future__ import annotations
import re
from typing import TYPE_CHECKING, Any
from ansiblelint.rules import AnsibleLintRule
from ansiblelint.utils import convert_to_boolean
if TYPE_CHECKING:
from ansiblelint.file_utils import Lintable
class ShellWithoutPipefail(AnsibleLintRule):
"""Shells that use pipes should set the pipefail option."""
id = "risky-shell-pipe"
description = (
"Without the pipefail option set, a shell command that "
"implements a pipeline can fail and still return 0. If "
"any part of the pipeline other than the terminal command "
"fails, the whole pipeline will still return 0, which may "
"be considered a success by Ansible. "
"Pipefail is available in the bash shell."
)
severity = "MEDIUM"
tags = ["command-shell"]
version_added = "v4.1.0"
_pipefail_re = re.compile(r"^\s*set.*[+-][A-Za-z]*o\s*pipefail", re.M)
_pipe_re = re.compile(r"(?<!\|)\|(?!\|)")
def matchtask(
self, task: dict[str, Any], file: Lintable | None = None
) -> bool | str:
if task["__ansible_action_type__"] != "task":
return False
if task["action"]["__ansible_module__"] != "shell":
return False
if task.get("ignore_errors"):
return False
jinja_stripped_cmd = self.unjinja(
" ".join(task["action"].get("__ansible_arguments__", []))
)
return bool(
self._pipe_re.search(jinja_stripped_cmd)
and not self._pipefail_re.search(jinja_stripped_cmd)
and not convert_to_boolean(task["action"].get("ignore_errors", False))
)
|
