Phase 3: Consolidate test mock patterns and shared test data

Copilot · chrisreddington · Copilot · commit d0f6d1c12c89 · 2025-08-07T13:45:39.000Z
Co-authored-by: chrisreddington &lt;791642+chrisreddington@users.noreply.github.com&gt;
diff --git a/shared/src/testing/api-test-utils.ts b/shared/src/testing/api-test-utils.ts
@@ -0,0 +1,135 @@
+/**
+ * Shared API Test Utilities
+ * 
+ * Provides reusable mock factories and test utilities for API route testing
+ * to eliminate duplication across test files.
+ */
+
+import { vi } from 'vitest'
+import type { GameSession, Player, BaseGameState } from '../types/game'
+import type { TicTacToeGameState, RPSGameState, TicTacToeMove, RPSMove } from '../types/games'
+
+/**
+ * Generic game mock factory
+ * Creates a mock game instance with all required methods
+ */
+export function createGameMock() {
+  return {
+    getInitialState: vi.fn(),
+    validateMove: vi.fn(),
+    applyMove: vi.fn(),
+    checkGameEnd: vi.fn(),
+    getValidMoves: vi.fn()
+  }
+}
+
+/**
+ * Create mock players for testing
+ */
+export function createMockPlayers(): Player[] {
+  return [
+    { id: 'player1', name: 'Player', isAI: false },
+    { id: 'ai', name: 'AI', isAI: true }
+  ]
+}
+
+/**
+ * Create a mock TicTacToe game state
+ */
+export function createMockTicTacToeGameState(overrides: Partial<TicTacToeGameState> = {}): TicTacToeGameState {
+  return {
+    id: 'test-game-1',
+    players: createMockPlayers(),
+    currentPlayerId: 'player1',
+    status: 'playing',
+    createdAt: new Date('2024-01-01T10:00:00Z'),
+    updatedAt: new Date('2024-01-01T10:00:00Z'),
+    board: [
+      [null, null, null],
+      [null, null, null],
+      [null, null, null]
+    ],
+    playerSymbols: {
+      player1: 'X',
+      ai: 'O'
+    },
+    ...overrides
+  }
+}
+
+/**
+ * Create a mock Rock Paper Scissors game state
+ */
+export function createMockRPSGameState(overrides: Partial<RPSGameState> = {}): RPSGameState {
+  return {
+    id: 'test-rps-1',
+    players: createMockPlayers(),
+    currentPlayerId: 'player1',
+    status: 'playing',
+    createdAt: new Date('2024-01-01T10:00:00Z'),
+    updatedAt: new Date('2024-01-01T10:00:00Z'),
+    rounds: [],
+    currentRound: 0,
+    maxRounds: 3,
+    scores: {
+      player1: 0,
+      ai: 0
+    },
+    ...overrides
+  }
+}
+
+/**
+ * Create a mock game session
+ */
+export function createMockGameSession<T extends BaseGameState>(gameState: T, gameType: 'tic-tac-toe' | 'rock-paper-scissors'): GameSession<T> {
+  return {
+    gameState,
+    gameType,
+    history: [],
+    aiDifficulty: 'medium'
+  }
+}
+
+/**
+ * Vitest mock configuration for shared package games
+ * Use this to create consistent mocks across API route tests
+ */
+export function createSharedGameMocks(gameClass: string) {
+  const mockGame = createGameMock()
+  
+  return {
+    mockImplementation: {
+      ...vi.importActual('@turn-based-mcp/shared'),
+      [gameClass]: vi.fn().mockImplementation(() => mockGame)
+    },
+    mockGame
+  }
+}
+
+/**
+ * Create storage function mocks for a specific game type
+ */
+export function createStorageMocks(gameType: 'tic-tac-toe' | 'rock-paper-scissors') {
+  if (gameType === 'tic-tac-toe') {
+    return {
+      getTicTacToeGame: vi.fn(),
+      setTicTacToeGame: vi.fn(),
+      getAllTicTacToeGames: vi.fn()
+    }
+  } else {
+    return {
+      getRPSGame: vi.fn(),
+      setRPSGame: vi.fn(),
+      getAllRPSGames: vi.fn()
+    }
+  }
+}
+
+/**
+ * Standard test moves for different games
+ */
+export const TEST_MOVES = {
+  ticTacToe: { row: 0, col: 0 } as TicTacToeMove,
+  rockPaperScissors: { choice: 'rock' } as RPSMove
+}
diff --git a/shared/src/testing/index.ts b/shared/src/testing/index.ts
@@ -12,3 +12,14 @@ export {
   getTestDatabase,
   isTestDatabaseReady
 } from './test-database'
+
+export {
+  createGameMock,
+  createMockPlayers,
+  createMockTicTacToeGameState,
+  createMockRPSGameState,
+  createMockGameSession,
+  createSharedGameMocks,
+  createStorageMocks,
+  TEST_MOVES
+} from './api-test-utils'
diff --git a/web/src/app/api/games/rock-paper-scissors/route.test.ts b/web/src/app/api/games/rock-paper-scissors/route.test.ts
@@ -1,6 +1,7 @@
 import { vi } from 'vitest'
 import { NextRequest } from 'next/server';
 import type { GameSession, RPSGameState } from '@turn-based-mcp/shared';
+import { createRPSTestState } from '../../../../test-utils/common-test-data';
 
 // Use vi.hoisted() to ensure the mock object is available during hoisting
 const mockGame = vi.hoisted(() => ({
@@ -33,34 +34,15 @@ import { GET, POST } from './route';
 const mockGameStorage = vi.mocked(gameStorage);
 
 describe('/api/games/rock-paper-scissors', () => {
-  // Create the mock game state at module level
-  const createMockGameState = (): RPSGameState => ({
-    id: 'test-rps-1',
-    players: [
-      { id: 'player1' as const, name: 'Player', isAI: false },
-      { id: 'ai' as const, name: 'AI', isAI: true }
-    ],
-    currentPlayerId: 'player1' as const,
-    status: 'playing' as const,
-    createdAt: new Date('2024-01-01T10:00:00Z'),
-    updatedAt: new Date('2024-01-01T10:00:00Z'),
-    rounds: [],
-    currentRound: 0,
-    scores: {
-      player1: 0,
-      ai: 0
-    },
-    maxRounds: 3
-  });
-
+  // Use shared test data factory to reduce duplication
   let mockGameState: RPSGameState;
   let mockGameSession: GameSession<RPSGameState>;
 
   beforeEach(() => {
     vi.clearAllMocks();
     
-    // Create fresh mock state for each test
-    mockGameState = createMockGameState();
+    // Create fresh test data for each test using shared factory
+    mockGameState = createRPSTestState();
     mockGameSession = {
       gameState: mockGameState,
       gameType: 'rock-paper-scissors' as const,
diff --git a/web/src/app/api/games/tic-tac-toe/route.test.ts b/web/src/app/api/games/tic-tac-toe/route.test.ts
@@ -1,6 +1,7 @@
 import { vi } from 'vitest'
 import { NextRequest } from 'next/server';
 import type { GameSession, TicTacToeGameState } from '@turn-based-mcp/shared';
+import { createTicTacToeTestState } from '../../../../test-utils/common-test-data';
 
 // Use vi.hoisted() to ensure the mock object is available during hoisting
 const mockGame = vi.hoisted(() => ({
@@ -33,27 +34,8 @@ import { GET, POST } from './route';
 const mockGameStorage = vi.mocked(gameStorage);
 
 describe('/api/games/tic-tac-toe', () => {
-  // Create the mock game state at module level
-  const mockGameState: TicTacToeGameState = {
-    id: 'test-game-1',
-    players: [
-      { id: 'player1' as const, name: 'Player', isAI: false },
-      { id: 'ai' as const, name: 'AI', isAI: true }
-    ],
-    currentPlayerId: 'player1' as const,
-    status: 'playing' as const,
-    createdAt: new Date('2024-01-01T10:00:00Z'),
-    updatedAt: new Date('2024-01-01T10:00:00Z'),
-    board: [
-      [null, null, null],
-      [null, null, null],
-      [null, null, null]
-    ],
-    playerSymbols: {
-      player1: 'X' as const,
-      ai: 'O' as const
-    }
-  };
+  // Use shared test data factory to reduce duplication
+  const mockGameState = createTicTacToeTestState();
 
   const mockGameSession: GameSession<TicTacToeGameState> = {
     gameState: mockGameState,
diff --git a/web/src/test-utils/api-route-mocks.ts b/web/src/test-utils/api-route-mocks.ts
@@ -0,0 +1,106 @@
+/**
+ * API Route Testing Utilities for Web Package
+ * 
+ * Provides web-specific mock patterns and utilities for testing
+ * Next.js API routes consistently across all game types.
+ */
+
+import { vi } from 'vitest'
+import { 
+  createSharedGameMocks, 
+  createStorageMocks,
+  createMockTicTacToeGameState,
+  createMockRPSGameState,
+  createMockGameSession
+} from '@turn-based-mcp/shared'
+
+/**
+ * Setup standard API route mocks for a specific game type
+ * This consolidates the common mock setup pattern used across API route tests
+ */
+export function setupAPIRouteMocks(gameType: 'tic-tac-toe' | 'rock-paper-scissors') {
+  const gameClass = gameType === 'tic-tac-toe' ? 'TicTacToeGame' : 'RockPaperScissorsGame'
+  
+  // Create shared game mocks
+  const { mockImplementation, mockGame } = createSharedGameMocks(gameClass)
+  
+  // Create storage mocks
+  const storageMocks = createStorageMocks(gameType)
+  
+  // Setup vi.mock calls
+  vi.mock('@turn-based-mcp/shared', () => mockImplementation)
+  vi.mock('../../../../lib/game-storage', () => storageMocks)
+  
+  return {
+    mockGame,
+    storageMocks
+  }
+}
+
+/**
+ * Setup mocks for move route testing
+ * Handles the slightly different mock setup needed for move routes
+ */
+export function setupMoveRouteMocks(gameType: 'tic-tac-toe' | 'rock-paper-scissors') {
+  const gameClass = gameType === 'tic-tac-toe' ? 'TicTacToeGame' : 'RockPaperScissorsGame'
+  
+  // Create game mock
+  const mockGame = {
+    getInitialState: vi.fn(),
+    validateMove: vi.fn(),
+    applyMove: vi.fn(),
+    checkGameEnd: vi.fn(),
+    getValidMoves: vi.fn()
+  }
+  
+  // Setup shared mock
+  vi.mock('@turn-based-mcp/shared', () => ({
+    ...vi.importActual('@turn-based-mcp/shared'),
+    [gameClass]: vi.fn(() => mockGame),
+    __mockGameInstance: mockGame
+  }))
+  
+  // Storage mocks - different path depth for move routes
+  if (gameType === 'tic-tac-toe') {
+    vi.mock('../../../../../../lib/game-storage', () => ({
+      getTicTacToeGame: vi.fn(),
+      setTicTacToeGame: vi.fn()
+    }))
+  } else {
+    vi.mock('../../../../../../lib/game-storage', () => ({
+      getRPSGame: vi.fn(),
+      setRPSGame: vi.fn()
+    }))
+  }
+  
+  return mockGame
+}
+
+/**
+ * Create standard mock game sessions for testing
+ */
+export function createTestGameSessions() {
+  return {
+    ticTacToe: createMockGameSession(
+      createMockTicTacToeGameState(),
+      'tic-tac-toe'
+    ),
+    rockPaperScissors: createMockGameSession(
+      createMockRPSGameState(),
+      'rock-paper-scissors'  
+    )
+  }
+}
+
+/**
+ * Helper to create NextRequest mock for testing
+ */
+export function createMockNextRequest(url: string, init?: { method?: string; body?: any }) {
+  const mockRequest = {
+    url,
+    method: init?.method || 'GET',
+    json: vi.fn().mockResolvedValue(init?.body || {})
+  }
+  
+  return mockRequest as any
+}
diff --git a/web/src/test-utils/common-test-data.ts b/web/src/test-utils/common-test-data.ts
