Skip to content

testing.md

Latest commit

 

History

History
98 lines (73 loc) · 1.8 KB

testing.md

File metadata and controls

98 lines (73 loc) · 1.8 KB
Raw

Testing Guide

Quick Start

# Run all tests
./run-tests.sh

# Run with coverage report
./run-tests.sh coverage

# Run specific test file
./run-tests.sh tests/test_models.py

Test Results

  • 151 tests - 100% passing ✅
  • 99% coverage - 238/239 lines covered
  • ~1.1s execution time

Test Structure

tests/
├── conftest.py                 # Shared fixtures
├── test_models.py              # Domain models (30 tests)
├── test_api_client.py          # HTTP client (28 tests)
├── test_search_service.py      # Search logic (31 tests)
├── test_translator_service.py  # Translation (18 tests)
├── test_formatters.py          # Formatting (33 tests)
└── test_server_integration.py  # MCP tools (18 tests)

Running Tests

All Tests

./run-tests.sh

Unit Tests Only

./run-tests.sh unit

Integration Tests Only

./run-tests.sh integration

Coverage Report

./run-tests.sh coverage
# Generates coverage.xml (for CI/CD tools like Codecov, SonarQube)

Specific Test

docker-compose run --rm techword-mcp pytest tests/test_models.py::TestWord -v

Local Development (without Docker)

# Create virtual environment
python3 -m venv venv
source venv/bin/activate

# Install dependencies
pip install -e ".[dev]"

# Run tests
pytest -v

CI/CD Integration

# Example GitHub Actions
- name: Run Tests
  run: docker-compose run --rm techword-mcp pytest --cov

- name: Upload Coverage
  uses: codecov/codecov-action@v2

Coverage

Coverage is reported as XML (for CI/CD integration):

./run-tests.sh coverage
# Outputs coverage.xml — consume with Codecov, SonarQube, or similar

Writing Tests

See tests/README.md for detailed guide on writing tests.