Fix test names within report

Author: johngrimes

src/tests/utils/generator.ts

@@ -40,7 +40,10 @@ export class DynamicVitestGenerator {
     const testSuite = ViewDefinitionParser.parseTestSuite(testSuiteJson);
     const suiteName = testSuite.title;
 
-    this.generateTestSuite(testSuite, suiteName);
+    // Extract filename for report (e.g., "basic.json" from "/path/to/basic.json")
+    const fileName = filePath.split("/").pop() ?? filePath;
+
+    this.generateTestSuite(testSuite, suiteName, fileName);
   }
 
   /**
@@ -49,6 +52,7 @@ export class DynamicVitestGenerator {
   generateTestsFromDirectory(directoryPath: string): void {
     const files = readdirSync(directoryPath)
       .filter((file) => file.endsWith(".json"))
+      .sort() // Sort to ensure consistent ordering
       .map((file) => join(directoryPath, file));
 
     for (const filePath of files) {
@@ -58,8 +62,16 @@ export class DynamicVitestGenerator {
 
   /**
    * Generate a Vitest test suite for a SQL-on-FHIR test definition.
+   *
+   * @param testSuite The test suite definition
+   * @param suiteName The display name for Vitest (e.g., "basic")
+   * @param reportFileName The filename for the test report (e.g., "basic.json")
    */
-  private generateTestSuite(testSuite: TestSuite, suiteName: string): void {
+  private generateTestSuite(
+    testSuite: TestSuite,
+    suiteName: string,
+    reportFileName: string,
+  ): void {
     const suiteResults: TestReportEntry[] = [];
 
     describe(suiteName, () => {
@@ -70,10 +82,10 @@ export class DynamicVitestGenerator {
       afterAll(async () => {
         await cleanupDatabase();
 
-        // Store results for report generation
+        // Store results for report generation using the filename as the key
         if (typeof global !== "undefined") {
           global.testResults = global.testResults ?? {};
-          global.testResults[suiteName] = { tests: suiteResults };
+          global.testResults[reportFileName] = { tests: suiteResults };
         }
       });
 
@@ -131,11 +143,18 @@ export class DynamicVitestGenerator {
         await executeViewDefinition(testCase.view, testId);
 
         // If we get here, the test should have failed but didn't
-        suiteResults.push({ name: testName, result: { passed: false } });
-        expect.fail("Expected an error but the test passed");
+        const errorMessage = "Expected an error but the test passed";
+        suiteResults.push({
+          name: testCase.title, // Use plain title for report
+          result: { passed: false, error: errorMessage },
+        });
+        expect.fail(errorMessage);
       } catch {
         // Test passed - we expected an error
-        suiteResults.push({ name: testName, result: { passed: true } });
+        suiteResults.push({
+          name: testCase.title, // Use plain title for report
+          result: { passed: true },
+        });
       } finally {
         await cleanupTestData(testId);
       }
@@ -163,17 +182,28 @@ export class DynamicVitestGenerator {
           result.columns,
         );
 
-        suiteResults.push({ name: testName, result: { passed } });
-
         if (!passed) {
-          expect.fail(
-            `Results don't match. Expected: ${JSON.stringify(testCase.expect)}, Actual: ${JSON.stringify(result.results)}`,
-          );
+          const errorMessage = `Results don't match. Expected: ${JSON.stringify(testCase.expect)}, Actual: ${JSON.stringify(result.results)}`;
+          suiteResults.push({
+            name: testCase.title, // Use plain title for report
+            result: { passed: false, error: errorMessage },
+          });
+          expect.fail(errorMessage);
+        } else {
+          suiteResults.push({
+            name: testCase.title, // Use plain title for report
+            result: { passed: true },
+          });
         }
 
         expect(passed).toBe(true);
       } catch (error) {
-        suiteResults.push({ name: testName, result: { passed: false } });
+        const errorMessage =
+          error instanceof Error ? error.message : String(error);
+        suiteResults.push({
+          name: testCase.title, // Use plain title for report
+          result: { passed: false, error: errorMessage },
+        });
         throw error;
       } finally {
         await cleanupTestData(testId);

src/tests/utils/reporter.ts

@@ -203,15 +203,21 @@ class SqlOnFhirReporter implements Reporter {
 
   /**
    * Recursively collect test results from a test suite.
+   *
+   * Note: This is a fallback mechanism. The primary test result collection
+   * happens in the DynamicVitestGenerator which stores results in global.testResults.
+   * This method extracts the plain test title from the formatted test name.
    */
   private collectTestsFromSuite(suite: RunnerTask): TestReportEntry[] {
     const tests: TestReportEntry[] = [];
 
     if ("tasks" in suite && suite.tasks) {
       for (const task of suite.tasks) {
         if (task.type === "test") {
+          // Extract plain title from formatted name: "(suite) title #tag" -> "title"
+          const plainTitle = this.extractPlainTitle(task.name);
           tests.push({
-            name: task.name,
+            name: plainTitle,
             result: {
               passed: task.result?.state === "pass",
             },
@@ -226,6 +232,19 @@ class SqlOnFhirReporter implements Reporter {
     return tests;
   }
 
+  /**
+   * Extract the plain test title from a formatted test name.
+   * Formatted: "(suite) title #tag1 #tag2"
+   * Plain: "title"
+   */
+  private extractPlainTitle(formattedName: string): string {
+    // Remove suite prefix: "(suite) " -> ""
+    let title = formattedName.replace(/^\([^)]+\)\s+/, "");
+    // Remove tags: " #tag1 #tag2" -> ""
+    title = title.replace(/\s+#\S+/g, "");
+    return title.trim();
+  }
+
   /**
    * Clear the collected test results.
    */

src/tests/utils/types.ts

@@ -1,18 +1,33 @@
 /**
  * Type definitions for test reporting.
+ *
+ * Matches the SQL on FHIR test report schema:
+ * https://raw.githubusercontent.com/FHIR/sql-on-fhir-v2/refs/heads/master/test_report/test-report.schema.json
  */
 
 export interface TestReportEntry {
+  /** The name/description of the test case. */
   name: string;
+  /** The test execution result. */
   result: {
+    /** Whether the test passed (true) or failed (false). */
     passed: boolean;
+    /** Optional error message if the test failed. */
+    error?: string;
+    /** Optional additional details about the test result. */
+    details?: Record<string, unknown>;
   };
 }
 
 export interface TestReportSuite {
+  /** Array of test cases within this test suite. */
   tests: TestReportEntry[];
 }
 
 export interface TestReport {
+  /**
+   * Each property represents a test suite file (e.g., 'basic.json', 'common.json').
+   * The report should be a flat object where each key represents a test suite file.
+   */
   [suiteName: string]: TestReportSuite;
 }