Running Tests

Running Tests¶

pyrs-yaml has both Rust unit tests and Python integration tests.

Rust Tests¶

# Run all Rust tests with nextest (preferred)
cargo nextest run --all

# Run all Rust tests with cargo test
cargo test --all

# Run pure Rust core tests (no Python runtime needed)
cargo test --all --no-default-features

# Run with output
cargo test --all -- --nocapture

Test Coverage¶

• crates/pyrs-yaml-core/src/ast.rs — Node construction, metadata, equality
• crates/pyrs-yaml-core/src/parser/ — Parsing various YAML constructs
• crates/pyrs-yaml-core/src/serializer.rs — Serialization round-trips
• crates/pyrs-yaml-core/src/editing/ — Edit primitives (navigate, region, dirty, metadata)
• crates/pyrs-yaml-core/src/integration/ — YAML Test Suite integration
• crates/pyrs-yaml/src/fidelity.rs — Property-based fuzz tests

Python Tests¶

# Run all Python tests
uv run pytest tests/ -v

# Run a specific test file
uv run pytest tests/test_edit.py -v

# Run a specific test class
uv run pytest tests/test_node_api.py::TestDocWalk -v

# Run with coverage
uv run pytest tests/ -v --cov=pyrs_yaml

# Run compliance suite
uv run pytest tests/test_yaml_suite.py -v

# Run benchmarks
uv run pytest tests/ --codspeed

Maturin Build¶

# Build and install (uses monorepo manifest-path)
uv run maturin develop --release

# Generate stubs for .pyi files
uv run maturin build --release --generate-stubs

Test Files¶

CI Testing¶

GitHub Actions runs on every push and PR:

• Rust: cargo nextest run --all, cargo clippy --all -- -D warnings, cargo fmt --check
• Python: uv run pytest tests/ on 4 Python versions × 3 OSes
• Maturin: Build wheel for each Python version (via crates/pyrs-yaml/Cargo.toml)

Adding New Tests¶

Rust Test¶

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_new_feature() {
        // Your test here
    }
}

Python Test¶

import pyrs_yaml
import pytest


class TestNewFeature:
    def test_basic(self):
        result = pyrs_yaml.parse("key: value")
        assert result.get("key") == "value"

    def test_edge_case(self):
        # Edge case test
        pass

Test Categories¶

• Unit tests — Individual functions, small inputs
• Integration tests — Full parse → serialize round-trips
• Edge case tests — Special characters, empty input, malformed YAML
• Performance tests — Sanity checks (not benchmarks)
• YAML Test Suite — External test suite for YAML compliance

YAML Test Suite Known Deviations¶

The suite pass rate is gated at 95% (see test_compliance_report). A small number of cases are intentionally not chased because rejecting them is spec-correct and matches reference parsers (notably PyYAML/libyaml):

All other suite cases pass (currently 405/406 = 99.75%).