forked from DataDog/datadog-ci
-
Notifications
You must be signed in to change notification settings - Fork 0
/
upload.ts
266 lines (228 loc) · 8.97 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
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
import fs from 'fs'
import os from 'os'
import path from 'path'
import chalk from 'chalk'
import {Command} from 'clipanion'
import {XMLParser, XMLValidator} from 'fast-xml-parser'
import glob from 'glob'
import asyncPool from 'tiny-async-pool'
import {getCISpanTags} from '../../helpers/ci'
import {getGitMetadata} from '../../helpers/git/format-git-span-data'
import {SpanTags} from '../../helpers/interfaces'
import {retryRequest} from '../../helpers/retry'
import {parseTags} from '../../helpers/tags'
import {getUserGitSpanTags} from '../../helpers/user-provided-git'
import {buildPath} from '../../helpers/utils'
import {apiConstructor} from './api'
import {APIHelper, Payload} from './interfaces'
import {
renderCommandInfo,
renderDryRunUpload,
renderFailedUpload,
renderInvalidFile,
renderRetriedUpload,
renderSuccessfulCommand,
} from './renderer'
import {getBaseIntakeUrl} from './utils'
const errorCodesStopUpload = [400, 403]
const validateXml = (xmlFilePath: string) => {
const xmlFileContentString = String(fs.readFileSync(xmlFilePath))
const validationOutput = XMLValidator.validate(xmlFileContentString)
if (validationOutput !== true) {
return validationOutput.err.msg
}
const xmlParser = new XMLParser()
const xmlFileJSON = xmlParser.parse(String(xmlFileContentString))
if (!xmlFileJSON.testsuites && !xmlFileJSON.testsuite) {
return 'Neither <testsuites> nor <testsuite> are the root tag.'
}
return undefined
}
export class UploadJUnitXMLCommand extends Command {
public static usage = Command.Usage({
description: 'Upload jUnit XML test reports files to Datadog.',
details: `
This command will upload to jUnit XML test reports files to Datadog.\n
See README for details.
`,
examples: [
['Upload all jUnit XML test report files in current directory', 'datadog-ci junit upload --service my-service .'],
[
'Upload all jUnit XML test report files in src/unit-test-reports and src/acceptance-test-reports',
'datadog-ci junit upload --service my-service src/unit-test-reports src/acceptance-test-reports',
],
[
'Upload all jUnit XML test report files in current directory and add extra tags globally',
'datadog-ci junit upload --service my-service --tags key1:value1 --tags key2:value2 .',
],
[
'Upload all jUnit XML test report files in current directory to the datadoghq.eu site',
'DATADOG_SITE=datadoghq.eu datadog-ci junit upload --service my-service .',
],
[
'Upload all jUnit XML test report files in current directory while also collecting logs',
'datadog-ci junit upload --service my-service --logs .',
],
[
'Upload all jUnit XML test report files in current directory customizing test suite with xpath',
'datadog-ci junit upload --service my-service --xpath-tag test.suite=/testcase/@classname .',
],
[
'Upload all jUnit XML test report files in current directory adding a custom tag from property with xpath',
"datadog-ci junit upload --service my-service --xpath-tag custom_tag=/testcase/..//property[@name='property-name'] .",
],
],
})
private basePaths?: string[]
private config = {
apiKey: process.env.DATADOG_API_KEY || process.env.DD_API_KEY,
env: process.env.DD_ENV,
envVarTags: process.env.DD_TAGS,
}
private dryRun = false
private env?: string
private logs = false
private maxConcurrency = 20
private service?: string
private tags?: string[]
private rawXPathTags?: string[]
private xpathTags?: Record<string, string>
public async execute() {
if (!this.service) {
this.service = process.env.DD_SERVICE
}
if (!this.service) {
this.context.stderr.write('Missing service\n')
return 1
}
if (!this.basePaths || !this.basePaths.length) {
this.context.stderr.write('Missing basePath\n')
return 1
}
if (!this.config.env) {
this.config.env = this.env
}
if (
!this.logs &&
process.env.DD_CIVISIBILITY_LOGS_ENABLED &&
!['false', '0'].includes(process.env.DD_CIVISIBILITY_LOGS_ENABLED.toLowerCase())
) {
this.logs = true
}
if (this.rawXPathTags) {
this.xpathTags = this.parseXPathTags(this.rawXPathTags)
if (Object.keys(this.xpathTags).length !== this.rawXPathTags.length) {
return 1
}
}
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))
this.context.stdout.write(renderCommandInfo(this.basePaths, this.service, this.maxConcurrency, this.dryRun))
const spanTags = await this.getSpanTags()
const payloads = await this.getMatchingJUnitXMLFiles(spanTags)
const upload = (p: Payload) => this.uploadJUnitXML(api, p)
const initialTime = new Date().getTime()
await asyncPool(this.maxConcurrency, payloads, upload)
const totalTimeSeconds = (Date.now() - initialTime) / 1000
this.context.stdout.write(
renderSuccessfulCommand(payloads.length, totalTimeSeconds, spanTags, this.service, this.config.env)
)
}
private parseXPathTags(rawXPathTags: string[]): Record<string, string> {
return rawXPathTags.reduce((xpathTags: Record<string, string>, rawExpression: string) => {
const index = rawExpression.indexOf('=')
if (index === -1) {
this.context.stderr.write('Invalid xpath-tag: missing =. Value must be <tag>=<xpath-expression>\n')
return xpathTags
}
const tagName = rawExpression.substring(0, index)
const xPath = rawExpression.substring(index + 1)
xpathTags[tagName] = xPath
return xpathTags
}, {})
}
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 getMatchingJUnitXMLFiles(spanTags: SpanTags): Promise<Payload[]> {
const jUnitXMLFiles = (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, '*.xml')))
}, [])
const validUniqueFiles = [...new Set(jUnitXMLFiles)].filter((jUnitXMLFilePath) => {
const validationErrorMessage = validateXml(jUnitXMLFilePath)
if (validationErrorMessage) {
this.context.stdout.write(renderInvalidFile(jUnitXMLFilePath, validationErrorMessage))
return false
}
return true
})
return validUniqueFiles.map((jUnitXMLFilePath) => ({
hostname: os.hostname(),
logsEnabled: this.logs,
xpathTags: this.xpathTags,
service: this.service!,
spanTags,
xmlPath: jUnitXMLFilePath,
}))
}
private async getSpanTags(): Promise<SpanTags> {
const ciSpanTags = getCISpanTags()
const gitSpanTags = await getGitMetadata()
const userGitSpanTags = getUserGitSpanTags()
const envVarTags = this.config.envVarTags ? parseTags(this.config.envVarTags.split(',')) : {}
const cliTags = this.tags ? parseTags(this.tags) : {}
return {
...gitSpanTags,
...ciSpanTags,
...userGitSpanTags,
...cliTags,
...envVarTags,
...(this.config.env ? {env: this.config.env} : {}),
}
}
private async uploadJUnitXML(api: APIHelper, jUnitXML: Payload) {
if (this.dryRun) {
this.context.stdout.write(renderDryRunUpload(jUnitXML))
return
}
try {
await retryRequest(() => api.uploadJUnitXML(jUnitXML, this.context.stdout.write.bind(this.context.stdout)), {
onRetry: (e, attempt) => {
this.context.stderr.write(renderRetriedUpload(jUnitXML, e.message, attempt))
},
retries: 5,
})
} catch (error) {
this.context.stderr.write(renderFailedUpload(jUnitXML, error))
if (error.response) {
// If it's an axios error
if (!errorCodesStopUpload.includes(error.response.status)) {
// And a status code that should not stop the whole upload, just return
return
}
}
throw error
}
}
}
UploadJUnitXMLCommand.addPath('junit', 'upload')
UploadJUnitXMLCommand.addOption('service', Command.String('--service'))
UploadJUnitXMLCommand.addOption('env', Command.String('--env'))
UploadJUnitXMLCommand.addOption('dryRun', Command.Boolean('--dry-run'))
UploadJUnitXMLCommand.addOption('tags', Command.Array('--tags'))
UploadJUnitXMLCommand.addOption('basePaths', Command.Rest({required: 1}))
UploadJUnitXMLCommand.addOption('maxConcurrency', Command.String('--max-concurrency'))
UploadJUnitXMLCommand.addOption('logs', Command.Boolean('--logs'))
UploadJUnitXMLCommand.addOption('rawXPathTags', Command.Array('--xpath-tag'))