Testing

Ensuring the integrity of our SEO tools.

Reliability is the core of this project. Any new tool or logic must be accompanied by tests that verify its deterministic output.

Test Suite

We use Vitest for our unit and integration tests.

Running Tests

To run the full suite:

npm test

Writing a Tool Test

When testing an SEO tool, focus on verifying the math and the filtering logic.

import { findStrikingDistance } from '../src/tools/seo-insights';

describe('findStrikingDistance', () => {
  it('should only return keywords in positions 8-15', async () => {
    // Mock GSC data...
    const result = await findStrikingDistance(mockSite, { limit: 10 });
    
    result.forEach(item => {
      expect(item.position).toBeGreaterThanOrEqual(8);
      expect(item.position).toBeLessThanOrEqual(15);
    });
  });
});

Mocking Google Data

We prefer using mock data for standard unit tests to avoid hitting API rate limits during CI/CD. Check tests/mocks.ts for existing search performance mocks.

CI/CD Workflow

Every pull request triggers our GitHub Actions CI, which:

1. Installs dependencies.
2. Builds the project.
3. Runs the test suite.
4. Generates a coverage report.

Please ensure your changes do not decrease the overall project test coverage.