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

//! # dockertest-server
//!
//! > A test framework built around [dockertest][1] for testing against server containers.
//!
//! This crate provides a small abstraction layer around the
//! [dockertest][1] crate for easily running a test against multiple servers running
//! in containers. It provides traits for defining a server and it's associated
//! configuration and then registering a variable number of servers to bring up for
//! a test.
//!
//! The primary use-case of this crate is to provide an easy-to-use testing
//! framework for crates that wish to build integration tests against services which
//! are able to run in a container.
//!
//! ## Installation
//!
//! Add `dockertest-server` as a dependency to your cargo.toml:
//! ```ignore
//! [dev-dependencies]
//! dockertest-server = "0.1.7"
//! ```
//!
//! ## Usage
//!
//! The below example brings up a mock OAuth server and then tests it's responding
//! to HTTP requests:
//!
//! ```rust
//! // Note: This requires the `web` feature
//! use dockertest_server::servers::auth::{OIDCServer, OIDCServerConfig};
//! use dockertest_server::Test;
//!
//! let config = OIDCServerConfig::builder().port(8090).build().unwrap();
//! let mut test = Test::new();
//! test.register(config);
//!
//! test.run(|instance| async move {
//!     let server: OIDCServer = instance.server();
//!
//!     let client = reqwest::Client::new();
//!     let resp = client
//!         .get(format!(
//!             "{}/default/.well-known/openid-configuration",
//!             server.external_url()
//!         ))
//!         .send()
//!         .await;
//!     assert!(resp.is_ok());
//!     assert_eq!(resp.unwrap().status(), 200);
//! });
//! ```
//!
//! This crate ships with support for various servers already included. See the
//! `servers` module for the ones included. Note that most require a feature flag to
//! be enabled to avoid bundling unnecessary implementations.
//!
//! Please feel free to submit a PR with your own implementations to be added to the
//! main crate.
//!
//! ## Testing
//!
//! Run tests with `cargo test`.
//!
//! [1]: https://crates.io/crates/dockertest

pub mod common;
pub mod server;
pub mod servers;
pub mod test;

pub use server::{new_handle, Config, ContainerConfig, Server};
pub use test::{Test, TestInstance};