testophobia/lib/utils/generate/generate-junit-xml.js

Web application snapshot tester

import fs from 'fs';
import path from 'path';

/**
 * Produce a JUnit-style results XML file for use with continuous integration software
 *
 * @param {string} outputDir Directory to write the xml file
 * @param {array} tests The test information
 * @param {array} failures The test failures to include
 */
export const generateJUnitXML = (outputDir, tests, failures) => {
  const createTestCase = (suite, test, dim, description, index) => {
    const testcase = {
      className: `${test.name}-${dim.type}-${index}`,
      name: description === 'none' ? 'Initial Snapshot' : description,
      time: 0
    };
    const failure = failures.find(f => f.test === test.name && f.screenType === dim.type && f.action === description);
    if (failure) {
      testcase.failure = {message: 'Not a match!', value: 'Screenshot Failure'};
      suite.failures++;
    }
    suite.tests++;
    suite.testcases.push(testcase);
  };
  const output = [];
  tests.forEach((test, idx) => {
    test.dimensions.forEach(dim => {
      const testsuite = {
        name: test.name + '-' + dim.type,
        testcases: [],
        time: 0,
        tests: 0,
        skipped: 0,
        failures: 0
      };
      createTestCase(testsuite, test, dim, 'none', 0);
      if (test.actions) {
        test.actions.forEach((action, i) => {
          createTestCase(testsuite, test, dim, action.description, i + 1);
        });
      }
      output.push(testsuite);
    });
  });
  const escapeForXml = str => {
    return str
      .toString()
      .replace(/&/g, '&')
      .replace(/</g, '&lt;')
      .replace(/>/g, '&gt;')
      .replace(/"/g, '&quot;')
      .replace(/'/g, '&apos;');
  };
  let xml = '<?xml version="1.0" encoding="UTF-8"?><testsuites>';
  output.forEach(ts => {
    xml += '<testsuite';
    Object.keys(ts).forEach(k => (k !== 'testcases' ? (xml += ` ${k}="${escapeForXml(ts[k])}"`) : ''));
    xml += '>';
    ts.testcases.forEach(tc => {
      xml += '<testcase';
      Object.keys(tc).forEach(k => (k !== 'failure' ? (xml += ` ${k}="${escapeForXml(tc[k])}"`) : ''));
      xml += '>';
      if (tc.failure) {
        xml += `<failure message="${escapeForXml(tc.failure.message)}">${escapeForXml(tc.failure.value)}</failure>`;
      }
      xml += '</testcase>';
    });
    xml += '</testsuite>';
  });
  xml += '</testsuites>';
  fs.writeFileSync(path.resolve(outputDir, 'junit.xml'), xml);
};