refactor(core): improve read-code-pushup-config error handling and tests

Author: Tlacenka

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

@@ -32,6 +32,6 @@ describe('configMiddleware', () => {
   it('should throw with invalid config path', async () => {
     await expect(
       configMiddleware({ config: 'wrong/path/to/config' }),
-    ).rejects.toThrow(/no such file or directory/);
+    ).rejects.toThrow(/Provided path .* is not valid./);
   });
 });

packages/core/src/lib/implementation/read-code-pushup-config.integration.test.ts

@@ -1,59 +1,64 @@
-import { join } from 'path';
-import * as process from 'process';
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
 import { describe, expect } from 'vitest';
-import { persistConfig, uploadConfig } from '@code-pushup/models/testing';
 import { readCodePushupConfig } from './read-code-pushup-config';
 
 describe('readCodePushupConfig', () => {
-  it('should load file', async () => {
-    const module = await readCodePushupConfig(
-      join(process.cwd(), 'packages', 'core', 'test', 'minimal.config.mjs'),
-    );
-    expect(module).toEqual(
+  const configDirPath = join(
+    fileURLToPath(dirname(import.meta.url)),
+    '..',
+    '..',
+    '..',
+    '..',
+    '..',
+    'testing-utils',
+    'src',
+    'lib',
+    'fixtures',
+    'configs',
+  );
+
+  it('should load a valid configuration file', async () => {
+    await expect(
+      readCodePushupConfig(join(configDirPath, 'code-pushup.config.ts')),
+    ).resolves.toEqual(
       expect.objectContaining({
-        persist: expect.objectContaining(persistConfig()),
         upload: expect.objectContaining({
-          ...uploadConfig(),
           organization: 'code-pushup',
         }),
-        categories: expect.arrayContaining([
-          expect.objectContaining({
-            slug: 'category-slug-1',
-          }),
-        ]),
+        categories: expect.any(Array),
         plugins: expect.arrayContaining([
           expect.objectContaining({
-            slug: 'mock-plugin-slug',
+            slug: 'node',
           }),
         ]),
       }),
     );
   });
 
-  it('should throw if filepath not given', async () => {
-    const filepath = '';
-    await expect(readCodePushupConfig(filepath)).rejects.toThrow(
-      `No filepath provided`,
+  it('should throw if the path is empty', async () => {
+    await expect(readCodePushupConfig('')).rejects.toThrow(
+      'The configuration path is empty.',
     );
   });
 
-  it('should throw if file does not exist', async () => {
-    const filepath = join('invalid-path', 'valid-export.mjs');
-    await expect(readCodePushupConfig(filepath)).rejects.toThrow(
-      `invalid-path`,
-    );
+  it('should throw if the file does not exist', async () => {
+    await expect(
+      readCodePushupConfig(join('non-existent', 'config.file.js')),
+    ).rejects.toThrow(/Provided path .* is not valid./);
   });
 
-  it('should throw if config is invalid', async () => {
-    const filepath = join(
-      process.cwd(),
-      'packages',
-      'core',
-      'test',
-      'invaid.config.mjs',
-    );
-    await expect(readCodePushupConfig(filepath)).rejects.toThrow(
-      `"code": "invalid_type",`,
-    );
+  it('should throw if the configuration is empty', async () => {
+    await expect(
+      readCodePushupConfig(join(configDirPath, 'code-pushup.empty.config.js')),
+    ).rejects.toThrow(`"code": "invalid_type",`);
+  });
+
+  it('should throw if the configuration is invalid', async () => {
+    await expect(
+      readCodePushupConfig(
+        join(configDirPath, 'code-pushup.invalid.config.ts'),
+      ),
+    ).rejects.toThrow(/refs are duplicates/);
   });
 });

packages/core/src/lib/implementation/read-code-pushup-config.ts

@@ -1,20 +1,18 @@
-import { stat } from 'fs/promises';
 import { CoreConfig, coreConfigSchema } from '@code-pushup/models';
-import { importEsmModule } from '@code-pushup/utils';
+import { fileExists, importEsmModule } from '@code-pushup/utils';
 
 export class ConfigPathError extends Error {
   constructor(configPath: string) {
-    super(`Config path ${configPath} is not a file.`);
+    super(`Provided path '${configPath}' is not valid.`);
   }
 }
 
 export async function readCodePushupConfig(filepath: string) {
   if (!filepath.length) {
-    throw new Error('No filepath provided');
+    throw new Error('The configuration path is empty.');
   }
 
-  const isFile = (await stat(filepath)).isFile();
-  if (!isFile) {
+  if (!(await fileExists(filepath))) {
     throw new ConfigPathError(filepath);
   }
 

testing-utils/src/lib/fixtures/configs/code-pushup.config.ts

@@ -26,8 +26,8 @@ export default {
         outputFile: 'output.json',
       },
       groups: [],
-      slug: 'plugin-1',
-      title: 'plugin 1',
+      slug: 'node',
+      title: 'Node.js',
       icon: 'javascript',
     },
   ],