Adds tests and coverage summary to workflow. Closes #3288

Reorganize scripts

Author: Vedu1996

.c8rc.json

@@ -1,10 +1,16 @@
 {
-  "exclude": ["**/*.spec.js", "**/*.mock.js", "**/clientsidepages.js", "docs"],
+  "exclude": [
+    "**/*.spec.js",
+    "**/*.mock.js",
+    "**/clientsidepages.js",
+    "docs",
+    "**/ci-test-summary.cjs"
+  ],
   "reporter": ["lcov", "text", "text-summary"],
   "check-coverage": true,
   "branches": 100,
   "functions": 100,
   "lines": 100,
   "statements": 100,
   "skip-full": true
-}
+}

.eslintrc.cjs

@@ -142,7 +142,8 @@ module.exports = {
     "**/package-generate/assets/**",
     "**/test-projects/**",
     "clientsidepages.ts",
-    "*.js"
+    "*.js",
+    "*.cjs"
   ],
   "rules": {
     "cli-microsoft365/correct-command-class-name": ["error", sortedDictionary, capitalized],

.mocharc.json

@@ -1,11 +1,9 @@
 {
-  "extension": [
-    "ts"
-  ],
+  "extension": ["ts"],
   "spec": "dist/**/*.spec.js",
-  "reporter": "min",
+  "reporter": "scripts/ci-test-summary.cjs",
   "require": "source-map-support/register",
   "watch": "dist/**/*.js",
   "timeout": 10000,
   "logpanel": true
-}
+}

npm-shrinkwrap.json

@@ -163,7 +163,7 @@
     "Kornet, Michał <kornetmichal@gmail.com>",
     "Kumar, Shantha <34408892+ktskumar@users.noreply.github.com>",
     "Kurian, Cyril C <cyril.kurian2@gmail.com>",
-    "Lakshminarayanan, Vedant <vlakshminarayanan@seekasia.com>",
+    "Lakshminarayanan, Vedant <28388096+Vedu1996@users.noreply.github.com>",
     "Lamber, Patrick <patrick@nubo.eu>",
     "Laskewitz, Daniel <daniel@laskewitz.nl>",
     "Lengelle, Veronique <25181757+veronicageek@users.noreply.github.com>",
@@ -277,6 +277,7 @@
     "yaml": "^2.3.4"
   },
   "devDependencies": {
+    "@actions/core": "^1.10.1",
     "@microsoft/microsoft-graph-types": "^2.40.0",
     "@types/adm-zip": "^0.5.5",
     "@types/jmespath": "^0.15.2",

package.json

@@ -0,0 +1,125 @@
+const mocha = require('mocha');
+const core = require('@actions/core');
+
+const { EVENT_RUN_END, EVENT_TEST_FAIL, EVENT_RUN_BEGIN } =
+  mocha.Runner.constants;
+
+class TestSummaryReporter {
+  summary = core.summary;
+  testResult = { failedTests: {}, stats: {} };
+  suiteIndenter = '  ';
+  destination;
+
+  constructor(runner, options) {
+    new mocha.reporters.Min(runner, options);
+
+    if (!process.env.GITHUB_STEP_SUMMARY) {
+      return;
+    }
+
+    const stats = runner.stats;
+    runner
+      .on(EVENT_RUN_BEGIN, () => {
+        // Capturing the value of GITHUB_STEP_SUMMARY to use later
+        this.destination = process.env.GITHUB_STEP_SUMMARY;
+      })
+      .on(EVENT_TEST_FAIL, (test, _) => {
+        const testPath = test.titlePath();
+        const testName = testPath.pop();
+        let resultPath = this.testResult.failedTests;
+        testPath.forEach((item, index) => {
+          if (index === testPath.length - 1) {
+            if (!resultPath.hasOwnProperty(item)) {
+              resultPath[item] = [];
+            }
+            resultPath[item].push(testName);
+          }
+          if (!resultPath.hasOwnProperty(item)) {
+            resultPath[item] = {};
+          }
+          resultPath = resultPath[item];
+        });
+      })
+      .once(EVENT_RUN_END, () => {
+        this.testResult.stats = {
+          passed: stats.passes,
+          failed: stats.failures,
+          total: stats.passes + stats.failures,
+        };
+        this.writeSummary();
+      });
+  }
+
+  async writeSummary() {
+    try {
+      if (this.testResult.stats.failed > 0) {
+        this.summary = this.summary.addHeading('Failed tests', 3);
+        this.summary = this.summary
+          .addRaw(this.generateAccordion('', null, this.testResult.failedTests))
+          .addSeparator();
+      }
+      this.writeStatsTable();
+      this.writeResultsBar();
+      // Resettig GITHUB_STEP_SUMMARY, since unit tests might overwrite it
+      process.env.GITHUB_STEP_SUMMARY = this.destination;
+      await this.summary.write();
+    } catch (e) {
+      console.error(e);
+    }
+  }
+
+  generateAccordion(suitePrefix, suiteName, suiteObject) {
+    if (typeof suiteObject !== 'object') {
+      // Item is a test, not a suite
+      return `${suitePrefix}❌ ${suiteObject}<br />`;
+    }
+    let detailsContent = '';
+
+    // Generate accordion for each item in suite
+    Object.keys(suiteObject).forEach(
+      (item) =>
+        (detailsContent =
+          detailsContent +
+          this.generateAccordion(
+            `${suitePrefix}${this.suiteIndenter}`,
+            item,
+            suiteObject[item]
+          ))
+    );
+
+    // First level does not require accordion
+    if (suiteName === null) {
+      return detailsContent;
+    }
+
+    // Return an accordion for the suite
+    return `
+      <details>
+        <summary>${suitePrefix}${suiteName}</summary>
+        ${detailsContent}
+      </details>
+    `;
+  }
+
+  writeStatsTable() {
+    this.summary.addHeading('Stats', 3);
+    this.summary = this.summary.addTable([
+      ['Total number of tests', '' + this.testResult.stats.total],
+      ['Passed ✅', '' + this.testResult.stats.passed],
+      ['Failed ❌', '' + this.testResult.stats.failed],
+    ]);
+  }
+
+  writeResultsBar() {
+    let percentagePassed = Math.floor(
+      (this.testResult.stats.passed / this.testResult.stats.total) * 100
+    );
+    this.summary = this.summary.addRaw(
+      '<div style="width: 50%; background-color: red; text-align: center; color: white;"><div style="width:' +
+        percentagePassed +
+        '%; height: 18px; background-color: green;"></div></div>'
+    );
+  }
+}
+
+module.exports = TestSummaryReporter;