https://github.com/testcontainers/testcontainers-rs-modules-community

Community maintained modules for Testcontainers for Rust
https://github.com/testcontainers/testcontainers-rs-modules-community

rust testcontainers testcontainers-rust testing

Last synced: 3 days ago
JSON representation

Community maintained modules for Testcontainers for Rust

• Host: GitHub
• URL: https://github.com/testcontainers/testcontainers-rs-modules-community
• Owner: testcontainers
• License: mit
• Created: 2023-06-07T11:39:51.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-21T00:14:05.000Z (6 months ago)
• Last Synced: 2024-05-22T18:21:22.866Z (6 months ago)
• Topics: rust, testcontainers, testcontainers-rust, testing
• Language: Rust
• Homepage: https://docs.rs/crate/testcontainers-modules/
• Size: 200 KB
• Stars: 50
• Watchers: 7
• Forks: 27
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# testcontainers-modules

![Continuous Integration](https://github.com/testcontainers/testcontainers-rs-modules-community/workflows/Continuous%20Integration/badge.svg?branch=main)

[![Crates.io](https://img.shields.io/crates/v/testcontainers-modules.svg)](https://crates.io/crates/testcontainers-modules)

[![Docs.rs](https://docs.rs/testcontainers-modules/badge.svg)](https://docs.rs/testcontainers-modules)

Community maintained modules for [testcontainers]

Provides modules to use for testing components in accordance with [testcontainers-rs].

Every module is treated as a feature inside this crate.

## Usage

1. Depend on [testcontainers-modules] with necessary features (e.g `postgres`, `minio` and etc)

    - Enable `blocking` feature if you want to use modules within synchronous tests (feature-gate for `SyncRunner`)

2. Then start using the modules inside your tests with either `AsyncRunner` or `SyncRunner`

Simple example of using `postgres` module with `SyncRunner` (`blocking` and `postgres` features enabled):

```rust,ignore

use testcontainers_modules::{postgres, testcontainers::runners::SyncRunner};

#[test]

fn test_with_postgres() {

    let container = postgres::Postgres::default().start().unwrap();

    let host_ip = container.get_host().unwrap();

    let host_port = container.get_host_port_ipv4(5432).unwrap();

}

```

**Note**: you don't need to explicitly depend on `testcontainers` as it's re-exported dependency

of `testcontainers-modules` with aligned version between these crates.

For example:

```rust

use testcontainers_modules::testcontainers::ImageExt;

```

You can also see [examples](https://github.com/testcontainers/testcontainers-rs-modules-community/tree/main/examples)

for more details.

### How to override module defaults (version, tag, ENV-variables)

Just use [RunnableImage](https://docs.rs/testcontainers/latest/testcontainers/core/struct.RunnableImage.html):

```rust,ignore

use testcontainers_modules::{

    redis::Redis,

    testcontainers::{ContainerRequest, ImageExt}

};

/// Create a Redis module with `6.2-alpine` tag and custom password

fn create_redis() -> ContainerRequest {

    Redis::default()

        .with_tag("6.2-alpine")

        .with_env_var("REDIS_PASSWORD", "my_secret_password")

}

```

## License

- MIT license ([LICENSE] or )

[testcontainers-rs]: https://github.com/testcontainers/testcontainers-rs

[testcontainers]: https://crates.io/crates/testcontainers

[testcontainers-modules]: https://crates.io/crates/testcontainers-modules

[LICENSE]: https://github.com/testcontainers/testcontainers-rs-modules-community/blob/main/LICENSE