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

A library for integration-testing against docker containers from within Rust.
https://github.com/testcontainers/testcontainers-rs

docker integration-testing rust test-automation testcontainers testcontainers-rust testing

Last synced: 2 days ago
JSON representation

A library for integration-testing against docker containers from within Rust.

• Host: GitHub
• URL: https://github.com/testcontainers/testcontainers-rs
• Owner: testcontainers
• License: apache-2.0
• Created: 2018-08-21T01:35:53.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2025-01-07T02:34:30.000Z (17 days ago)
• Last Synced: 2025-01-19T00:15:45.678Z (5 days ago)
• Topics: docker, integration-testing, rust, test-automation, testcontainers, testcontainers-rust, testing
• Language: Rust
• Homepage: https://rust.testcontainers.org
• Size: 1.16 MB
• Stars: 807
• Watchers: 7
• Forks: 141
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE-Apache-2.0

Awesome Lists containing this project

• awesome-testcontainers - Repository
• awesome-testcontainers - Repository

README

        
# Testcontainers-rs

![Continuous Integration](https://github.com/testcontainers/testcontainers-rs/actions/workflows/ci.yml/badge.svg)

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

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

[![Slack](https://img.shields.io/badge/Slack-join-orange?style=flat&logo=slack&)](https://join.slack.com/t/testcontainers/shared_invite/zt-2gra37tid-n9xDJGjjVb7hMRanGjowkw)

Testcontainers-rs is the official Rust language fork of [http://testcontainers.org](http://testcontainers.org).

## Usage

### `testcontainers` is the core crate

The crate provides an API for working with containers in a test environment.

1. Depend on `testcontainers`

2. Implement `testcontainers::core::Image` for necessary docker-images

3. Run it with any available runner `testcontainers::runners::*` (use `blocking` feature for synchronous API)

#### Example:

- Blocking API (under `blocking` feature)

```rust

use testcontainers::{core::{IntoContainerPort, WaitFor}, runners::SyncRunner, GenericImage, ImageExt};

#[test]

fn test_redis() {

    let container = GenericImage::new("redis", "7.2.4")

        .with_exposed_port(6379.tcp())

        .with_wait_for(WaitFor::message_on_stdout("Ready to accept connections"))

        .with_network("bridge")

        .with_env_var("DEBUG", "1")

        .start()

        .expect("Failed to start Redis");

}

```

- Async API

```rust

use testcontainers::{core::{IntoContainerPort, WaitFor}, runners::AsyncRunner, GenericImage, ImageExt};

#[tokio::test]

async fn test_redis() {

    let container = GenericImage::new("redis", "7.2.4")

        .with_exposed_port(6379.tcp())

        .with_wait_for(WaitFor::message_on_stdout("Ready to accept connections"))

        .with_network("bridge")

        .with_env_var("DEBUG", "1")

        .start()

        .await

        .expect("Failed to start Redis");

}

```

### Ready-to-use images

The easiest way to use `testcontainers` is to depend on ready-to-use images (aka modules).

Modules are available as a community-maintained crate: [testcontainers-modules](https://github.com/testcontainers/testcontainers-rs-modules-community)

## License

Licensed under either of

- Apache License, Version 2.0

  ([LICENSE-APACHE](LICENSE-Apache-2.0) or http://www.apache.org/licenses/LICENSE-2.0)

- MIT license

  ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your option.