Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Project revamp #563

Closed
2 of 4 tasks
eddumelendez opened this issue Mar 27, 2024 · 1 comment
Closed
2 of 4 tasks

Project revamp #563

eddumelendez opened this issue Mar 27, 2024 · 1 comment
Assignees
@DDtKey
Labels
enhancement New feature or request

Comments

@eddumelendez
Copy link
Member

eddumelendez commented Mar 27, 2024 •
edited by DDtKey

  • Deprecate cli support
  • Support testcontainers/ryuk as resource reaper
  • Read tc.host from ~/.testcontainers.properties to connect with http client. See issue related to the docker client
  • Add User-Agent with value tc-rust/<version>, version should be the version from Cargo.toml

Tasks
Beta Give feedback
  3. Add User-Agent with value tc-rust/<version> #576
  4. Support testcontainers/ryuk as resource reaper #577
    enhancement help wanted
This was referenced Apr 6, 2024
Closed
Closed
Closed
Closed
Closed
Closed
Closed
This was referenced Apr 16, 2024
Closed
Closed
@DDtKey DDtKey self-assigned this Apr 18, 2024
@DDtKey DDtKey added the enhancement New feature or request label Apr 18, 2024
DDtKey added a commit that referenced this issue Apr 18, 2024
@DDtKey
feat!: container-centric API
ae9f585 
Quite large refactoring as part of project revamp #563, and also the long-awaited refactoring #386

Closes #386
Closes #326
Closes #475
Closes #508
Closes #392
Closes #561
Closes #559

MSRV was bumped to `1.70` in order to use `std::sync::OnceLock`. This should NOT be a problem, tests usually executed on more recent versions (also see [this ref](https://github.com/testcontainers/testcontainers-rs/pull/503/files#r1242651354)).
DDtKey added a commit that referenced this issue Apr 18, 2024
@DDtKey
feat!: container-centric API
f2d27d2 
Quite large refactoring as part of project revamp #563, and also the long-awaited refactoring #386

Closes #386
Closes #326
Closes #475
Closes #508
Closes #392
Closes #561
Closes #559

MSRV was bumped to `1.70` in order to use `std::sync::OnceLock`. This should NOT be a problem, tests usually executed on more recent versions (also see [this ref](https://github.com/testcontainers/testcontainers-rs/pull/503/files#r1242651354)).
@DDtKey DDtKey mentioned this issue Apr 18, 2024
Merged
github-merge-queue bot pushed a commit that referenced this issue Apr 22, 2024
@DDtKey
feat!: container-centric API with refactored underlying layer (#575)
9c65640 
Quite large refactoring as part of project revamp #563, and also the
long-awaited refactoring #386

Now it's really simple API, e.g:
```rs
let container = GenericImage::new("redis", "latest")
        .with_exposed_port(6379)
        .with_wait_for(WaitFor::message_on_stdout("Ready to accept connections"))
        .start();
```

I find this new API much easier to use, solves a lot of problems, and
seems flexible enough to be extended.
This also works regardless of the tokio runtime flavor (multi-thread vs
current-thread). And the sync API is still available, right under
`blocking` feature (just like `reqwest` does).

From a maintainer's perspective this also simplifies the code, we don't
have to worry about two different clients and their differences.

### Docker host resolution
The host is resolved in the following order:

1. Docker host from the `tc.host` property in the
`~/.testcontainers.properties` file.
2. `DOCKER_HOST` environment variable.
3. Docker host from the "docker.host" property in the
`~/.testcontainers.properties` file.
4. Else, the default Docker socket will be returned.

### Notes
- MSRV was bumped to `1.70` in order to use `std::sync::OnceLock`. This
should NOT be a problem, tests usually executed on more recent versions
(also see [this
ref](https://github.com/testcontainers/testcontainers-rs/pull/503/files#r1242651354)).
- `Cli` client is removed, instead we provide `sync` (under `blocking`
feature) and `async` impls based on HTTP client (bollard)
- tested with
[modules](https://github.com/testcontainers/testcontainers-rs-modules-community)

## Migration guide 

- Sync API migration (`Cli` client)
  - Add `blocking` feature
  - Drop all usages of `clients::Cli`
  - Add `use testcontainers::runners::SyncRunner;`
  - Replace `client.run(image)` with `image.start()`
- Async API migration (`Http` client)
  - Remove `experimental` feature
  - Drop all usages of `clients::Http`
  - Add `use testcontainers::runners::AsyncRunner;`
  - Replace `client.run(image)` with `image.start()`

## References

Closes #386
Closes #326
Closes #475
Closes #508
Closes #392
Closes #561
Closes #559
Closes #564
Closes #538
Closes #507
Closes #89
Closes #198
@DDtKey
Copy link
Collaborator

DDtKey commented Apr 22, 2024

I've extracted separate issues for remaining tasks.
Main part is done within #575, so closing this issue and let's track new issues separately.

@DDtKey DDtKey closed this as completed Apr 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@DDtKey DDtKey

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@eddumelendez @DDtKey