1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

// Copyright 2022 CeresDB Project Authors. Licensed under Apache-2.0.

use std::path::Path;

use async_trait::async_trait;

use crate::database::Database;

/// Controller of test environments.
///
/// Environments usually stand for different start or deploy manner,
/// like standalone versus cluster etc. [`EnvController`] is sort of [`Database`]
/// "factory" - it create different [`Database`]s with different environment
/// mode parameter.
///
/// Environments are distingushed via the mode name (see the signature of
/// [`Self::start`] and [`Self::stop`]). Those names are extracted from the first-level
/// directories of test case directory. Refer to crate level documentation for more information
/// about directory organizaiton rules.
#[async_trait]
pub trait EnvController {
    type DB: Database;

    /// Start a [`Database`] to run test queries.
    ///
    /// Two parameters are the mode of this environment, or environment's name.
    /// And the config file's path to this environment if it's find, it's defined
    /// by the `env_config_file` field in the root config toml, and the default
    /// value is `config.toml`.
    async fn start(&self, env: &str, config: Option<&Path>) -> Self::DB;

    /// Stop one [`Database`].
    async fn stop(&self, env: &str, database: Self::DB);
}