test(nx-plugin): add tests for buildCommandString

Author: BioPhoton

packages/nx-plugin/src/internal/execute-process.ts

@@ -7,7 +7,10 @@ export function calcDuration(start: number, stop?: number): number {
   return Math.round((stop ?? performance.now()) - start);
 }
 
-function buildCommandString(command: string, args: string[] = []): string {
+export function buildCommandString(
+  command: string,
+  args: string[] = [],
+): string {
   if (args.length === 0) {
     return command;
   }
@@ -169,9 +172,6 @@ export function executeProcess(cfg: ProcessConfig): Promise<ProcessResult> {
   const date = new Date().toISOString();
   const start = performance.now();
 
-  // Build the complete command string
-  const commandString = buildCommandString(command, args ?? []);
-
   ui().logger.log(
     gray(
       `Executing command:\n${formatCommandLog({
@@ -193,6 +193,8 @@ export function executeProcess(cfg: ProcessConfig): Promise<ProcessResult> {
   }
 
   return new Promise((resolve, reject) => {
+    const commandString = buildCommandString(command, args ?? []);
+
     const childProcess = exec(commandString, {
       cwd,
       env: env ? { ...process.env, ...env } : process.env,

packages/nx-plugin/src/internal/execute-process.unit.test.ts

@@ -1,6 +1,10 @@
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 import { getAsyncProcessRunnerConfig } from '@code-pushup/test-utils';
-import { type ProcessObserver, executeProcess } from './execute-process.js';
+import {
+  type ProcessObserver,
+  buildCommandString,
+  executeProcess,
+} from './execute-process.js';
 
 describe('executeProcess', () => {
   const spyObserver: ProcessObserver = {
@@ -90,3 +94,43 @@ describe('executeProcess', () => {
     expect(spyObserver.onComplete).toHaveBeenCalledOnce();
   });
 });
+
+describe('buildCommandString', () => {
+  it('should return command when no args provided', () => {
+    expect(buildCommandString('node')).toBe('node');
+  });
+
+  it('should return command when empty args array provided', () => {
+    expect(buildCommandString('node', [])).toBe('node');
+  });
+
+  it('should return command with simple args', () => {
+    expect(buildCommandString('npm', ['install', 'package'])).toBe(
+      'npm install package',
+    );
+  });
+
+  it('should escape args with spaces', () => {
+    expect(buildCommandString('echo', ['hello world'])).toBe(
+      'echo "hello world"',
+    );
+  });
+
+  it('should escape args with double quotes for shell safety and cross-platform compatibility', () => {
+    expect(buildCommandString('echo', ['say "hello"'])).toBe(
+      'echo "say \\"hello\\""',
+    );
+  });
+
+  it('should escape args with single quotes for shell safety and cross-platform compatibility', () => {
+    expect(buildCommandString('echo', ["it's working"])).toBe(
+      'echo "it\'s working"',
+    );
+  });
+
+  it('should handle mixed escaped and non-escaped args', () => {
+    expect(
+      buildCommandString('node', ['script.js', 'hello world', '--flag']),
+    ).toBe('node script.js "hello world" --flag');
+  });
+});