feat(utils): convert runner args to and from environment variables

Author: matejchalk

packages/utils/src/index.ts

@@ -16,6 +16,8 @@ export {
   isCI,
   isEnvVarEnabled,
   isVerbose,
+  runnerArgsFromEnv,
+  runnerArgsToEnv,
 } from './lib/env.js';
 export { stringifyError } from './lib/errors.js';
 export {

packages/utils/src/lib/env.ts

@@ -1,3 +1,11 @@
+import {
+  DEFAULT_PERSIST_FILENAME,
+  DEFAULT_PERSIST_FORMAT,
+  DEFAULT_PERSIST_OUTPUT_DIR,
+  DEFAULT_PERSIST_SKIP_REPORT,
+  type RunnerArgs,
+  formatSchema,
+} from '@code-pushup/models';
 import { ui } from './logging.js';
 
 export function isCI() {
@@ -51,3 +59,37 @@ export function coerceBooleanValue(value: unknown): boolean | undefined {
 
   return undefined;
 }
+
+type RUNNER_ARGS_ENV_VAR =
+  | 'CP_PERSIST_OUTPUT_DIR'
+  | 'CP_PERSIST_FILENAME'
+  | 'CP_PERSIST_FORMAT'
+  | 'CP_PERSIST_SKIP_REPORTS';
+
+type RunnerEnv = Record<RUNNER_ARGS_ENV_VAR, string>;
+
+const FORMAT_SEP = ',';
+
+export function runnerArgsToEnv(config: RunnerArgs): RunnerEnv {
+  return {
+    CP_PERSIST_OUTPUT_DIR: config.persist.outputDir,
+    CP_PERSIST_FILENAME: config.persist.filename,
+    CP_PERSIST_FORMAT: config.persist.format.join(FORMAT_SEP),
+    CP_PERSIST_SKIP_REPORTS: config.persist.skipReports.toString(),
+  };
+}
+
+export function runnerArgsFromEnv(env: Partial<RunnerEnv>): RunnerArgs {
+  const formats = env.CP_PERSIST_FORMAT?.split(FORMAT_SEP)
+    .map(item => formatSchema.safeParse(item).data)
+    .filter(item => item != null);
+  const skipReports = coerceBooleanValue(env.CP_PERSIST_SKIP_REPORTS);
+  return {
+    persist: {
+      outputDir: env.CP_PERSIST_OUTPUT_DIR || DEFAULT_PERSIST_OUTPUT_DIR,
+      filename: env.CP_PERSIST_FILENAME || DEFAULT_PERSIST_FILENAME,
+      format: formats?.length ? formats : DEFAULT_PERSIST_FORMAT,
+      skipReports: skipReports ?? DEFAULT_PERSIST_SKIP_REPORT,
+    },
+  };
+}

packages/utils/src/lib/env.unit.test.ts

@@ -1,4 +1,14 @@
-import { coerceBooleanValue, isEnvVarEnabled } from './env.js';
+import {
+  DEFAULT_PERSIST_FILENAME,
+  DEFAULT_PERSIST_FORMAT,
+  DEFAULT_PERSIST_SKIP_REPORT,
+} from '@code-pushup/models';
+import {
+  coerceBooleanValue,
+  isEnvVarEnabled,
+  runnerArgsFromEnv,
+  runnerArgsToEnv,
+} from './env.js';
 import { ui } from './logging.js';
 
 describe('isEnvVarEnabled', () => {
@@ -65,3 +75,61 @@ describe('coerceBooleanValue', () => {
     expect(coerceBooleanValue(input)).toBe(expected);
   });
 });
+
+describe('runnerArgsToEnv', () => {
+  it('should convert runner args object to namespaced environment variables', () => {
+    expect(
+      runnerArgsToEnv({
+        persist: {
+          outputDir: '.code-pushup',
+          filename: 'report',
+          format: ['json', 'md'],
+          skipReports: false,
+        },
+      }),
+    ).toEqual({
+      CP_PERSIST_OUTPUT_DIR: '.code-pushup',
+      CP_PERSIST_FILENAME: 'report',
+      CP_PERSIST_FORMAT: 'json,md',
+      CP_PERSIST_SKIP_REPORTS: 'false',
+    });
+  });
+});
+
+describe('runnerArgsFromEnv', () => {
+  it('should parse environment variables and create runner args object', () => {
+    expect(
+      runnerArgsFromEnv({
+        CP_PERSIST_OUTPUT_DIR: '.code-pushup',
+        CP_PERSIST_FILENAME: 'report',
+        CP_PERSIST_FORMAT: 'json,md',
+        CP_PERSIST_SKIP_REPORTS: 'false',
+      }),
+    ).toEqual({
+      persist: {
+        outputDir: '.code-pushup',
+        filename: 'report',
+        format: ['json', 'md'],
+        skipReports: false,
+      },
+    });
+  });
+
+  it('should fallback to defaults instead of empty or invalid values', () => {
+    expect(
+      runnerArgsFromEnv({
+        CP_PERSIST_OUTPUT_DIR: '.code-pushup',
+        CP_PERSIST_FILENAME: '',
+        CP_PERSIST_FORMAT: 'html',
+        CP_PERSIST_SKIP_REPORTS: 'yup',
+      }),
+    ).toEqual({
+      persist: {
+        outputDir: '.code-pushup',
+        filename: DEFAULT_PERSIST_FILENAME,
+        format: DEFAULT_PERSIST_FORMAT,
+        skipReports: DEFAULT_PERSIST_SKIP_REPORT,
+      },
+    });
+  });
+});