@loki/runner/src/commands/test/index.js

Loki test runner

const pickBy = require('ramda/src/pickBy');
const uniq = require('ramda/src/uniq');
const minimist = require('minimist');
const {
  ReferenceImageError,
  ensureDependencyAvailable,
} = require('@loki/core');
const { warn, error, info } = require('../../console');
const getConfig = require('../../config');
const parseOptions = require('./parse-options');
const runTests = require('./run-tests');
const buildCommand = require('../../build-command');

const escapeRegExp = (str) => str.replace(/[-[\]/{}()*+?.\\^$|]/g, '\\$&');

const getUpdateCommand = (errors, args) => {
  const argv = minimist(args);
  const stories = uniq(errors.map((e) => `${e.kind} ${e.story}`));
  const storiesFilter = `^${stories.map(escapeRegExp).join('|')}$`;
  const tooManyToFilter = stories.length > 10;

  const argObject = Object.assign(
    {
      configurationFilter: argv._[1],
      storiesFilter: !tooManyToFilter && storiesFilter,
    },
    pickBy((value, key) => {
      switch (key) {
        case '_':
        case 'requireReference': {
          return false;
        }
        case 'storiesFilter':
        case 'skipStories': {
          return tooManyToFilter;
        }
        default: {
          return true;
        }
      }
    }, argv)
  );

  return buildCommand('update', argObject);
};

async function test(args) {
  const config = getConfig();
  const options = parseOptions(args, config);

  if (options.diffingEngine === 'gm') {
    ensureDependencyAvailable('gm');
  }

  const targetFilter = new RegExp(options.targetFilter);
  const configurationFilter = new RegExp(options.configurationFilter);
  const matchesFilters = ({ target }, name) =>
    targetFilter.test(target) && configurationFilter.test(name);

  const configurations = pickBy(matchesFilters, config.configurations);

  if (Object.keys(configurations).length === 0) {
    warn('No matching configurations');
    process.exit(0);
  }

  try {
    await runTests(configurations, options);
  } catch (err) {
    if (err.name === 'TaskRunnerError') {
      const imageErrors = err.errors.filter(
        (e) => e instanceof ReferenceImageError
      );
      if (imageErrors.length !== 0) {
        error('Visual tests failed');
        info('You can update the reference files with:');
        info(getUpdateCommand(imageErrors, args));
      } else {
        error('Some visual tests failed to run');
      }
      process.exit(1);
    }
    throw err;
  }
}

module.exports = test;