refactor(nx-plugin): add env vars to executor (#1161)

Author: BioPhoton

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

@@ -1,14 +1,11 @@
-import { afterEach, expect, vi } from 'vitest';
+import { afterEach, beforeEach, describe, expect, it, 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 runCliExecutor from './executor.js';
 import * as utils from './utils.js';
 
-describe('runAutorunExecutor', () => {
-  const parseAutorunExecutorOptionsSpy = vi.spyOn(
-    utils,
-    'parseAutorunExecutorOptions',
-  );
+describe('runCliExecutor', () => {
+  const parseCliExecutorOptionsSpy = vi.spyOn(utils, 'parseCliExecutorOptions');
   const executeProcessSpy = vi.spyOn(executeProcessModule, 'executeProcess');
 
   beforeEach(() => {
@@ -22,22 +19,22 @@ describe('runAutorunExecutor', () => {
   });
 
   afterEach(() => {
-    parseAutorunExecutorOptionsSpy.mockReset();
+    parseCliExecutorOptionsSpy.mockRestore();
     executeProcessSpy.mockReset();
   });
 
   it('should normalize context, parse CLI options and execute command', async () => {
     expect(process.env).not.toHaveProperty('CP_VERBOSE', 'true');
-    const output = await runAutorunExecutor(
+    const output = await runCliExecutor(
       { verbose: true },
       executorContext('utils'),
     );
     expect(output.success).toBe(true);
 
-    expect(parseAutorunExecutorOptionsSpy).toHaveBeenCalledTimes(1);
+    expect(parseCliExecutorOptionsSpy).toHaveBeenCalledTimes(1);
 
     //is context normalized
-    expect(parseAutorunExecutorOptionsSpy).toHaveBeenCalledWith(
+    expect(parseCliExecutorOptionsSpy).toHaveBeenCalledWith(
       { verbose: true },
       expect.objectContaining({
         projectConfig: expect.objectContaining({ name: 'utils' }),
@@ -49,7 +46,24 @@ describe('runAutorunExecutor', () => {
       args: expect.arrayContaining(['@code-pushup/cli']),
       cwd: process.cwd(),
     });
+  });
 
-    expect(process.env).toHaveProperty('CP_VERBOSE', 'true');
+  it('should forward env options to executeProcess', async () => {
+    const output = await runCliExecutor(
+      {
+        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

@@ -1,8 +1,8 @@
 import type { ExecutorContext } from '@nx/devkit';
 import { executeProcess } from '../../internal/execute-process.js';
 import { normalizeContext } from '../internal/context.js';
-import type { AutorunCommandExecutorOptions } from './schema.js';
-import { parseAutorunExecutorOptions } from './utils.js';
+import type { CliCommandExecutorOptions } from './schema.js';
+import { parseCliExecutorOptions } from './utils.js';
 
 export type ExecutorOutput = {
   success: boolean;
@@ -11,44 +11,58 @@ export type ExecutorOutput = {
 };
 
 /* eslint-disable-next-line max-lines-per-function */
-export default async function runAutorunExecutor(
-  terminalAndExecutorOptions: AutorunCommandExecutorOptions,
+export default async function runCliExecutor(
+  terminalAndExecutorOptions: CliCommandExecutorOptions,
   context: ExecutorContext,
 ): Promise<ExecutorOutput> {
   const { objectToCliArgs, formatCommandStatus, logger, stringifyError } =
     await import('@code-pushup/utils');
   const normalizedContext = normalizeContext(context);
-  const cliArgumentObject = parseAutorunExecutorOptions(
-    terminalAndExecutorOptions,
-    normalizedContext,
-  );
-  const { command: cliCommand } = terminalAndExecutorOptions;
-  const { verbose = false, dryRun, bin, ...restArgs } = cliArgumentObject;
+  const {
+    command: cliCommand,
+    verbose = false,
+    dryRun,
+    env: executorEnv,
+    bin,
+    ...restArgs
+  } = parseCliExecutorOptions(terminalAndExecutorOptions, normalizedContext);
+  // this sets `CP_VERBOSE=true` on process.env
   logger.setVerbose(verbose);
 
   const command = bin ? `node` : 'npx';
-  const positionals = [
+  const args = [
     bin ?? '@code-pushup/cli',
     ...(cliCommand ? [cliCommand] : []),
+    ...objectToCliArgs(restArgs),
   ];
-  const args = [...positionals, ...objectToCliArgs(restArgs)];
-  const executorEnvVariables = {
+  const loggedEnvVars = {
+    ...executorEnv,
     ...(verbose && { CP_VERBOSE: 'true' }),
   };
   const commandString = formatCommandStatus([command, ...args].join(' '), {
     cwd: context.cwd,
-    env: executorEnvVariables,
+    env: loggedEnvVars,
   });
 
   if (dryRun) {
     logger.warn(`DryRun execution of: ${commandString}`);
   } else {
     try {
-      logger.debug(`With env vars: ${executorEnvVariables}`);
+      logger.debug(`Run CLI with env vars: ${loggedEnvVars}`);
       await executeProcess({
         command,
         args,
         ...(context.cwd ? { cwd: context.cwd } : {}),
+        ...(executorEnv && Object.keys(executorEnv).length > 0
+          ? {
+              env: {
+                // if env is undefined, executeProcess extends process.env by default
+                ...process.env,
+                // we don't pass `CP_VERBOSE=true` as it is handled inside logger.setVerbose
+                ...executorEnv,
+              },
+            }
+          : {}),
       });
     } catch (error) {
       logger.error(stringifyError(error));

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

@@ -1,10 +1,19 @@
-import { afterAll, afterEach, beforeEach, expect, vi } from 'vitest';
+import {
+  afterAll,
+  afterEach,
+  beforeAll,
+  beforeEach,
+  describe,
+  expect,
+  it,
+  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';
+import runCliExecutor from './executor.js';
 
-describe('runAutorunExecutor', () => {
+describe('runCliExecutor', () => {
   const processEnvCP = Object.fromEntries(
     Object.entries(process.env).filter(([k]) => k.startsWith('CP_')),
   );
@@ -41,7 +50,7 @@ describe('runAutorunExecutor', () => {
   });
 
   it('should call executeProcess with return result', async () => {
-    const output = await runAutorunExecutor({}, executorContext('utils'));
+    const output = await runCliExecutor({}, executorContext('utils'));
     expect(output.success).toBe(true);
     expect(output.command).toMatch('npx @code-pushup/cli');
     expect(executeProcessSpy).toHaveBeenCalledWith({
@@ -52,15 +61,16 @@ describe('runAutorunExecutor', () => {
   });
 
   it('should normalize context', async () => {
-    const output = await runAutorunExecutor(
+    const output = await runCliExecutor(
       {},
       {
         ...executorContext('utils'),
         cwd: 'cwd-form-context',
       },
     );
     expect(output.success).toBe(true);
-    expect(output.command).toMatch('utils');
+    expect(output.command).toMatch('npx @code-pushup/cli');
+    expect(output.command).toContain('cwd-form-context');
     expect(executeProcessSpy).toHaveBeenCalledWith({
       command: 'npx',
       args: expect.arrayContaining(['@code-pushup/cli']),
@@ -69,7 +79,7 @@ describe('runAutorunExecutor', () => {
   });
 
   it('should process executorOptions', async () => {
-    const output = await runAutorunExecutor(
+    const output = await runCliExecutor(
       { output: 'code-pushup.config.json', persist: { filename: 'REPORT' } },
       executorContext('testing-utils'),
     );
@@ -79,7 +89,7 @@ describe('runAutorunExecutor', () => {
   });
 
   it('should create command from context and options if no api key is set', async () => {
-    const output = await runAutorunExecutor(
+    const output = await runCliExecutor(
       { persist: { filename: 'REPORT', format: ['md', 'json'] } },
       executorContext('core'),
     );
@@ -91,7 +101,7 @@ describe('runAutorunExecutor', () => {
 
   it('should create command from context, options and arguments if api key is set', async () => {
     vi.stubEnv('CP_API_KEY', 'cp_1234567');
-    const output = await runAutorunExecutor(
+    const output = await runCliExecutor(
       {
         persist: { filename: 'REPORT', format: ['md', 'json'] },
         upload: { project: 'CLI' },
@@ -107,7 +117,7 @@ describe('runAutorunExecutor', () => {
   });
 
   it('should set env var information if verbose is set', async () => {
-    const output = await runAutorunExecutor(
+    const output = await runCliExecutor(
       {
         verbose: true,
       },
@@ -131,8 +141,8 @@ describe('runAutorunExecutor', () => {
     expect(logger.warn).toHaveBeenCalledTimes(0);
   });
 
-  it('should log env var in dryRun information if verbose is set', async () => {
-    const output = await runAutorunExecutor(
+  it('should log CP_VERBOSE env var in dryRun information if verbose is set', async () => {
+    const output = await runCliExecutor(
       {
         dryRun: true,
         verbose: true,
@@ -150,7 +160,7 @@ describe('runAutorunExecutor', () => {
   });
 
   it('should log command if dryRun is set', async () => {
-    await runAutorunExecutor({ dryRun: true }, executorContext('utils'));
+    await runCliExecutor({ dryRun: true }, executorContext('utils'));
 
     expect(logger.command).toHaveBeenCalledTimes(0);
     expect(logger.warn).toHaveBeenCalledTimes(1);

packages/nx-plugin/src/executors/cli/schema.json

@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/schema",
-  "$id": "AutorunExecutorOptions",
+  "$id": "CliExecutorOptions",
   "title": "CodePushup CLI autorun executor",
   "description": "Executes the @code-pushup/cli autorun command See: https://github.com/code-pushup/cli/blob/main/packages/cli/README.md#autorun-command",
   "type": "object",
@@ -21,6 +21,13 @@
       "type": "string",
       "description": "Path to Code PushUp CLI"
     },
+    "env": {
+      "type": "object",
+      "additionalProperties": {
+        "type": "string"
+      },
+      "description": "Environment variables added to Code PushUp CLI process"
+    },
     "verbose": {
       "type": "boolean",
       "description": "Print additional logs"

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

@@ -8,15 +8,15 @@ import type {
 
 export type PrintConfigOptions = { output?: string };
 export type PrintConfigCommandExecutorOptions = PrintConfigOptions;
-export type AutorunCommandExecutorOnlyOptions = ProjectExecutorOnlyOptions &
+export type CliCommandExecutorOnlyOptions = ProjectExecutorOnlyOptions &
   CollectExecutorOnlyOptions &
   GeneralExecutorOnlyOptions;
 
-export type AutorunCommandExecutorOptions = Partial<
+export type CliCommandExecutorOptions = Partial<
   {
     upload: Partial<UploadConfig>;
     persist: Partial<PersistConfig>;
-  } & AutorunCommandExecutorOnlyOptions &
+  } & CliCommandExecutorOnlyOptions &
     GlobalExecutorOptions
 > &
   PrintConfigOptions;

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

@@ -1,10 +1,10 @@
-import { expect, vi } from 'vitest';
+import { describe, expect, it, vi } from 'vitest';
 import type { UploadConfig } from '@code-pushup/models';
 import { normalizedExecutorContext } from '../../../mock/utils/executor.js';
 import * as config from '../internal/config.js';
-import { parseAutorunExecutorOptions } from './utils.js';
+import { parseCliExecutorOptions } from './utils.js';
 
-describe('parseAutorunExecutorOptions', () => {
+describe('parseCliExecutorOptions', () => {
   const persistConfigSpy = vi.spyOn(config, 'persistConfig');
   const uploadConfigSpy = vi.spyOn(config, 'uploadConfig');
   const globalConfigSpy = vi.spyOn(config, 'globalConfig');
@@ -17,7 +17,7 @@ describe('parseAutorunExecutorOptions', () => {
   });
 
   it('should call child config functions with options', () => {
-    parseAutorunExecutorOptions(
+    parseCliExecutorOptions(
       {
         verbose: true,
         persist: { filename: 'my-name' },

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

@@ -5,19 +5,21 @@ import {
 } from '../internal/config.js';
 import type { NormalizedExecutorContext } from '../internal/context.js';
 import type {
-  AutorunCommandExecutorOnlyOptions,
-  AutorunCommandExecutorOptions,
+  CliCommandExecutorOnlyOptions,
+  CliCommandExecutorOptions,
   PrintConfigCommandExecutorOptions,
 } from './schema.js';
 
-export function parseAutorunExecutorOnlyOptions(
-  options: Partial<AutorunCommandExecutorOnlyOptions>,
-): AutorunCommandExecutorOnlyOptions {
-  const { projectPrefix, dryRun, onlyPlugins } = options;
+export function parseCliExecutorOnlyOptions(
+  options: Partial<CliCommandExecutorOnlyOptions>,
+): CliCommandExecutorOnlyOptions {
+  const { projectPrefix, dryRun, onlyPlugins, env, bin } = options;
   return {
     ...(projectPrefix && { projectPrefix }),
     ...(dryRun != null && { dryRun }),
     ...(onlyPlugins && { onlyPlugins }),
+    ...(env && { env }),
+    ...(bin && { bin }),
   };
 }
 
@@ -30,10 +32,10 @@ export function parsePrintConfigExecutorOptions(
   };
 }
 
-export function parseAutorunExecutorOptions(
-  options: Partial<AutorunCommandExecutorOptions>,
+export function parseCliExecutorOptions(
+  options: Partial<CliCommandExecutorOptions>,
   normalizedContext: NormalizedExecutorContext,
-): AutorunCommandExecutorOptions {
+): CliCommandExecutorOptions {
   const { projectPrefix, persist, upload, command, output } = options;
   const needsUploadParams =
     command === 'upload' || command === 'autorun' || command === undefined;
@@ -44,7 +46,7 @@ export function parseAutorunExecutorOptions(
   const hasApiToken = uploadCfg?.apiKey != null;
   return {
     ...parsePrintConfigExecutorOptions(options),
-    ...parseAutorunExecutorOnlyOptions(options),
+    ...parseCliExecutorOnlyOptions(options),
     ...globalConfig(options, normalizedContext),
     ...(output ? { output } : {}),
     persist: persistConfig({ projectPrefix, ...persist }, normalizedContext),