From 5350e1bcc37f501b6a0a8ad6f3f283c98a5516b7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Giancarlo=20Calder=C3=B3n=20C=C3=A1rdenas?=
 <gian1200@hotmail.com>
Date: Sat, 21 Sep 2024 00:12:49 -0500
Subject: [PATCH] fix: complete testResults information

- Add support for nested suites
- Fix TestResultError(s) information
- Fix TestSuiteResult(s) information
- Fix TestResult(s) information
- Update spec file: add new tests
- Add Reporters to improve debugging
---
 src/index.spec.ts          |  19 +++++
 src/index.ts               | 154 ++++++++++++++++++++++++++++++-------
 web-test-runner.config.mjs |   5 ++
 3 files changed, 152 insertions(+), 26 deletions(-)

diff --git a/src/index.spec.ts b/src/index.spec.ts
index 25b86f1..4b38c19 100644
--- a/src/index.spec.ts
+++ b/src/index.spec.ts
@@ -13,4 +13,23 @@ describe('a test suite', () => {
   it('should create element', () => {
     expect(element.innerHTML).toBe('hello there');
   });
+
+  describe('an inner test suite', () => {
+    it("should always be true: Level 2", () => {
+      expect(true).toBeTrue();
+      expect(undefined).toBeUndefined();
+      expect(null).toBeNull();
+      expect(["foo", "bar"]).toHaveSize(2);
+      expect({ "foo": "bar" }).toEqual({ "foo": "bar" });
+    });
+    describe('another inner test suite', () => {
+      it("should always be true: level 3", () => {
+        expect(true).toBeTrue();
+        expect(undefined).toBeUndefined();
+        expect(null).toBeNull();
+        expect(["foo", "bar"]).toHaveSize(2);
+        expect({ "foo": "bar" }).toEqual({ "foo": "bar" });
+      });
+    });
+  });
 });
diff --git a/src/index.ts b/src/index.ts
index 18abbd3..f7350df 100644
--- a/src/index.ts
+++ b/src/index.ts
@@ -18,7 +18,7 @@ export const jasmineTestRunnerConfig = () => {
     reporters: [
       defaultReporter({ reportTestResults: true, reportTestProgress: true })
     ],
-    testRunnerHtml: (_path: any, config: { testFramework: { config?: JasmineConfig }}) => {
+    testRunnerHtml: (_path: any, config: { testFramework: { config?: JasmineConfig } }) => {
       const testFramework = {
         path: './node_modules/jasmine-core/lib/jasmine-core/jasmine.js',
         config: {
@@ -35,7 +35,7 @@ export const jasmineTestRunnerConfig = () => {
             <script>${fs.readFileSync(jasminePath, 'utf8')}</script>
             <script type="module">
               import { getConfig, sessionStarted, sessionFinished, sessionFailed } from '@web/test-runner-core/browser/session.js';
-   
+  
               const testFramework = {
                 ...${JSON.stringify(testFramework)}
               };
@@ -48,44 +48,146 @@ export const jasmineTestRunnerConfig = () => {
               Object.assign(window, jasmineRequire.interface(jasmine, env));
               window.onload = function () {};
   
+              const findParentNode = (treeNode, result) => {
+                if (treeNode.id === result.parentSuiteId) {
+                  return treeNode;
+                } else if (treeNode.suites) {
+                  for (let i = 0; i < treeNode.suites.length; i++) {
+                    const childSuite = treeNode.suites[i];
+                    const elementFound = findParentNode(childSuite, result);
+                    if (elementFound) {
+                      return elementFound;
+                    }
+                  }
+                }
+                return null;
+              };
+              const findResultNode = (treeNode, result) => {
+                if (treeNode.id === result.id) {
+                  return treeNode;
+                }
+                if (treeNode.tests) {
+                  for (let i = 0; i < treeNode.tests.length; i++) {
+                    const childTest = treeNode.tests[i];
+                    const elementFound = findResultNode(childTest, result);
+                    if (elementFound) {
+                      return elementFound;
+                    }
+                  }
+                }
+                if (treeNode.suites) {
+                  for (let i = 0; i < treeNode.suites.length; i++) {
+                    const childSuite = treeNode.suites[i];
+                    const elementFound = findResultNode(childSuite, result);
+                    if (elementFound) {
+                      return elementFound;
+                    }
+                  }
+                }
+                return null;
+              };
+              const buildTestResults = (jasmineTreeNode) => {
+                const treeNode = {
+                  name: jasmineTreeNode.name
+                };
+                if (jasmineTreeNode.tests) {
+                  treeNode.tests = [];
+                  for (let i = 0; i < jasmineTreeNode.tests.length; i++) {
+                    const jasmineTestNode = jasmineTreeNode.tests[i];
+                    treeNode.tests.push({
+                      name: jasmineTestNode.name,
+                      passed: jasmineTestNode.passed,
+                      skipped: jasmineTestNode.skipped,
+                      duration: jasmineTestNode.duration,
+                      error: jasmineTestNode.errors?.[0]
+                    });
+                  }
+                }
+                if (jasmineTreeNode.suites) {
+                  treeNode.suites = [];
+                  for (let i = 0; i < jasmineTreeNode.suites.length; i++) {
+                    const jasmineSuiteNode = jasmineTreeNode.suites[i];
+                    treeNode.suites.push(buildTestResults(jasmineSuiteNode));
+                  }
+                }
+                return treeNode;
+              };
+  
               const failedSpecs = [];
-              const allSpecs = [];
               const failedImports = [];
   
+              const jasmineRootTreeNode = {
+                id: null,
+                name: "",
+                suites: [],
+                tests: []
+              };
+  
               env.addReporter({
-                jasmineStarted: () => {},
-                suiteStarted: () => {},
-                specStarted: () => {},
-                suiteDone: () => {},
+                jasmineStarted: suiteInfo => {},
+                suiteStarted: result => {
+                  if (!result.parentSuiteId) {
+                    jasmineRootTreeNode.id = result.id;
+                    jasmineRootTreeNode.name = result.description;
+                  } else {
+                    const nodeFound = findParentNode(jasmineRootTreeNode, result);
+                    if (nodeFound) {
+                      nodeFound.suites.push({
+                        id: result.id,
+                        name: result.description,
+                        suites: [],
+                        tests: []
+                      });
+                    }
+                  }
+                },
+                specStarted: result => {
+                  if (!result.parentSuiteId) {
+                    jasmineRootTreeNode.id = result.id;
+                    jasmineRootTreeNode.name = result.description;
+                  } else {
+                    const nodeFound = findParentNode(jasmineRootTreeNode, result);
+                    if (nodeFound) {
+                      nodeFound.tests.push({
+                        id: result.id,
+                        name: result.description
+                      });
+                    }
+                  }
+                },
                 specDone: result => {
-                  [...result.passedExpectations, ...result.failedExpectations].forEach(e => {
-                    allSpecs.push({
-                      name: e.description,
-                      passed: e.passed,
-                    });
-                  });
+                  const nodeFound = findResultNode(jasmineRootTreeNode, result);
+                  nodeFound.passed = result.status === "passed";
+                  nodeFound.skipped = false;
+                  nodeFound.duration = result.duration;
+  
+                  if (result.failedExpectations && result.failedExpectations.length > 0) {
+                    nodeFound.errors = [];
+                    for (let i = 0; i < result.failedExpectations.length; i++) {
+                      const e = result.failedExpectations[i];
   
-                  if (result.status !== 'passed' || result.status !== 'incomplete') {
-                    result.failedExpectations.forEach(e => {
-                      failedSpecs.push({
+                      const testResultError = {
                         message: result.fullName + ': ' + e.message,
-                        name: e.description,
+                        name: result.description,
                         stack: e.stack,
-                        expected: e.expected,
-                        actual: e.actual,
-                      });
-                    });
+                        expected: JSON.stringify(e.expected) ?? String(e.expected),
+                        actual: JSON.stringify(e.actual) ?? String(e.actual)
+                      };
+  
+                      failedSpecs.push(testResultError);
+                      nodeFound.errors.push(testResultError);
+                    };
                   }
                 },
+                suiteDone: result => {
+                  const nodeFound = findResultNode(jasmineRootTreeNode, result);
+                  nodeFound.passed = result.status === "passed";
+                },
                 jasmineDone: result => {
                   sessionFinished({
                     passed: result.overallStatus === 'passed',
                     errors: [...failedSpecs, ...failedImports],
-                    testResults: {
-                      name: '',
-                      suites: [],
-                      tests: allSpecs,
-                    },
+                    testResults: buildTestResults(jasmineRootTreeNode)
                   });
                 },
               });
diff --git a/web-test-runner.config.mjs b/web-test-runner.config.mjs
index b1cac66..e881b6d 100644
--- a/web-test-runner.config.mjs
+++ b/web-test-runner.config.mjs
@@ -1,5 +1,6 @@
 import { playwrightLauncher } from '@web/test-runner-playwright';
 import { esbuildPlugin } from '@web/dev-server-esbuild';
+import { defaultReporter, summaryReporter } from "@web/test-runner";
 import { jasmineTestRunnerConfig } from './dist/lib/index.js'; // web-test-runner-jasmine
 
 export default /** @type {import("@web/test-runner").TestRunnerConfig} */ ({
@@ -25,4 +26,8 @@ export default /** @type {import("@web/test-runner").TestRunnerConfig} */ ({
       lines: 90,
     },
   },
+  reporters: [
+    defaultReporter(),
+    summaryReporter(),
+  ],
 });