test(test-setup): prepare logger spies, silence logs unless --verbose

Author: matejchalk

nx.json

@@ -28,6 +28,9 @@
     ],
     "test-vitest-inputs": [
       "os",
+      {
+        "env": "NX_VERBOSE_LOGGING"
+      },
       {
         "externalDependencies": ["vitest"]
       }

packages/utils/src/lib/logging.ts

@@ -3,6 +3,8 @@ import { cliui } from '@poppinss/cliui';
 import { underline } from 'ansis';
 import { TERMINAL_WIDTH } from './reports/constants.js';
 
+// TODO: remove once logger is used everywhere
+
 // eslint-disable-next-line  @typescript-eslint/no-explicit-any
 type ArgumentsType<T> = T extends (...args: infer U) => any ? U : never;
 export type CliUiBase = ReturnType<typeof cliui>;

testing/test-setup/src/lib/cliui.mock.ts

@@ -1,5 +1,7 @@
 import { beforeAll, beforeEach, vi } from 'vitest';
 
+// TODO: remove once logger is used everywhere
+
 beforeAll(async () => {
   const utils: typeof import('@code-pushup/utils') =
     await vi.importActual('@code-pushup/utils');

testing/test-setup/src/lib/console.mock.ts

@@ -1,5 +1,7 @@
 import { type MockInstance, afterEach, beforeEach, vi } from 'vitest';
 
+// TODO: remove once logger is used everywhere
+
 let consoleInfoSpy: MockInstance<any[], void> | undefined;
 let consoleWarnSpy: MockInstance<any[], void> | undefined;
 let consoleErrorSpy: MockInstance<any[], void> | undefined;

testing/test-setup/src/lib/extend/ui-logger.matcher.ts

@@ -8,6 +8,8 @@ import {
   hasExpectedMessage,
 } from './ui-logger.matcher.utils';
 
+// TODO: remove once logger is used everywhere
+
 type CliUi = ReturnType<typeof cliui>;
 
 export type CustomUiLoggerMatchers = {

testing/test-setup/src/lib/logger.mock.ts

@@ -0,0 +1,46 @@
+import { type MockInstance, afterAll, beforeAll, vi } from 'vitest';
+import { logger } from '@code-pushup/utils';
+
+const loggerSpies: MockInstance[] = [];
+
+beforeAll(() => {
+  // TODO: use vi.mockObject after Vitest update: https://vitest.dev/api/vi.html#vi-mockobject-3-2-0
+  if (process.env['NX_VERBOSE_LOGGING'] === 'true') {
+    // only track calls, but preserve original implementation so logs are printed
+    loggerSpies.push(
+      vi.spyOn(logger, 'error'),
+      vi.spyOn(logger, 'warn'),
+      vi.spyOn(logger, 'info'),
+      vi.spyOn(logger, 'debug'),
+      vi.spyOn(logger, 'newline'),
+      vi.spyOn(logger, 'group'),
+      vi.spyOn(logger, 'task'),
+      vi.spyOn(logger, 'command'),
+    );
+  } else {
+    // track calls and silence logs
+    loggerSpies.push(
+      vi.spyOn(logger, 'error').mockImplementation(() => {}),
+      vi.spyOn(logger, 'warn').mockImplementation(() => {}),
+      vi.spyOn(logger, 'info').mockImplementation(() => {}),
+      vi.spyOn(logger, 'debug').mockImplementation(() => {}),
+      vi.spyOn(logger, 'newline').mockImplementation(() => {}),
+      // make sure worker still gets executed
+      vi.spyOn(logger, 'group').mockImplementation(async (_, worker) => {
+        await worker();
+      }),
+      vi.spyOn(logger, 'task').mockImplementation(async (_, worker) => {
+        await worker();
+      }),
+      vi.spyOn(logger, 'command').mockImplementation(async (_, worker) => {
+        await worker();
+      }),
+    );
+  }
+});
+
+afterAll(() => {
+  loggerSpies.forEach(loggerSpy => {
+    loggerSpy.mockRestore();
+  });
+});