Redis Testing Guide

​

Redis Service Testing Guide

​

Overview

​

Test Infrastructure

​

Running Tests

​

Test Configuration

​

Vitest Configuration

// .config.ts
{
  preset: 'ts-vitest',
  testEnvironment: 'node',
  testMatch: [
    '<rootDir>/**/*.test.ts',
    '<rootDir>/**/*.perf.test.ts',
    '<rootDir>/**/*.integration.test.ts',
  ],
  setupFilesAfterEnv: ['<rootDir>/.setup.ts'],
  globalSetup: '<rootDir>/.global.setup.ts',
  globalTeardown: '<rootDir>/.global.teardown.ts',
  testTimeout: 30000,
  maxWorkers: 4,
  collectCoverage: true,
  coverageThreshold: {
    global: {
      branches: 80,
      functions: 80,
      lines: 80,
      statements: 80,
    },
  },
}

​

Environment Setup

// .setup.ts
{
  // Configure test environment
  .setTimeout(10000)
  process.env.REDIS_URL = 'redis://localhost:6379'
  process.env.REDIS_KEY_PREFIX = "test:"

  // Custom matchers
  expect.extend({
    toBeRedisError(received, expectedCode) {
      // ...
    },
  })
}

​

Coverage Requirements

​

Minimum Coverage Thresholds

​

Coverage Report

• Line-by-line code coverage
• Branch coverage analysis
• Function coverage details
• Uncovered code identification

​

Performance Benchmarks

​

Connection Pool

​

Throughput

​

Data Size

​

CI/CD Integration

​

GitHub Actions Workflow

name: Redis Service Tests

on:
  push:
    paths:
      - 'src/lib/services/redis/**'
  pull_request:
    paths:
      - 'src/lib/services/redis/**'

jobs:
  test:
    runs-on: ubuntu-latest

    services:
      redis:
        image: redis:latest
        ports:
          - 6379:6379

    steps:
      - uses: actions/checkout@v4
      - uses: pnpm/action-setup@v2
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
          cache: 'pnpm'

      - name: Install dependencies
        run: pnpm install --frozen-lockfile

      - name: Run tests
        run: pnpm test:redis:all
        env:
          REDIS_URL: redis://localhost:6379
          REDIS_KEY_PREFIX: "test:"

      - name: Upload coverage
        uses: codecov/codecov-action@v3
        with:
          files: ./coverage/lcov.info

​

Best Practices

​

Writing Tests

1. Test Organization
   • Group related tests using describe blocks
   • Use clear, descriptive test names
   • Follow the Arrange-Act-Assert pattern
   • Keep tests focused and atomic
2. Test Data Management
   • Use unique keys for each test
   • Clean up test data after each test
   • Use appropriate TTLs for test data
   • Handle test data isolation
3. Error Handling
   • Test both success and error cases
   • Verify error types and messages
   • Test retry mechanisms
   • Validate error recovery
4. Performance Testing
   • Use realistic data sizes
   • Test under various loads
   • Monitor resource usage
   • Validate scaling behavior

​

Running Tests 2

1. Local Development
   • Use watch mode for development
   • Run affected tests only
   • Monitor test coverage
   • Profile test performance
2. CI/CD Pipeline
   • Run all tests before merge
   • Enforce coverage thresholds
   • Archive test artifacts
   • Monitor test trends

​

Troubleshooting

​

Common Issues

1. Connection Failures
   Copy

   # Verify Redis is running
   docker ps | grep redis
   
   # Check Redis logs
   docker logs redis
   
   # Test connection
   redis-cli ping
   

2. Performance Issues
   Copy

   # Monitor Redis metrics
   redis-cli info
   
   # Check system resources
   top -n 1
   
   # View test metrics
   pnpm test:redis:perf
   

3. Test Failures
   Copy

   # Run specific test
   pnpm test:redis:unit -t "test name"
   
   # Debug test
   NODE_OPTIONS=--inspect pnpm test:redis:unit
   
   # View detailed logs
   DEBUG=true pnpm test:redis:all
   

​

Support

• GitHub Issues: Report a bug
• Documentation: Redis Service API
• Slack: #redis-service channel