arangodb/UnitTests/unittest.js

/*jshint globalstrict:false, unused:false */
/*global print, start_pretty_print, ARGUMENTS */
'use strict';

const yaml = require("js-yaml");
const _ = require("lodash");

const UnitTest = require("@arangodb/testing");

const internalMembers = UnitTest.internalMembers;
const fs = require("fs");
const internal = require("internal");
const inspect = internal.inspect;

function makePathGeneric(path) {
  return path.split(fs.pathSeparator);
}

function xmlEscape(s) {
  return s.replace(/[<>&"]/g, function(c) {
    return "&" + {
      "<": "lt",
      ">": "gt",
      "&": "amp",
      "\"": "quot"
    }[c] + ";";
  });
}

function buildXml() {
  let xml = ["<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"];

  xml.text = function(s) {
    Array.prototype.push.call(this, s);
    return this;
  };

  xml.elem = function(tagName, attrs, close) {
    this.text("<").text(tagName);
    attrs = attrs || {};

    for (let a in attrs) {
      if (attrs.hasOwnProperty(a)) {
        this.text(" ").text(a).text("=\"")
          .text(xmlEscape(String(attrs[a]))).text("\"");
      }
    }

    if (close) {
      this.text("/");
    }

    this.text(">\n");

    return this;
  };

  return xml;
}

////////////////////////////////////////////////////////////////////////////////
/// @brief converts results to XML representation
////////////////////////////////////////////////////////////////////////////////

function resultsToXml(results, baseName, cluster) {
  let clprefix = '';

  if (cluster) {
    clprefix = 'CL_';
  }

  const isSignificant = function(a, b) {
    return (internalMembers.indexOf(b) === -1) && a.hasOwnProperty(b);
  };

  for (let resultName in results) {
    if (isSignificant(results, resultName)) {
      let run = results[resultName];

      for (let runName in run) {
        if (isSignificant(run, runName)) {
          const current = run[runName];

          if (current.skipped) {
            continue;
          }

          let xml = buildXml();
          let failuresFound = 0;

          if (current.hasOwnProperty('failed')) {
            failuresFound = current.failed;
          }

          xml.elem("testsuite", {
            errors: 0,
            failures: failuresFound,
            name: clprefix + runName,
            tests: current.total,
            time: current.duration
          });

          for (let oneTestName in current) {
            if (isSignificant(current, oneTestName)) {
              const oneTest = current[oneTestName];
              const success = (oneTest.status === true);

              xml.elem("testcase", {
                name: clprefix + oneTestName,
                time: oneTest.duration
              }, success);

              if (!success) {
                xml.elem("failure");
                xml.text('<![CDATA[' + oneTest.message + ']]>\n');
                xml.elem("/failure");
                xml.elem("/testcase");
              }
            }
          }

          if (!current.status) {
            xml.elem("testcase", {
              name: 'all tests in ' + clprefix + runName,
              time: current.duration
            }, false);

            xml.elem("failure");
            xml.text('<![CDATA[' +
              JSON.stringify(current.message || "unknown failure reason") +
              ']]>\n');
            xml.elem("/failure");
            xml.elem("/testcase");
          }

          xml.elem("/testsuite");

          const fn = makePathGeneric(baseName + clprefix +
            resultName + '_' + runName + ".xml").join('_');

          fs.write("out/" + fn, xml.join(""));
        }
      }
    }
  }
}

////////////////////////////////////////////////////////////////////////////////
/// @brief runs the test using testing.js
////////////////////////////////////////////////////////////////////////////////

function main(argv) {
  start_pretty_print();

  // parse arguments
  let cases = [];
  let options = {};

  while (argv.length >= 1) {
    if (argv[0].slice(0, 1) === '{') {
      break;
    }

    if (argv[0].slice(0, 1) === '-') {
      break;
    }

    cases.push(argv[0]);
    argv = argv.slice(1);
  }

  // convert arguments
  if (argv.length >= 1) {
    try {
      if (argv[0].slice(0, 1) === '{') {
        options = JSON.parse(argv[0]);
      } else {
        options = internal.parseArgv(argv, 0);
      }
    } catch (x) {
      print("failed to parse the json options: " + x.message);
      return -1;
    }
  }

  // force json reply
  options.jsonReply = true;

  // create output directory
  fs.makeDirectoryRecursive("out");

  // run the test and store the result
  let r = {};

  try {
    r = UnitTest.unitTest(cases, options) || {};
  } catch (x) {
    print("caught exception during test execution!");

    if (x.message !== undefined) {
      print(x.message);
    }

    if (x.stack !== undefined) {
      print(x.stack);
    } else {
      print(x);

    }

    print(JSON.stringify(r));
  }

  _.defaults(r, {
    status: false,
    crashed: true
  });

  // whether or not there was an error 
  fs.write("out/UNITTEST_RESULT_EXECUTIVE_SUMMARY.json", String(r.status));

  if (options.writeXmlReport) {
    let j;

    try {
      j = JSON.stringify(r);
    } catch (err) {
      j = inspect(r);
    }

    fs.write("out/UNITTEST_RESULT.json", j);
    fs.write("out/UNITTEST_RESULT_CRASHED.json", String(r.crashed));

    try {
      resultsToXml(r,
        "UNITTEST_RESULT_", (options.hasOwnProperty('cluster') && options.cluster));
    } catch (x) {
      print("exception while serializing status xml!");
      print(x.message);
      print(x.stack);
      print(inspect(r));
    }
  }

  UnitTest.unitTestPrettyPrintResults(r);

  return r.crashed ? -1 : 0;
}

main(ARGUMENTS);