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
|
{ "defaults":
{ "doc":
[ "A rule to provide default paths common to all lint targets."
, ""
, "While lint targets bring their own host directory via the"
, "field \"config\", it can still be necessary to bring some"
, "default paths, e.g., for finding the compiler, or the interpreter"
, "for the runner."
]
, "string_fields": ["PATH"]
, "target_fields": ["base"]
, "field_doc":
{ "base": ["Other targets to inherit values from."]
, "PATH":
[ "Paths for looking up system tools."
, "Specifying this field extends values from \"base\"."
]
}
, "imports": {"base-provides-++": ["CC", "defaults-base-provides-++"]}
, "expression":
{ "type": "let*"
, "bindings":
[ [ "PATH"
, { "type": "nub_left"
, "$1":
{ "type": "++"
, "$1":
[ {"type": "FIELD", "name": "PATH"}
, { "type": "let*"
, "bindings": [["provider", "PATH"]]
, "body":
{"type": "CALL_EXPRESSION", "name": "base-provides-++"}
}
]
}
}
]
]
, "body": {"type": "RESULT", "provides": {"type": "env", "vars": ["PATH"]}}
}
}
, "targets":
{ "doc":
[ "Run a given linter on the lint information provided by the given targets."
]
, "target_fields": ["linter", "config", "summarizer", "targets"]
, "string_fields": ["name"]
, "tainted": ["lint"]
, "field_doc":
{ "linter":
[ "Single artifact running the lint checks."
, ""
, "This program is invoked with"
, "- argv[1] the file to lint, and"
, "- argv[2:] the original command line."
, "This invocation happens in an environment with"
, "- CONFIG pointing to the directory with all the artifacts given"
, " by the field \"config\", and"
, "- OUT pointing to a directory to which files with the lint result"
, " can be written."
, "- META pointing to a json file containing"
, " - at key \"direct deps artifact names\" a list of all input"
, " artifacts that come from the target itself or are runfiles of a"
, " direct dependency."
, " - at key \"extra outs\" a list of extra output artifacts that the"
, " command might produce, such as DWARF objects if debug fission is"
, " enabled."
, "- TMPDIR pointing to a directory location that can be used to"
, " create additional temporary files."
, "It is supposed to indicate by the exit code whether the file to lint"
, "complies with the given linting policy, with 0 meaning"
, "compliant."
, "Stdout and stderr, as well as the directory ${OUT} can be used to"
, "provide additional information."
]
, "config": ["Any configuration or other files needed by the linter."]
, "summarizer":
[ "Single artifact generating a summary of the individual lint results."
, "It will be called in a directory where all subdirectories"
, "except . and .. represent the results of the individual lint"
, "actions. Those are given as"
, " - a file \"result\" with content \"PASS\" if and only if the lint"
, " action exited 0,"
, " - files \"stdout\" and \"stderr\" with stdout and stderr of the lint"
, " action, and"
, " - a directory \"out\" with the additional information provided by the"
, " lint action."
, "The summarizer is required to indicate the overall result by the exit"
, "code, produce a human-readable summary on stdout, and optionally"
, "additional information in the directory ${OUT}."
]
, "call_lint": ["Launcher for the linter"]
, "call_summary": ["Launcher for the summarizer"]
, "name":
[ "Name of the kind of lint check performed, to be reported"
, "when an action is failing."
]
}
, "implicit":
{ "defaults": ["defaults"]
, "call_lint": ["call_lint"]
, "call_summary": ["call_summary"]
}
, "config_transitions": {"targets": [{"type": "'", "$1": {"LINT": true}}]}
, "anonymous":
{"lint": {"target": "targets", "provider": "lint", "rule_map": {}}}
, "imports":
{ "stage": ["", "stage_singleton_field"]
, "artifacts": ["", "field_artifacts"]
, "default-PATH": ["CC", "default-PATH"]
}
, "expression":
{ "type": "let*"
, "bindings":
[ [ "linter"
, { "type": "let*"
, "bindings": [["fieldname", "linter"], ["location", "linter"]]
, "body": {"type": "CALL_EXPRESSION", "name": "stage"}
}
]
, [ "runner"
, { "type": "let*"
, "bindings": [["fieldname", "call_lint"], ["location", "runner"]]
, "body": {"type": "CALL_EXPRESSION", "name": "stage"}
}
]
, [ "config"
, { "type": "let*"
, "bindings": [["fieldname", "config"]]
, "body": {"type": "CALL_EXPRESSION", "name": "artifacts"}
}
]
, [ "PATH"
, { "type": "join"
, "separator": ":"
, "$1": {"type": "CALL_EXPRESSION", "name": "default-PATH"}
}
]
, ["name", {"type": "join", "$1": {"type": "FIELD", "name": "name"}}]
, [ "lint results"
, { "type": "foreach"
, "range": {"type": "FIELD", "name": "lint"}
, "body":
{ "type": "let*"
, "bindings":
[ [ "src"
, { "type": "DEP_PROVIDES"
, "dep": {"type": "var", "name": "_"}
, "provider": "src"
}
]
, [ "cmd"
, { "type": "DEP_PROVIDES"
, "dep": {"type": "var", "name": "_"}
, "provider": "cmd"
}
]
, [ "src input"
, { "type": "DEP_ARTIFACTS"
, "dep": {"type": "var", "name": "_"}
}
]
, [ "direct deps artifact names"
, { "type": "DEP_PROVIDES"
, "dep": {"type": "var", "name": "_"}
, "provider": "direct deps artifact names"
}
]
, [ "extra outs"
, { "type": "DEP_PROVIDES"
, "dep": {"type": "var", "name": "_"}
, "provider": "extra outs"
}
]
]
, "body":
{ "type": "TREE"
, "$1":
{ "type": "ACTION"
, "inputs":
{ "type": "map_union"
, "$1":
[ {"type": "var", "name": "runner"}
, {"type": "var", "name": "linter"}
, { "type": "to_subdir"
, "subdir": "work"
, "$1": {"type": "var", "name": "src input"}
}
, { "type": "to_subdir"
, "subdir": "config"
, "$1": {"type": "var", "name": "config"}
}
, { "type": "singleton_map"
, "key": "meta.json"
, "value":
{ "type": "BLOB"
, "data":
{ "type": "json_encode"
, "$1":
{ "type": "env"
, "vars":
["direct deps artifact names", "extra outs"]
}
}
}
}
]
}
, "cmd":
{ "type": "++"
, "$1":
[ ["./runner", {"type": "var", "name": "src"}]
, {"type": "var", "name": "cmd"}
]
}
, "env": {"type": "env", "vars": ["PATH"]}
, "outs": ["stdout", "stderr", "result"]
, "out_dirs": ["out"]
, "may_fail": ["lint"]
, "fail_message":
{ "type": "join"
, "$1":
[ "lint "
, {"type": "var", "name": "name"}
, { "type": "if"
, "cond": {"type": "var", "name": "name"}
, "then": " failed for "
, "else": "failed for "
}
, {"type": "var", "name": "src"}
]
}
}
}
}
}
]
, [ "lint results"
, {"type": "nub_right", "$1": {"type": "var", "name": "lint results"}}
]
, [ "summary input"
, {"type": "enumerate", "$1": {"type": "var", "name": "lint results"}}
]
, [ "summarizer"
, { "type": "let*"
, "bindings":
[["fieldname", "summarizer"], ["location", "summarizer"]]
, "body": {"type": "CALL_EXPRESSION", "name": "stage"}
}
]
, [ "runner"
, { "type": "let*"
, "bindings": [["fieldname", "call_summary"], ["location", "runner"]]
, "body": {"type": "CALL_EXPRESSION", "name": "stage"}
}
]
, [ "summary"
, { "type": "ACTION"
, "inputs":
{ "type": "map_union"
, "$1":
[ {"type": "var", "name": "runner"}
, {"type": "var", "name": "summarizer"}
, { "type": "to_subdir"
, "subdir": "work"
, "$1": {"type": "var", "name": "summary input"}
}
]
}
, "cmd": ["./runner"]
, "outs": ["report", "result"]
, "out_dirs": ["out"]
}
]
]
, "body":
{ "type": "RESULT"
, "artifacts":
{ "type": "map_union"
, "$1":
[ {"type": "var", "name": "summary"}
, { "type": "singleton_map"
, "key": "work"
, "value":
{"type": "TREE", "$1": {"type": "var", "name": "summary input"}}
}
]
}
}
}
}
}
|
