refactor: wip

Author: Michael Hladky

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

@@ -1,14 +1,11 @@
 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 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.mockRestore();
+    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' }),
@@ -52,7 +49,7 @@ describe('runAutorunExecutor', () => {
   });
 
   it('should forward env options to executeProcess', async () => {
-    const output = await runAutorunExecutor(
+    const output = await runCliExecutor(
       {
         verbose: true,
         env: { 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,14 +11,14 @@ 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(
+  const cliArgumentObject = parseCliExecutorOptions(
     terminalAndExecutorOptions,
     normalizedContext,
   );

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

@@ -2,9 +2,9 @@ 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';
+import runCliExecutor from './executor.js';
 
-describe('runAutorunExecutor', () => {
+describe('runCliExecutor', () => {
   const processEnvCP = Object.fromEntries(
     Object.entries(process.env).filter(([k]) => k.startsWith('CP_')),
   );
@@ -41,7 +41,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,7 +52,7 @@ describe('runAutorunExecutor', () => {
   });
 
   it('should normalize context', async () => {
-    const output = await runAutorunExecutor(
+    const output = await runCliExecutor(
       {},
       {
         ...executorContext('utils'),
@@ -70,7 +70,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'),
     );
@@ -80,7 +80,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'),
     );
@@ -92,7 +92,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' },
@@ -108,7 +108,7 @@ describe('runAutorunExecutor', () => {
   });
 
   it('should set env var information if verbose is set', async () => {
-    const output = await runAutorunExecutor(
+    const output = await runCliExecutor(
       {
         verbose: true,
       },
@@ -133,7 +133,7 @@ describe('runAutorunExecutor', () => {
   });
 
   it('should log CP_VERBOSE env var in dryRun information if verbose is set', async () => {
-    const output = await runAutorunExecutor(
+    const output = await runCliExecutor(
       {
         dryRun: true,
         verbose: true,
@@ -151,7 +151,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",

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

@@ -2,9 +2,9 @@ import { expect, 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,14 +5,14 @@ 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 {
+export function parseCliExecutorOnlyOptions(
+  options: Partial<CliCommandExecutorOnlyOptions>,
+): CliCommandExecutorOnlyOptions {
   const { projectPrefix, dryRun, onlyPlugins, env, bin } = options;
   return {
     ...(projectPrefix && { projectPrefix }),
@@ -32,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;
@@ -46,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),

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

@@ -2,8 +2,8 @@ import { type MockInstance, expect, vi } from 'vitest';
 import { osAgnosticPath } from '@code-pushup/test-utils';
 import type { Command } from '../internal/types.js';
 import {
-  parseAutorunExecutorOnlyOptions,
-  parseAutorunExecutorOptions,
+  parseCliExecutorOnlyOptions,
+  parseCliExecutorOptions,
   parsePrintConfigExecutorOptions,
 } from './utils.js';
 
@@ -23,57 +23,57 @@ describe('parsePrintConfigExecutorOptions', () => {
   });
 });
 
-describe('parseAutorunExecutorOnlyOptions', () => {
+describe('parseCliExecutorOnlyOptions', () => {
   it('should provide NO default projectPrefix', () => {
-    expect(parseAutorunExecutorOnlyOptions({})).toStrictEqual(
+    expect(parseCliExecutorOnlyOptions({})).toStrictEqual(
       expect.not.objectContaining({ projectPrefix: expect.anything() }),
     );
   });
 
   it('should process given projectPrefix', () => {
-    expect(
-      parseAutorunExecutorOnlyOptions({ projectPrefix: 'cli' }),
-    ).toStrictEqual(expect.objectContaining({ projectPrefix: 'cli' }));
+    expect(parseCliExecutorOnlyOptions({ projectPrefix: 'cli' })).toStrictEqual(
+      expect.objectContaining({ projectPrefix: 'cli' }),
+    );
   });
 
   it('should provide NO default dryRun', () => {
-    expect(parseAutorunExecutorOnlyOptions({})).toStrictEqual(
+    expect(parseCliExecutorOnlyOptions({})).toStrictEqual(
       expect.not.objectContaining({ dryRun: expect.anything() }),
     );
   });
 
   it('should process given dryRun', () => {
-    expect(parseAutorunExecutorOnlyOptions({ dryRun: false })).toStrictEqual(
+    expect(parseCliExecutorOnlyOptions({ dryRun: false })).toStrictEqual(
       expect.objectContaining({ dryRun: false }),
     );
   });
 
   it('should provide default onlyPlugins', () => {
-    expect(parseAutorunExecutorOnlyOptions({})).toStrictEqual(
+    expect(parseCliExecutorOnlyOptions({})).toStrictEqual(
       expect.not.objectContaining({ onlyPlugins: ['json'] }),
     );
   });
 
   it('should process given onlyPlugins', () => {
     expect(
-      parseAutorunExecutorOnlyOptions({ onlyPlugins: ['md', 'json'] }),
+      parseCliExecutorOnlyOptions({ 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' } }),
+      parseCliExecutorOnlyOptions({ env: { TEST_ENV_VAR: '42' } }),
     ).toStrictEqual(expect.objectContaining({ env: { TEST_ENV_VAR: '42' } }));
   });
 
   it('should process given bin', () => {
-    expect(parseAutorunExecutorOnlyOptions({ bin: 'index.js' })).toStrictEqual(
+    expect(parseCliExecutorOnlyOptions({ bin: 'index.js' })).toStrictEqual(
       expect.objectContaining({ bin: 'index.js' }),
     );
   });
 });
 
-describe('parseAutorunExecutorOptions', () => {
+describe('parseCliExecutorOptions', () => {
   let processEnvSpy: MockInstance<[], NodeJS.ProcessEnv>;
 
   beforeAll(() => {
@@ -86,7 +86,7 @@ describe('parseAutorunExecutorOptions', () => {
 
   it('should leverage other config helper to assemble the executor config', () => {
     const projectName = 'my-app';
-    const executorOptions = parseAutorunExecutorOptions(
+    const executorOptions = parseCliExecutorOptions(
       {
         persist: {
           filename: 'from-options',
@@ -130,7 +130,7 @@ describe('parseAutorunExecutorOptions', () => {
       TSX_TSCONFIG_PATH: 'tsconfig.base.json',
     };
 
-    const executorOptions = parseAutorunExecutorOptions(
+    const executorOptions = parseCliExecutorOptions(
       { env },
       {
         projectName,
@@ -149,7 +149,7 @@ describe('parseAutorunExecutorOptions', () => {
     'should include upload config for command %s if API key is provided',
     command => {
       const projectName = 'my-app';
-      const executorOptions = parseAutorunExecutorOptions(
+      const executorOptions = parseCliExecutorOptions(
         {
           command,
           upload: {
@@ -178,7 +178,7 @@ describe('parseAutorunExecutorOptions', () => {
     'should not include upload config for command %s',
     command => {
       const projectName = 'my-app';
-      const executorOptions = parseAutorunExecutorOptions(
+      const executorOptions = parseCliExecutorOptions(
         {
           command,
           upload: {

packages/nx-plugin/src/index.ts

@@ -10,7 +10,7 @@ const plugin = {
 
 export default plugin;
 
-export type { AutorunCommandExecutorOptions } from './executors/cli/schema.js';
+export type { CliCommandExecutorOptions } from './executors/cli/schema.js';
 export { generateCodePushupConfig } from './generators/configuration/code-pushup-config.js';
 export { configurationGenerator } from './generators/configuration/generator.js';
 export type { ConfigurationGeneratorOptions } from './generators/configuration/schema.js';