Struct mx_tester::Config

pub struct Config {
    pub name: String,
    pub modules: Vec<ModuleConfig>,
    pub homeserver: HomeserverConfig,
    pub up: Option<UpScript>,
    pub run: Option<Script>,
    pub down: Option<DownScript>,
    pub docker: DockerConfig,
    pub users: Vec<User>,
    pub synapse: SynapseVersion,
}

The contents of a mx-tester.yaml

Fields

name: String

A name for this test.

modules: Vec<ModuleConfig>

Modules to install in Synapse.

homeserver: HomeserverConfig

Values to pass through into the homeserver.yaml for this synapse.

up: Option<UpScript>

A script to run at the end of the setup phase.

run: Option<Script>

The testing script to run.

down: Option<DownScript>

A script to run at the start of the teardown phase.

docker: DockerConfig

Configuration for the docker network.

users: Vec<User>

Any users to register and make available

synapse: SynapseVersion

The version of Synapse to use

Implementations

impl Config

pub fn builder() -> ConfigBuilder<((), (), (), (), (), (), (), (), ())>

Create a builder for building Config. On the builder, call .name(...), .modules(...)(optional), .homeserver(...)(optional), .up(...)(optional), .run(...)(optional), .down(...)(optional), .docker(...)(optional), .users(...)(optional), .synapse(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of Config.

impl Config

pub fn shared_env_variables(
    &self
) -> Result<HashMap<&'static OsStr, OsString>, Error>

Create a map containing the environment variables that are common to all scripts.

Callers may add additional variables that are specific to a given script step.

pub fn patch_homeserver_config(&self) -> Result<(), Error>

Patch the homeserver.yaml at the given path (usually one that has been generated by synapse) with the properties in this struct (which will usually have been provided from mx-tester.yaml)

pub fn test_root(&self) -> PathBuf

The directory in which we’re putting all data for this test.

Cleaned up upon test start.

pub fn synapse_root(&self) -> PathBuf

The directory in which we’re putting synapse data for this test.

It will contain, among other things, the logs for the test.

pub fn tag(&self) -> String

A tag for the Docker image we’re creating/using.

pub fn network(&self) -> String

pub fn setup_container_name(&self) -> String

The name for the container we’re using to setup Synapse.

pub fn run_container_name(&self) -> String

The name for the container we’re using to actually run Synapse.

Trait Implementations

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.