Testing

Test strategy and coverage information for GLM Proxy.

Related:

• Load Testing Guide - Performance baseline validation
• Troubleshooting Guide - Common test failures and solutions
• Configuration Guide - Test environment setup

E2E Testing with Screenshots

The project uses Playwright for E2E testing, including automated screenshot generation for documentation:

Screenshot Generation

Generate screenshots for documentation:

npm run screenshots:generate
npm run screenshots:extract

See Screenshots Gallery for all available screenshots.

Running Tests

Run All Tests

npm test

Run with Coverage

npm run test:verbose

Test Structure

Tests are located in the test/ directory:

test/
├── circuit-breaker.test.js      # Circuit breaker logic
├── config.test.js               # Configuration handling
├── key-manager.test.js          # Key management and rotation
├── rate-limiter.test.js         # Rate limiting
├── request-handler.test.js       # Request proxy logic
├── stats-aggregator.test.js     # Metrics collection
├── circular-buffer.test.js       # Latency tracking
└── ...

Test Strategy

Unit Tests

• Individual module testing in isolation
• Mocked dependencies
• Fast execution

Integration Tests

• End-to-end request flow
• Component interaction
• Real HTTP server (test port)

Coverage Tracking

Performance Testing: See Load Testing Guide for baseline validation and performance targets.

Current coverage status is tracked in:

• test/COVERAGE_DEBT.md - Coverage gaps and improvement plan

Coverage Goals

Writing New Tests

Test Template

describe('module-name', () => {
  beforeEach(() => {
    // Setup
  });

  afterEach(() => {
    // Teardown
  });

  test('should do something', () => {
    // Arrange
    const input = {};

    // Act
    const result = functionUnderTest(input);

    // Assert
    expect(result).toBe(expected);
  });
});

Test Quarantine

Tests that are temporarily disabled are tracked in:

• test/quarantine/QUARANTINE_EXIT.md - Quarantined tests and exit criteria

Continuous Integration

Release Process: See Release Process for automated release workflow and commit conventions.

Tests run automatically on:

• Every push
• Every pull request
• Before release

Debugging Tests

Run Single Test File

npm test -- path/to/test.test.js

Run Specific Test

npm test -- -t "test name pattern"

Debug Mode

NODE_ENV=test node --inspect-brk node_modules/.bin/jest --runInBand

Test Data

Test fixtures and mocks:

• Mock API keys in test setup
• Sample responses for testing
• Error scenario mocks

See Also

• TEST_PLAN.md - Comprehensive test strategy
• COVERAGE_DEBT.md - Coverage tracking