feat(azure-badge): added build, release, versions (#330)

* Update azure-pipelines.ts

Added azure build, release, and deployment versions. Support for private azure projects.

* PR comment fixes

Fixed PR comments

* Removed unused import

Removed unused import

* Removed azure token from now
pull/336/head
deepdotnet 2019-12-12 11:59:07 +05:30 zatwierdzone przez 晋晓炜 Amio /
rodzic ec13cca438
commit b9da463bc2
1 zmienionych plików z 123 dodań i 5 usunięć

Wyświetl plik

@ -1,18 +1,136 @@
import cheerio from 'cheerio'
import got from '../libs/got'
import { createBadgenHandler, PathArgs } from '../libs/create-badgen-handler'
export default createBadgenHandler({
title: 'Azure Piplines',
examples: {
'/azure-pipelines/yarnpkg/yarn/Yarn Acceptance Tests': 'build',
'/azure-pipelines/yarnpkg/yarn/Yarn Acceptance Tests/azure-pipelines': 'build (branch)',
'/azure-pipelines/build/status/yarnpkg/yarn/1': 'build status',
'/azure-pipelines/build/status/yarnpkg/yarn/1/1.21-stable': 'build status (branch)',
'/azure-pipelines/build/version/yarnpkg/yarn/1': 'build version',
'/azure-pipelines/build/version/yarnpkg/yarn/1/1.21-stable': 'build version (branch)'
},
handlers: {
'/azure-pipelines/:org/:project/:definition/:branch?': handler
'/azure-pipelines/build/status/:org/:project/:definition/:branch?': buildStatus,
'/azure-pipelines/build/version/:org/:project/:definition/:branch?': buildVersion,
'/azure-pipelines/build/test/:org/:project/:definition/:branch?': buildTestResult,
'/azure-pipelines/release/version/:org/:project/:definition?': releaseVersion,
'/azure-pipelines/deployment/version/:org/:project/:definition/:environment?': deployedReleaseVersion,
'/azure-pipelines/:org/:project/:definition/:branch?': handler,
}
})
const AZURE_DEVOPS_TOKEN = process.env.AZURE_DEVOPS_TOKEN
const colors = {
'succeeded': 'green',
'partially succeeded': 'yellow',
'partiallySucceeded': 'yellow',
'failed': 'red'
}
const statuses = {
'succeeded': 'succeeded',
'partiallySucceeded': 'partially succeeded',
'failed': 'failed'
}
const getOptions = () => {
const options = {}
if (AZURE_DEVOPS_TOKEN) options['auth'] = `:${AZURE_DEVOPS_TOKEN}`
return options
}
const getApiVersion = (preview: boolean) => preview ? '5.1-preview' : '5.1'
const azureDevOpsApiResponse = async (org: string, project: string, path: string, release: boolean = false) => {
const prefix = release ? 'vsrm.' : ''
const res = await got.get(`https://${prefix}dev.azure.com/${org}/${project}/_apis/${path}`, getOptions())
return res.body
}
async function getLatestBuild ({ org, project, definition, branch = 'master'}: PathArgs) {
const build = await azureDevOpsApiResponse(org, project, `build/builds?api-version=${getApiVersion(false)}&branchName=refs/heads/${branch}&definitions=${definition}&$top=1`)
return build.value[0]
}
async function getLatestRelease ({ org, project, definition}: PathArgs) {
return await azureDevOpsApiResponse(org, project, `release/releases?api-version=${getApiVersion(true)}&definitionId=${definition}&$top=1`, true)
}
async function getDeployedRelease ({ org, project, definition, environment}: PathArgs) {
return await azureDevOpsApiResponse(org, project, `release/deployments?api-version=${getApiVersion(true)}&definitionId=${definition}&$top=1&deploymentStatus=succeeded&definitionEnvironmentId=${environment}`, true)
}
async function getTestResultByBuild ({ org, project, build, minLastUpdatedDate, maxLastUpdatedDate}: PathArgs) {
return await azureDevOpsApiResponse(org, project, `test/runs?api-version=${getApiVersion(true)}&$top=1&buildIds=${build}&minLastUpdatedDate=${minLastUpdatedDate}&maxLastUpdatedDate=${maxLastUpdatedDate}`)
}
async function buildStatus ({ org, project, definition, branch = 'master'}: PathArgs) {
const response = await getLatestBuild({org, project, definition, branch})
const status = statuses[response.result]
const color = colors[response.result]
return {
subject: 'Build',
status,
color
}
}
async function buildVersion ({ org, project, definition, branch = 'master'}: PathArgs) {
const response = await getLatestBuild({org, project, definition, branch})
const version = response.buildNumber
const color = colors[response.result]
return {
subject: 'Build Version',
status: version,
color
}
}
async function buildTestResult ({ org, project, definition, branch = 'master'}: PathArgs) {
const build = await getLatestBuild({org, project, definition, branch})
const testResult = await getTestResultByBuild({org, project, build: build.id, minLastUpdatedDate: build.startTime, maxLastUpdatedDate: build.finishTime})
const runStatistics = testResult.value[0].runStatistics
const total: number = testResult.value[0].totalTests
const passed: {outcome: string, count: number} = runStatistics.find( (value: { outcome: string; }) => value.outcome === 'Passed')
const notExecuted: {outcome: string, count: number} = runStatistics.find( (value: { outcome: string; }) => value.outcome === 'NotExecuted')
const failed: {outcome: string, count: number} = runStatistics.find( (value: { outcome: string; }) => value.outcome === 'Failed')
const passedCount = passed?.count ?? 0
const notExecutedCount = notExecuted?.count ?? 0
const failedCount = failed?.count ?? total - passedCount - notExecutedCount
const status = total == passedCount ? 'succeeded' : total == failedCount ? 'failed' : 'partially succeeded'
const color = colors[status]
return {
subject: 'Test',
status: `passed: ${passedCount}, failed: ${failedCount}, ignored: ${notExecutedCount}`,
color
}
}
async function releaseVersion ({ org, project, definition}: PathArgs) {
const response = await getLatestRelease({org, project, definition})
const status = response.value[0].name
const color = colors['succeeded']
return {
subject: 'Release Version',
status,
color
}
}
async function deployedReleaseVersion ({ org, project, definition, environment}: PathArgs) {
const response = await getDeployedRelease({org, project, definition, environment})
const status = response.value[0].release.name
const color = colors['succeeded']
return {
subject: 'Deployed Version',
status,
color
}
}
async function handler ({ org, project, definition, branch = 'master'}: PathArgs) {
// @ts-ignore
const response = await got(`https://dev.azure.com/${org}/${project}/_apis/build/status/${definition}?branchName=${branch}`, { json: false })
@ -39,4 +157,4 @@ async function handler ({ org, project, definition, branch = 'master'}: PathArgs
status,
color
}
}
}