refactor: wip

Author: Michael Hladky

packages/nx-plugin/src/executors/cli/executor.int.test.ts

@@ -22,7 +22,7 @@ describe('runAutorunExecutor', () => {
   });
 
   afterEach(() => {
-    parseAutorunExecutorOptionsSpy.mockReset();
+    parseAutorunExecutorOptionsSpy.mockRestore();
     executeProcessSpy.mockReset();
   });
 
@@ -48,11 +48,25 @@ describe('runAutorunExecutor', () => {
       command: 'npx',
       args: expect.arrayContaining(['@code-pushup/cli']),
       cwd: process.cwd(),
-      env: expect.objectContaining({
-        CP_VERBOSE: 'true',
-      }),
     });
+  });
 
-    expect(process.env).toHaveProperty('CP_VERBOSE', 'true');
+  it('should forward env options to executeProcess', async () => {
+    const output = await runAutorunExecutor(
+      {
+        verbose: true,
+        env: { TEST_VALUE: '42' },
+      },
+      executorContext('utils'),
+    );
+    expect(output.success).toBe(true);
+    expect(executeProcessSpy).toHaveBeenCalledTimes(1);
+    expect(executeProcessSpy).toHaveBeenCalledWith(
+      expect.objectContaining({
+        env: expect.objectContaining({
+          TEST_VALUE: '42',
+        }),
+      }),
+    );
   });
 });

packages/nx-plugin/src/executors/cli/executor.ts

@@ -22,8 +22,8 @@ export default async function runAutorunExecutor(
     terminalAndExecutorOptions,
     normalizedContext,
   );
-  const { command: cliCommand } = terminalAndExecutorOptions;
   const {
+    command: cliCommand,
     verbose = false,
     dryRun,
     env: executorEnv,

packages/nx-plugin/src/executors/cli/executor.unit.test.ts

@@ -132,7 +132,7 @@ describe('runAutorunExecutor', () => {
     expect(logger.warn).toHaveBeenCalledTimes(0);
   });
 
-  it('should log env var in dryRun information if verbose is set', async () => {
+  it('should log CP_VERBOSE env var in dryRun information if verbose is set', async () => {
     const output = await runAutorunExecutor(
       {
         dryRun: true,

packages/nx-plugin/src/executors/cli/utils.ts

@@ -13,11 +13,12 @@ import type {
 export function parseAutorunExecutorOnlyOptions(
   options: Partial<AutorunCommandExecutorOnlyOptions>,
 ): AutorunCommandExecutorOnlyOptions {
-  const { projectPrefix, dryRun, onlyPlugins } = options;
+  const { projectPrefix, dryRun, onlyPlugins, env } = options;
   return {
     ...(projectPrefix && { projectPrefix }),
     ...(dryRun != null && { dryRun }),
     ...(onlyPlugins && { onlyPlugins }),
+    ...(env && { env }),
   };
 }
 

packages/nx-plugin/src/executors/cli/utils.unit.test.ts

@@ -1,6 +1,8 @@
 import { type MockInstance, expect, vi } from 'vitest';
+import { executorContext } from '@code-pushup/test-nx-utils';
 import { osAgnosticPath } from '@code-pushup/test-utils';
 import type { Command } from '../internal/types.js';
+import runAutorunExecutor from './executor';
 import {
   parseAutorunExecutorOnlyOptions,
   parseAutorunExecutorOptions,
@@ -59,6 +61,12 @@ describe('parseAutorunExecutorOnlyOptions', () => {
       parseAutorunExecutorOnlyOptions({ onlyPlugins: ['md', 'json'] }),
     ).toStrictEqual(expect.objectContaining({ onlyPlugins: ['md', 'json'] }));
   });
+
+  it('should log env variables options if given', async () => {
+    expect(
+      parseAutorunExecutorOnlyOptions({ env: { TEST_ENV_VAR: '42' } }),
+    ).toStrictEqual(expect.objectContaining({ env: { TEST_ENV_VAR: '42' } }));
+  });
 });
 
 describe('parseAutorunExecutorOptions', () => {
@@ -84,7 +92,7 @@ describe('parseAutorunExecutorOptions', () => {
         projectName,
         workspaceRoot: 'workspaceRoot',
         projectConfig: {
-          name: 'my-app',
+          name: projectName,
           root: 'root',
         },
       },
@@ -111,6 +119,28 @@ describe('parseAutorunExecutorOptions', () => {
     );
   });
 
+  it('should include the env options', () => {
+    const projectName = 'my-app';
+    const env = {
+      NODE_OPTIONS: '--import tsx',
+      TSX_TSCONFIG_PATH: 'tsconfig.base.json',
+    };
+
+    const executorOptions = parseAutorunExecutorOptions(
+      { env },
+      {
+        projectName,
+        workspaceRoot: 'workspaceRoot',
+        projectConfig: {
+          name: projectName,
+          root: 'root',
+        },
+      },
+    );
+
+    expect(executorOptions.env).toStrictEqual(env);
+  });
+
   it.each<Command | undefined>(['upload', 'autorun', undefined])(
     'should include upload config for command %s if API key is provided',
     command => {

packages/nx-plugin/src/executors/internal/config.ts

@@ -14,8 +14,9 @@ export function globalConfig(
 ): GlobalExecutorOptions {
   const { projectConfig } = context;
   const { root: projectRoot = '' } = projectConfig ?? {};
-  const { verbose, config } = options;
+  const { verbose, config, command } = options;
   return {
+    command,
     verbose: !!verbose,
     config: config ?? path.join(projectRoot, 'code-pushup.config.ts'),
   };

packages/nx-plugin/src/executors/internal/config.unit.test.ts

@@ -67,6 +67,20 @@ describe('globalConfig', () => {
     ).toEqual(expect.objectContaining({ config: 'my.config.ts' }));
   });
 
+  it('should include the command options', () => {
+    const { command } = globalConfig(
+      { command: 'collect' },
+      {
+        workspaceRoot: '/test/root/workspace-root',
+        projectConfig: {
+          name: 'my-app',
+          root: 'packages/project-root',
+        },
+      },
+    );
+    expect(command).toBe('collect');
+  });
+
   it('should work with empty projectConfig', () => {
     expect(
       globalConfig(

packages/nx-plugin/src/executors/internal/types.ts

@@ -5,6 +5,7 @@ import type { ProjectConfiguration } from 'nx/src/config/workspace-json-project-
  */
 export type GeneralExecutorOnlyOptions = {
   dryRun?: boolean;
+  env?: Record<string, string>;
 };
 
 /**