test-setup-patterns

Test Setup Patterns

Global Test Configuration

Test Setup File: tests/setup/test-setup.ts

import { vi, beforeAll, beforeEach, afterEach, expect } from 'bun:test';
import { createAnalyticsEngineStub } from '../utils/analytics-engine-stub';

// Global analytics stub instance
let globalAnalyticsStub: ReturnType<typeof createAnalyticsEngineStub> | null = null;
let currentTestName: string = '';

export function getGlobalAnalyticsStub() {
  return globalAnalyticsStub;
}

export function setCurrentTestName(name: string) {
  currentTestName = name;
}

Auto-Flush Pattern

Analytics Tests Only

afterEach(function () {
  if (currentTestName.toLowerCase().includes('analytics') && globalAnalyticsStub) {
    globalAnalyticsStub.flush();
  }
  vi.restoreAllMocks();
});

Test Name Detection

// In analytics tests, always set test name
test('should track analytics calls with stub', async () => {
  setCurrentTestName('should track analytics calls with stub');
  // Test implementation
});

Mock Environment Pattern

Create Mock Environment

import { createMockEnv } from '../utils/test-helpers';

describe('My Analytics Test', () => {
  let mockEnv: any;
  let analytics: any;

  beforeEach(() => {
    const mock = createMockEnv();
    mockEnv = mock.env;
    analytics = mock.analytics;
  });
});

Use Global Stub

// ✅ CORRECT: Use global stub
const analytics = getGlobalAnalyticsStub();

// ❌ WRONG: Create duplicate stubs
const analytics1 = createAnalyticsEngineStub();
const analytics2 = createAnalyticsEngineStub();

Test Isolation Patterns

Fresh Stub Per Test

beforeEach(() => {
  // Create fresh analytics stub for each test
  globalAnalyticsStub = createAnalyticsEngineStub();
});

Console Mocking

beforeEach(() => {
  vi.spyOn(console, 'log').mockImplementation(() => {});
  vi.spyOn(console, 'error').mockImplementation(() => {});
  vi.spyOn(console, 'warn').mockImplementation(() => {});
});