Struct E2eTestRunner 

pub struct E2eTestRunner { /* private fields */ }

A process runner bound to a specific E2E test environment.

This provides a higher-level abstraction for running E2E test tasks against a named environment, eliminating the need to pass both the runner and environment name to every task function.

Example

use torrust_tracker_deployer_lib::testing::e2e::tasks::black_box::E2eTestRunner;

let test_runner = E2eTestRunner::new("e2e-provision")
    .with_cleanup_on_failure(true);

test_runner.provision_infrastructure()?;
test_runner.destroy_infrastructure()?;

Implementations

impl E2eTestRunner

pub fn new(environment_name: impl Into<String>) -> Self

Creates a new E2E test runner for the specified environment.

By default, cleanup on failure is disabled. Use with_cleanup_on_failure to enable automatic infrastructure destruction when tasks fail.

pub fn with_cleanup_on_failure(self, cleanup: bool) -> Self

Enables or disables automatic cleanup on failure.

When enabled, if a task like provision_infrastructure or configure_services fails, the runner will attempt to destroy the infrastructure before returning the error.

pub fn environment_name(&self) -> &str

Returns the environment name.

pub fn cleanup_on_failure(&self) -> bool

Returns whether cleanup on failure is enabled.

pub fn create_environment(&self, config_path: &Path) -> Result<()>

Creates the environment from the configuration file.

Arguments

• config_path - Path to the environment configuration file

Errors

Returns an error if the create command fails.

Panics

Panics if the config path contains invalid UTF-8.

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

Provisions the infrastructure for the environment.

Errors

Returns an error if the provision command fails. If cleanup_on_failure is enabled, attempts to destroy infrastructure before returning.

pub fn register_instance( &self, instance_ip: &str, ssh_port: Option<u16>, ) -> Result<()>

Registers an existing instance with the environment.

This is an alternative to provision_infrastructure for use with existing VMs, physical servers, or containers.

Arguments

• instance_ip - IP address of the existing instance to register

Errors

Returns an error if the register command fails.

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

Configures services on the provisioned infrastructure.

Errors

Returns an error if the configure command fails. If cleanup_on_failure is enabled, attempts to destroy infrastructure before returning.

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

Releases software to the provisioned and configured infrastructure.

Errors

Returns an error if the release command fails. If cleanup_on_failure is enabled, attempts to destroy infrastructure before returning.

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

Runs services on the released infrastructure.

Skip Condition

When TORRUST_TD_SKIP_RUN_IN_CONTAINER environment variable is set to "true", this step is skipped because Docker daemon is not available in the test container (no Docker-in-Docker configuration).

Errors

Returns an error if the run command fails. If cleanup_on_failure is enabled, attempts to destroy infrastructure before returning.

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

Validates the deployment by running the test command.

Errors

Returns an error if the test command fails.

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

Destroys the infrastructure for the environment.

Errors

Returns an error if the destroy command fails.

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

Purges all local environment data (build/, data/ directories).

This removes all local state for the environment, including:

• Build directory (build/{env-name}/)
• Data directory (data/{env-name}/)
• Environment entry in the repository

Important: This does NOT destroy infrastructure - only local files. Use destroy_infrastructure() to tear down VMs/servers before purging.

Errors

Returns an error if the purge command fails.