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.

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

feat!: switch to fallible API #636

Merged
merged 5 commits into from
May 26, 2024
Merged

feat!: switch to fallible API #636

merged 5 commits into from
May 26, 2024

Conversation

DDtKey
Copy link
Collaborator

@DDtKey DDtKey commented May 25, 2024

Closes #606

Migration guide

  • The easiest way to use unwrap or expect for all testcontainers operations.
    • or you can cast error if your tests are already Result based
  • The Image::exec_after_start method returns a Result, so if you have an implementation of Image that uses exec_after_start, it's important to handle possible errors (e.g required port not found)

Closes #606

## Migration guide
- The easiest way to use `unwrap` or `expect` for all `testcontainers` operations.
  - or you can cast error if your tests are already `Result` based (for `anyhow::Result` it's enough to use `?`)
- The `Image::exec_after_start` method returns a `Result`, so if you have an implementation of `Image` that uses `exec_after_start`, it's important to handle possible errors.
Copy link

netlify bot commented May 25, 2024

Deploy Preview for testcontainers-rust ready!

Name Link
🔨 Latest commit 44997a5
🔍 Latest deploy log https://app.netlify.com/sites/testcontainers-rust/deploys/66526ab408ddb00008d468bb
😎 Deploy Preview https://deploy-preview-636--testcontainers-rust.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@DDtKey DDtKey marked this pull request as ready for review May 25, 2024 22:50
@DDtKey DDtKey changed the title feat: switch to fallible API feat!: switch to fallible API May 25, 2024
@DDtKey DDtKey merged commit d51b9a0 into main May 26, 2024
13 checks passed
@DDtKey DDtKey deleted the fallible-api branch May 26, 2024 10:36
DDtKey added a commit that referenced this pull request May 26, 2024
Follow-up PR after #636
Also removes outdated mentions of panics
@github-actions github-actions bot mentioned this pull request May 26, 2024
DDtKey pushed a commit that referenced this pull request May 26, 2024
## 🤖 New release
* `testcontainers`: 0.16.7 -> 0.17.0

<details><summary><i><b>Changelog</b></i></summary><p>

<blockquote>

## [0.17.0] - 2024-05-26

### Details
#### Bug Fixes
- Collect bridge IP address correctly
([#626](#626))
- Replace missed panics with `Result`
([#638](#638))

#### Features
- Impl `Error` for `WaitError`
([#629](#629))
- [❗] Extend `exec` interface to return logs and exec code
([#631](#631))
- Ability to access container logs
([#633](#633))
- [❗] Switch to fallible API
([#636](#636))
- Make container and exec logs `Send`able
([#637](#637))
- Map container not found error to `eof` for container log streams
([#639](#639))
- Expose follow flag for `stdout` and `stderr`
([#640](#640))
- Add ability to read container logs into `Vec`
([#641](#641))
- [❗] Add container startup timeout with default of 1 minute
([#643](#643))

#### Miscellaneous Tasks
- Fix clippy warning without features enabled
([#632](#632))

#### Refactor
- [❗] Drop re-export of `CgroupnsMode` accessible through `core`
([#630](#630))
- [❗] Drop previously deprecated `get_host_ip_address`
([#628](#628))
- [❗] Return `PortNotExposed` error from `ContainerState::host_port_*`
([#644](#644))
</blockquote>


</p></details>

---
This PR was generated with
[release-plz](https://github.com/MarcoIeni/release-plz/).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

RFC: add fallible result-based API
1 participant