mocha-distributed 0.9.7 → 0.9.8

package/example/suite-7-duplicated-titles.js

@@ -0,0 +1,25 @@
+const util = require('./util.js');
+const { expect } = require('chai');
+
+// require('mocha-distributed')
+require('../index.js');
+
+describe ('suite-7', async function () {
+  this.timeout (10*1000);
+  this.retries(3);
+
+  // this test is created to make sure that
+  for (let i = 0; i < 10; i++) {
+    it ('test-7.1-duplicated-title', async function() {
+      const retryCount = this.test.currentRetry();
+      const id = `${i}`.padStart(2, '0');
+      console.log (`[id=${id}] test-7.1-duplicated-title (retry ${retryCount})`);
+      await util.sleep(0.1 + 0.5*Math.random());
+
+      // make this test flacky to make sure that it is retried
+      if (retryCount < 2) {
+        expect (false).to.be.true;
+      }
+    })
+  }
+})

package/index.js

@@ -39,6 +39,11 @@ let g_capture = { stdout: null, stderr: null };
 // EVENT_TEST_RETRY instead and never stores the error on the test object.
 const g_retryErrors = new Map();
 
+// Map to keep track of the number of times a test key full path has been seen,
+// to add a suffix and parallelize duplicated test titles in multiple runners
+const g_duplicateTestKeyFullPathCount = new Map();
+let g_lastTestKeyFullPath = null;
+
 // -----------------------------------------------------------------------------
 // getTestPath
 //
@@ -170,9 +175,26 @@ exports.mochaGlobalTeardown = async function () {
 exports.mochaHooks = {
   beforeEach: async function () {
     const testPath = getTestPath(this.currentTest);
-    const testKeyFullPath = `${g_testExecutionId}:${getSerialGranularity(testPath.join(":"))}`;
+    let testKeyFullPath = `${g_testExecutionId}:${getSerialGranularity(testPath.join(":"))}`;
     const testKeySuite = `${g_testExecutionId}:${getSerialGranularity(testPath[0])}`;
 
+    // if this is the first attempt, we need to put a suffix to be able to
+    // parallelize duplicates in multiple runners
+    if ((this.currentTest._currentRetry || 0) === 0) {
+      g_duplicateTestKeyFullPathCount.set(
+        testKeyFullPath,
+        (g_duplicateTestKeyFullPathCount.get(testKeyFullPath) || 0) + 1
+      );
+      testKeyFullPath += `:dup-${g_duplicateTestKeyFullPathCount.get(testKeyFullPath)}`;
+      g_lastTestKeyFullPath = testKeyFullPath;
+    }
+    else {
+      // ensure we use the same key for retries as the original attempt, otherwise
+      // we will screw up the distribution of tests; we use the last generated key
+      // since retries are executed sequentially
+      testKeyFullPath = g_lastTestKeyFullPath;
+    }
+
     const testKey =
       g_granularity === GRANULARITY.TEST ? testKeyFullPath : testKeySuite;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mocha-distributed",
-  "version": "0.9.7",
+  "version": "0.9.8",
   "description": "Run multiple mocha suites and tests in parallel, from different processes and different machines. Results available on a redis database.",
   "main": "index.js",
   "scripts": {

package/test-example-nworkers.sh

@@ -5,10 +5,10 @@ export MOCHA_DISTRIBUTED="redis://127.0.0.1"
 npm install > /dev/null 2>&1
 
 N=$1
-COMMAND="mocha --require ./index.js example/**/*.js"
+COMMAND="npx mocha --require ./index.js example/**/*.js"
 
 # cleanup tmp files
-rm tmp-*
+rm -f tmp-*
 
 echo "Spawning $N commands in parallel with Execution ID: $MOCHA_DISTRIBUTED_EXECUTION_ID"