refactor TestRegister and some test suite functions into common area

tests/lib/TestRegister.mjs

@@ -48,6 +48,7 @@ class TestRegister {
      * Runs all the tests in the register.
      */
     runTests () {
+        console.log("run tests");
         return Promise.all(
             this.tests.map(function(test, i) {
                 const chef = new Chef();

tests/lib/utils.mjs

@@ -0,0 +1,102 @@
+/**
+ * Utils for test suite
+ *
+ * @author d98762625@gmail.com
+ * @author tlwr [toby@toby.codes]
+ * @author n1474335 [n1474335@gmail.com]
+ * @copyright Crown Copyright 2018
+ * @license Apache-2.0
+ */
+
+// Define global environment functions
+global.ENVIRONMENT_IS_WORKER = function() {
+    return typeof importScripts === "function";
+};
+global.ENVIRONMENT_IS_NODE = function() {
+    return typeof process === "object" && typeof require === "function";
+};
+global.ENVIRONMENT_IS_WEB = function() {
+    return typeof window === "object";
+};
+
+/**
+ * Helper function to convert a status to an icon.
+ *
+ * @param {string} status
+ * @returns {string}
+ */
+const statusToIcon = function statusToIcon(status) {
+    const icons = {
+        erroring: "🔥",
+        failing: "❌",
+        passing: "✔️️",
+    };
+    return icons[status] || "?";
+};
+
+
+/**
+ * Displays a given test result in the console.
+ * Counts test statuses.
+ *
+ * @param {Object} testStatusCounts
+ * @param {Object} testResult
+ */
+function handleTestResult(testStatus, testResult) {
+    testStatus.allTestsPassing = testStatus.allTestsPassing && testResult.status === "passing";
+    const newCount = (testStatus.counts[testResult.status] || 0) + 1;
+    testStatus.counts[testResult.status] = newCount;
+    testStatus.counts.total += 1;
+    console.log([
+        statusToIcon(testResult.status),
+        testResult.test.name
+    ].join(" "));
+
+    if (testResult.output) {
+        console.log(
+            testResult.output
+                .trim()
+                .replace(/^/, "\t")
+                .replace(/\n/g, "\n\t")
+        );
+    }
+}
+
+/**
+ * Log each test result, count tests and failures. Log test suite run duration.
+ * 
+ * @param {Object} testStatus - object describing test run data
+ * @param {Object[]} results - results from TestRegister
+ */
+export function logTestReport(testStatus, results) {
+    results.forEach(r => handleTestResult(testStatus, r));
+    console.log("\n");
+
+    for (const testStatusCount in testStatus.counts) {
+        const count = testStatus.counts[testStatusCount];
+        if (count > 0) {
+            console.log(testStatusCount.toUpperCase(), count);
+        }
+    }
+
+    if (!testStatus.allTestsPassing) {
+        console.log("\nFailing tests:\n");
+        results.filter(r => r.status !== "passing").forEach(handleTestResult);
+    }
+
+
+    console.log(`Tests took ${(testStatus.finish - testStatus.start) / 1000} seconds`);
+
+    process.exit(testStatus.allTestsPassing ? 0 : 1);
+}
+
+/**
+ * Fail if the process takes longer than 60 seconds.
+ */
+export function setLongTestFailure() {
+    setTimeout(function() {
+        console.log("Tests took longer than 60 seconds to run, returning.");
+        process.exit(1);
+    }, 60 * 1000);
+}
+

tests/operations/index.mjs

@@ -12,6 +12,11 @@
  */
 import "babel-polyfill";
 
+import {
+    setLongTestFailure,
+    logTestReport,
+} from "../lib/utils";
+
 // Define global environment functions
 global.ENVIRONMENT_IS_WORKER = function() {
     return typeof importScripts === "function";
@@ -23,7 +28,7 @@ global.ENVIRONMENT_IS_WEB = function() {
     return typeof window === "object";
 };
 
-import TestRegister from "./TestRegister";
+import TestRegister from "../lib/TestRegister";
 import "./tests/BCD";
 import "./tests/BSON";
 import "./tests/Base58";
@@ -86,93 +91,21 @@ import "./tests/Media";
 // Cannot test operations that use the File type yet
 //import "./tests/SplitColourChannels";
 
-import "./tests/nodeApi/nodeApi";
-import "./tests/nodeApi/ops";
+// import "./tests/nodeApi/nodeApi";
+// import "./tests/nodeApi/ops";
 
-let allTestsPassing = true;
-const testStatusCounts = {
-    total: 0,
+const testStatus = {
+    allTestsPassing: true,
+    counts: {
+        total: 0,
+    },
+    start: new Date(),
 };
 
+setLongTestFailure();
 
-/**
- * Helper function to convert a status to an icon.
- *
- * @param {string} status
- * @returns {string}
- */
-function statusToIcon(status) {
-    const icons = {
-        erroring: "🔥",
-        failing: "❌",
-        passing: "✔️️",
-    };
-    return icons[status] || "?";
-}
+const logOpsTestReport = logTestReport.bind(null, testStatus);
 
-
-/**
- * Displays a given test result in the console.
- *
- * @param {Object} testResult
- */
-function handleTestResult(testResult) {
-    allTestsPassing = allTestsPassing && testResult.status === "passing";
-    const newCount = (testStatusCounts[testResult.status] || 0) + 1;
-    testStatusCounts[testResult.status] = newCount;
-    testStatusCounts.total += 1;
-
-    console.log([
-        statusToIcon(testResult.status),
-        testResult.test.name
-    ].join(" "));
-
-    if (testResult.output) {
-        console.log(
-            testResult.output
-                .trim()
-                .replace(/^/, "\t")
-                .replace(/\n/g, "\n\t")
-        );
-    }
-}
-
-
-/**
- * Fail if the process takes longer than 60 seconds.
- */
-setTimeout(function() {
-    console.log("Tests took longer than 60 seconds to run, returning.");
-    process.exit(1);
-}, 60 * 1000);
-
-const start = new Date();
-
-Promise.all([
-    TestRegister.runTests(),
-    TestRegister.runApiTests()
-])
-    .then(function(resultsPair) {
-        const finish = new Date();
-        const results = resultsPair[0].concat(resultsPair[1]);
-        results.forEach(handleTestResult);
-
-        console.log("\n");
-
-        for (const testStatus in testStatusCounts) {
-            const count = testStatusCounts[testStatus];
-            if (count > 0) {
-                console.log(testStatus.toUpperCase(), count);
-            }
-        }
-
-        if (!allTestsPassing) {
-            console.log("\nFailing tests:\n");
-            results.filter(r => r.status !== "passing").forEach(handleTestResult);
-        }
-
-        console.log(`Tests took ${(finish - start) / 1000} seconds`);
-
-        process.exit(allTestsPassing ? 0 : 1);
-    });
+TestRegister.runTests()
+    .then(logOpsTestReport);
 

tests/operations/tests/BCD.mjs

@@ -5,7 +5,7 @@
  * @copyright Crown Copyright 2017
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/BSON.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/Base58.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2017
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/Base62.mjs

@@ -7,7 +7,7 @@
  * @license Apache-2.0
  */
 
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/Base64.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 const ALL_BYTES = [
     "\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f",

tests/operations/tests/BitwiseOp.mjs

@@ -5,7 +5,7 @@
  * @copyright Crown Copyright 2017
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/ByteRepr.mjs

@@ -5,7 +5,7 @@
  * @copyright Crown Copyright 2017
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 const ALL_BYTES = [
     "\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f",

tests/operations/tests/CSV.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 const EXAMPLE_CSV = `A,B,C,D,E,F\r
 1,2,3,4,5,6\r

tests/operations/tests/CartesianProduct.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/CharEnc.mjs

@@ -5,7 +5,7 @@
  * @copyright Crown Copyright 2017
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/Checksum.mjs

@@ -5,7 +5,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 const BASIC_STRING = "The ships hung in the sky in much the same way that bricks don't.";
 const UTF8_STR = "ნუ პანიკას";

tests/operations/tests/Ciphers.mjs

@@ -7,7 +7,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 
 TestRegister.addTests([

tests/operations/tests/Code.mjs

@@ -7,7 +7,7 @@
  * @copyright Crown Copyright 2017
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 const JSON_TEST_DATA = {
     "store": {

tests/operations/tests/Comment.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 const ALL_BYTES = [
     "\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f",

tests/operations/tests/Compress.mjs

@@ -5,7 +5,7 @@
  * @copyright Crown Copyright 2017
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/ConditionalJump.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/Crypt.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     /**

tests/operations/tests/DateTime.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2017
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/ExtractEmailAddresses.mjs

@@ -5,7 +5,7 @@
  * @copyright Crown Copyright 2017
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/Fork.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/FromDecimal.mjs

@@ -5,7 +5,7 @@
  * @copyright Crown Copyright 2018
  * @licence Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/FromGeohash.mjs

@@ -5,7 +5,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/Hash.mjs

@@ -5,7 +5,7 @@
  * @copyright Crown Copyright 2017
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/HaversineDistance.mjs

@@ -5,7 +5,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/Hexdump.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 const ALL_BYTES = [
     "\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x0a\x0b\x0c\x0d\x0e\x0f",

tests/operations/tests/Image.mjs

@@ -7,7 +7,7 @@
  * @copyright Crown Copyright 2017
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/JSONBeautify.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/JSONMinify.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/JWTDecode.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 const outputObject = JSON.stringify({
     String: "SomeString",

tests/operations/tests/JWTSign.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 const inputObject = JSON.stringify({
     String: "SomeString",

tests/operations/tests/JWTVerify.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 const outputObject = JSON.stringify({
     String: "SomeString",

tests/operations/tests/Jump.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/MS.mjs

@@ -5,7 +5,7 @@
  * @copyright Crown Copyright 2017
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/Magic.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 
 TestRegister.addTests([

tests/operations/tests/Media.mjs

@@ -4,7 +4,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/MorseCode.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2017
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/NetBIOS.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2017
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/OTP.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2017
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/PGP.mjs

@@ -5,7 +5,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 const ASCII_TEXT = "A common mistake that people make when trying to design something completely foolproof is to underestimate the ingenuity of complete fools.";
 

tests/operations/tests/PHP.mjs

@@ -7,7 +7,7 @@
  * @license Apache-2.0
  */
 
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/ParseIPRange.mjs

@@ -5,7 +5,7 @@
  * @copyright Crown Copyright 2017
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/ParseQRCode.mjs

@@ -5,7 +5,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/ParseTLV.mjs

@@ -6,7 +6,7 @@
  * @license Apache-2.0
  */
 
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/PowerSet.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/Regex.mjs

@@ -5,7 +5,7 @@
  * @copyright Crown Copyright 2017
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/Register.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/RemoveDiacritics.mjs

@@ -5,7 +5,7 @@
  * @copyright Crown Copyright 2017
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/Rotate.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 
 TestRegister.addTests([

tests/operations/tests/SeqUtils.mjs

@@ -5,7 +5,7 @@
  * @copyright Copyright 2017
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/SetDifference.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/SetIntersection.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/SetUnion.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/StrUtils.mjs

@@ -5,7 +5,7 @@
  * @copyright Crown Copyright 2017
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/SymmetricDifference.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/TextEncodingBruteForce.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/ToGeohash.mjs

@@ -5,7 +5,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {

tests/operations/tests/TranslateDateTimeFormat.mjs

@@ -6,7 +6,7 @@
  * @copyright Crown Copyright 2018
  * @license Apache-2.0
  */
-import TestRegister from "../TestRegister";
+import TestRegister from "../../lib/TestRegister";
 
 TestRegister.addTests([
     {