test: adjust test helper for message transform

Author: BioPhoton

e2e/plugin-typescript-e2e/tests/collect.e2e.test.ts

@@ -7,6 +7,7 @@ import {
   E2E_ENVIRONMENTS_DIR,
   TEST_OUTPUT_DIR,
   omitVariableReportData,
+  osAgnosticAuditOutputs,
   osAgnosticPath,
   teardownTestFolder,
 } from '@code-pushup/test-utils';
@@ -17,27 +18,9 @@ function sanitizeReportPaths(report: Report): Report {
     ...report,
     plugins: report.plugins.map(plugin => ({
       ...plugin,
-      audits: plugin.audits.map(audit => ({
-        ...audit,
-        ...(audit.details && {
-          details: {
-            ...audit.details,
-            issues: audit.details.issues?.map(issue => ({
-              ...issue,
-              ...(issue.source && {
-                source: {
-                  ...issue.source,
-                  file: osAgnosticPath(issue.source.file),
-                },
-              }),
-              message: issue.message.replace(
-                /['"]([^'"]*[/\\][^'"]*)['"]/g,
-                osAgnosticPath,
-              ),
-            })),
-          },
-        }),
-      })),
+      audits: osAgnosticAuditOutputs(plugin.audits, message =>
+        message.replace(/['"]([^'"]*[/\\][^'"]*)['"]/g, osAgnosticPath),
+      ),
     })),
   };
 }

packages/plugin-typescript/src/lib/runner/runner.int.test.ts

@@ -1,5 +1,6 @@
 import { describe, expect } from 'vitest';
-import { osAgnosticPath } from '@code-pushup/test-utils';
+import type { AuditOutputs } from '@code-pushup/models';
+import { osAgnosticAuditOutputs } from '@code-pushup/test-utils';
 import { getAudits } from '../utils.js';
 import { createRunnerFunction } from './runner.js';
 
@@ -13,24 +14,8 @@ describe('createRunnerFunction', () => {
 
     const result = await runnerFunction();
 
-    const sanitizedResult = result.map(audit => ({
-      ...audit,
-      ...(audit.details && {
-        details: {
-          ...audit.details,
-          issues: audit.details.issues?.map(issue => ({
-            ...issue,
-            ...(issue.source && {
-              source: {
-                ...issue.source,
-                file: osAgnosticPath(issue.source.file),
-              },
-            }),
-          })),
-        },
-      }),
-    }));
-
-    await expect(sanitizedResult).toMatchSnapshot();
+    await expect(
+      osAgnosticAuditOutputs(result as AuditOutputs),
+    ).toMatchSnapshot();
   }, 35_000);
 });

testing/test-utils/src/lib/utils/os-agnostic-paths.ts

@@ -1,8 +1,4 @@
-import type {
-  AuditOutput,
-  AuditOutputs,
-  AuditReport,
-} from '@code-pushup/models';
+import type { AuditOutput, AuditReport } from '@code-pushup/models';
 
 const AGNOSTIC_PATH_SEP_REGEX = /[/\\]/g;
 const OS_AGNOSTIC_PATH_SEP = '/';
@@ -102,6 +98,7 @@ export function osAgnosticPath(filePath?: string): string | undefined {
 
 export function osAgnosticAudit<T extends AuditOutput | AuditReport>(
   audit: T,
+  transformMessage: (message: string) => string = s => s,
 ): T {
   const { issues = [] } = audit.details ?? {};
   if (issues.every(({ source }) => source == null)) {
@@ -119,12 +116,18 @@ export function osAgnosticAudit<T extends AuditOutput | AuditReport>(
                 ...issue.source,
                 file: osAgnosticPath(issue.source.file),
               },
+              message: transformMessage(issue.message),
             },
       ),
     },
   };
 }
 
-export function osAgnosticAuditOutputs(audits: AuditOutputs): AuditOutputs {
-  return audits.map(osAgnosticAudit);
+export function osAgnosticAuditOutputs<T extends AuditOutput | AuditReport>(
+  audits: T[],
+  transformAuditIssueMessage?: (message: string) => string,
+): T[] {
+  return audits.map(audit =>
+    osAgnosticAudit(audit, transformAuditIssueMessage),
+  );
 }