shields/services/coveralls/coveralls.service.js

'use strict'

const Joi = require('@hapi/joi')
const { coveragePercentage } = require('../color-formatters')
const { BaseJsonService } = require('..')

const schema = Joi.object({
  covered_percent: Joi.number().min(0).max(100).required(),
}).required()

module.exports = class Coveralls extends BaseJsonService {
  static category = 'coverage'
  static route = {
    base: 'coveralls',
    pattern: ':vcsType(github|bitbucket)?/:user/:repo/:branch*',
  }

  static examples = [
    {
      title: 'Coveralls github',
      pattern: ':vcsType/:user/:repo',
      namedParams: { vcsType: 'github', user: 'jekyll', repo: 'jekyll' },
      staticPreview: this.render({ coverage: 86 }),
    },
    {
      title: 'Coveralls github branch',
      pattern: ':vcsType/:user/:repo/:branch',
      namedParams: {
        vcsType: 'github',
        user: 'lemurheavy',
        repo: 'coveralls-ruby',
        branch: 'master',
      },
      staticPreview: this.render({ coverage: 91.81 }),
    },
    {
      title: 'Coveralls bitbucket',
      pattern: ':vcsType/:user/:repo',
      namedParams: { vcsType: 'bitbucket', user: 'pyKLIP', repo: 'pyklip' },
      staticPreview: this.render({ coverage: 86 }),
    },
    {
      title: 'Coveralls bitbucket branch',
      pattern: ':vcsType/:user/:repo/:branch',
      namedParams: {
        vcsType: 'bitbucket',
        user: 'pyKLIP',
        repo: 'pyklip',
        branch: 'master',
      },
      staticPreview: this.render({ coverage: 96 }),
    },
  ]

  static defaultBadgeData = { label: 'coverage' }

  static render({ coverage }) {
    return {
      message: `${coverage.toFixed(0)}%`,
      color: coveragePercentage(coverage),
    }
  }

  async fetch({ vcsType, user, repo, branch }) {
    // https://docs.coveralls.io/api-introduction#getting-data-from-coveralls
    const url = `https://coveralls.io/${
      vcsType || 'github'
    }/${user}/${repo}.json`
    const options = {
      qs: {
        // The API returns the latest result (across any branch) if no branch is explicitly specified,
        // whereas the Coveralls native badge (and the Shields.io badges for Coveralls) show
        // the coverage for the default branch if no branch is explicitly specified. If the user
        // doesn't specify their desired badge, then we can get the Coverage for the latest branch
        // from the API by specifying an invalid branch name in which case the API returns the coverage
        // for the default branch. This ensures we show the same percentage value.
        branch: branch || '@',
      },
    }

    return this._requestJson({
      schema,
      url,
      options,
      errorMessages: {
        404: 'repository not found',
      },
    })
  }

  async handle({ vcsType, user, repo, branch }) {
    const json = await this.fetch({ vcsType, user, repo, branch })
    return this.constructor.render({ coverage: json.covered_percent })
  }
}