Getting Started

Setup

Add skuld as a dev-dependency and declare a [[test]] target with harness = false in your Cargo.toml:

[dev-dependencies]
skuld = { path = "skuld" }

[[test]]
name = "my_tests"
path = "tests/my_tests.rs"
harness = false

Create the test entry point. Tests live in a support module alongside the entry point:

// tests/my_tests.rs
#[path = "my_tests_support/mod.rs"]
mod support;

fn main() {
    skuld::run_all();
}

Writing your first test

Annotate test functions with #[skuld::test]. Every annotated function is automatically registered with the harness:

// tests/my_tests_support/mod.rs

#[skuld::test]
fn basic_test() {
    assert_eq!(2 + 2, 4);
}

Run with:

cargo test

Adding preconditions

Declare runtime requirements with requires. Each requirement is a function fn() -> Result<(), String> — returning Ok(()) means the requirement is met, Err(reason) means it’s not:

fn valgrind() -> Result<(), String> {
    use std::process::{Command, Stdio};
    Command::new("valgrind")
        .arg("--version")
        .stdout(Stdio::null())
        .stderr(Stdio::null())
        .status()
        .is_ok_and(|s| s.success())
        .then_some(())
        .ok_or_else(|| "valgrind not installed".into())
}

fn my_binary() -> Result<(), String> {
    std::path::Path::new("target/debug/my_binary")
        .exists()
        .then_some(())
        .ok_or_else(|| "target/debug/my_binary not found".into())
}

#[skuld::test(requires = [valgrind, my_binary])]
fn smoke_test() {
    // This body only runs if both valgrind and my_binary are available.
}

When a requirement is missing, the test shows as ignored and the reason appears in the unavailability summary:

running 2 tests
test smoke_test     ... ignored
test full_pipeline  ... ignored

test result: ok. 0 passed; 0 failed; 2 ignored

--- Unavailable (2) ---
  smoke_test:     valgrind not installed
  full_pipeline:  valgrind not installed

Next steps

• Writing Tests — all #[skuld::test] options

• Fixtures — dependency-injected test resources

• Labels — tag tests with sentinel labels and filter via SKULD_LABELS