Skip to content

TESTING_SETUP.md

Latest commit

 

History

History
91 lines (69 loc) · 3.13 KB

TESTING_SETUP.md

File metadata and controls

91 lines (69 loc) · 3.13 KB
Raw

Testing Foundation Setup

This document summarizes the testing infrastructure that has been added to the SorobanPulse project.

Completed Tasks

✅ 1. Added dev-dependencies to Cargo.toml

  • Added tokio-test = "0.4" for async testing utilities
  • Added serde_json = "1" for JSON testing (already in dependencies but added to dev-dependencies for clarity)

✅ 2. Created tests/ directory for integration tests

  • Created /tests/integration_tests.rs with placeholder integration tests
  • Framework ready for comprehensive integration testing

✅ 3. Added #[cfg(test)] modules to source files

  • models.rs: Already had tests, enhanced with additional test coverage
  • config.rs: Added comprehensive test module with 10+ unit tests
  • handlers.rs: Enhanced existing test module with validation function tests
  • metrics.rs: Added new test module with tests for all public functions

✅ 4. Unit tests for public functions

Each file now has at least one test per public function:

models.rs

  • PaginationParams tests (existing, enhanced)
  • Tests for columns(), offset(), limit() methods

config.rs

  • Environment parsing tests
  • IndexerState tests
  • HealthState tests
  • Config tests including safe_db_url()

handlers.rs

  • Validation function tests:
    • validate_contract_id() - 4 test cases
    • validate_tx_hash() - 3 test cases
  • Enhanced existing integration tests

metrics.rs

  • Tests for all 7 public functions
  • Coverage for metrics recording functions

✅ 5. Updated CI pipeline

  • Added system dependency installation (pkg-config, libssl-dev)
  • Removed test skipping - now runs all tests
  • Added cargo-tarpaulin for coverage reporting
  • Added coverage upload to Codecov

Test Coverage Summary

  • models.rs: 6 unit tests covering pagination logic
  • config.rs: 10 unit tests covering configuration, environment, and state management
  • handlers.rs: 7 unit tests for validation functions + existing integration tests
  • metrics.rs: 7 unit tests covering all metrics functions
  • tests/: Integration test framework ready

Remaining Tasks

⏳ 6. Verify cargo test runs without errors

Status: Blocked by system dependencies

  • Need OpenSSL development packages: sudo apt install pkg-config libssl-dev
  • Once dependencies are installed, cargo test should run successfully
  • CI pipeline is configured to handle this automatically

Expected Coverage

With the current test suite, we should achieve:

  • Well above 40% coverage baseline target
  • Comprehensive coverage of business logic in core modules
  • Good coverage of validation functions and configuration logic

Running Tests Locally

# Install system dependencies (requires sudo)
sudo apt update && sudo apt install -y pkg-config libssl-dev

# Run all tests
cargo test

# Run tests with coverage (requires cargo-tarpaulin)
cargo install cargo-tarpaulin
cargo tarpaulin --out Html

Next Steps

  1. Install system dependencies to enable local testing
  2. Run cargo test to verify all tests pass
  3. Consider adding more integration tests as the application grows
  4. Monitor coverage reports to identify areas needing additional tests