fix(nx-plugin): print stdout for CLI command

BioPhoton · BioPhoton · commit 104a05964c32 · 2025-09-01T22:54:50.000+02:00
diff --git a/packages/nx-plugin/src/executors/cli/executor.int.test.ts b/packages/nx-plugin/src/executors/cli/executor.int.test.ts
@@ -1,25 +1,29 @@
-import { execSync } from 'node:child_process';
 import { afterEach, expect, vi } from 'vitest';
 import { executorContext } from '@code-pushup/test-nx-utils';
+import * as executeProcessModule from '../../internal/execute-process.js';
 import runAutorunExecutor from './executor.js';
 import * as utils from './utils.js';
 
-vi.mock('node:child_process', async () => {
-  const actual = await vi.importActual('node:child_process');
-  return {
-    ...actual,
-    execSync: vi.fn(),
-  };
-});
-
 describe('runAutorunExecutor', () => {
   const parseAutorunExecutorOptionsSpy = vi.spyOn(
     utils,
     'parseAutorunExecutorOptions',
   );
+  const executeProcessSpy = vi.spyOn(executeProcessModule, 'executeProcess');
+
+  beforeEach(() => {
+    executeProcessSpy.mockResolvedValue({
+      code: 0,
+      stdout: '',
+      stderr: '',
+      date: new Date().toISOString(),
+      duration: 100,
+    });
+  });
 
   afterEach(() => {
     parseAutorunExecutorOptionsSpy.mockReset();
+    executeProcessSpy.mockReset();
   });
 
   it('should normalize context, parse CLI options and execute command', async () => {
@@ -38,11 +42,17 @@ describe('runAutorunExecutor', () => {
         projectConfig: expect.objectContaining({ name: 'utils' }),
       }),
     );
-    // eslint-disable-next-line n/no-sync
-    expect(execSync).toHaveBeenCalledTimes(1);
-    // eslint-disable-next-line n/no-sync
-    expect(execSync).toHaveBeenCalledWith(expect.stringContaining('utils'), {
-      cwd: process.cwd(),
-    });
+    expect(executeProcessSpy).toHaveBeenCalledTimes(1);
+    expect(executeProcessSpy).toHaveBeenCalledWith(
+      expect.objectContaining({
+        command: 'npx',
+        args: expect.arrayContaining(['@code-pushup/cli']),
+        cwd: process.cwd(),
+        observer: expect.objectContaining({
+          onError: expect.any(Function),
+          onStdout: expect.any(Function),
+        }),
+      }),
+    );
   });
 });
diff --git a/packages/nx-plugin/src/executors/cli/executor.ts b/packages/nx-plugin/src/executors/cli/executor.ts
@@ -1,20 +1,20 @@
 import { type ExecutorContext, logger } from '@nx/devkit';
-import { execSync } from 'node:child_process';
-import { createCliCommand } from '../internal/cli.js';
+import { executeProcess } from '../../internal/execute-process.js';
+import {
+  createCliCommandObject,
+  createCliCommandString,
+} from '../internal/cli.js';
 import { normalizeContext } from '../internal/context.js';
 import type { AutorunCommandExecutorOptions } from './schema.js';
-import {
-  mergeExecutorOptions,
-  objectToCliArgs,
-  parseAutorunExecutorOptions,
-} from './utils.js';
+import { mergeExecutorOptions, parseAutorunExecutorOptions } from './utils.js';
 
 export type ExecutorOutput = {
   success: boolean;
   command?: string;
   error?: Error;
 };
 
+// eslint-disable-next-line max-lines-per-function
 export default async function runAutorunExecutor(
   terminalAndExecutorOptions: AutorunCommandExecutorOptions,
   context: ExecutorContext,
@@ -30,8 +30,10 @@ export default async function runAutorunExecutor(
   );
   const { dryRun, verbose, command } = mergedOptions;
 
-  const commandString = createCliCommand({ command, args: cliArgumentObject });
-  const commandStringOptions = context.cwd ? { cwd: context.cwd } : {};
+  const commandString = createCliCommandString({
+    command,
+    args: cliArgumentObject,
+  });
   if (verbose) {
     logger.info(`Run CLI executor ${command ?? ''}`);
     logger.info(`Command: ${commandString}`);
@@ -40,32 +42,30 @@ export default async function runAutorunExecutor(
     logger.warn(`DryRun execution of: ${commandString}`);
   } else {
     try {
-      const { executeProcess }: typeof import('@code-pushup/utils') =
-        await import('@code-pushup/utils');
       await executeProcess({
-        command: command,
-        args: objectToCliArgs(cliArgumentObject),
+        ...createCliCommandObject({ command, args: cliArgumentObject }),
         observer: {
-          error: data => {
-            process.stderr.write(data);
+          onError: error => {
+            logger.error(error.message);
           },
-          next: data => {
+          onStdout: data => {
             process.stdout.write(data);
           },
         },
+        ...(context.cwd ? { cwd: context.cwd } : {}),
       });
     } catch (error) {
       logger.error(error);
-      return Promise.resolve({
+      return {
         success: false,
         command: commandString,
         error: error as Error,
-      });
+      };
     }
   }
 
-  return Promise.resolve({
+  return {
     success: true,
     command: commandString,
-  });
+  };
 }
diff --git a/packages/nx-plugin/src/executors/cli/executor.unit.test.ts b/packages/nx-plugin/src/executors/cli/executor.unit.test.ts
@@ -1,35 +1,30 @@
 import { logger } from '@nx/devkit';
-import { execSync } from 'node:child_process';
 import { afterAll, afterEach, beforeEach, expect, vi } from 'vitest';
 import { executorContext } from '@code-pushup/test-nx-utils';
 import { MEMFS_VOLUME } from '@code-pushup/test-utils';
+import * as executeProcessModule from '../../internal/execute-process.js';
 import runAutorunExecutor from './executor.js';
 
-vi.mock('node:child_process', async () => {
-  const actual = await vi.importActual('node:child_process');
-
-  return {
-    ...actual,
-    execSync: vi.fn((command: string) => {
-      if (command.includes('THROW_ERROR')) {
-        throw new Error(command);
-      }
-    }),
-  };
-});
-
 describe('runAutorunExecutor', () => {
   const processEnvCP = Object.fromEntries(
     Object.entries(process.env).filter(([k]) => k.startsWith('CP_')),
   );
   const loggerInfoSpy = vi.spyOn(logger, 'info');
   const loggerWarnSpy = vi.spyOn(logger, 'warn');
+  const executeProcessSpy = vi.spyOn(executeProcessModule, 'executeProcess');
 
   /* eslint-disable functional/immutable-data, @typescript-eslint/no-dynamic-delete */
   beforeAll(() => {
     Object.entries(process.env)
       .filter(([k]) => k.startsWith('CP_'))
       .forEach(([k]) => delete process.env[k]);
+    executeProcessSpy.mockResolvedValue({
+      code: 0,
+      stdout: '',
+      stderr: '',
+      date: new Date().toISOString(),
+      duration: 100,
+    });
   });
 
   beforeEach(() => {
@@ -39,21 +34,28 @@ describe('runAutorunExecutor', () => {
   afterEach(() => {
     loggerWarnSpy.mockReset();
     loggerInfoSpy.mockReset();
+    executeProcessSpy.mockReset();
   });
 
   afterAll(() => {
     Object.entries(processEnvCP).forEach(([k, v]) => (process.env[k] = v));
   });
   /* eslint-enable functional/immutable-data, @typescript-eslint/no-dynamic-delete */
 
-  it('should call execSync with return result', async () => {
+  it('should call executeProcess with return result', async () => {
     const output = await runAutorunExecutor({}, executorContext('utils'));
     expect(output.success).toBe(true);
     expect(output.command).toMatch('npx @code-pushup/cli');
-    // eslint-disable-next-line n/no-sync
-    expect(execSync).toHaveBeenCalledWith(
-      expect.stringContaining('npx @code-pushup/cli'),
-      { cwd: MEMFS_VOLUME },
+    expect(executeProcessSpy).toHaveBeenCalledWith(
+      expect.objectContaining({
+        command: 'npx',
+        args: expect.arrayContaining(['@code-pushup/cli']),
+        cwd: MEMFS_VOLUME,
+        observer: expect.objectContaining({
+          onError: expect.any(Function),
+          onStdout: expect.any(Function),
+        }),
+      }),
     );
   });
 
@@ -67,10 +69,17 @@ describe('runAutorunExecutor', () => {
     );
     expect(output.success).toBe(true);
     expect(output.command).toMatch('utils');
-    // eslint-disable-next-line n/no-sync
-    expect(execSync).toHaveBeenCalledWith(expect.stringContaining('utils'), {
-      cwd: 'cwd-form-context',
-    });
+    expect(executeProcessSpy).toHaveBeenCalledWith(
+      expect.objectContaining({
+        command: 'npx',
+        args: expect.arrayContaining(['@code-pushup/cli']),
+        cwd: 'cwd-form-context',
+        observer: expect.objectContaining({
+          onError: expect.any(Function),
+          onStdout: expect.any(Function),
+        }),
+      }),
+    );
   });
 
   it('should process executorOptions', async () => {
@@ -114,8 +123,7 @@ describe('runAutorunExecutor', () => {
       { verbose: true },
       { ...executorContext('github-action'), cwd: '<CWD>' },
     );
-    // eslint-disable-next-line n/no-sync
-    expect(execSync).toHaveBeenCalledTimes(1);
+    expect(executeProcessSpy).toHaveBeenCalledTimes(1);
 
     expect(output.command).toMatch('--verbose');
     expect(loggerWarnSpy).toHaveBeenCalledTimes(0);
diff --git a/packages/nx-plugin/src/executors/internal/cli.ts b/packages/nx-plugin/src/executors/internal/cli.ts
@@ -1,4 +1,4 @@
-export function createCliCommand(options?: {
+export function createCliCommandString(options?: {
   args?: Record<string, unknown>;
   command?: string;
   bin?: string;
@@ -9,6 +9,22 @@ export function createCliCommand(options?: {
   )}`;
 }
 
+export function createCliCommandObject(options?: {
+  args?: Record<string, unknown>;
+  command?: string;
+  bin?: string;
+}): {
+  command: string;
+  args: string[];
+  cwd?: string;
+} {
+  const { bin = '@code-pushup/cli', command, args } = options ?? {};
+  return {
+    command: 'npx',
+    args: [bin, ...objectToCliArgs({ _: command ?? [], ...args })],
+  };
+}
+
 type ArgumentValue = number | string | boolean | string[];
 export type CliArgsObject<T extends object = Record<string, ArgumentValue>> =
   T extends never
diff --git a/packages/nx-plugin/src/executors/internal/cli.unit.test.ts b/packages/nx-plugin/src/executors/internal/cli.unit.test.ts
@@ -1,5 +1,5 @@
 import { describe, expect, it } from 'vitest';
-import { createCliCommand, objectToCliArgs } from './cli.js';
+import { createCliCommandString, objectToCliArgs } from './cli.js';
 
 describe('objectToCliArgs', () => {
   it('should empty params', () => {
@@ -86,14 +86,16 @@ describe('objectToCliArgs', () => {
   });
 });
 
-describe('createCliCommand', () => {
+describe('createCliCommandString', () => {
   it('should create command out of object for arguments', () => {
-    const result = createCliCommand({ args: { verbose: true } });
+    const result = createCliCommandString({ args: { verbose: true } });
     expect(result).toBe('npx @code-pushup/cli --verbose');
   });
 
   it('should create command out of object for arguments with positional', () => {
-    const result = createCliCommand({ args: { _: 'autorun', verbose: true } });
+    const result = createCliCommandString({
+      args: { _: 'autorun', verbose: true },
+    });
     expect(result).toBe('npx @code-pushup/cli autorun --verbose');
   });
 });
