gitlab-pipeline-status.service.js

'use strict'

const Joi = require('joi')
const BaseSvgScrapingService = require('../base-svg-scraping')
const { optionalUrl } = require('../validators')
const { NotFound } = require('../errors')
const { isPipelineStatus } = require('./gitlab-helpers')

const badgeSchema = Joi.object({
  message: Joi.alternatives()
    .try([isPipelineStatus, Joi.equal('unknown')])
    .required(),
}).required()

const queryParamSchema = Joi.object({
  gitlab_url: optionalUrl,
}).required()

module.exports = class GitlabPipelineStatus extends BaseSvgScrapingService {
  static get category() {
    return 'build'
  }

  static get route() {
    return {
      base: 'gitlab/pipeline',
      format: '([^/]+)/([^/]+)(?:/([^/]+))?',
      capture: ['user', 'repo', 'branch'],
      // Trailing optional parameters don't work. The issue relates to the `.`
      // separator before the extension.
      // pattern: ':user/:repo/:branch?',
      queryParams: ['gitlab_url'],
    }
  }

  static get examples() {
    return [
      {
        title: 'Gitlab pipeline status',
        pattern: ':user/:repo',
        namedParams: { user: 'gitlab-org', repo: 'gitlab-ce' },
        staticExample: this.render({ status: 'passed' }),
      },
      {
        title: 'Gitlab pipeline status (branch)',
        pattern: ':user/:repo/:branch',
        namedParams: {
          user: 'gitlab-org',
          repo: 'gitlab-ce',
          branch: 'master',
        },
        staticExample: this.render({ status: 'passed' }),
      },
      {
        title: 'Gitlab pipeline status (self-hosted)',
        pattern: ':user/:repo',
        namedParams: { user: 'GNOME', repo: 'pango' },
        queryParams: { gitlab_url: 'https://gitlab.gnome.org' },
        staticExample: this.render({ status: 'passed' }),
      },
    ]
  }

  static render({ status }) {
    const color = {
      pending: 'yellow',
      running: 'yellow',
      passed: 'brightgreen',
      failed: 'red',
      skipped: 'lightgray',
      canceled: 'lightgray',
    }[status]

    return {
      message: status,
      color,
    }
  }

  async handle({ user, repo, branch = 'master' }, queryParams) {
    const {
      gitlab_url: baseUrl = 'https://gitlab.com',
    } = this.constructor._validateQueryParams(queryParams, queryParamSchema)
    const { message: status } = await this._requestSvg({
      schema: badgeSchema,
      url: `${baseUrl}/${user}/${repo}/badges/${branch}/pipeline.svg`,
      errorMessages: {
        401: 'repo not found',
      },
    })
    if (status === 'unknown') {
      throw new NotFound({ prettyMessage: 'branch not found' })
    }
    return this.constructor.render({ status })
  }
}