refactor(testing): consolidate global setup logic and remove redundant files

Author: Szymon.Poltorak

e2e/ci-e2e/global-setup.ts

@@ -8,7 +8,6 @@
     "vitest.e2e.config.ts",
     "tests/**/*.e2e.test.ts",
     "tests/**/*.d.ts",
-    "mocks/**/*.ts",
-    "global-setup.ts"
+    "mocks/**/*.ts"
   ]
 }

e2e/ci-e2e/tsconfig.test.json

@@ -1,16 +1,6 @@
 /// <reference types="vitest" />
-import type { UserConfig } from 'vite';
 import { createE2ETestConfig } from '../../testing/test-setup-config/src/index.js';
 
-const baseConfig = createE2ETestConfig('ci-e2e', {
+export default createE2ETestConfig('ci-e2e', {
   testTimeout: 60_000,
-  disableCoverage: true,
 });
-
-export default {
-  ...baseConfig,
-  test: {
-    ...(baseConfig as any).test,
-    globalSetup: ['./global-setup.ts'],
-  },
-} as UserConfig;

e2e/ci-e2e/vitest.e2e.config.ts

@@ -1,3 +1,18 @@
-export async function setup() {
+/* eslint-disable functional/immutable-data */
+
+const originalCI = process.env['CI'];
+
+export function setup() {
   process.env.TZ = 'UTC';
+
+  // package is expected to run in CI environment
+  process.env['CI'] = 'true';
+}
+
+export function teardown() {
+  if (originalCI === undefined) {
+    delete process.env['CI'];
+  } else {
+    process.env['CI'] = originalCI;
+  }
 }

global-setup.ts

@@ -30,7 +30,6 @@ export default createE2ETestConfig('my-e2e');
 // With options:
 export default createE2ETestConfig('my-e2e', {
   testTimeout: 60_000,
-  disableCoverage: true,
 });
 ```
 

testing/test-setup-config/README.md

@@ -1,14 +1,12 @@
-import path from 'node:path';
-import { type UserConfig as ViteUserConfig, defineConfig } from 'vite';
 import type { CoverageOptions, InlineConfig } from 'vitest';
+import { type UserConfig as ViteUserConfig, defineConfig } from 'vitest/config';
 import { getSetupFiles } from './vitest-setup-files.js';
 import { tsconfigPathAliases } from './vitest-tsconfig-path-aliases.js';
 
 export type TestKind = 'unit' | 'int' | 'e2e';
 
 export type E2ETestOptions = {
   testTimeout?: number;
-  disableCoverage?: boolean;
 };
 
 export type VitestConfig = ViteUserConfig & { test?: InlineConfig };
@@ -34,9 +32,8 @@ function getGlobalSetup(kind: TestKind): string[] | undefined {
 function buildCoverageConfig(
   projectKey: string,
   kind: TestKind,
-  disableCoverage?: boolean,
 ): CoverageOptions | undefined {
-  if (disableCoverage || kind === 'e2e') {
+  if (kind === 'e2e') {
     return undefined;
   }
 
@@ -55,11 +52,7 @@ export function createVitestConfig(
   kind: TestKind,
   options?: E2ETestOptions,
 ): ViteUserConfig {
-  const coverage = buildCoverageConfig(
-    projectKey,
-    kind,
-    options?.disableCoverage,
-  );
+  const coverage = buildCoverageConfig(projectKey, kind);
 
   const config: VitestConfig = {
     cacheDir: `../../node_modules/.vite/${projectKey}`,

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

@@ -1,10 +1,10 @@
-import { defineConfig } from 'vite';
 import { beforeEach, describe, expect, it, vi } from 'vitest';
+import { defineConfig } from 'vitest/config';
 import type { E2ETestOptions, TestKind } from './vitest-config-factory.js';
 import { createVitestConfig } from './vitest-config-factory.js';
 
-vi.mock('vite', async importOriginal => {
-  const actual = await importOriginal<typeof import('vite')>();
+vi.mock('vitest/config', async importOriginal => {
+  const actual = await importOriginal<typeof import('vitest/config')>();
   return {
     ...actual,
     defineConfig: vi.fn(config => config),
@@ -215,17 +215,9 @@ describe('createVitestConfig', () => {
       expect((config as any).test.testTimeout).toBe(60_000);
     });
 
-    it('should support disableCoverage option', () => {
-      const options: E2ETestOptions = { disableCoverage: true };
-      const config = createVitestConfig('test-package', 'e2e', options);
-
-      expect((config as any).test.coverage).toBeUndefined();
-    });
-
     it('should support multiple options together', () => {
       const options: E2ETestOptions = {
         testTimeout: 30_000,
-        disableCoverage: true,
       };
       const config = createVitestConfig('test-package', 'e2e', options);
 

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

@@ -1,4 +1,4 @@
-import type { UserConfig as ViteUserConfig } from 'vite';
+import type { UserConfig as ViteUserConfig } from 'vitest/config';
 import {
   type E2ETestOptions,
   createVitestConfig,
@@ -49,7 +49,6 @@ export function createIntTestConfig(projectKey: string): ViteUserConfig {
  * // With options
  * export default createE2ETestConfig('my-e2e', {
  *   testTimeout: 60_000,
- *   disableCoverage: true,
  * });
  *
  * // Override any config using spread operator

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

@@ -80,7 +80,6 @@ describe('vitest-setup-presets', () => {
     it('should pass options to createVitestConfig', () => {
       const options = {
         testTimeout: 60_000,
-        disableCoverage: true,
       };
 
       createE2ETestConfig(MOCK_PROJECT_KEY, options);
@@ -101,31 +100,6 @@ describe('vitest-setup-presets', () => {
         { testTimeout: 30_000 },
       );
     });
-
-    it('should handle disableCoverage option', () => {
-      createE2ETestConfig(MOCK_PROJECT_KEY, { disableCoverage: true });
-
-      expect(configFactory.createVitestConfig).toHaveBeenCalledWith(
-        MOCK_PROJECT_KEY,
-        'e2e',
-        { disableCoverage: true },
-      );
-    });
-
-    it('should handle multiple options', () => {
-      const options = {
-        testTimeout: 45_000,
-        disableCoverage: false,
-      };
-
-      createE2ETestConfig(MOCK_PROJECT_KEY, options);
-
-      expect(configFactory.createVitestConfig).toHaveBeenCalledWith(
-        MOCK_PROJECT_KEY,
-        'e2e',
-        options,
-      );
-    });
   });
 
   describe('function naming', () => {