Threaded tests (#145)

lolleko · web-flow · commit 4fcd6a50802d · 2018-07-15T21:57:24.000+02:00
* Added experiemental test-threaded command

* Improved workload distrubution

* Travis test

* Fixed Travis script

* Fixed thread count for CI

* Fixed work distrubution

* Fixed codecov beeing invoked twice

* Removed threaded tests from ci config. Since CI doesnt really benifit from multiple threads.

* Fixed Typo and some formatting

* Added some build and test info to readme
diff --git a/.travis.yml b/.travis.yml
@@ -6,9 +6,9 @@ install:
 script:
 - npm run build
 # Testing & Coverage
-- npm test
-after_success:
 - npm run coverage
+after_success:
+- codecov
 deploy:
   provider: npm
   email: 'lorenz.junglas@student.kit.edu'
diff --git a/README.md b/README.md
@@ -45,6 +45,16 @@ The real power of this transpiler is usage together with good declarations for t
 - [Dota 2 Modding](https://github.com/ModDota/API/tree/master/declarations/server)
 - [Defold Game Engine Scripting](https://github.com/dasannikov/DefoldTypeScript/blob/master/defold.d.ts)
 
+## Building & Tests
+
+`npm run build` to build the project.
+
+`npm run test` to run tests.
+
+`npm run test-threaded` runs test in parallel, faster but less detailed output.
+
+`npm run coverage` or `npm run coverage-html` to generate a coverage report.
+
 ## Sublime Text integration
 This compiler works great in combination with the [Sublime Text Typescript plugin](https://github.com/Microsoft/TypeScript-Sublime-Plugin) (available through the package manager as `TypeScript`).
 
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -12,7 +12,9 @@
     "scripts": {
         "build": "tsc -p tsconfig.json",
         "test": "tslint -p . && ts-node ./test/runner.ts",
-        "coverage": "nyc npm test && nyc report --reporter=text-lcov > coverage.lcov && codecov",
+        "test-threaded": "tslint -p . && ts-node ./test/threaded_runner.ts",
+        "coverage-threaded": "nyc npm run test-threaded && nyc report --reporter=text-lcov > coverage.lcov",
+        "coverage": "nyc npm test && nyc report --reporter=text-lcov > coverage.lcov",
         "coverage-html": "nyc npm test && nyc report --reporter=html",
         "release-patch": "npm version patch",
         "release-minor": "npm version minor",
@@ -40,13 +42,17 @@
         "yargs": "^11.1.0"
     },
     "devDependencies": {
+        "@types/glob": "^5.0.35",
         "@types/node": "^9.6.23",
         "@types/yargs": "^11.0.0",
         "alsatian": "^2.2.1",
+        "circular-json": "^0.5.5",
         "codecov": "3.0.2",
         "deep-equal": "^1.0.1",
         "fengari": "^0.1.2",
+        "glob": "^7.1.2",
         "nyc": "^11.9.0",
+        "threads": "^0.12.0",
         "ts-node": "^7.0.0",
         "tslint": "^5.10.0",
         "tslint-override": "^0.1.2"
diff --git a/test/test_thread.ts b/test/test_thread.ts
@@ -0,0 +1,31 @@
+import { MatchError, TestRunner, TestSet, TestOutcome } from "alsatian";
+import * as JSON from "circular-json";
+
+module.exports = function(input, done) {
+    const testSet = TestSet.create();
+    testSet.addTestsFromFiles(input.files);
+    const testRunner = new TestRunner();
+
+    testRunner.onTestComplete((result) => {
+        if (result.outcome === TestOutcome.Fail) {
+            if (result.error instanceof MatchError) {
+                console.log(`Test ${result.testFixture.description}, ${result.test.key}(${JSON.stringify(result.testCase.caseArguments)}) Failed!`)
+                console.log(" ---\n" +
+                '   message: "' +
+                result.error.message +
+                '"\n' +
+                "   severity: fail\n" +
+                "   data:\n" +
+                "     got: " +
+                result.error.actual +
+                "\n" +
+                "     expect: " +
+                result.error.expected +
+                "\n");
+            }
+        }
+    })
+
+    testRunner.run(testSet)
+              .then((results) => done(results, input))
+};
diff --git a/test/threaded_runner.ts b/test/threaded_runner.ts
@@ -0,0 +1,56 @@
+import {MatchError} from "alsatian";
+import * as glob from "glob";
+import * as os from "os";
+import * as path from "path";
+import {config, Pool} from "threads";
+
+config.set({
+  basepath: {
+    node: __dirname,
+  }
+});
+
+let cpuCount = os.cpus().length + 1;
+if ("TRAVIS" in process.env && "CI" in process.env) {
+  // fixed thread count for CI
+  cpuCount = 8;
+}
+const testFiles: string[] = glob.sync("./test/**/*.spec.ts");
+const pool = new Pool(cpuCount);
+let jobCounter = 0;
+
+const fileArrToString = (fileArr: string[]) =>
+    fileArr.map(val => path.basename(val).replace(".spec.ts", "")).join(", ");
+
+console.log(
+    `Running tests: ${fileArrToString(testFiles)} with ${cpuCount} threads`);
+
+const filesPerThread = Math.floor(testFiles.length / cpuCount);
+const threadsWithMoreWork = testFiles.length % cpuCount;
+
+for (let i = 1; i <= cpuCount; i++) {
+  let files: string[] = [];
+  if (i <= threadsWithMoreWork) {
+    files = testFiles.splice(0, filesPerThread + 1);
+  } else {
+    files = testFiles.splice(0, filesPerThread);
+  }
+  console.log(`Running tests: ${fileArrToString(files)} in thread ${i}`);
+
+  pool.run("./test_thread")
+      .send({files: files})
+      .on("done",
+          (results, input) => {
+            jobCounter++;
+            console.log(`Tests ${fileArrToString(files)} ${jobCounter}/${
+                cpuCount} done.`);
+          })
+      .on("error", error => {
+        console.log("Exception in test:", files, error);
+      });
+}
+
+pool.on("finished", () => {
+  console.log("Everything done, shutting down the thread pool.");
+  pool.killAll();
+});
diff --git a/test/unit/string.spec.ts b/test/unit/string.spec.ts
@@ -18,7 +18,7 @@ export class StringTests {
     @TestCase([65, 66])
     @TestCase([65, 66, 67])
     @Test("String.fromCharCode")
-    public stringFromCharcode(inp: number[], expected: string) {
+    public stringFromCharcode(inp: number[]) {
         // Transpile
         const lua = util.transpileString(
             `return String.fromCharCode(${inp.toString()})`
