"""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"(? 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)) )