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

//! Kevlar is a light-weight Test Harness that provides basic test features
//! such as logging, setting up a test workspace, and managing the test
//! result object, so that you can focus on writing your tests and the
//! abstractions / support libraries that go along with them.
//!
//! This crate is designed for writing test suites for testing other software.
//!
//! If you just want to write unit tests, it is recommended to use Rust's
//! [built-in testing features](https://doc.rust-lang.org/book/ch11-00-testing.html) instead.
//!
//! ```rust
//! use kevlar::*;
//! use std::path::PathBuf;
//! use async_trait::async_trait;
//! use log::*;
//!
//! #[tokio::main]
//! async fn main() {
//!     let harness = TestHarness::new(
//!         "kevlar_example",
//!         ConfigType::File(PathBuf::from("./config.json")),
//!     );
//!     harness.run_async::<MyTest>().await;
//! }
//!
//! #[derive(Default)]
//! struct MyTest;
//!
//! #[async_trait]
//! impl AsyncTestCase for MyTest {
//!     async fn run_async(&mut self, _test_config: TestConfig, _test_result: &mut TestRecord) -> TestResult {
//!         info!("Do something interesting");
//!         Err(TestEvent::new(TestStatus::Failed).with_description("Something went wrong"))
//!     }
//! }
//! ```

mod testcase;
mod testconfig;
mod testharness;
mod testresult;

// Convenience re-exports.
pub use testcase::{AsyncTestCase, TestCase};
pub use testconfig::{ConfigType, TestConfig};
pub use testharness::TestHarness;
pub use testresult::{
    TestArtifact, TestArtifactType, TestEvent, TestRecord, TestResult, TestStatus,
};

#[cfg(test)]
mod tests {
    #[test]
    fn it_works() {
        assert_eq!(2 + 2, 4);
    }
}