forked from ansible/ansible-lint
-
Notifications
You must be signed in to change notification settings - Fork 0
/
__init__.py
328 lines (274 loc) · 11.2 KB
/
__init__.py
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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
"""Output formatters."""
import hashlib
import json
import os
from pathlib import Path
from typing import TYPE_CHECKING, Any, Dict, Generic, List, Tuple, TypeVar, Union
import rich
from ansiblelint.config import options
from ansiblelint.version import __version__
if TYPE_CHECKING:
from ansiblelint.errors import MatchError
T = TypeVar("T", bound="BaseFormatter") # type: ignore
class BaseFormatter(Generic[T]):
"""Formatter of ansible-lint output.
Base class for output formatters.
Args:
base_dir (str|Path): reference directory against which display relative path.
display_relative_path (bool): whether to show path as relative or absolute
"""
def __init__(self, base_dir: Union[str, Path], display_relative_path: bool) -> None:
"""Initialize a BaseFormatter instance."""
if isinstance(base_dir, str):
base_dir = Path(base_dir)
if base_dir: # can be None
base_dir = base_dir.absolute()
# Required 'cause os.path.relpath() does not accept Path before 3.6
if isinstance(base_dir, Path):
base_dir = str(base_dir) # Drop when Python 3.5 is no longer supported
self._base_dir = base_dir if display_relative_path else None
def _format_path(self, path: Union[str, Path]) -> str:
# Required 'cause os.path.relpath() does not accept Path before 3.6
if isinstance(path, Path):
path = str(path) # Drop when Python 3.5 is no longer supported
if not self._base_dir or not path:
return path
# Use os.path.relpath 'cause Path.relative_to() misbehaves
return os.path.relpath(path, start=self._base_dir)
# pylint: disable=no-self-use
def format(self, match: "MatchError") -> str:
"""Format a match error."""
return str(match)
@staticmethod
def escape(text: str) -> str:
"""Escapes a string to avoid processing it as markup."""
return rich.markup.escape(text)
class Formatter(BaseFormatter): # type: ignore
"""Default output formatter of ansible-lint."""
def format(self, match: "MatchError") -> str:
_id = getattr(match.rule, "id", "000")
result = f"[error_code]{_id}[/][dim]:[/] [error_title]{self.escape(match.message)}[/]"
if match.tag:
result += f" [dim][error_code]({match.tag})[/][/]"
result += (
"\n"
f"[filename]{self._format_path(match.filename or '')}[/]:{match.position}"
)
if match.details:
result += f" [dim]{match.details}[/]"
result += "\n"
return result
class QuietFormatter(BaseFormatter[Any]):
"""Brief output formatter for ansible-lint."""
def format(self, match: "MatchError") -> str:
return (
f"[error_code]{match.rule.id}[/] "
f"[filename]{self._format_path(match.filename or '')}[/]:{match.position}"
)
class ParseableFormatter(BaseFormatter[Any]):
"""Parseable uses PEP8 compatible format."""
def format(self, match: "MatchError") -> str:
result = (
f"[filename]{self._format_path(match.filename or '')}[/]:{match.position}: "
f"[error_code]{match.rule.id}[/]"
)
if not options.quiet:
result += f" [dim]{match.message}[/]"
if match.tag:
result += f" [dim][error_code]({match.tag})[/][/]"
return result
class AnnotationsFormatter(BaseFormatter): # type: ignore
# https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-a-warning-message
"""Formatter for emitting violations as GitHub Workflow Commands.
These commands trigger the GHA Workflow runners platform to post violations
in a form of GitHub Checks API annotations that appear rendered in pull-
request files view.
::debug file={name},line={line},col={col},severity={severity}::{message}
::warning file={name},line={line},col={col},severity={severity}::{message}
::error file={name},line={line},col={col},severity={severity}::{message}
Supported levels: debug, warning, error
"""
def format(self, match: "MatchError") -> str:
"""Prepare a match instance for reporting as a GitHub Actions annotation."""
level = self._severity_to_level(match.rule.severity)
file_path = self._format_path(match.filename or "")
line_num = match.linenumber
rule_id = match.rule.id
severity = match.rule.severity
violation_details = self.escape(match.message)
if match.column:
col = f",col={match.column}"
else:
col = ""
return (
f"::{level} file={file_path},line={line_num}{col},severity={severity}"
f"::{rule_id} {violation_details}"
)
@staticmethod
def _severity_to_level(severity: str) -> str:
if severity in ["VERY_LOW", "LOW"]:
return "warning"
if severity in ["INFO"]:
return "debug"
# ['MEDIUM', 'HIGH', 'VERY_HIGH'] or anything else
return "error"
class CodeclimateJSONFormatter(BaseFormatter[Any]):
"""Formatter for emitting violations in Codeclimate JSON report format.
The formatter expects a list of MatchError objects and returns a JSON formatted string.
The spec for the codeclimate report can be found here:
https://github.com/codeclimate/platform/blob/master/spec/analyzers/SPEC.md#user-content-data-types
"""
def format_result(self, matches: List["MatchError"]) -> str:
"""Format a list of match errors as a JSON string."""
if not isinstance(matches, list):
raise RuntimeError(
f"The {self.__class__} was expecting a list of MatchError."
)
result = []
for match in matches:
issue: Dict[str, Any] = {}
issue["type"] = "issue"
issue["check_name"] = f"[{match.rule.id}] {match.message}"
issue["categories"] = match.rule.tags
issue["severity"] = self._severity_to_level(match.rule.severity)
issue["description"] = self.escape(str(match.rule.description))
issue["fingerprint"] = hashlib.sha256(
repr(match).encode("utf-8")
).hexdigest()
issue["location"] = {}
issue["location"]["path"] = self._format_path(match.filename or "")
issue["location"]["lines"] = {}
if match.column:
issue["location"]["lines"]["begin"] = {}
issue["location"]["lines"]["begin"]["line"] = match.linenumber
issue["location"]["lines"]["begin"]["column"] = match.column
else:
issue["location"]["lines"]["begin"] = match.linenumber
if match.details:
issue["content"] = {}
issue["content"]["body"] = match.details
# Append issue to result list
result.append(issue)
return json.dumps(result)
@staticmethod
def _severity_to_level(severity: str) -> str:
if severity in ["LOW"]:
return "minor"
if severity in ["MEDIUM"]:
return "major"
if severity in ["HIGH"]:
return "critical"
if severity in ["VERY_HIGH"]:
return "blocker"
# VERY_LOW, INFO or anything else
return "info"
class SarifFormatter(BaseFormatter[Any]):
"""Formatter for emitting violations in SARIF report format.
The spec of SARIF can be found here:
https://docs.oasis-open.org/sarif/sarif/v2.1.0/
"""
BASE_URI_ID = "SRCROOT"
TOOL_NAME = "Ansible-lint"
TOOL_URL = "https://github.com/ansible/ansible-lint"
SARIF_SCHEMA_VERSION = "2.1.0"
RULE_DOC_URL = "https://ansible-lint.readthedocs.io/en/latest/default_rules/"
SARIF_SCHEMA = (
"https://schemastore.azurewebsites.net/schemas/json/sarif-2.1.0-rtm.5.json"
)
def format_result(self, matches: List["MatchError"]) -> str:
"""Format a list of match errors as a JSON string."""
if not isinstance(matches, list):
raise RuntimeError(
f"The {self.__class__} was expecting a list of MatchError."
)
root_path = Path(str(self._base_dir)).as_uri()
root_path = root_path + "/" if not root_path.endswith("/") else root_path
rules, results = self._extract_results(matches)
tool = {
"driver": {
"name": self.TOOL_NAME,
"version": __version__,
"informationUri": self.TOOL_URL,
"rules": rules,
}
}
runs = [
{
"tool": tool,
"columnKind": "utf16CodeUnits",
"results": results,
"originalUriBaseIds": {
self.BASE_URI_ID: {"uri": root_path},
},
}
]
report = {
"$schema": self.SARIF_SCHEMA,
"version": self.SARIF_SCHEMA_VERSION,
"runs": runs,
}
return json.dumps(
report, default=lambda o: o.__dict__, sort_keys=False, indent=2
)
def _extract_results(
self, matches: List["MatchError"]
) -> Tuple[List[Any], List[Any]]:
rules = {}
results = []
for match in matches:
if match.rule.id not in rules:
rules[match.rule.id] = self._to_sarif_rule(match)
results.append(self._to_sarif_result(match))
return list(rules.values()), results
def _to_sarif_rule(self, match: "MatchError") -> Dict[str, Any]:
rule: Dict[str, Any] = {
"id": match.rule.id,
"name": match.rule.id,
"shortDescription": {
"text": self.escape(str(match.message)),
},
"defaultConfiguration": {
"level": self._to_sarif_level(match.rule.severity),
},
"help": {
"text": str(match.rule.description),
},
"helpUri": self.RULE_DOC_URL + "#" + match.rule.id,
"properties": {"tags": match.rule.tags},
}
if match.rule.link:
rule["helpUri"] = match.rule.link
return rule
def _to_sarif_result(self, match: "MatchError") -> Dict[str, Any]:
result: Dict[str, Any] = {
"ruleId": match.rule.id,
"message": {
"text": match.details,
},
"locations": [
{
"physicalLocation": {
"artifactLocation": {
"uri": self._format_path(match.filename or ""),
"uriBaseId": self.BASE_URI_ID,
},
"region": {
"startLine": match.linenumber,
},
},
},
],
}
if match.column:
result["locations"][0]["physicalLocation"]["region"][
"startColumn"
] = match.column
return result
@staticmethod
def _to_sarif_level(severity: str) -> str:
if severity in ["VERY_HIGH", "HIGH", "MEDIUM"]:
return "error"
if severity in ["LOW"]:
return "warning"
# VERY_LOW, INFO or anything else
return "note"