Skip to content

Commit

Permalink
Add section about integration tests to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
arctic-alpaca committed May 8, 2022
1 parent fb5bca2 commit c9c5aa1
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,11 @@ to showcase a usable example parameter per API operation.
Podtender uses [hyper](https://github.com/hyperium/hyper) and requires [tokio](https://github.com/tokio-rs/tokio).
An active Podman socket is needed to communicate with Podman.

### Tests
To run the integration tests, the `tracing` and `examples` features are required. To allow easy testing, the tests are
defined as target in the [Cargo.toml](Cargo.toml) file and can be run with `cargo test --test {target-name} --features="examples tracing"`
where `{target-name}` is one of the specified targets (e.g. `containers-test`).

### Project structure
The Podman socket and network operations are internally managed by the `PodmanService` struct.

Expand Down

0 comments on commit c9c5aa1

Please sign in to comment.