shields/services/codeclimate/codeclimate-coverage.service.js

'use strict'

const Joi = require('@hapi/joi')
const { coveragePercentage, letterScore } = require('../color-formatters')
const { keywords, isLetterGrade, fetchRepo } = require('./codeclimate-common')
const { BaseJsonService, NotFound } = require('..')

const schema = Joi.object({
  data: Joi.object({
    attributes: Joi.object({
      covered_percent: Joi.number().required(),
      rating: Joi.object({
        letter: isLetterGrade,
      }).required(),
    }).required(),
  }).allow(null),
}).required()

module.exports = class CodeclimateCoverage extends BaseJsonService {
  static get category() {
    return 'coverage'
  }

  static get route() {
    return {
      base: 'codeclimate',
      pattern: ':format(coverage|coverage-letter)/:user/:repo',
    }
  }

  static get examples() {
    return [
      {
        title: 'Code Climate coverage',
        namedParams: { format: 'coverage', user: 'jekyll', repo: 'jekyll' },
        staticPreview: this.render({
          format: 'coverage',
          percentage: 95.123,
          letter: 'A',
        }),
        keywords,
      },
    ]
  }

  static render({ wantLetter, percentage, letter }) {
    if (wantLetter) {
      return {
        message: letter,
        color: letterScore(letter),
      }
    } else {
      return {
        message: `${percentage.toFixed(0)}%`,
        color: coveragePercentage(percentage),
      }
    }
  }

  async fetch({ user, repo }) {
    const {
      id: repoId,
      relationships: {
        latest_default_branch_test_report: { data: testReportInfo },
      },
    } = await fetchRepo(this, { user, repo })
    if (testReportInfo === null) {
      throw new NotFound({ prettyMessage: 'test report not found' })
    }
    const { data } = await this._requestJson({
      schema,
      url: `https://api.codeclimate.com/v1/repos/${repoId}/test_reports/${testReportInfo.id}`,
    })
    return data
  }

  async handle({ format, user, repo }) {
    const {
      attributes: {
        rating: { letter },
        covered_percent: percentage,
      },
    } = await this.fetch({ user, repo })

    return this.constructor.render({
      wantLetter: format === 'coverage-letter',
      letter,
      percentage,
    })
  }
}