refactor: clean up mock and setup-file files

Author: Szymon.Poltorak

eslint.config.js

@@ -139,6 +139,7 @@ export default tseslint.config(
   {
     ignores: [
       '**/*.mock.*',
+      '**/*.setup-file.*',
       '**/code-pushup.config.ts',
       '**/mocks/fixtures/**',
       '**/__snapshots__/**',

packages/plugin-lighthouse/CONTRIBUTING.md

@@ -15,7 +15,7 @@ To test lighthouse properly we work with a predefined testing setup.
 
 On some OS there could be a problem finding the path to Chrome.
 
-We try to detect it automatically in the [`chrome-path.mock.ts` script](../../testing/test-setup/src/lib/chrome-path.mock.ts).
+We try to detect it automatically in the [`chrome-path.setup-file.ts` script](../../testing/test-setup/src/lib/chrome-path.setup-file.ts).
 There we use `getChromePath` and have `chromium` installed as NPM package, so detecting the path should not cause any problem.
 
 However, if no chrome path is detected automatically the error looks like this:
@@ -46,7 +46,7 @@ In the CI you can set a static path if needed over the env variable like this:
 # ...
 ```
 
-We consider this path in our `beforeAll` hook in a [`chrome-path.mock.ts` script](../../testing/test-setup/src/lib/chrome-path.mock.ts).
+We consider this path in our `beforeAll` hook in a [`chrome-path.setup-file.ts` script](../../testing/test-setup/src/lib/chrome-path.setup-file.ts).
 
 ### Testing chrome flags
 

testing/test-setup-config/src/lib/vitest-config-factory.unit.test.ts

@@ -32,8 +32,8 @@ describe('createVitestConfig', () => {
           ],
           globalSetup: ['../../global-setup.ts'],
           setupFiles: expect.arrayContaining([
-            '../../testing/test-setup/src/lib/reset.mock.ts',
-            '../../testing/test-setup/src/lib/fs.mock.ts',
+            '../../testing/test-setup/src/lib/reset.setup-file.ts',
+            '../../testing/test-setup/src/lib/fs.setup-file.ts',
           ]),
           coverage: expect.objectContaining({
             reporter: ['text', 'lcov'],
@@ -70,19 +70,19 @@ describe('createVitestConfig', () => {
 
       const setupFiles = config.test!.setupFiles;
       expect(setupFiles).toContain(
-        '../../testing/test-setup/src/lib/reset.mock.ts',
+        '../../testing/test-setup/src/lib/reset.setup-file.ts',
       );
       expect(setupFiles).toContain(
-        '../../testing/test-setup/src/lib/fs.mock.ts',
+        '../../testing/test-setup/src/lib/fs.setup-file.ts',
       );
       expect(setupFiles).toContain(
-        '../../testing/test-setup/src/lib/git.mock.ts',
+        '../../testing/test-setup/src/lib/git.setup-file.ts',
       );
       expect(setupFiles).toContain(
-        '../../testing/test-setup/src/lib/portal-client.mock.ts',
+        '../../testing/test-setup/src/lib/portal-client.setup-file.ts',
       );
       expect(setupFiles).toContain(
-        '../../testing/test-setup/src/lib/logger.mock.ts',
+        '../../testing/test-setup/src/lib/logger.setup-file.ts',
       );
       expect(setupFiles).toContain(
         '../../testing/test-setup/src/lib/extend/markdown-table.matcher.ts',
@@ -141,16 +141,16 @@ describe('createVitestConfig', () => {
 
       const setupFiles = config.test!.setupFiles;
       expect(setupFiles).toContain(
-        '../../testing/test-setup/src/lib/logger.mock.ts',
+        '../../testing/test-setup/src/lib/logger.setup-file.ts',
       );
       expect(setupFiles).not.toContain(
-        '../../testing/test-setup/src/lib/fs.mock.ts',
+        '../../testing/test-setup/src/lib/fs.setup-file.ts',
       );
       expect(setupFiles).not.toContain(
-        '../../testing/test-setup/src/lib/cliui.mock.ts',
+        '../../testing/test-setup/src/lib/cliui.setup-file.ts',
       );
       expect(setupFiles).not.toContain(
-        '../../testing/test-setup/src/lib/git.mock.ts',
+        '../../testing/test-setup/src/lib/git.setup-file.ts',
       );
       expect(setupFiles).toContain(
         '../../testing/test-setup/src/lib/extend/path.matcher.ts',
@@ -186,14 +186,14 @@ describe('createVitestConfig', () => {
       const setupFiles = config.test!.setupFiles;
       // Should only include reset mocks
       expect(setupFiles).toContain(
-        '../../testing/test-setup/src/lib/reset.mock.ts',
+        '../../testing/test-setup/src/lib/reset.setup-file.ts',
       );
       // Should NOT include fs, git, etc.
       expect(setupFiles).not.toContain(
-        '../../testing/test-setup/src/lib/git.mock.ts',
+        '../../testing/test-setup/src/lib/git.setup-file.ts',
       );
       expect(setupFiles).not.toContain(
-        '../../testing/test-setup/src/lib/fs.mock.ts',
+        '../../testing/test-setup/src/lib/fs.setup-file.ts',
       );
       // Should include all matchers
       expect(setupFiles).toContain(

testing/test-setup-config/src/lib/vitest-setup-files.ts

@@ -20,12 +20,12 @@ const CUSTOM_MATCHERS = [
  * which is why they use `../../` to navigate to the workspace root first.
  */
 const UNIT_TEST_SETUP_FILES = [
-  '../../testing/test-setup/src/lib/reset.mock.ts',
-  '../../testing/test-setup/src/lib/fs.mock.ts',
-  '../../testing/test-setup/src/lib/logger.mock.ts',
-  '../../testing/test-setup/src/lib/git.mock.ts',
+  '../../testing/test-setup/src/lib/reset.setup-file.ts',
+  '../../testing/test-setup/src/lib/fs.setup-file.ts',
+  '../../testing/test-setup/src/lib/logger.setup-file.ts',
+  '../../testing/test-setup/src/lib/git.setup-file.ts',
   '../../testing/test-setup/src/lib/performance.setup-file.ts',
-  '../../testing/test-setup/src/lib/portal-client.mock.ts',
+  '../../testing/test-setup/src/lib/portal-client.setup-file.ts',
   '../../testing/test-setup/src/lib/process.setup-file.ts',
   ...CUSTOM_MATCHERS,
 ] as const;
@@ -38,9 +38,9 @@ const UNIT_TEST_SETUP_FILES = [
 
  */
 const INT_TEST_SETUP_FILES = [
-  '../../testing/test-setup/src/lib/reset.mock.ts',
-  '../../testing/test-setup/src/lib/logger.mock.ts',
-  '../../testing/test-setup/src/lib/chrome-path.mock.ts',
+  '../../testing/test-setup/src/lib/reset.setup-file.ts',
+  '../../testing/test-setup/src/lib/logger.setup-file.ts',
+  '../../testing/test-setup/src/lib/chrome-path.setup-file.ts',
   ...CUSTOM_MATCHERS,
 ] as const;
 
@@ -51,7 +51,7 @@ const INT_TEST_SETUP_FILES = [
  * which is why they use `../../` to navigate to the workspace root first.
  */
 const E2E_TEST_SETUP_FILES = [
-  '../../testing/test-setup/src/lib/reset.mock.ts',
+  '../../testing/test-setup/src/lib/reset.setup-file.ts',
   ...CUSTOM_MATCHERS,
 ] as const;
 

testing/test-setup/README.md

@@ -13,11 +13,11 @@ See [`@code-pushup/test-setup-config` docs](../test-setup-config/README.md) on h
 In this library you can find all files that can be used in `setupFiles` property of `vitest.config.(unit|int|e2e).ts` files. Currently include:
 
 - [console](./src/lib/console.mock.ts) mocking
-- [file system](./src/lib/fs.mock.ts) mocking
-- [`portal-client`](./src/lib/portal-client.mock.ts) mocking
-- [git](./src/lib/git.mock.ts) mocking
+- [file system](./src/lib/fs.setup-file.ts) mocking
+- [`portal-client`](./src/lib/portal-client.setup-file.ts) mocking
+- [git](./src/lib/git.setup-file.ts) mocking
 
 Additionally, you may find helper functions for:
 
 - setting up and tearing down a [testing folder](./src/lib/test-folder.setup.ts)
-- [resetting](./src/lib/reset.mock.ts) mocks
+- [resetting](./src/lib/reset.setup-file.ts) mocks