Updated example with 'mocha-junit-reporters-retries'

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
 
     - run: npm ci
 
-    - run: npm test -- --reporter mocha-multi-reporters --reporter-options configFile=mocha-reporter-config.json
+    - run: npm test -- --reporter mocha-multi-reporters --reporter-options configFile=mocha-reporter-config.json --retries 5
 
     - name: Upload test results to BuildPulse for flaky test detection
       if: '!cancelled()' # Run this step even when the tests fail. Skip if the workflow is cancelled.

.gitignore

@@ -1,2 +1 @@
 /node_modules
-/test-results.xml

mocha-reporter-config.json

@@ -1,3 +1,3 @@
 {
-  "reporterEnabled": "spec, mocha-junit-reporter"
+  "reporterEnabled": "spec, mocha-junit-reporters-retries"
 }

package.json

@@ -15,6 +15,10 @@
   "devDependencies": {
     "mocha": "^9.1.1",
     "mocha-junit-reporter": "^2.0.0",
-    "mocha-multi-reporters": "^1.5.1"
+    "mocha-multi-reporters": "^1.5.1",
+    "mocha-junit-reporters-retries": "https://github.com/buildpulse/mocha-junit-reporter"
+  },
+  "dependencies": {
+    "xmlbuilder2": "^3.1.1"
   }
 }

test-results.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuites name="Mocha Tests" time="0.008" tests="2" failures="0">
+  <testsuite name="Root Suite" timestamp="2024-08-15T21:37:42" tests="0" time="0.000" failures="0" retries="0">
+  </testsuite>
+  <testsuite name="sum" timestamp="2024-08-15T21:37:42" tests="1" file="/Users/siddange/code/buildpulse/buildpulse-examples/buildpulse-example-mocha/test/sum.spec.js" time="0.001" failures="0" retries="0">
+    <testcase name="sum adds 1 + 2 to equal 3" time="0.000" classname="adds 1 + 2 to equal 3" retries="0" conclusion="success">
+    </testcase>
+  </testsuite>
+  <testsuite name="flaky" timestamp="2024-08-15T21:37:42" tests="1" file="/Users/siddange/code/buildpulse/buildpulse-examples/buildpulse-example-mocha/test/sum.spec.js" time="0.007" failures="0" retries="9">
+    <testcase name="flaky flaky failure test with retries enabled" time="0.000" classname="flaky failure test with retries enabled" retries="9" conclusion="success">
+    </testcase>
+  </testsuite>
+</testsuites>

test/sum.spec.js

@@ -6,3 +6,11 @@ describe('sum', () => {
         assert.equal(sum(1, 2), 3);
     });
 });
+
+describe('flaky', function () {
+    it('flaky failure test with retries enabled', function () {
+        const random = Math.random() * 100;
+        const passes = random > 70;
+        assert(passes);
+    });
+});