Files
shields/services/codecov/codecov.service.js
Paul Melnikow a27bef5aa5 Split “quality” into “code coverage” and “analysis” (#2723)
With the menu in place I think having more categories is helping that process because it's grouping more similar things together. Given #2722, improving our discoverability in the analysis area may be particularly useful to developers right now.
2019-01-10 21:18:43 -05:00

108 lines
3.1 KiB
JavaScript

'use strict'
const queryString = require('query-string')
const LegacyService = require('../legacy-service')
const { makeBadgeData: getBadgeData } = require('../../lib/badge-data')
const {
coveragePercentage: coveragePercentageColor,
} = require('../../lib/color-formatters')
// This legacy service should be rewritten to use e.g. BaseJsonService.
//
// Tips for rewriting:
// https://github.com/badges/shields/blob/master/doc/rewriting-services.md
//
// Do not base new services on this code.
module.exports = class Codecov extends LegacyService {
static get category() {
return 'coverage'
}
static get route() {
return {
base: 'codecov/c',
}
}
static get examples() {
return [
{
title: 'Codecov',
pattern: ':vcsName/:user/:repo',
namedParams: {
vcsName: 'github',
user: 'codecov',
repo: 'example-python',
},
staticPreview: { label: 'coverage', message: '90%', color: 'green' },
},
{
title: 'Codecov branch',
pattern: ':vcsName/:user/:repo/:branch',
namedParams: {
vcsName: 'github',
user: 'codecov',
repo: 'example-python',
branch: 'master',
},
staticPreview: { label: 'coverage', message: '90%', color: 'green' },
},
{
title: 'Codecov private',
pattern: 'token/:token/:vcsName/:user/:repo',
namedParams: {
token: 'My0A8VL917',
vcsName: 'github',
user: 'codecov',
repo: 'example-python',
},
staticPreview: { label: 'coverage', message: '90%', color: 'green' },
},
]
}
static registerLegacyRouteHandler({ camp, cache }) {
camp.route(
/^\/codecov\/c\/(?:token\/(\w+))?[+/]?([^/]+\/[^/]+\/[^/]+)(?:\/(.+))?\.(svg|png|gif|jpg|json)$/,
cache((data, match, sendBadge, request) => {
const token = match[1]
const userRepo = match[2] // eg, `github/codecov/example-python`.
const branch = match[3]
const format = match[4]
let apiUrl
if (branch) {
apiUrl = `https://codecov.io/${userRepo}/branch/${branch}/graphs/badge.txt`
} else {
apiUrl = `https://codecov.io/${userRepo}/graphs/badge.txt`
}
if (token) {
apiUrl += `?${queryString.stringify({ token })}`
}
const badgeData = getBadgeData('coverage', data)
request(apiUrl, (err, res, body) => {
if (err != null) {
badgeData.text[1] = 'invalid'
sendBadge(format, badgeData)
return
}
try {
// Body: range(0, 100) or "unknown"
const coverage = body.trim()
if (Number.isNaN(+coverage)) {
badgeData.text[1] = 'unknown'
sendBadge(format, badgeData)
return
}
badgeData.text[1] = `${coverage}%`
badgeData.colorscheme = coveragePercentageColor(coverage)
sendBadge(format, badgeData)
} catch (e) {
badgeData.text[1] = 'malformed'
sendBadge(format, badgeData)
}
})
})
)
}
}