Struct FakeEngine 

pub struct FakeEngine { /* private fields */ }

Available on crate feature testing only.

An in-memory Docker: up creates a project with scripted services, down removes it, and both raise the events Docker would. Clones share state, so a test can hand one to the code under test and inspect another.

A project’s name is read from the name: line of the head compose.yaml in the directory up is given, as Compose does for the files trestle renders. Its services default to a single healthy app; script sets others.

Implementations

impl FakeEngine

pub fn new() -> Self

An empty Docker host.

pub fn script( &self, project: &str, services: impl IntoIterator<Item = (&'static str, Health)>, )

Give project these services, each reaching health once up.

pub fn fail_up(&self, project: &str)

Make the next up of project fail, as an unhealthy --wait does.

pub fn set_unavailable(&self, unavailable: bool)

Make every call fail as if the daemon were down (or back up with false).

pub fn adopt(&self, project: &str)

Add a project as if something else had started it (e.g. a runtime that since died).

pub fn add_network(&self, name: &str)

Declare the network name, as the first project joining it would.

pub fn networks(&self) -> BTreeSet<String>

The networks that exist.

pub fn projects(&self) -> BTreeSet<String>

The projects that exist.

pub fn calls(&self) -> Vec<FakeCall>

Every call so far, in order.

pub fn set_health(&self, project: &str, service: &str, health: Health)

Change the health of service in project, raising a health event.

Trait Implementations

impl Clone for FakeEngine

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl ComposeEngine for FakeEngine

fn up<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, dir: &'life1 Path, opts: &'life2 UpOptions, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Create and start the project in dir (docker compose up -d).

fn down<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, dir: &'life1 Path, opts: &'life2 DownOptions, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Stop and remove the project in dir (docker compose down).

fn ls<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<ProjectStatus>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Every project Docker knows of, running or stopped (docker compose ls --all).

fn ps<'life0, 'life1, 'async_trait>( &'life0 self, project: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<ServiceStatus>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

The containers of project, running or stopped (docker compose ps --all).

fn logs<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, project: &'life1 str, _opts: &'life2 LogOptions, ) -> Pin<Box<dyn Future<Output = Result<EngineStream<LogLine>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

The log lines of project’s containers (docker compose logs --timestamps).

fn events<'life0, 'life1, 'async_trait>( &'life0 self, filter: &'life1 EventFilter, ) -> Pin<Box<dyn Future<Output = Result<EngineStream<EngineEvent>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Container events of the projects filter picks, from now on (docker events).

fn network_rm<'life0, 'life1, 'async_trait>( &'life0 self, name: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Remove the network name; Ok(false) when it doesn’t exist or is still in use.

impl Default for FakeEngine

fn default() -> Self

Returns the “default value” for a type.