Struct TestWorld 

pub struct TestWorld { /* private fields */ }

Declarative test environment builder.

Example

use agtrace_testing::TestWorld;

let world = TestWorld::new()
    .with_project("project-a")
    .enter_dir("project-a");

let result = world.run(&["session", "list"]).unwrap();
assert!(result.success());

Implementations

impl TestWorld

pub fn builder() -> TestWorldBuilder

Create a builder for constructing a TestWorld.

Example

use agtrace_testing::TestWorld;

let world = TestWorld::builder()
    .without_data_dir()
    .build();

pub fn new() -> Self

Create a new isolated test environment with default settings.

This is a convenience method that creates a fully initialized environment. For testing edge cases, use TestWorld::builder().

pub fn data_dir(&self) -> &Path

Get the data directory path (.agtrace).

pub fn log_root(&self) -> &Path

Get the log root directory path (.claude).

pub fn cwd(&self) -> &Path

Get the current working directory.

pub fn temp_dir(&self) -> &Path

Get the temp directory root.

pub fn remove_config(&self) -> Result<()>

Remove config.toml to simulate loss or fresh install.

Example

let world = TestWorld::new();
world.remove_config().unwrap();
assert!(!world.assert_config_exists());

pub fn remove_database(&self) -> Result<()>

Remove agtrace.db to simulate database loss.

Example

let world = TestWorld::new();
world.remove_database().unwrap();
assert!(!world.assert_database_exists());

pub fn write_raw_config(&self, content: &str) -> Result<()>

Write arbitrary content to config.toml.

Creates the data directory if it doesn’t exist.

Example

let world = TestWorld::builder().without_data_dir().build();

world.write_raw_config(r#"
[providers.claude_code]
enabled = true
log_root = "/custom/path"
"#).unwrap();

assert!(world.assert_config_exists());

pub fn assert_database_exists(&self) -> bool

Check if agtrace.db exists.

pub fn assert_config_exists(&self) -> bool

Check if config.toml exists.

pub fn enter_dir<P: AsRef<Path>>(self, path: P) -> Self

Change the current working directory (relative to temp root).

This is crucial for testing CWD-dependent logic. This method consumes self for use in builder pattern chains.

For changing directory multiple times in a test, use set_cwd() instead.

pub fn set_cwd<P: AsRef<Path>>(&mut self, path: P)

Set the current working directory without consuming self.

This is useful when you need to change directories multiple times during a test.

Example

let mut world = TestWorld::new()
    .with_project("project-a")
    .with_project("project-b");

// Move to project-a
world.set_cwd("project-a");
let result = world.run(&["session", "list"]).unwrap();

// Move to project-b
world.set_cwd("project-b");
let result = world.run(&["session", "list"]).unwrap();

pub fn with_env(self, key: impl Into<String>, value: impl Into<String>) -> Self

Set an environment variable for CLI execution.

pub fn with_project(self, project_name: &str) -> Self

Create a project directory structure.

pub fn configure_command<'a>(&self, cmd: &'a mut Command) -> &'a mut Command

Configure a CLI command with this test environment’s settings.

The caller must provide the base command (e.g., from cargo_bin_cmd!("agtrace")). This method configures it with the appropriate data-dir, cwd, and env vars.

pub fn copy_sample(&self, sample_name: &str, dest_name: &str) -> Result<()>

Copy a sample file to the log root.

pub fn copy_sample_to_project( &self, sample_name: &str, dest_name: &str, project_dir: &str, ) -> Result<()>

Copy a sample file to a Claude-encoded project directory.

pub fn copy_sample_to_project_with_cwd( &self, sample_name: &str, dest_name: &str, target_project_dir: &str, provider: TestProvider, ) -> Result<()>

Copy a sample file to a project with cwd and sessionId replacement.

This is the recommended method for creating isolated test sessions.

pub fn run(&self, args: &[&str]) -> Result<CliResult>

Execute a command using the project’s binary and return the result.

This is a convenience method that creates a command, configures it with the test environment settings, and executes it.

Example

let world = TestWorld::new();
let result = world.run(&["session", "list"]).unwrap();
assert!(result.success());

Note

This method uses Command::cargo_bin() which requires the binary to be built and the CARGO_BIN_EXE_ environment variable to be set (which cargo test does automatically).

pub fn run_in_dir<P: AsRef<Path>>( &mut self, args: &[&str], dir: P, ) -> Result<CliResult>

Execute a command in a specific directory temporarily.

This helper temporarily changes the working directory, runs the command, and restores the original directory. This is useful for testing commands that depend on the current working directory without permanently changing the TestWorld state.

Example

let mut world = TestWorld::new()
    .with_project("project-a")
    .with_project("project-b");

// Run in project-a
let result_a = world.run_in_dir(&["session", "list"], "project-a").unwrap();

// Run in project-b (without manually changing cwd)
let result_b = world.run_in_dir(&["session", "list"], "project-b").unwrap();

// Original cwd is preserved

pub fn enable_provider(&self, provider: TestProvider) -> Result<()>

Enable a provider and configure it in the test environment.

This method:

1. Creates the provider’s log directory
2. Runs provider set command to update config.toml
3. Enables the provider

Example

let world = TestWorld::new();
world.enable_provider(TestProvider::Claude).unwrap();
world.enable_provider(TestProvider::Gemini).unwrap();

This tests the CLI’s configuration routing logic.

pub fn add_session( &self, provider: TestProvider, dest_filename: &str, ) -> Result<()>

Add a session log for the specified provider.

This method:

1. Determines the provider’s log directory
2. Places a sample session file in the correct location
3. Handles provider-specific directory encoding via the provider adapter

Example

let mut world = TestWorld::new()
    .with_project("my-project")
    .enter_dir("my-project");

world.enable_provider(TestProvider::Claude).unwrap();

// Add a Claude session for the current project
world.add_session(TestProvider::Claude, "session1.jsonl").unwrap();

This tests the CLI’s ability to find logs in the correct provider directory.

Trait Implementations

impl Default for TestWorld

fn default() -> Self

Returns the “default value” for a type.