Skip to content
Snippets Groups Projects
Select Git revision
  • 2ffad1363e42fdf0583cc98aa9fba5bfebf4b6f0
  • main default protected
  • feat/gnupg
  • next
  • fix/36615b-branch-reuse-no-cache
  • renovate/main-redis-5.x
  • chore/punycode
  • refactor/pin-new-value
  • feat/36219--git-x509-signing
  • feat/structured-logger
  • hotfix/39.264.1
  • feat/skip-dangling
  • gh-readonly-queue/next/pr-36034-7a061c4ca1024a19e2c295d773d9642625d1c2be
  • hotfix/39.238.3
  • refactor/gitlab-auto-approve
  • feat/template-strings
  • gh-readonly-queue/next/pr-35654-137d934242c784e0c45d4b957362214f0eade1d7
  • fix/32307-global-extends-merging
  • fix/32307-global-extends-repositories
  • gh-readonly-queue/next/pr-35009-046ebf7cb84ab859f7fefceb5fa53a54ce9736f8
  • gh-readonly-queue/next/pr-35009-9d5e583b7d7251148ab0d11ee8dd38149618d162
  • 41.43.5
  • 41.43.4
  • 41.43.3
  • 41.43.2
  • 41.43.1
  • 41.43.0
  • 41.42.12
  • 41.42.11
  • 41.42.10
  • 41.42.9
  • 41.42.8
  • 41.42.7
  • 41.42.6
  • 41.42.5
  • 41.42.4
  • 41.42.3
  • 41.42.2
  • 41.42.1
  • 41.42.0
  • 41.41.0
41 results

status-checks.ts

Blame
  • gitlab-pipeline-coverage.service.js 3.97 KiB
    import Joi from 'joi'
    import { coveragePercentage } from '../color-formatters.js'
    import { optionalUrl } from '../validators.js'
    import { BaseSvgScrapingService, NotFound } from '../index.js'
    import { documentation, errorMessagesFor } from './gitlab-helper.js'
    
    const schema = Joi.object({
      message: Joi.string()
        .regex(/^([0-9]+\.[0-9]+%)|unknown$/)
        .required(),
    }).required()
    
    const queryParamSchema = Joi.object({
      gitlab_url: optionalUrl,
      job_name: Joi.string(),
      branch: Joi.string(),
    }).required()
    
    const moreDocs = `
    <p>
      Important: If your project is publicly visible, but the badge is like this:
      <img src="https://img.shields.io/badge/coverage-not&nbsp;set&nbsp;up-red" alt="coverage not set up"/>
    </p>
    <p>
      Check if your pipelines are publicly visible as well.<br />
      Navigate to your project settings on GitLab and choose General Pipelines under CI/CD.<br />
      Then tick the setting Public pipelines.
    </p>
    <p>
      Now your settings should look like this:
    </p>
    <img src="https://user-images.githubusercontent.com/12065866/67156911-e225a180-f324-11e9-93ad-10aafbb3e69e.png" alt="Setting Public pipelines set"/>
    <p>
    Also make sure you have set up code covrage parsing as described <a href="https://docs.gitlab.com/ee/ci/pipelines/settings.html#test-coverage-parsing">here</a>
    </p>
    <p>
      Your badge should be working fine now.
    </p>
    `
    
    export default class GitlabPipelineCoverage extends BaseSvgScrapingService {
      static category = 'coverage'
    
      static route = {
        base: 'gitlab/pipeline-coverage',
        pattern: ':project+',
        queryParamSchema,
      }
    
      static examples = [
        {
          title: 'Gitlab code coverage',
          namedParams: { project: 'gitlab-org/gitlab-runner' },
          queryParams: { branch: 'master' },
          staticPreview: this.render({ coverage: 67 }),
          documentation: documentation + moreDocs,
        },
        {
          title: 'Gitlab code coverage (specific job)',
          namedParams: { project: 'gitlab-org/gitlab-runner' },
          queryParams: { job_name: 'test coverage report', branch: 'master' },
          staticPreview: this.render({ coverage: 96 }),
          documentation: documentation + moreDocs,
        },
        {
          title: 'Gitlab code coverage (self-managed)',
          namedParams: { project: 'GNOME/at-spi2-core' },
          queryParams: { gitlab_url: 'https://gitlab.gnome.org', branch: 'master' },
          staticPreview: this.render({ coverage: 93 }),
          documentation: documentation + moreDocs,