danger-plugin-coverage/tests/specs/settings.spec.js

A Danger plugin to report code coverage.

import path from 'path';
import mockFs from 'mock-fs';

import coverage from '../../src';
import { CLOVER_PATH, DEFAULT_METRICS, DEFAULT_LINE } from '../constants';
import {
  getFileXml,
  getMarkdownReport,
  setupEnv,
  wrapXmlReport,
} from '../utils';

describe('Settings', () => {
  beforeEach(setupEnv);

  afterEach(() => {
    mockFs.restore();
  });

  it('reports with a custom success message', async () => {
    const file = getFileXml('src/one.js', DEFAULT_METRICS, [DEFAULT_LINE]);
    const xmlReport = wrapXmlReport(file);

    mockFs({
      [CLOVER_PATH]: xmlReport,
    });

    Object.assign(danger, {
      git: {
        created_files: ['src/one.js'],
        modified_files: [],
      },
    });

    await coverage({
      successMessage: 'All good',
    });

    const report = getMarkdownReport();
    const lines = report.split('\n');

    expect(lines).toContain('> All good');
  });

  it('reports with a custom failure message', async () => {
    const file = getFileXml('src/one.js', {
      statements: 10,
      coveredstatements: 0,
      conditionals: 10,
      coveredconditionals: 0,
      methods: 10,
      coveredmethods: 0,
    }, [DEFAULT_LINE]);
    const xmlReport = wrapXmlReport(file);

    mockFs({
      [CLOVER_PATH]: xmlReport,
    });

    Object.assign(danger, {
      git: {
        created_files: ['src/one.js'],
        modified_files: [],
      },
    });

    await coverage({
      failureMessage: 'Not good',
    });

    const report = getMarkdownReport();
    const lines = report.split('\n');

    expect(lines).toContain('> Not good');
  });

  it('loads the report from a custom path', async () => {
    const file = getFileXml('from-custom-report.js', DEFAULT_METRICS, [DEFAULT_LINE]);
    const xmlReport = wrapXmlReport(file);

    const cloverReportPath = './custom/path/to/clover.xml';

    mockFs({
      [path.join(process.cwd(), cloverReportPath)]: xmlReport,
    });

    Object.assign(danger, {
      git: {
        created_files: ['from-custom-report.js'],
        modified_files: [],
      },
    });

    await coverage({ cloverReportPath });

    const report = getMarkdownReport();
    const lines = report.split('\n');

    expect(lines).toContain('|from-custom-report.js|100|100|100|100||:white_check_mark:|');
  });

  it('limits the number of rows', async () => {
    const files = new Array(10).fill().map((_, i) => (
      getFileXml(i, DEFAULT_METRICS, [DEFAULT_LINE])
    ));
    const xmlReport = wrapXmlReport(files.join('\n'));

    mockFs({
      [CLOVER_PATH]: xmlReport,
    });

    Object.assign(danger, {
      git: {
        created_files: new Array(10).fill().map((_, i) => String(i)),
        modified_files: [],
      },
    });

    await coverage({ maxRows: 2 });

    const report = getMarkdownReport();
    const lines = report.split('\n');

    expect(report).toMatchSnapshot();
    expect(lines).toContain('and 8 more...');
  });

  it('shows all files', async () => {
    const file = getFileXml('src/one.js', DEFAULT_METRICS, [DEFAULT_LINE]);
    const xmlReport = wrapXmlReport(file);

    mockFs({
      [CLOVER_PATH]: xmlReport,
    });

    Object.assign(danger, {
      git: {
        created_files: [],
        modified_files: [],
      },
    });

    await coverage({ showAllFiles: true });

    const report = getMarkdownReport();
    const lines = report.split('\n');

    expect(lines).toContain('|Files|% Stmts|% Branch|% Funcs|% Lines|Uncovered Lines||');
    expect(lines).toContain('|src/one.js|100|100|100|100||:white_check_mark:|');
  });

  it('uses custom thresholds', async () => {
    const file = getFileXml('src/one.js', {
      statements: 10,
      coveredstatements: 9,
      conditionals: 10,
      coveredconditionals: 9,
      methods: 10,
      coveredmethods: 9,
    }, [
      {
        num: 1,
        count: 0,
        type: 'stmt',
      },
      {
        num: 1,
        count: 1,
        type: 'stmt',
      },
    ]);
    const xmlReport = wrapXmlReport(file);

    mockFs({
      [CLOVER_PATH]: xmlReport,
    });

    Object.assign(danger, {
      git: {
        created_files: ['src/one.js'],
        modified_files: [],
      },
    });

    await coverage({
      failureMessage: 'Not good',
      threshold: {
        statements: 100,
        branches: 100,
        functions: 100,
        lines: 50,
      },
    });

    const report = getMarkdownReport();
    const lines = report.split('\n');

    expect(lines).toContain('> Not good');
    expect(lines).toContain('|src/one.js|90|90|90|50|1|:x:|');
  });

  it('makes paths even shorter', async () => {
    const longPath = 'ab/cd/ef/gh/ij/kl/mn'; // 20 chars
    const file = getFileXml(longPath, DEFAULT_METRICS, [DEFAULT_LINE]);

    const xmlReport = wrapXmlReport(file);

    mockFs({
      [CLOVER_PATH]: xmlReport,
    });

    Object.assign(danger, {
      git: {
        created_files: [longPath],
        modified_files: [],
      },
    });

    await coverage({ maxChars: 10 });

    const report = getMarkdownReport();
    const lines = report.split('\n');

    expect(report).toMatchSnapshot();
    expect(lines).toContain('|../kl/mn|100|100|100|100||:white_check_mark:|');
  });
});