-
Notifications
You must be signed in to change notification settings - Fork 54
/
upload.ts
195 lines (160 loc) · 6.37 KB
/
upload.ts
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
import fs from 'fs'
import path from 'path'
import chalk from 'chalk'
import {Command, Option} from 'clipanion'
import glob from 'glob'
import {doWithMaxConcurrency} from '../../helpers/concurrency'
import {DatadogCiConfig} from '../../helpers/config'
import {SpanTags} from '../../helpers/interfaces'
import {retryRequest} from '../../helpers/retry'
import {GIT_SHA, getSpanTags, mandatoryGitFields} from '../../helpers/tags'
import {buildPath} from '../../helpers/utils'
import * as validation from '../../helpers/validation'
import {apiConstructor} from './api'
import {APIHelper, Payload} from './interfaces'
import {
renderCommandInfo,
renderSuccessfulCommand,
renderDryRunUpload,
renderRetriedUpload,
renderFailedUpload,
renderInvalidFile,
renderFilesNotFound,
renderMissingSpan,
} from './renderer'
import {getBaseIntakeUrl} from './utils'
import {checkForError, validateSarif} from './validation'
export class UploadSarifReportCommand extends Command {
public static paths = [['sarif', 'upload']]
public static usage = Command.Usage({
category: 'Static Analysis',
description: 'Upload SARIF reports files to Datadog.',
details: `
This command will upload SARIF reports files to Datadog.\n
See README for details.
`,
examples: [
['Upload all SARIF report files in current directory', 'datadog-ci sarif upload --service my-service .'],
[
'Upload all SARIF report files in src/sarif-go-reports and src/sarif-java-reports',
'datadog-ci sarif upload --service my-service src/sarif-go-reports src/sarif-java-reports',
],
[
'Upload all SARIF report files in current directory and add extra tags globally',
'datadog-ci sarif upload --service my-service --tags key1:value1 --tags key2:value2 .',
],
[
'Upload all SARIF report files in current directory to the datadoghq.eu site',
'DATADOG_SITE=datadoghq.eu datadog-ci sarif upload --service my-service .',
],
],
})
private basePaths = Option.Rest({required: 1})
private dryRun = Option.Boolean('--dry-run', false)
private env = Option.String('--env', 'ci')
private maxConcurrency = Option.String('--max-concurrency', '20', {validator: validation.isInteger()})
private service = Option.String('--service', 'datadog-ci')
private tags = Option.Array('--tags')
private noVerify = Option.Boolean('--no-verify', false)
private noCiTags = Option.Boolean('--no-ci-tags', false)
private config: DatadogCiConfig = {
apiKey: process.env.DATADOG_API_KEY || process.env.DD_API_KEY,
env: process.env.DD_ENV,
envVarTags: process.env.DD_TAGS,
}
public async execute() {
if (!this.basePaths || !this.basePaths.length) {
this.context.stderr.write('Missing basePath\n')
return 1
}
if (!this.config.env) {
this.config.env = this.env
}
const api = this.getApiHelper()
// Normalizing the basePath to resolve .. and .
// Always using the posix version to avoid \ on Windows.
this.basePaths = this.basePaths.map((basePath) => path.posix.normalize(basePath))
const spanTags = await getSpanTags(this.config, this.tags, !this.noCiTags)
// Check if we have all the mandatory git fields
const spanTagsKeys = Object.keys(spanTags)
const filteredSpanTags = spanTagsKeys.filter((key) => mandatoryGitFields[key])
if (filteredSpanTags.length !== Object.keys(mandatoryGitFields).length) {
this.context.stdout.write(renderMissingSpan('missing span tags (CI, git, or user-provided tags)'))
return 1
}
const payloads = await this.getMatchingSarifReports(spanTags)
if (payloads.length === 0) {
this.context.stdout.write(renderFilesNotFound(this.basePaths, this.service))
return 1
}
const sha = spanTags[GIT_SHA] || 'sha-not-found'
const env = this.config.env || 'env-not-set'
this.context.stdout.write(
renderCommandInfo(this.basePaths, this.service, env, sha, this.maxConcurrency, this.dryRun, this.noVerify)
)
const upload = (p: Payload) => this.uploadSarifReport(api, p)
const initialTime = new Date().getTime()
await doWithMaxConcurrency(this.maxConcurrency, payloads, upload)
const totalTimeSeconds = (Date.now() - initialTime) / 1000
this.context.stdout.write(renderSuccessfulCommand(payloads.length, totalTimeSeconds))
}
private async uploadSarifReport(api: APIHelper, sarifReport: Payload) {
if (this.dryRun) {
this.context.stdout.write(renderDryRunUpload(sarifReport))
return
}
try {
await retryRequest(
() => api.uploadSarifReport(sarifReport, this.context.stdout.write.bind(this.context.stdout)),
{
onRetry: (e, attempt) => {
this.context.stderr.write(renderRetriedUpload(sarifReport, e.message, attempt))
},
retries: 5,
}
)
} catch (error) {
this.context.stderr.write(renderFailedUpload(sarifReport, error))
throw error
}
}
private getApiHelper(): APIHelper {
if (!this.config.apiKey) {
this.context.stdout.write(
`Neither ${chalk.red.bold('DATADOG_API_KEY')} nor ${chalk.red.bold('DD_API_KEY')} is in your environment.\n`
)
throw new Error('API key is missing')
}
return apiConstructor(getBaseIntakeUrl(), this.config.apiKey)
}
private async getMatchingSarifReports(spanTags: SpanTags): Promise<Payload[]> {
const sarifReports = (this.basePaths || []).reduce((acc: string[], basePath: string) => {
const isFile = !!path.extname(basePath)
if (isFile) {
return acc.concat(fs.existsSync(basePath) ? [basePath] : [])
}
return acc.concat(glob.sync(buildPath(basePath, '*.sarif')))
}, [])
const validUniqueFiles = [...new Set(sarifReports)].filter((sarifReport) => {
if (this.noVerify) {
return true
}
const validationErrorMessage = validateSarif(sarifReport)
if (validationErrorMessage) {
this.context.stdout.write(renderInvalidFile(sarifReport, [validationErrorMessage]))
return false
}
const potentialErrors = checkForError(sarifReport)
if (potentialErrors.length > 0) {
this.context.stdout.write(renderInvalidFile(sarifReport, potentialErrors))
return false
}
return true
})
return validUniqueFiles.map((sarifReport) => ({
service: this.service,
reportPath: sarifReport,
spanTags,
}))
}
}