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
|
"""Rule definition for ansible syntax check."""
from __future__ import annotations
import re
from dataclasses import dataclass
from ansiblelint.rules import AnsibleLintRule
@dataclass
class KnownError:
"""Class that tracks result of linting."""
tag: str
regex: re.Pattern[str]
# Order matters, we only report the first matching pattern, the one at the end
# is used to match generic or less specific patterns.
OUTPUT_PATTERNS = (
KnownError(
tag="missing-file",
regex=re.compile(
# do not use <filename> capture group for this because we want to report original file, not the missing target one
r"(?P<title>Unable to retrieve file contents)\n(?P<details>Could not find or access '(?P<value>.*)'[^\n]*)",
re.MULTILINE | re.S | re.DOTALL,
),
),
KnownError(
tag="no-file",
regex=re.compile(
r"^ERROR! (?P<title>No file specified for [^\n]*)",
re.MULTILINE | re.S | re.DOTALL,
),
),
KnownError(
tag="empty-playbook",
regex=re.compile(
"Empty playbook, nothing to do",
re.MULTILINE | re.S | re.DOTALL,
),
),
KnownError(
tag="malformed",
regex=re.compile(
"^ERROR! (?P<title>A malformed block was encountered while loading a block[^\n]*)",
re.MULTILINE | re.S | re.DOTALL,
),
),
KnownError(
tag="unknown-module",
regex=re.compile(
r"^ERROR! (?P<title>couldn't resolve module/action [^\n]*)\n\nThe error appears to be in '(?P<filename>[\w\/\.\-]+)': line (?P<line>\d+), column (?P<column>\d+)",
re.MULTILINE | re.S | re.DOTALL,
),
),
KnownError(
tag="specific",
regex=re.compile(
r"^ERROR! (?P<title>[^\n]*)\n\nThe error appears to be in '(?P<filename>[\w\/\.\-]+)': line (?P<line>\d+), column (?P<column>\d+)",
re.MULTILINE | re.S | re.DOTALL,
),
),
# "ERROR! the role 'this_role_is_missing' was not found in ROLE_INCLUDE_PATHS\n\nThe error appears to be in 'FILE_PATH': line 5, column 7, but may\nbe elsewhere in the file depending on the exact syntax problem.\n\nThe offending line appears to be:\n\n roles:\n - this_role_is_missing\n ^ here\n"
KnownError(
tag="specific",
regex=re.compile(
r"^ERROR! (?P<title>the role '.*' was not found in[^\n]*)'(?P<filename>[\w\/\.\-]+)': line (?P<line>\d+), column (?P<column>\d+)",
re.MULTILINE | re.S | re.DOTALL,
),
),
)
class AnsibleSyntaxCheckRule(AnsibleLintRule):
"""Ansible syntax check failed."""
id = "syntax-check"
severity = "VERY_HIGH"
tags = ["core", "unskippable"]
version_added = "v5.0.0"
_order = 0
|
