Improve reports loading and clean code

- Improve JUnit test reports loading
  - Refine file patterns
  - Load all reports instead of only the first one
  - Read only top-level `<testsuite>` tags
- Exclude some directories from file search
- Improve the documentation
  - Clarify how reports are loaded
  - Add more examples
- Clean code (quotes, semicolons, ...)

README.md

@@ -86,7 +86,7 @@ Only matched report formats will get a file uploaded to the Gist.
 
 ### Go
 
-Write the verbose test output (`>` or `tee`) with coverage enabled to a
+Write the verbose test output (`>` or `tee`) with coverage enabled to a single
 `test*.{out,txt}` file next to the `go.mod` file:
 
 - `RUN`, `PASS` and `FAIL` flags will be used to count tests
@@ -100,21 +100,26 @@ sure the last percentage is the global coverage value.
 
 ### JUnit
 
-Write the test report to a file matching:
+Write test reports to files matching:
 
+- `**/TEST-*.xml`
 - `**/report.xml`
-- `**/*TEST*.xml`
 - `**/*test*.xml`
 - `**/*junit*.xml`
 
 This is the default format and location with JUnit, but most test runners
-support this format too, natively or using an additional reporter, e.g.:
-
-- **Mocha**: `mocha --reporter mocha-junit-reporter`
-- **Jest**: `jest --reporters="jest-junit"`
+support this format too, natively or using an additional reporter:
+
+- **Maven**: `mvn test` → `target/{surefire,failsafe}-reports/TEST-*.xml`
+- **Gradle**: `gradle test` → `build/test-results/test/**/TEST-*.xml`
+- **Node.js**: `node --test --test-reporter=junit --test-reporter-destination=report.xml`
+- **Mocha**: `mocha --reporter mocha-junit-reporter` → `test-results.xml`
+- **Jest**: `jest --reporters="jest-junit"` → `junit.xml`
+- **Deno**: `deno test --junit-path=report.xml`
 - **PHPUnit**: `phpunit --log-junit report.xml`
 
-The number of tests and failures will be extracted from `<testsuite>` tags.
+The number of tests and failures will be extracted from top-level `<testsuite>`
+tags, from all matching and valid report files.
 
 ➡️ `{repo}-[{ref}-]junit-tests.json`
 
@@ -126,14 +131,14 @@ Write the coverage report to a file matching:
 - `**/*coverage*.xml`
 
 This is the default format and location with Cobertura, but most code coverage
-tools support this format too, natively or using an additional reporter, e.g.:
+tools support this format too, natively or using an additional reporter:
 
-- **c8**: `c8 --reporter cobertura [...]`
-- **nyc**: `nyc --reporter cobertura [...]`
+- **c8**: `c8 --reporter cobertura [...]` → `coverage/cobertura-coverage.xml`
+- **nyc**: `nyc --reporter cobertura [...]` → `coverage/cobertura-coverage.xml`
 - **PHPUnit**: `phpunit --coverage-cobertura coverage.xml`
 
 The coverage will be extracted from the `line-rate` attribute of the
-`<coverage>` tag.
+`<coverage>` tag, from the first matching and valid report file.
 
 ➡️ `{repo}-[{ref}-]cobertura-coverage.json`
 
@@ -147,7 +152,8 @@ Write the coverage report to a file matching:
 This is the default format and location with JaCoCo, but some code coverage
 tools may support this format too.
 
-The coverage will be extracted from the last `<counter>` tag with type `LINE`.
+The coverage will be extracted from the last `<counter>` tag with type `LINE`,
+from the first matching and valid report file.
 
 ➡️ `{repo}-[{ref}-]jacoco-coverage.json`
 

src/reports/cobertura.test.js

@@ -4,9 +4,9 @@ import { getReports } from './cobertura.js';
 
 describe('reports/cobertura', function () {
   describe('#getReports()', function () {
-    it(`should return coverage report`, async function () {
+    it('should return coverage report', async function () {
       const reports = await getReports(join(process.cwd(), 'test/data/cobertura'));
-      assert.equal(reports.length, 1)
+      assert.equal(reports.length, 1);
       assert.deepStrictEqual(reports, [
         { type: 'coverage', data: { coverage: 92.09999999999999 } }
       ]);

src/reports/go.js

@@ -29,7 +29,7 @@ export async function getReports(root) {
     }
     const passed = (report.match(/--- PASS/g) || []).length;
     const failed = (report.match(/--- FAIL/g) || []).length;
-    badges.push({ type: 'tests', data: { passed, failed, tests } })
+    badges.push({ type: 'tests', data: { passed, failed, tests } });
     const percentages = report.match(/(?<=\s)[0-9.]+(?=%)/g);
     if (percentages && percentages.length >= 1) {
       const coverage = parseFloat(percentages.slice(-1)[0]);

src/reports/go.test.js

@@ -4,9 +4,9 @@ import { getReports } from './go.js';
 
 describe('reports/go', function () {
   describe('#getReports()', function () {
-    it(`should return tests and coverage reports`, async function () {
+    it('should return tests and coverage reports', async function () {
       const reports = await getReports(join(process.cwd(), 'test/data/go'));
-      assert.equal(reports.length, 2)
+      assert.equal(reports.length, 2);
       assert.deepStrictEqual(reports, [
         { type: 'tests', data: { passed: 3, failed: 0, tests: 3 } },
         { type: 'coverage', data: { coverage: 96.5 } }

src/reports/index.js

@@ -30,6 +30,6 @@ export async function getReports() {
       core.warning(`Skipping ${id} report format: ${error}`);
     }
   }
-  core.info(`Loaded ${all.length} reports`);
+  core.info(`Loaded ${all.length} report(s)`);
   return all;
 }

src/reports/jacoco.test.js

@@ -4,9 +4,9 @@ import { getReports } from './jacoco.js';
 
 describe('reports/jacoco', function () {
   describe('#getReports()', function () {
-    it(`should return coverage report`, async function () {
+    it('should return coverage report', async function () {
       const reports = await getReports(join(process.cwd(), 'test/data/jacoco'));
-      assert.equal(reports.length, 1)
+      assert.equal(reports.length, 1);
       assert.deepStrictEqual(reports, [
         { type: 'coverage', data: { coverage: 65.61056105610561 } }
       ]);

src/reports/junit.js

@@ -11,31 +11,56 @@ import { globNearest } from '../util/index.js';
 export async function getReports(root) {
   core.info('Load JUnit tests report');
   const patterns = [
+    join(root, '**/TEST-*.xml'),
     join(root, '**/report.xml'),
-    join(root, '**/*TEST*.xml'),
     join(root, '**/*test*.xml'),
     join(root, '**/*junit*.xml')
   ];
   const reports = await globNearest(patterns);
-  const badges = [];
+  const data = { passed: 0, failed: 0, tests: 0 };
+  let count = 0;
   for (const r of reports) {
     core.info(`Load JUnit report '${r}'`);
-    const report = await fs.readFile(r, { encoding: 'utf8' });
-    const testSuites = report.match(/<testsuite[^s]([^>]+)>/g);
-    if (!testSuites) {
+    const testSuites = await getTestSuiteTags(r);
+    if (testSuites.length === 0) {
       core.info('Report is not a valid JUnit report');
       continue; // Invalid report file, trying the next one
     }
-    const data = { passed: 0, failed: 0, tests: 0 };
     for (const ts of testSuites) {
-      data.failed += parseInt(ts.match(/failures="([0-9]+)"/)?.[1] ?? "0");
-      data.failed += parseInt(ts.match(/errors="([0-9]+)"/)?.[1] ?? "0");
-      data.tests += parseInt(ts.match(/tests="([0-9]+)"/)?.[1] ?? "0");
+      data.failed += parseInt(ts.match(/failures="([0-9]+)"/)?.[1] ?? '0');
+      data.failed += parseInt(ts.match(/errors="([0-9]+)"/)?.[1] ?? '0');
+      data.tests += parseInt(ts.match(/tests="([0-9]+)"/)?.[1] ?? '0');
     }
-    data.passed = data.tests - data.failed;
-    badges.push({ type: 'tests', data })
-    break; // Successfully loaded a report file, can return now
+    count++;
   }
-  core.info(`Loaded ${badges.length} JUnit report(s)`);
-  return badges;
+  data.passed = data.tests - data.failed;
+  core.info(`Loaded ${count} JUnit report(s)`);
+  return [{ type: 'tests', data }];
+}
+
+/**
+ * Extract top-level `<testsuite>` opening tags
+ * from the given JUnit test report file.
+ * Some test runners output nested `<testsuite>` tags
+ * (e.g. Node.js test runner), these nested tags must be
+ * ignored as values are aggregated in top-level ones.
+ * @param {string} path Path to the JUnit test report file
+ * @returns {Promise<string[]>} Top-level `<testsuite>` opening tags
+ */
+async function getTestSuiteTags(path) {
+  const testSuites = [];
+  let depth = 0;
+  const report = await fs.readFile(path, { encoding: 'utf8' });
+  const tags = report.match(/<\/?testsuite(?:[^s>][^>]+|\s*)>/g) ?? [];
+  for (const tag of tags) {
+    if (tag.startsWith('</')) {
+      depth--;
+    } else {
+      if (depth === 0) {
+        testSuites.push(tag);
+      }
+      depth++;
+    }
+  }
+  return testSuites;
 }

src/reports/junit.test.js

@@ -4,11 +4,11 @@ import { getReports } from './junit.js';
 
 describe('reports/junit', function () {
   describe('#getReports()', function () {
-    it(`should return tests report`, async function () {
+    it('should return tests report', async function () {
       const reports = await getReports(join(process.cwd(), 'test/data/junit'));
-      assert.equal(reports.length, 1)
+      assert.equal(reports.length, 1);
       assert.deepStrictEqual(reports, [
-        { type: 'tests', data: { passed: 6, failed: 4, tests: 10 } }
+        { type: 'tests', data: { passed: 8, failed: 4, tests: 12 } }
       ]);
     });
   });

src/util/index.js

@@ -1,15 +1,29 @@
 import * as glob from '@actions/glob';
 
 /**
- * Returns files and directories matching the glob patterns,
- * sorted by the nearest.
+ * Returns files matching the glob patterns,
+ * excluding some common unwanted directories from the search,
+ * sorted by ascending depth and name.
  * @param {string[]} patterns Glob patterns
  * @return {Promise<string[]>} Files sorted by the nearest.
  */
 export async function globNearest(patterns) {
-  const globber = await glob.create(patterns.join('\n'));
+  const safePatterns = [
+    ...patterns,
+    '!**/.git/**',
+    '!**/.idea/**',
+    '!**/.vscode/**',
+    '!**/node_modules/**',
+    '!**/vendor/**'
+  ];
+  const globber = await glob.create(safePatterns.join('\n'), {
+    followSymbolicLinks: false,
+    implicitDescendants: false,
+    matchDirectories: false
+  });
   const files = await globber.glob();
   return files.sort((a, b) => {
-    return (a.match(/[\\/]/g)?.length ?? 0) - (b.match(/[\\/]/g)?.length ?? 0);
-  })
+    const depthDiff = (a.match(/[\\/]/g)?.length ?? 0) - (b.match(/[\\/]/g)?.length ?? 0);
+    return depthDiff !== 0 ? depthDiff : a.localeCompare(b);
+  });
 }

test/data/junit/test-results-2.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuites name="More suites" time="0.398" tests="2" failures="0" errors="0">
+  <testsuite name="Suite 4" tests="2" time="0.397" failures="0" errors="0">
+    <testsuite name="Nested suite 4.1" tests="2" time="0.397" failures="0" errors="0">
+      <testcase name="Case 4.1.1" time="0.192"></testcase>
+      <testcase name="Case 4.1.2" time="0.204"></testcase>
+    </testsuite>
+  </testsuite>
+</testsuites>

test/data/junit/vendor/test-results-3.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuites name="Suites that should be excluded" time="9.999" tests="99" failures="19" errors="9">
+  <testsuite name="Ignore this" tests="99" time="9.999" failures="19" errors="9">
+  </testsuite>
+</testsuites>

test/e2e.test.js

@@ -24,7 +24,7 @@ describe('CI Badges action', function () {
       // Check update date
       const updatedAt = new Date(response.data.updated_at).getTime();
       const now = new Date().getTime();
-      assert.ok((now - updatedAt) / 1000 < 10)
+      assert.ok((now - updatedAt) / 1000 < 10);
       // Check uploaded files
       const files = Object.keys(response.data.files);
       [