test(cli): unify yargs testing

Author: Tlacenka

e2e/cli-e2e/tests/print-config.e2e.test.ts

@@ -4,7 +4,7 @@ import {
   PERSIST_FORMAT,
   PERSIST_OUTPUT_DIR,
 } from '@code-pushup/models';
-import { executeProcess, objectToCliArgs } from '@code-pushup/utils';
+import { executeProcess } from '@code-pushup/utils';
 import { configFile, extensions } from '../mocks/utils';
 
 describe('print-config', () => {

packages/cli/src/lib/autorun/autorun-command.ts

@@ -7,7 +7,7 @@ import {
   upload,
 } from '@code-pushup/core';
 import { CLI_NAME } from '../cli';
-import { onlyPluginsOption } from '../implementation/only-plugins-options';
+import { yargsOnlyPluginsOptionsDefinition } from '../implementation/only-plugins-options';
 
 type AutorunOptions = CollectOptions & UploadOptions;
 
@@ -16,9 +16,7 @@ export function yargsAutorunCommandObject() {
   return {
     command,
     describe: 'Shortcut for running collect followed by upload',
-    builder: {
-      onlyPlugins: onlyPluginsOption,
-    },
+    builder: yargsOnlyPluginsOptionsDefinition(),
     handler: async <T>(args: ArgumentsCamelCase<T>) => {
       console.info(chalk.bold(CLI_NAME));
       console.info(chalk.gray(`Run ${command}...`));

packages/cli/src/lib/autorun/autorun-command.unit.test.ts

@@ -1,10 +1,9 @@
 import { bundleRequire } from 'bundle-require';
 import { vol } from 'memfs';
-import { beforeEach, describe, expect, it, vi } from 'vitest';
+import { describe, expect, it, vi } from 'vitest';
 import { PortalUploadArgs, uploadToPortal } from '@code-pushup/portal-client';
 import { collectAndPersistReports } from '@code-pushup/core';
-import { MINIMAL_REPORT_MOCK } from '@code-pushup/testing-utils';
-import { objectToCliArgs } from '@code-pushup/utils';
+import { MEMFS_VOLUME, MINIMAL_REPORT_MOCK } from '@code-pushup/testing-utils';
 import { DEFAULT_CLI_CONFIGURATION } from '../../../mocks/constants';
 import { yargsCli } from '../yargs-cli';
 import { yargsAutorunCommandObject } from './autorun-command';
@@ -17,36 +16,29 @@ vi.mock('@code-pushup/core', async () => {
   };
 });
 
-const cli = (options = {}) =>
-  yargsCli(
-    objectToCliArgs({
-      _: 'autorun',
-      verbose: true,
-      config: '/test/code-pushup.config.ts',
-      'persist.outputDir': '/test',
-      ...options,
-    }),
-    {
-      ...DEFAULT_CLI_CONFIGURATION,
-      commands: [yargsAutorunCommandObject()],
-    },
-  );
-
 describe('autorun-command', () => {
-  beforeEach(() => {
+  it('should call collect and upload with correct parameters', async () => {
     vol.fromJSON(
       {
         'my-report.json': JSON.stringify(MINIMAL_REPORT_MOCK),
         'code-pushup.config.ts': '', // only needs to exist for stat inside readCodePushupConfig
       },
-      '/test',
+      MEMFS_VOLUME,
     );
-  });
 
-  it('should call collect and upload with correct parameters', async () => {
-    await cli({
-      'persist.filename': 'my-report',
-    }).parseAsync();
+    await yargsCli(
+      [
+        'autorun',
+        '--verbose',
+        '--config=/test/code-pushup.config.ts',
+        '--persist.filename=my-report',
+        '--persist.outputDir=/test',
+      ],
+      {
+        ...DEFAULT_CLI_CONFIGURATION,
+        commands: [yargsAutorunCommandObject()],
+      },
+    ).parseAsync();
 
     expect(bundleRequire).toHaveBeenCalledWith({
       format: 'esm',

packages/cli/src/lib/collect/collect-command.ts

@@ -5,16 +5,14 @@ import {
   collectAndPersistReports,
 } from '@code-pushup/core';
 import { CLI_NAME } from '../cli';
-import { onlyPluginsOption } from '../implementation/only-plugins-options';
+import { yargsOnlyPluginsOptionsDefinition } from '../implementation/only-plugins-options';
 
 export function yargsCollectCommandObject(): CommandModule {
   const command = 'collect';
   return {
     command,
     describe: 'Run Plugins and collect results',
-    builder: {
-      onlyPlugins: onlyPluginsOption,
-    },
+    builder: yargsOnlyPluginsOptionsDefinition(),
     handler: async <T>(args: ArgumentsCamelCase<T>) => {
       const options = args as unknown as CollectAndPersistReportsOptions;
       console.info(chalk.bold(CLI_NAME));

packages/cli/src/lib/implementation/core-config-options.integration.test.ts

@@ -3,7 +3,9 @@ import { CoreConfig } from '@code-pushup/models';
 import {
   CoreConfigCliOptions,
   GeneralCliOptions,
+  OnlyPluginsOptions,
 } from './implementation/model';
+import { yargsOnlyPluginsOptionsDefinition } from './implementation/only-plugins-options';
 import { options } from './options';
 import { yargsCli } from './yargs-cli';
 
@@ -23,6 +25,14 @@ describe('yargsCli', () => {
     expect(parsedArgv.config).toBe('code-pushup.config.js');
   });
 
+  it('should parse an empty array as a default onlyPlugins option', async () => {
+    const parsedArgv = await yargsCli<GeneralCliOptions & OnlyPluginsOptions>(
+      [],
+      { options: { ...options, ...yargsOnlyPluginsOptionsDefinition() } },
+    ).parseAsync();
+    expect(parsedArgv.onlyPlugins).toEqual([]);
+  });
+
   it('should parse a single boolean negated argument', async () => {
     const parsedArgv = await yargsCli<GeneralCliOptions>(['--no-progress'], {
       options,
@@ -43,7 +53,7 @@ describe('yargsCli', () => {
       ['--persist.format=md', '--persist.format=json'],
       { options },
     ).parseAsync();
-    expect(parsedArgv.persist.format).toEqual(['md', 'json']);
+    expect(parsedArgv?.persist?.format).toEqual(['md', 'json']);
   });
 
   it('should parse global options correctly', async () => {
@@ -64,7 +74,9 @@ describe('yargsCli', () => {
   });
 
   it('should handle global options and middleware argument overrides correctly', async () => {
-    const parsedArgv = await yargsCli<GeneralCliOptions & CoreConfigCliOptions>(
+    const parsedArgv = await yargsCli<
+      GeneralCliOptions & CoreConfigCliOptions & OnlyPluginsOptions
+    >(
       [
         '--verbose',
         '--persist.format=md',
@@ -74,8 +86,10 @@ describe('yargsCli', () => {
         '--upload.project=code-push-down',
         '--upload.server=https://code-pushdown.com/api',
         '--upload.apiKey=some-api-key',
+        '--onlyPlugins=lighthouse',
+        '--onlyPlugins=eslint',
       ],
-      { options },
+      { options: { ...options, ...yargsOnlyPluginsOptionsDefinition() } },
     ).parseAsync();
     expect(parsedArgv).toEqual(
       expect.objectContaining({
@@ -95,6 +109,7 @@ describe('yargsCli', () => {
           server: 'https://code-pushdown.com/api',
           apiKey: 'some-api-key',
         }),
+        onlyPlugins: ['lighthouse', 'eslint'],
       }),
     );
   });