bananass/src/commands/bananass-run/test-runner.js

Baekjoon Framework for JavaScript.🍌

/**
 * @fileoverview Test runner. Return an object with test results.
 */

// --------------------------------------------------------------------------------
// Import
// --------------------------------------------------------------------------------

import { SolutionWithTestcases, Input, Output } from '../../core/structs/index.js';

// --------------------------------------------------------------------------------
// Typedefs
// --------------------------------------------------------------------------------

/**
 * @typedef {import('../../core/types.js').SolutionWithTestcases} SolutionWithTestcases
 * @typedef {import('../../core/types.js').Output} Output
 */

// --------------------------------------------------------------------------------
// Helpers
// --------------------------------------------------------------------------------

/** @param {Output} output */
function transformOutput(output) {
  return String(output).trimEnd();
}

// --------------------------------------------------------------------------------
// Export
// --------------------------------------------------------------------------------

/**
 * Test runner. Return an object with test results.
 *
 * @param {SolutionWithTestcases} solutionWithTestcases
 */
export default function testRunner(solutionWithTestcases) {
  // ------------------------------------------------------------------------------
  // Runtime Validation
  // ------------------------------------------------------------------------------

  SolutionWithTestcases.assert(solutionWithTestcases);

  // ------------------------------------------------------------------------------
  // Declarations
  // ------------------------------------------------------------------------------

  const { solution, testcases } = solutionWithTestcases;

  // ------------------------------------------------------------------------------
  // Test Runner
  // ------------------------------------------------------------------------------

  const results = testcases.map(({ input, output: outputExpected }) => {
    const outputActual = solution(input);

    Input.assert(input);
    Output.assert(outputExpected);
    Output.assert(outputActual);

    const outputExpectedTransformed = transformOutput(outputExpected);
    const outputActualTransformed = transformOutput(outputActual);

    return {
      input,
      outputExpected,
      outputActual,
      outputExpectedTransformed,
      outputActualTransformed,
      isTestPassed: Object.is(outputExpectedTransformed, outputActualTransformed),
    };
  });

  const numberOfTests = testcases.length;
  const numberOfTestsPassed = results.filter(({ isTestPassed }) => isTestPassed).length;
  const numberOfTestsFailed = numberOfTests - numberOfTestsPassed;
  const isAllTestsPassed = Object.is(numberOfTests, numberOfTestsPassed);

  // ------------------------------------------------------------------------------
  // Return
  // ------------------------------------------------------------------------------

  return {
    results,
    numberOfTests,
    numberOfTestsPassed,
    numberOfTestsFailed,
    isAllTestsPassed,
  };
}