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

//! Easy temporary MongoDB instance for unit tests.
//!
//! Use the [`TempMongo`] struct to get a [`mongodb::Client`] that is connected to a temporary MongoDB instance.
//! All state of the spawned MongoDB instance is stored in a temporary directory, which will be cleaned up automatically (unless disabled).
//!
//! On Unix platforms, the client is connected over a Unix socket.
//! Windows support is planned by picking a free TCP port on the loopback adapter.
//!
//! # Example
//!
//! See the [example in the repository](https://github.com/rocsys/temp-mongo/blob/main/examples/example.rs) for a more detailed example using [`assert2`](https://crates.io/crates/assert2).
//! ```
//! # #[cfg_attr(feature = "tokio-runtime", tokio::main)]
//! # #[cfg_attr(feature = "async-std-runtime", async_std::main)]
//! # async fn main() -> Result<(), Box<dyn std::error::Error>> {
//! use temp_mongo::TempMongo;
//! use mongodb::bson::doc;
//!
//! let mongo = TempMongo::new().await?;
//! println!("Using temporary directory: {}", mongo.directory().display());
//!
//! let client = mongo.client();
//! let collection = client.database("test").collection("animals");
//!
//! collection.insert_one(doc! { "species": "dog", "cute": "yes", "scary": "usually not" }, None).await?;
//! collection.insert_one(doc! { "species": "T-Rex", "cute": "maybe", "scary": "yes" }, None).await?;
//! # Ok(())
//! # }

#![warn(missing_docs)]

mod error;
mod temp_mongo;
mod util;

pub use error::Error;
pub use temp_mongo::TempMongo;
pub use temp_mongo::TempMongoBuilder;