refactor: create verbosity middleware

Author: vmasek

packages/cli/src/lib/implementation/set-verbose.middleware.integration.test.ts

@@ -0,0 +1,30 @@
+import { describe, expect, it, vi } from 'vitest';
+import { isVerbose } from '@code-pushup/utils';
+import { setVerboseMiddleware } from './set-verbose.middleware.js';
+
+describe('setVerboseMiddleware', () => {
+  it.each([
+    [true, undefined, true],
+    [false, undefined, false],
+    [undefined, undefined, false],
+    [undefined, true, true],
+    [true, true, true],
+    [false, true, true],
+    [true, false, false],
+    [false, false, false],
+    ['True', undefined, true],
+    ['TRUE', undefined, true],
+    [42, undefined, false],
+    [undefined, 'true', true],
+    [true, 'False', false],
+  ])(
+    'should set CP_VERBOSE based on env variable `%j` and cli argument `%j` and return `%j` from isVerbose() function',
+    (envValue, cliFlag, expected) => {
+      vi.stubEnv('CP_VERBOSE', `${envValue}`);
+
+      setVerboseMiddleware({ verbose: cliFlag } as any);
+      expect(process.env['CP_VERBOSE']).toBe(`${expected}`);
+      expect(isVerbose()).toBe(expected);
+    },
+  );
+});

packages/cli/src/lib/implementation/set-verbose.middleware.ts

@@ -0,0 +1,52 @@
+import type { GlobalOptions } from '@code-pushup/core';
+import type { CoreConfig } from '@code-pushup/models';
+import type { FilterOptions } from './filter.model.js';
+import type { GeneralCliOptions } from './global.model';
+
+/**
+ *
+ * | CP_VERBOSE value | CLI `--verbose` flag        | Effect     |
+ * |------------------|-----------------------------|------------|
+ * | true             | Not provided                | enabled    |
+ * | false            | Not provided                | disabled   |
+ * | Not provided     | Not provided                | disabled   |
+ * | Not provided     | Explicitly set (true)       | enabled    |
+ * | true             | Explicitly set (true)       | enabled    |
+ * | false            | Explicitly set (true)       | enabled    |
+ * | true             | Explicitly negated (false)  | disabled   |
+ * | false            | Explicitly negated (false)  | disabled   |
+ *
+ * @param originalProcessArgs
+ */
+export function setVerboseMiddleware<
+  T extends GeneralCliOptions & CoreConfig & FilterOptions & GlobalOptions,
+>(originalProcessArgs: T): T {
+  const envVerbose = getNormalizedOptionValue(process.env['CP_VERBOSE']);
+  const cliVerbose = getNormalizedOptionValue(originalProcessArgs.verbose);
+  const verboseEffect = cliVerbose ?? envVerbose ?? false;
+
+  // eslint-disable-next-line functional/immutable-data
+  process.env['CP_VERBOSE'] = `${verboseEffect}`;
+
+  return {
+    ...originalProcessArgs,
+    verbose: verboseEffect,
+  };
+}
+
+export function getNormalizedOptionValue(value: unknown): boolean | undefined {
+  if (typeof value === 'boolean') {
+    return value;
+  }
+  if (typeof value === 'string') {
+    const lowerCaseValue = value.toLowerCase();
+    if (lowerCaseValue === 'true') {
+      return true;
+    }
+    if (lowerCaseValue === 'false') {
+      return false;
+    }
+  }
+
+  return undefined;
+}

packages/cli/src/lib/implementation/set-verbose.middleware.unit.test.ts

@@ -0,0 +1,49 @@
+import { describe, expect, it, vi } from 'vitest';
+import {
+  getNormalizedOptionValue,
+  setVerboseMiddleware,
+} from './set-verbose.middleware.js';
+
+describe('setVerboseMiddleware', () => {
+  it.each([
+    [true, true],
+    ['true', true],
+    ['True', true],
+    ['TRUE', true],
+    [false, false],
+    ['false', false],
+    ['False', false],
+    ['FALSE', false],
+    [undefined, undefined],
+    ['undefined', undefined],
+    ['Whatever else', undefined],
+    [0, undefined],
+    [1, undefined],
+    [null, undefined],
+  ])(
+    'should return normalize value of `%j` option set as `%j`',
+    (value, expected) => {
+      expect(getNormalizedOptionValue(value)).toBe(expected);
+    },
+  );
+
+  it.each([
+    [true, undefined, true],
+    [false, undefined, false],
+    [undefined, undefined, false],
+    [undefined, true, true],
+    [true, true, true],
+    [false, true, true],
+    [true, false, false],
+    [false, false, false],
+  ])(
+    'should set verbosity based on env variable `%j` and cli argument `%j` to perform verbose effect as `%j`',
+    (envValue, cliFlag, expected) => {
+      vi.stubEnv('CP_VERBOSE', `${envValue}`);
+
+      expect(setVerboseMiddleware({ verbose: cliFlag } as any).verbose).toBe(
+        expected,
+      );
+    },
+  );
+});

packages/cli/src/lib/middlewares.ts

@@ -1,8 +1,13 @@
 import type { MiddlewareFunction } from 'yargs';
 import { coreConfigMiddleware } from './implementation/core-config.middleware.js';
 import { filterMiddleware } from './implementation/filter.middleware.js';
+import { setVerboseMiddleware } from './implementation/set-verbose.middleware.js';
 
 export const middlewares = [
+  {
+    middlewareFunction: setVerboseMiddleware as unknown as MiddlewareFunction,
+    applyBeforeValidation: false,
+  },
   {
     middlewareFunction: coreConfigMiddleware as unknown as MiddlewareFunction,
     applyBeforeValidation: false,