FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
codeql-action/src/cli-errors.ts at main · github/codeql-action · GitHub
Uh oh!
There was an error while loading.
Please reload this page
.
github
/
codeql-action
Public
Notifications
You must be signed in to change notification settings
Fork
488
Star
1.6k
Code
Issues
158
Pull requests
35
Actions
Security and quality
2
Insights
Additional navigation options
Code
Issues
Pull requests
Actions
Security and quality
Insights
Expand file tree
Breadcrumbs
codeql-action
/
src
/
cli-errors.ts
Copy path
More file actions
More file actions
Latest commit
History
History
History
379 lines (358 loc) · 13 KB
Breadcrumbs
codeql-action
/
src
/
cli-errors.ts
Copy path
File metadata and controls
379 lines (358 loc) · 13 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
import
{
CommandInvocationError
,
ensureEndsInPeriod
,
prettyPrintInvocation
,
}
from
"./actions-util"
;
import
{
DocUrl
}
from
"./doc-url"
;
import
{
ConfigurationError
}
from
"./util"
;
const
SUPPORTED_PLATFORMS
=
[
[
"linux"
,
"x64"
]
,
[
"win32"
,
"x64"
]
,
[
"darwin"
,
"x64"
]
,
[
"darwin"
,
"arm64"
]
,
]
;
/**
* An error from a CodeQL CLI invocation, with associated exit code, stderr, etc.
*/
export
class
CliError
extends
Error
{
public
readonly
exitCode
:
number
|
undefined
;
public
readonly
stderr
:
string
;
constructor
(
{
cmd
,
args
,
exitCode
,
stderr
}
:
CommandInvocationError
)
{
const
prettyCommand
=
prettyPrintInvocation
(
cmd
,
args
)
;
const
fatalErrors
=
extractFatalErrors
(
stderr
)
;
const
autobuildErrors
=
extractAutobuildErrors
(
stderr
)
;
let
message
:
string
;
if
(
fatalErrors
)
{
message
=
`Encountered a fatal error while running "
${
prettyCommand
}
". `
+
`Exit code was
${
exitCode
}
and error was:
${
ensureEndsInPeriod
(
fatalErrors
.
trim
(
)
,
)
}
See the logs for more details.`
;
}
else
if
(
autobuildErrors
)
{
message
=
"We were unable to automatically build your code. Please provide manual build steps. "
+
`See
${
DocUrl
.
AUTOMATIC_BUILD_FAILED
}
for more information. `
+
`Encountered the following error:
${
autobuildErrors
}
`
;
}
else
{
const
lastLine
=
ensureEndsInPeriod
(
stderr
.
trim
(
)
.
split
(
"\n"
)
.
pop
(
)
?.
trim
(
)
||
"n/a"
,
)
;
message
=
`Encountered a fatal error while running "
${
prettyCommand
}
". `
+
`Exit code was
${
exitCode
}
and last log line was:
${
lastLine
}
See the logs for more details.`
;
}
super
(
message
)
;
this
.
exitCode
=
exitCode
;
this
.
stderr
=
stderr
;
}
}
/**
* Provide a better error message from the stderr of a CLI invocation that failed with a fatal
* error.
*
* - If the CLI invocation failed with a fatal error, this returns that fatal error, followed by
* any fatal errors that occurred in plumbing commands.
* - If the CLI invocation did not fail with a fatal error, this returns `undefined`.
*
* ### Example
*
* ```
* Running TRAP import for CodeQL database at /home/runner/work/_temp/codeql_databases/javascript...
* A fatal error occurred: Evaluator heap must be at least 384.00 MiB
* A fatal error occurred: Dataset import for
* /home/runner/work/_temp/codeql_databases/javascript/db-javascript failed with code 2
* ```
*
* becomes
*
* ```
* Encountered a fatal error while running "codeql-for-testing database finalize --finalize-dataset
* --threads=2 --ram=2048 db". Exit code was 32 and error was: A fatal error occurred: Dataset
* import for /home/runner/work/_temp/codeql_databases/javascript/db-javascript failed with code 2.
* Context: A fatal error occurred: Evaluator heap must be at least 384.00 MiB.
* ```
*
* Where possible, this tries to summarize the error into a single line, as this displays better in
* the Actions UI.
*/
function
extractFatalErrors
(
error
:
string
)
:
string
|
undefined
{
const
fatalErrorRegex
=
/
.
*
f
a
t
a
l
(
i
n
t
e
r
n
a
l
)
?
e
r
r
o
r
o
c
c
u
r
r
?
e
d
(
.
D
e
t
a
i
l
s
)
?
:
/
gi
;
let
fatalErrors
:
string
[
]
=
[
]
;
let
lastFatalErrorIndex
:
number
|
undefined
;
let
match
:
RegExpMatchArray
|
null
;
while
(
(
match
=
fatalErrorRegex
.
exec
(
error
)
)
!==
null
)
{
if
(
lastFatalErrorIndex
!==
undefined
)
{
fatalErrors
.
push
(
error
.
slice
(
lastFatalErrorIndex
,
match
.
index
)
.
trim
(
)
)
;
}
lastFatalErrorIndex
=
match
.
index
;
}
if
(
lastFatalErrorIndex
!==
undefined
)
{
const
lastError
=
error
.
slice
(
lastFatalErrorIndex
)
.
trim
(
)
;
if
(
fatalErrors
.
length
===
0
)
{
// No other errors
return
lastError
;
}
const
isOneLiner
=
!
fatalErrors
.
some
(
(
e
)
=>
e
.
includes
(
"\n"
)
)
;
if
(
isOneLiner
)
{
fatalErrors
=
fatalErrors
.
map
(
ensureEndsInPeriod
)
;
}
return
[
ensureEndsInPeriod
(
lastError
)
,
"Context:"
,
...
fatalErrors
.
reverse
(
)
,
]
.
join
(
isOneLiner
?
" "
:
"\n"
)
;
}
return
undefined
;
}
function
extractAutobuildErrors
(
error
:
string
)
:
string
|
undefined
{
const
pattern
=
/
.
*
\[
a
u
t
o
b
u
i
l
d
\]
\[
E
R
R
O
R
\]
(
.
*
)
/
gi
;
let
errorLines
=
[
...
error
.
matchAll
(
pattern
)
]
.
map
(
(
match
)
=>
match
[
1
]
)
;
// Truncate if there are more than 10 matching lines.
if
(
errorLines
.
length
>
10
)
{
errorLines
=
errorLines
.
slice
(
0
,
10
)
;
errorLines
.
push
(
"(truncated)"
)
;
}
return
errorLines
.
join
(
"\n"
)
||
undefined
;
}
/** Error messages from the CLI that we consider configuration errors and handle specially. */
export
enum
CliConfigErrorCategory
{
AutobuildError
=
"AutobuildError"
,
CouldNotCreateTempDir
=
"CouldNotCreateTempDir"
,
ExternalRepositoryCloneFailed
=
"ExternalRepositoryCloneFailed"
,
GradleBuildFailed
=
"GradleBuildFailed"
,
IncompatibleWithActionVersion
=
"IncompatibleWithActionVersion"
,
InitCalledTwice
=
"InitCalledTwice"
,
InvalidConfigFile
=
"InvalidConfigFile"
,
InvalidExternalRepoSpecifier
=
"InvalidExternalRepoSpecifier"
,
InvalidSourceRoot
=
"InvalidSourceRoot"
,
MavenBuildFailed
=
"MavenBuildFailed"
,
NoBuildCommandAutodetected
=
"NoBuildCommandAutodetected"
,
NoBuildMethodAutodetected
=
"NoBuildMethodAutodetected"
,
NoSourceCodeSeen
=
"NoSourceCodeSeen"
,
NoSupportedBuildCommandSucceeded
=
"NoSupportedBuildCommandSucceeded"
,
NoSupportedBuildSystemDetected
=
"NoSupportedBuildSystemDetected"
,
NotFoundInRegistry
=
"NotFoundInRegistry"
,
OutOfMemoryOrDisk
=
"OutOfMemoryOrDisk"
,
PackCannotBeFound
=
"PackCannotBeFound"
,
PackMissingAuth
=
"PackMissingAuth"
,
SwiftIncompatibleOs
=
"SwiftIncompatibleOs"
,
SwiftBuildFailed
=
"SwiftBuildFailed"
,
UnsupportedBuildMode
=
"UnsupportedBuildMode"
,
}
type
CliErrorConfiguration
=
{
/** One of these candidates, or the exit code, must be present in the error message. */
cliErrorMessageCandidates
:
RegExp
[
]
;
exitCode
?:
number
;
additionalErrorMessageToAppend
?:
string
;
}
;
/**
* All of our caught CLI error messages that we handle specially: ie. if we
* would like to categorize an error as a configuration error or not.
*/
const
cliErrorsConfig
:
Record
<
CliConfigErrorCategory
,
CliErrorConfiguration
>
=
{
[
CliConfigErrorCategory
.
AutobuildError
]
:
{
cliErrorMessageCandidates
:
[
new
RegExp
(
"We were unable to automatically build your code"
)
,
]
,
}
,
[
CliConfigErrorCategory
.
CouldNotCreateTempDir
]
:
{
cliErrorMessageCandidates
:
[
new
RegExp
(
"Could not create temp directory"
)
]
,
}
,
[
CliConfigErrorCategory
.
ExternalRepositoryCloneFailed
]
:
{
cliErrorMessageCandidates
:
[
new
RegExp
(
"Failed to clone external Git repository"
)
,
]
,
}
,
[
CliConfigErrorCategory
.
GradleBuildFailed
]
:
{
cliErrorMessageCandidates
:
[
new
RegExp
(
"\\[autobuild\\] FAILURE: Build failed with an exception."
)
,
]
,
}
,
// Version of CodeQL CLI is incompatible with this version of the CodeQL Action
[
CliConfigErrorCategory
.
IncompatibleWithActionVersion
]
:
{
cliErrorMessageCandidates
:
[
new
RegExp
(
"is not compatible with this CodeQL CLI"
)
,
]
,
}
,
[
CliConfigErrorCategory
.
InitCalledTwice
]
:
{
cliErrorMessageCandidates
:
[
new
RegExp
(
"Refusing to create databases .* but could not process any of it"
,
)
,
]
,
additionalErrorMessageToAppend
:
`Is the "init" action called twice in the same job?`
,
}
,
[
CliConfigErrorCategory
.
InvalidConfigFile
]
:
{
cliErrorMessageCandidates
:
[
new
RegExp
(
"Config file .* is not valid"
)
,
new
RegExp
(
"The supplied config file is empty"
)
,
]
,
}
,
[
CliConfigErrorCategory
.
InvalidExternalRepoSpecifier
]
:
{
cliErrorMessageCandidates
:
[
new
RegExp
(
"Specifier for external repository is invalid"
)
,
]
,
}
,
// Expected source location for database creation does not exist
[
CliConfigErrorCategory
.
InvalidSourceRoot
]
:
{
cliErrorMessageCandidates
:
[
new
RegExp
(
"Invalid source root"
)
]
,
}
,
[
CliConfigErrorCategory
.
MavenBuildFailed
]
:
{
cliErrorMessageCandidates
:
[
new
RegExp
(
"\\[autobuild\\] \\[ERROR\\] Failed to execute goal"
)
,
]
,
}
,
[
CliConfigErrorCategory
.
NoBuildCommandAutodetected
]
:
{
cliErrorMessageCandidates
:
[
new
RegExp
(
"Could not auto-detect a suitable build method"
)
,
]
,
}
,
[
CliConfigErrorCategory
.
NoBuildMethodAutodetected
]
:
{
cliErrorMessageCandidates
:
[
new
RegExp
(
"Could not detect a suitable build command for the source checkout"
,
)
,
]
,
}
,
// Usually when a manual build script has failed, or if an autodetected language
// was unintended to have CodeQL analysis run on it.
[
CliConfigErrorCategory
.
NoSourceCodeSeen
]
:
{
exitCode
:
32
,
cliErrorMessageCandidates
:
[
new
RegExp
(
"CodeQL detected code written in .* but could not process any of it"
,
)
,
new
RegExp
(
"CodeQL did not detect any code written in languages supported by CodeQL"
,
)
,
]
,
}
,
[
CliConfigErrorCategory
.
NoSupportedBuildCommandSucceeded
]
:
{
cliErrorMessageCandidates
:
[
new
RegExp
(
"No supported build command succeeded"
)
,
]
,
}
,
[
CliConfigErrorCategory
.
NoSupportedBuildSystemDetected
]
:
{
cliErrorMessageCandidates
:
[
new
RegExp
(
"No supported build system detected"
)
,
]
,
}
,
[
CliConfigErrorCategory
.
OutOfMemoryOrDisk
]
:
{
cliErrorMessageCandidates
:
[
new
RegExp
(
"CodeQL is out of memory."
)
,
new
RegExp
(
"out of disk"
)
,
new
RegExp
(
"No space left on device"
)
,
]
,
additionalErrorMessageToAppend
:
"For more information, see https://gh.io/troubleshooting-code-scanning/out-of-disk-or-memory"
,
}
,
[
CliConfigErrorCategory
.
PackCannotBeFound
]
:
{
cliErrorMessageCandidates
:
[
new
RegExp
(
"Query pack .* cannot be found\\. Check the spelling of the pack\\."
,
)
,
new
RegExp
(
"is not a .ql file, .qls file, a directory, or a query pack specification."
,
)
,
]
,
}
,
[
CliConfigErrorCategory
.
PackMissingAuth
]
:
{
cliErrorMessageCandidates
:
[
new
RegExp
(
"GitHub Container registry .* 403 Forbidden"
)
,
new
RegExp
(
"Do you need to specify a token to authenticate to the registry?"
,
)
,
]
,
}
,
[
CliConfigErrorCategory
.
SwiftBuildFailed
]
:
{
cliErrorMessageCandidates
:
[
new
RegExp
(
"\\[autobuilder/build\\] \\[build-command-failed\\] `autobuild` failed to run the build command"
,
)
,
]
,
}
,
[
CliConfigErrorCategory
.
SwiftIncompatibleOs
]
:
{
cliErrorMessageCandidates
:
[
new
RegExp
(
"\\[incompatible-os\\]"
)
,
new
RegExp
(
"Swift analysis is only supported on macOS"
)
,
]
,
}
,
[
CliConfigErrorCategory
.
UnsupportedBuildMode
]
:
{
cliErrorMessageCandidates
:
[
new
RegExp
(
"does not support the .* build mode. Please try using one of the following build modes instead"
,
)
,
]
,
}
,
[
CliConfigErrorCategory
.
NotFoundInRegistry
]
:
{
cliErrorMessageCandidates
:
[
new
RegExp
(
"'.*' not found in the registry '.*'"
)
,
]
,
}
,
}
;
/**
* Check if the given CLI error or exit code, if applicable, apply to any known
* CLI errors in the configuration record. If either the CLI error message matches one of
* the error messages in the config record, or the exit codes match, return the error category;
* if not, return undefined.
*/
function
getCliConfigCategoryIfExists
(
cliError
:
CliError
,
)
:
CliConfigErrorCategory
|
undefined
{
for
(
const
[
category
,
configuration
]
of
Object
.
entries
(
cliErrorsConfig
)
)
{
if
(
cliError
.
exitCode
!==
undefined
&&
configuration
.
exitCode
!==
undefined
&&
cliError
.
exitCode
===
configuration
.
exitCode
)
{
return
category
as
CliConfigErrorCategory
;
}
for
(
const
e
of
configuration
.
cliErrorMessageCandidates
)
{
if
(
cliError
.
message
.
match
(
e
)
||
cliError
.
stderr
.
match
(
e
)
)
{
return
category
as
CliConfigErrorCategory
;
}
}
}
return
undefined
;
}
/**
* Check if we are running on an unsupported platform/architecture combination.
*/
function
isUnsupportedPlatform
(
)
:
boolean
{
return
!
SUPPORTED_PLATFORMS
.
some
(
(
[
platform
,
arch
]
)
=>
platform
===
process
.
platform
&&
arch
===
process
.
arch
,
)
;
}
/**
* Transform a CLI error into a ConfigurationError for an unsupported platform.
*/
function
getUnsupportedPlatformError
(
cliError
:
CliError
)
:
ConfigurationError
{
return
new
ConfigurationError
(
"The CodeQL CLI does not support the platform/architecture combination of "
+
`
${
process
.
platform
}
/
${
process
.
arch
}
`
+
`(see
${
DocUrl
.
SYSTEM_REQUIREMENTS
}
). `
+
`The underlying error was:
${
cliError
.
message
}
`
,
)
;
}
/**
* Changes an error received from the CLI to a ConfigurationError with the message
* optionally being transformed, if it is a known configuration error. Otherwise,
* simply returns the original error.
*/
export
function
wrapCliConfigurationError
(
cliError
:
CliError
)
:
Error
{
if
(
isUnsupportedPlatform
(
)
)
{
return
getUnsupportedPlatformError
(
cliError
)
;
}
const
cliConfigErrorCategory
=
getCliConfigCategoryIfExists
(
cliError
)
;
if
(
cliConfigErrorCategory
===
undefined
)
{
return
cliError
;
}
let
errorMessageBuilder
=
cliError
.
message
;
const
additionalErrorMessageToAppend
=
cliErrorsConfig
[
cliConfigErrorCategory
]
.
additionalErrorMessageToAppend
;
if
(
additionalErrorMessageToAppend
!==
undefined
)
{
errorMessageBuilder
=
`
${
errorMessageBuilder
}
${
additionalErrorMessageToAppend
}
`
;
}
return
new
ConfigurationError
(
errorMessageBuilder
)
;
}
Back
|
FazBrowse Home
|
New Git URL