test-with

Crates.io MIT licensed Docs

A lib help you run test with conditions, else the test will be ignored.

Preamble

This crate provide a workable solution for this issue of rust-lang.

Currently, the condition is checked on build-time not runtime and not perfect, because of this issue of rust-lang. To avoid known issue at this moment, please clean before running test. bash cargo clean; SOME_VAR=true cargo test

If you forget to add #[test] flag on the test case, #[test_with] macro will add it for you.

Environment Variable

Run test case when the environment variable is set.

```rust // PWD environment variable exists

[test_with::env(PWD)]

[test]

fn test_works() { assert!(true); }

// NOTHING environment variable does not exist

[test_with::env(NOTHING)]

[test]

fn test_ignored() { panic!("should be ignored") } or run all test cases for test module when the environment variable is set. rust

[test_with::env(PWD)]

[cfg(test)]

mod tests {

#[test]
fn test_works() {
    assert!(true);
}

} ```

Result of cargo test ```text running 2 tests test tests::testignored ... ignored test tests::testworks ... ok

test result: ok. 1 passed; 0 failed; 1 ignored; 0 measured; 0 filtered out; finished in 0.00s ```

If the test depends on more than one environment variables, you can write it with multiple variables, #[test_with::env(VAR1, VAR2)].

File/Folder

Run test case when the file or folder exist. This is good for testing with database config. If you want to check the folder exist or not, please use path.

```rust // hostname exists

[test_with::file(/etc/hostname)]

[test]

fn test_works() { assert!(true); }

// nothing file does not exist

[test_with::file(/etc/nothing)]

[test]

fn test_ignored() { panic!("should be ignored") }

// etc exists

[test_with::path(/etc)]

[test]

fn testworksfor_path() { assert!(true); } ```

If the test depends on more than one file or path, you can write it with multiple file/path, #[test_with::file(/file1, /file2)] or #[test_with::path(/folder, /file)].

Http/Https Service

Run test case when the http/https service available. This is good for integration testing.

```rust // https service exists

[test_with::https(www.rust-lang.org)]

[test]

fn test_works() { assert!(true); }

// There is no not.exist.com

[test_with::https(not.exist.com)]

[test]

fn test_ignored() { panic!("should be ignored") } ```

If the test depends on more than one service, you can write it with multiple service, #[test_with::http(service1, service2)] or #[test_with::http2(service1, service2)].

TCP socket

Run integration test case when the remote tcp socket is listening.

```rust

[test_with::tcp(8.8.8.8:53)]

[test]

fn test_works() { assert!(true); }

[test_with::tcp(193.194.195.196)]

[test]

fn test_ignored() { panic!("should be ignored") } ```

Remote Server Online Status

Run integration test case when the remote server online. Please note the user running test case should have capability to open socket.

```rust // localhost is online

[test_with::icmp(127.0.0.1)]

[test]

fn test_works() { assert!(true); }

// 193.194.195.196 is offline

[test_with::icmp(193.194.195.196)]

[test]

fn test_ignored() { panic!("should be ignored") } ```

User/Group condition

Run integration test case when the user is specific user or in specific group ```rust

[test_with::root()]

[test]

fn test_ignored() { panic!("should be ignored") }

[test_with::group(avengers)]

[test]

fn test_ignored2() { panic!("should be ignored") }

[test_with::user(spider)]

[test]

fn test_ignored3() { panic!("should be ignored") } ```

Relating issues