refactor: intro test-fixtures project

Author: John Doe

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

@@ -8,7 +8,12 @@ const configDirPath = path.join(
   '..',
   '..',
   '..',
-  'mocks',
+  '..',
+  '..',
+  'testing',
+  'test-utils',
+  'src',
+  'lib',
   'fixtures',
   'configs',
 );

packages/core/mocks/fixtures/configs/code-pushup.config.js

@@ -9,7 +9,12 @@ describe('readRcByPath', () => {
     '..',
     '..',
     '..',
-    'mocks',
+    '..',
+    '..',
+    'testing',
+    'test-utils',
+    'src',
+    'lib',
     'fixtures',
     'configs',
   );

packages/core/mocks/fixtures/configs/code-pushup.config.mjs

@@ -0,0 +1,19 @@
+# test-utils
+
+This library contains testing utilities, such as helper functions or fixtures.
+Any reusable mocks should live here.
+
+More on this subject as well as all the testing strategy principles can be found on the GitHub [wiki](https://github.com/code-pushup/cli/wiki/Testing-Strategy#testing-utilities).
+
+## Library utilities
+
+### Mock data
+
+Hardcoded mocks, often referring to a smaller configuration object, live in [`utils`](./src/lib/utils/).
+Dynamic mocks (functions that accept objects), referring to a bigger example of a configuration and report object, live in [`dynamic-mocks`](./src/lib/utils/dynamic-mocks/).
+
+Please prefer using static mocks over dynamic ones for better readability. Dynamic mocks to be used with care when testing a snapshot after report generation or similar.
+
+### Fixtures
+
+Example configuration files that are to be used in integration or E2E tests live in [`configs`](./src//lib/fixtures/configs/).

packages/core/src/lib/implementation/read-rc-file.int.test.ts

@@ -0,0 +1,12 @@
+import tseslint from 'typescript-eslint';
+import baseConfig from '../../eslint.config.js';
+
+export default tseslint.config(...baseConfig, {
+  files: ['**/*.ts'],
+  languageOptions: {
+    parserOptions: {
+      projectService: true,
+      tsconfigRootDir: import.meta.dirname,
+    },
+  },
+});

testing/test-fixtures/README.md

@@ -0,0 +1,4 @@
+{
+  "name": "@code-pushup/test-fixtures",
+  "type": "module"
+}

testing/test-fixtures/eslint.config.js

@@ -0,0 +1,14 @@
+{
+  "name": "test-fixtures",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "testing/test-fixtures/src",
+  "projectType": "library",
+  "targets": {
+    "build": {},
+    "lint": {},
+    "nx-release-publish": {
+      "executor": "nx:noop"
+    }
+  },
+  "tags": ["scope:shared", "type:testing"]
+}

testing/test-fixtures/package.json

@@ -0,0 +1,21 @@
+export * from './lib/utils/omit-report-data.js';
+
+// static mocks
+export * from './lib/utils/commit.mock.js';
+export * from './lib/utils/core-config.mock.js';
+export * from './lib/utils/minimal-config.mock.js';
+export * from './lib/utils/report.mock.js';
+
+// dynamic mocks
+export * from './lib/utils/dynamic-mocks/categories.mock.js';
+export * from './lib/utils/dynamic-mocks/config.mock.js';
+export * from './lib/utils/dynamic-mocks/eslint-audits.mock.js';
+export * from './lib/utils/dynamic-mocks/eslint-plugin.mock.js';
+export * from './lib/utils/dynamic-mocks/lighthouse-audits.mock.js';
+export * from './lib/utils/dynamic-mocks/lighthouse-plugin.mock.js';
+export * from './lib/utils/dynamic-mocks/persist-config.mock.js';
+export * from './lib/utils/dynamic-mocks/plugin-config.mock.js';
+export * from './lib/utils/dynamic-mocks/report-diff.mock.js';
+export * from './lib/utils/dynamic-mocks/report.mock.js';
+export * from './lib/utils/dynamic-mocks/runner-config.mock.js';
+export * from './lib/utils/dynamic-mocks/upload-config.mock.js';