arangodb/js/common/modules/@arangodb/mocha-runner.js

/*global print */
'use strict';

////////////////////////////////////////////////////////////////////////////////
/// @brief ArangoDB Mocha integration
///
/// @file
///
/// DISCLAIMER
///
/// Copyright 2016 triAGENS GmbH, Cologne, Germany
///
/// Licensed under the Apache License, Version 2.0 (the "License");
/// you may not use this file except in compliance with the License.
/// You may obtain a copy of the License at
///
///     http://www.apache.org/licenses/LICENSE-2.0
///
/// Unless required by applicable law or agreed to in writing, software
/// distributed under the License is distributed on an "AS IS" BASIS,
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/// See the License for the specific language governing permissions and
/// limitations under the License.
///
/// Copyright holder is triAGENS GmbH, Cologne, Germany
///
/// @author Alan Plum
/// @author Copyright 2016, triAGENS GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////

const Module = require('module');
const runTests = require('@arangodb/mocha').run;
const colors = require('internal').COLORS;

const $_MODULE_CONTEXT = Symbol.for('@arangodb/module.context');


module.exports = function (files, returnJson) {
  const results = runTests(run, files, 'suite');
  print();
  logSuite(results);
  logStats(results.stats);
  print();
  if (returnJson) {
    return buildJson(results);
  }
  return results.stats.failures === 0;
};

function logStats(stats) {
  print(
    (
      stats.failures
      ? (
        colors.COLOR_RED
        + '[FAIL]'
        + colors.COLOR_RESET
      )
      : (
        colors.COLOR_GREEN
        + '[PASS]'
        + colors.COLOR_RESET
      )
    )
    + ' Completed '
    + colors.COLOR_BOLD_WHITE
    + stats.tests
    + colors.COLOR_RESET
    + ' tests in '
    + colors.COLOR_BOLD_WHITE
    + stats.duration + 'ms'
    + colors.COLOR_RESET
    + ' ( '
    + colors.COLOR_GREEN
    + stats.passes
    + colors.COLOR_RESET
    + ' | '
    + colors.COLOR_RED
    + stats.failures
    + colors.COLOR_RESET
    + ' | '
    + colors.COLOR_CYAN
    + stats.pending
    + colors.COLOR_RESET
    + ' )'
  );
}

function logSuite(suite, indentLevel) {
  if (!indentLevel) {
    indentLevel = 0;
  }
  if (suite.title) {
    print(
      indent(indentLevel - 1)
      + colors.COLOR_BOLD_WHITE
      + suite.title
      + colors.COLOR_RESET
    );
  }
  for (let test of suite.tests) {
    if (test.result === 'pass') {
      print(
        indent(indentLevel)
        + colors.COLOR_GREEN
        + '[PASS] '
        + test.title
        + colors.COLOR_RESET
      );
    } else if (test.result === 'pending') {
      print(
        indent(indentLevel)
        + colors.COLOR_CYAN
        + '[SKIP] '
        + test.title
        + colors.COLOR_RESET
      );
    } else {
      print(
        indent(indentLevel)
        + colors.COLOR_RED
        + '[' + test.result.toUpperCase() + '] '
        + test.title
        + colors.COLOR_RESET
      );
      for (let line of test.err.stack.split(/\n/)) {
        print(
          indent(indentLevel + 1)
          + colors.COLOR_RED
          + line
          + colors.COLOR_RESET
        );
      }
    }
  }
  for (let sub of suite.suites) {
    logSuite(sub, indentLevel + 1);
  }
  if (suite.suites.length) {
    print();
  }
}

function indent(level, indentWith) {
  if (!indentWith) {
    indentWith = '    ';
  }
  let padding = '';
  for (let i = 0; i < level; i++) {
    padding += indentWith;
  }
  return padding;
}

function buildJson(results) {
  const result = {
    duration: results.stats.duration,
    status: results.stats.failures ? false : true,
    failed: results.stats.failures,
    total: results.stats.tests
  };
  for (const test of findTests(results)) {
    const name = test[0];
    const stats = test[1];
    let newName = name;
    let i = 1;
    while (result.hasOwnProperty(newName)) {
      newName = `${name} ${i++}`;
    }
    result[newName] = {
      status: stats.result === 'pass' || stats.result === 'pending',
      duration: stats.duration
    };
    if (stats.result !== 'pass' && stats.result !== 'pending') {
      result[newName].message = stats.err.stack;
    }
  }
  return result;
}

function findTests(suite, prefix) {
  prefix = prefix ? prefix + ' ' : '';
  const results = [];
  for (const test of suite.tests) {
    results.push([prefix + test.title, test]);
  }
  for (const sub of suite.suites) {
    for (const res of findTests(sub, prefix + sub.title)) {
      results.push(res);
    }
  }
  return results;
}

function run(filename, context) {
  const module = new Module(filename);

  if (context) {
    Object.keys(context).forEach(function (key) {
      module[$_MODULE_CONTEXT][key] = context[key];
    });
  }

  module.load(filename);
  return module.exports;
}