e2e 0.1.0

Test framework for stateful integration tests
Documentation 
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
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183

use std::fmt;

pub use e2e_macro::test_suite;

struct TracingReporter;

impl TracingReporter {
    pub fn on_test_suite_creation_started(name: &str) {
        tracing::debug!("Creating test suite: {}", name);
    }

    pub fn on_test_suite_creation_finished(name: &str) {
        tracing::debug!("Test suite created: {}", name);
    }

    pub fn on_test_suite_start(name: &str) {
        tracing::info!("Starting test suite: {}", name);
    }

    pub fn on_test_suite_end(name: &str) {
        tracing::info!("Finished test suite: {}", name);
    }

    pub fn on_test_start(name: &str) {
        tracing::info!("Running: {}", name);
    }

    pub fn on_test_end(name: &str) {
        tracing::info!("✅: {}", name);
    }

    pub fn on_error(err: &TestError) {
        tracing::error!("❌: {}", err);
    }
}

#[derive(Debug)]
pub struct Tester<C: std::fmt::Debug + 'static> {
    /// Configuration for the tester.
    config: C,
    /// List of test suites to run.
    test_suites: Vec<Box<dyn TestSuiteFactory<C>>>,
}

impl<C: std::fmt::Debug + 'static> Tester<C> {
    pub fn new(config: C) -> Self {
        Self {
            config,
            test_suites: Vec::new(),
        }
    }

    pub fn add_suite(&mut self, factory: Box<dyn TestSuiteFactory<C>>) {
        self.test_suites.push(factory);
    }

    pub async fn run(self) -> Result<(), TestError> {
        for factory in self.test_suites {
            let name = factory.name();
            TracingReporter::on_test_suite_creation_started(&name);
            let suite = match factory
                .create_suite(&self.config)
                .await
                .map_err(TestError::CreateSuite)
            {
                Ok(suite) => suite,
                Err(err) => {
                    TracingReporter::on_error(&err);
                    continue;
                }
            };
            TracingReporter::on_test_suite_creation_finished(&name);

            TracingReporter::on_test_suite_start(&name);
            if let Err(err) = Self::run_suite(suite).await {
                TracingReporter::on_error(&err);
            }
            TracingReporter::on_test_suite_end(&name);
        }

        Ok(())
    }

    async fn run_suite(suite: Box<dyn TestSuite>) -> Result<(), TestError> {
        suite.before_all().await.map_err(TestError::BeforeAll)?;

        for test in suite.tests() {
            suite.before_each().await.map_err(TestError::BeforeEach)?;
            TracingReporter::on_test_start(&test.name());
            if let Err(err) = test
                .run()
                .await
                .map_err(|err| TestError::Test(test.name(), err))
            {
                TracingReporter::on_error(&err);
            } else {
                TracingReporter::on_test_end(&test.name());
            }
            suite.after_each().await.map_err(TestError::AfterEach)?;
        }

        suite.after_all().await.map_err(TestError::AfterAll)?;

        Ok(())
    }
}

#[derive(Debug, thiserror::Error)]
pub enum TestError {
    #[error("Failed to create test suite: {0:?}")]
    CreateSuite(anyhow::Error),
    #[error("Failed to run 'before_all' for the test suite: {0:?}")]
    BeforeAll(anyhow::Error),
    #[error("Failed to run 'before_each' the test suite: {0:?}")]
    BeforeEach(anyhow::Error),
    #[error("Failed to run 'after_each' the test suite: {0:?}")]
    AfterEach(anyhow::Error),
    #[error("Failed to run 'after_all' the test suite: {0:?}")]
    AfterAll(anyhow::Error),
    #[error("Test {0} failed: {1:?}")]
    Test(String, anyhow::Error),
}

#[async_trait::async_trait]
pub trait TestSuiteFactory<C>: Send + Sync + 'static {
    fn name(&self) -> String;

    /// Creates a new test suite instance.
    async fn create_suite(&self, config: &C) -> anyhow::Result<Box<dyn TestSuite>>;
}

impl<C: std::fmt::Debug + 'static> fmt::Debug for Box<dyn TestSuiteFactory<C>> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.name())
    }
}

#[async_trait::async_trait]
pub trait TestSuite: Send + Sync + 'static {
    fn name(&self) -> String;

    fn tests(&self) -> Vec<Box<dyn Test>>;

    async fn before_all(&self) -> anyhow::Result<()> {
        Ok(())
    }

    async fn before_each(&self) -> anyhow::Result<()> {
        Ok(())
    }

    async fn after_each(&self) -> anyhow::Result<()> {
        Ok(())
    }

    async fn after_all(&self) -> anyhow::Result<()> {
        Ok(())
    }
}

impl fmt::Debug for Box<dyn TestSuite> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.name())
    }
}

#[async_trait::async_trait]
pub trait Test: Send + Sync + 'static {
    fn name(&self) -> String;
    async fn run(&self) -> anyhow::Result<()>;
}

impl fmt::Debug for Box<dyn Test> {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.name())
    }
}

/// Re-exports for procedural macros.
#[doc(hidden)]
pub mod __private_reexports {
    pub use async_trait::async_trait;
}