'use strict'
const Joi = require('@hapi/joi')
const {
testResultQueryParamSchema,
renderTestResultBadge,
} = require('../test-results')
const AzureDevOpsBase = require('./azure-devops-base')
const commonAttrs = {
keywords: ['vso', 'vsts', 'azure-devops'],
documentation: `
To obtain your own badge, you need to get 3 pieces of information:
ORGANIZATION, PROJECT and DEFINITION_ID.
First, you need to select your build definition and look at the url:
Your badge will then have the form:
https://img.shields.io/azure-devops/tests/ORGANIZATION/PROJECT/DEFINITION_ID.svg.
Optionally, you can specify a named branch:
https://img.shields.io/azure-devops/tests/ORGANIZATION/PROJECT/DEFINITION_ID/NAMED_BRANCH.svg.
You may change the "passed", "failed" and "skipped" text on this badge by supplying query parameters &passed_label=, &failed_label= and &skipped_label= respectively.
There is also a &compact_message query parameter, which will default to displaying ✔, ✘ and ➟, separated by a horizontal bar |.
For example, if you want to use a different terminology:
/azure-devops/tests/ORGANIZATION/PROJECT/DEFINITION_ID.svg?passed_label=good&failed_label=bad&skipped_label=n%2Fa
Or, use symbols:
/azure-devops/tests/ORGANIZATION/PROJECT/DEFINITION_ID.svg?compact_message&passed_label=%F0%9F%8E%89&failed_label=%F0%9F%92%A2&skipped_label=%F0%9F%A4%B7
`,
}
const buildTestResultSummarySchema = Joi.object({
aggregatedResultsAnalysis: Joi.object({
totalTests: Joi.number().required(),
resultsByOutcome: Joi.object({
Passed: Joi.object({
count: Joi.number().required(),
}).optional(),
Failed: Joi.object({
count: Joi.number().required(),
}).optional(),
Skipped: Joi.object({
count: Joi.number().required(),
}).optional(),
}).required(),
}).required(),
}).required()
module.exports = class AzureDevOpsTests extends AzureDevOpsBase {
static category = 'build'
static route = {
base: 'azure-devops/tests',
pattern: ':organization/:project/:definitionId/:branch*',
queryParamSchema: testResultQueryParamSchema,
}
static examples = [
{
title: 'Azure DevOps tests',
pattern: ':organization/:project/:definitionId',
namedParams: {
organization: 'azuredevops-powershell',
project: 'azuredevops-powershell',
definitionId: '1',
},
staticPreview: this.render({
passed: 20,
failed: 1,
skipped: 1,
total: 22,
}),
...commonAttrs,
},
{
title: 'Azure DevOps tests (branch)',
pattern: ':organization/:project/:definitionId/:branch',
namedParams: {
organization: 'azuredevops-powershell',
project: 'azuredevops-powershell',
definitionId: '1',
branch: 'master',
},
staticPreview: this.render({
passed: 20,
failed: 1,
skipped: 1,
total: 22,
}),
...commonAttrs,
},
{
title: 'Azure DevOps tests (compact)',
pattern: ':organization/:project/:definitionId',
namedParams: {
organization: 'azuredevops-powershell',
project: 'azuredevops-powershell',
definitionId: '1',
},
queryParams: {
compact_message: null,
},
staticPreview: this.render({
passed: 20,
failed: 1,
skipped: 1,
total: 22,
isCompact: true,
}),
...commonAttrs,
},
{
title: 'Azure DevOps tests with custom labels',
pattern: ':organization/:project/:definitionId',
namedParams: {
organization: 'azuredevops-powershell',
project: 'azuredevops-powershell',
definitionId: '1',
},
queryParams: {
passed_label: 'good',
failed_label: 'bad',
skipped_label: 'n/a',
},
staticPreview: this.render({
passed: 20,
failed: 1,
skipped: 1,
total: 22,
passedLabel: 'good',
failedLabel: 'bad',
skippedLabel: 'n/a',
}),
...commonAttrs,
},
]
static defaultBadgeData = { label: 'tests' }
static render({
passed,
failed,
skipped,
total,
passedLabel,
failedLabel,
skippedLabel,
isCompact,
}) {
return renderTestResultBadge({
passed,
failed,
skipped,
total,
passedLabel,
failedLabel,
skippedLabel,
isCompact,
})
}
async handle(
{ organization, project, definitionId, branch },
{
compact_message: compactMessage,
passed_label: passedLabel,
failed_label: failedLabel,
skipped_label: skippedLabel,
}
) {
const errorMessages = {
404: 'build pipeline or test result summary not found',
}
const buildId = await this.getLatestCompletedBuildId(
organization,
project,
definitionId,
branch,
errorMessages
)
// https://dev.azure.com/azuredevops-powershell/azuredevops-powershell/_apis/test/ResultSummaryByBuild?buildId=20
const json = await this.fetch({
url: `https://dev.azure.com/${organization}/${project}/_apis/test/ResultSummaryByBuild`,
options: {
qs: { buildId },
},
schema: buildTestResultSummarySchema,
errorMessages,
})
const total = json.aggregatedResultsAnalysis.totalTests
let passed = 0
const passedTests = json.aggregatedResultsAnalysis.resultsByOutcome.Passed
if (passedTests) {
passed = passedTests.count
}
let failed = 0
const failedTests = json.aggregatedResultsAnalysis.resultsByOutcome.Failed
if (failedTests) {
failed = failedTests.count
}
// assume the rest has been skipped
const skipped = total - passed - failed
const isCompact = compactMessage !== undefined
return this.constructor.render({
passed,
failed,
skipped,
total,
passedLabel,
failedLabel,
skippedLabel,
isCompact,
})
}
}