rtf-orchestrator

This page documents how tests in the rtf-orchestrator crate are organized and implemented. The crate uses two test styles:

• Unit tests follow the unit test style
• HTTP API integration tests follow the HTTP API integration test style

See Run rtf-orchestrator tests for a step-by-step guide to running each category locally.

Categories

Running cargo test from the workspace root skips all stack-dependent tests. They must be run explicitly via make.

Unit test organization

Unit tests follow the Module → Function → Test class → Test case hierarchy from the unit test style:

#![allow(unused)]
fn main() {
// Without simple_test_case
module::path::tests::function_test_case

// With simple_test_case
module::path::tests::function_test_class::test_case
}

Integration test organization

Integration tests follow the Endpoint → Scenario naming described in the HTTP API integration test style:

#![allow(unused)]
fn main() {
endpoint_scenario
}

For example: trigger_valid_test_plan_returns_200.

Feature flag annotation

Stack-dependent tests must always carry this annotation to prevent the standard test run from failing without a stack:

#![allow(unused)]
fn main() {
#[cfg_attr(not(feature = "db_tests"), ignore)]    // for DB tests
#[cfg_attr(not(feature = "k8s_tests"), ignore)]   // for integration tests
}

Do not remove these annotations from existing tests.

Testing infrastructure

Integration tests use the following tools:

• TestHelper — Defined in tests/common/mod.rs. Wraps reqwest::Client and provides convenience methods for calling server endpoints
• tokio — #[tokio::test] for async test functions
• reqwest — HTTP client used inside TestHelper
• assert_fs — Temporary filesystem utilities; uses CARGO_TARGET_TMPDIR rather than /tmp to avoid macOS symlink issues with Docker volume mounts
• simple_test_case — Parameterized testing with #[test_case] for multiple input variations

TestHelper API

#![allow(unused)]
fn main() {
pub struct TestHelper {
    client: Client,
}
}

Shared logic between tests should be added as further methods on TestHelper.

Make targets