test(core): update unit tests to use custom matchers

Author: hanna-skryl

packages/core/src/lib/collect-and-persist.unit.test.ts

@@ -3,7 +3,6 @@ import {
   ISO_STRING_REGEXP,
   MINIMAL_CONFIG_MOCK,
   MINIMAL_REPORT_MOCK,
-  getLogMessages,
 } from '@code-pushup/test-utils';
 import {
   type ScoredReport,
@@ -115,7 +114,6 @@ describe('collectAndPersistReports', () => {
     await collectAndPersistReports(
       MINIMAL_CONFIG_MOCK as CollectAndPersistReportsOptions,
     );
-    const logs = getLogMessages(ui().logger);
-    expect(logs.at(-2)).toContain('Made with ❤ by code-pushup.dev');
+    expect(ui()).toHaveLoggedMessage('Made with ❤ by code-pushup.dev');
   });
 });

packages/core/src/lib/implementation/persist.unit.test.ts

@@ -7,7 +7,6 @@ import {
   MEMFS_VOLUME,
   MINIMAL_REPORT_MOCK,
   REPORT_MOCK,
-  getLogMessages,
 } from '@code-pushup/test-utils';
 import { scoreReport, sortReport, ui } from '@code-pushup/utils';
 import { logPersistedResults, persistReport } from './persist.js';
@@ -91,30 +90,35 @@ describe('persistReport', () => {
 describe('logPersistedResults', () => {
   it('should log report sizes correctly`', () => {
     logPersistedResults([{ status: 'fulfilled', value: ['out.json', 10_000] }]);
-    const logs = getLogMessages(ui().logger);
-    expect(logs[0]).toBe('[ green(success) ] Generated reports successfully: ');
-    expect(logs[1]).toContain('9.77 kB');
-    expect(logs[1]).toContain('out.json');
+    expect(ui()).toHaveLoggedNthLevel(1, 'success');
+    expect(ui()).toHaveLoggedNthMessageContaining(
+      1,
+      'Generated reports successfully: ',
+    );
+    expect(ui()).toHaveLoggedNthMessageContaining(2, '9.77 kB');
+    expect(ui()).toHaveLoggedNthMessageContaining(2, 'out.json');
   });
 
   it('should log fails correctly`', () => {
     logPersistedResults([{ status: 'rejected', reason: 'fail' }]);
-    const logs = getLogMessages(ui().logger);
-    expect(logs[0]).toBe('[ yellow(warn) ] Generated reports failed: ');
-    expect(logs[1]).toContain('fail');
+    expect(ui()).toHaveLoggedNthLevel(1, 'warn');
+    expect(ui()).toHaveLoggedNthMessage(1, 'Generated reports failed: ');
+    expect(ui()).toHaveLoggedNthMessageContaining(2, 'fail');
   });
 
   it('should log report sizes and fails correctly`', () => {
     logPersistedResults([
       { status: 'fulfilled', value: ['out.json', 10_000] },
       { status: 'rejected', reason: 'fail' },
     ]);
-    const logs = getLogMessages(ui().logger);
-    expect(logs[0]).toBe('[ green(success) ] Generated reports successfully: ');
-    expect(logs[1]).toContain('out.json');
-    expect(logs[1]).toContain('9.77 kB');
-
-    expect(logs[2]).toContain('Generated reports failed: ');
-    expect(logs[2]).toContain('fail');
+    expect(ui()).toHaveLoggedNthLevel(1, 'success');
+    expect(ui()).toHaveLoggedNthMessage(1, 'Generated reports successfully: ');
+    expect(ui()).toHaveLoggedNthMessageContaining(2, 'out.json');
+    expect(ui()).toHaveLoggedNthMessageContaining(2, '9.77 kB');
+    expect(ui()).toHaveLoggedNthMessageContaining(
+      3,
+      'Generated reports failed: ',
+    );
+    expect(ui()).toHaveLoggedNthMessageContaining(3, 'fail');
   });
 });

packages/core/src/lib/merge-diffs.unit.test.ts

@@ -4,7 +4,6 @@ import path from 'node:path';
 import type { PersistConfig } from '@code-pushup/models';
 import {
   MEMFS_VOLUME,
-  getLogMessages,
   reportsDiffAddedPluginMock,
   reportsDiffAltMock,
   reportsDiffMock,
@@ -64,13 +63,13 @@ describe('mergeDiffs', () => {
       ),
     ).resolves.toBe(path.join(MEMFS_VOLUME, 'report-diff.md'));
 
-    expect(getLogMessages(ui().logger)).toEqual([
-      expect.stringContaining(
-        'Skipped invalid report diff - Failed to read JSON file missing-report-diff.json',
-      ),
-      expect.stringContaining(
-        'Skipped invalid report diff - Invalid reports diff in invalid-report-diff.json',
-      ),
-    ]);
+    expect(ui()).toHaveLoggedNthMessageContaining(
+      1,
+      'Skipped invalid report diff - Failed to read JSON file missing-report-diff.json',
+    );
+    expect(ui()).toHaveLoggedNthMessageContaining(
+      2,
+      'Skipped invalid report diff - Invalid reports diff in invalid-report-diff.json',
+    );
   });
 });

packages/core/tsconfig.test.json

@@ -12,6 +12,7 @@
     "src/**/*.test.js",
     "src/**/*.test.jsx",
     "src/**/*.d.ts",
-    "mocks/**/*.ts"
+    "mocks/**/*.ts",
+    "../../testing/test-setup/src/vitest.d.ts"
   ]
 }

packages/core/vite.config.unit.ts

@@ -28,6 +28,7 @@ export default defineConfig({
       '../../testing/test-setup/src/lib/console.mock.ts',
       '../../testing/test-setup/src/lib/reset.mocks.ts',
       '../../testing/test-setup/src/lib/portal-client.mock.ts',
+      '../../testing/test-setup/src/lib/extend/ui-logger.matcher.ts',
     ],
   },
 });