Return-tests NPM

return-tests

return-tests loops through functions and runs as many parameterized tests per function that you add ([4, 8, 10, 2]). After a function executes a test case, its return value is compared against any of the chosen unit tests you have added. The tests are listed below in the unit object with more to (does not support WeakSet or WeakMap)

npm i return-tests

Getting Started

Pass an array of functions (see Function Format below) to the 'run' function and view your errors. For a standard testing example see /example/functions.js

var return_tests = require("return-tests");
var functions = require("my_testing_functions");

/*
  only test math functions <- index math must be set on function
*/
var index_set_A = ["math"];
/*
  only test business functions
*/
var index_set_B = ["business"];
/*
  only test todo functions
*/
var index_set_C = ["todo"];
/*
  only test math and business functions
*/
var index_set_D = ["math", "business"];

var errors = [];

try {
  errors = return_tests.run(functions /*,index_set_A*/); //only test functions containing a 'math' index (optional)
} catch (err) {
  console.log(err.message);
}

for (let i = 0; i < errors.length; i++) {
  console.log(errors[i]);
  /*
    "function index: index where the function failed
    function index name: name of index for running and testing certain sets (optional)
    parameter index: parameter index where the function failed (function_called.parameters)
    Execution time: execution time
    function description: function description
    ERRORS
  */
}

Function Format

module.exports = [
  {
    /*
      indexes are optional and only used for testing certain
      sets.
    */
    index: 1,
    function_called: {
      on: true,
      description: "this function adds numbers",
      /*
        each parameter set is passed
        to the function and a return value
        is tested against the unit 
        objects you have added (below)
      */
      parameters: [
        [1, 10],
        [10, 1],
      ],
      function: function (a, b) {
        try {
          return a + b;
        } catch (err) {
          return err;
        }
      },
    },
    /*
      add or remove tests here.  
    */
    unit: {
      must_be_type: {
        on: false,
        index_exact: false,
        values: ["string", "number"],
      },
      must_be_value: {
        on: true,
        index_exact: false,
        values: [12, 12], //objects use the library compare-an-object for a deep comparison only returning true or false. If you need to track changes, type npm i compare-an-object and use the other features offered like added, deleted and changed properties.
      },
      must_pass_regex: {
        on: false,
        index_exact: true,
        values: [/^([0-9])$/, /^([0-9])$/],
      },
      must_be_greater_than: {
        on: false,
        index_exact: true,
        values: [2, 5, 8],
      },
      must_be_less_than: {
        on: false,
        index_exact: true,
        values: [2, 5, 8],
      },
      must_be_in_range: {
        on: false,
        index_exact: true,
        values: [
          [2, 6],
          [1, 7],
          [2, 8],
        ],
      },
      must_be_even_or_odd: {
        on: true,
        index_exact: true,
        values: ["even", "odd", "odd", "even"],
      },
      must_be_divisible_by: {
        on: true,
        index_exact: false,
        values: [2, 2, 10, 22],
      },
      must_be_prime_or_not_prime: {
        on: true,
        index_exact: false,
        values: ["prime", "not prime", "prime", "not prime"],
      },
      must_be_log_of: {
        on: true,
        index_exact: true,
        values: [[4, 16]], //base^return_value=right hand value (return value is exponent)
      },
    },
  },
];

Parameters

/*
@param {index: optional}:
index is an optional value you can use when testing different sets or individual functions. 
This is used so that you dont have to keep setting functions on and off and to know what to control 
f for when something fails. Pass an index set to the run function, and only those
functions with indexeswill be run. See /example/errors.js

@param {function_called: object}:
function_called is the object containing the function in your application you are testing

@param {function_called.on: boolean}:
if true, loops through function_called.parameters and runs tests for each return value

@param {function_called.description: string}:
description of the function

@param {function_called.parameters: array}:
the sets of parameters passed to the function during execution

@param {function_called.function: function}:
the function you are testing

@param {unit: object}:
unit contains the testing objects (more tests will be added)

@param {unit.x: object}:
the object containing x.on, x.index_exact and x.values (the array the return value compares itself to)

@param {unit.x.on: boolean}:
whether or not to run the test

@param {unit.x.index_exact: boolean}:
check for a match or fact across the entire array or check for a match or fact on the
exact index

@param {unit.x.values: array}:
array of values the return value compares itself to (all of them or one depending on index_exact)

*/

Working Sets

To view your errors live in a page, use working sets. Spin up a terminal and type node 'filepath' and your errors will display in node_modules/return-tests/pages/yourkey.html

var return_tests = require("return-tests");

/*
  'index_a.html (and b)' will show all errors of
  of functions in '/example/functions.js' 
  ...keep the /pages html pages open 
  to see live errors
*/

return_tests.live_changes.set_working_set({
  index_a: { on: true, paths: ["../example/functions.js"] },
  index_b: { on: true, paths: ["../example/functions.js"] },
});

/*
  starts writing errors to file
*/

try {
  return_tests.live_changes.start_interval();
} catch (err) {
  console.log(err.message);
}

/*
  gets the current working set
*/

return_tests.live_changes.get_working_set();

/*
  checks if the interval is running (pages being displayed)
*/

return_tests.live_changes.interval_status();

/*
  stops listening for changes (same as ctrl c) <- leave interval on to view changes and dont do this
*/

return_tests.live_changes.stop_interval();

Uses

return-tests works well for functions that need to pass many test cases. return-tests will loop through functions and for each, input many sets of parameters. Every return value from each set of parameters is compared to one of the unit object tests you have added. Errors are displayed as a string. For best use, set every function to on and use index sets so that you get to decide what to run.

Fork Me

Although just started and not anywhere near completion, if you feel return-tests is useful, fork it and add it to your already existing testing framework.