eclipse-vertx / eclipse-vertx/vertx-junit5

Include documentation for `assertComplete` and `assertFailure` methods

Open
#140 1 comment 0 reactions 0 assignees View on GitHub
documentation enhancement help wanted
Dominant language
Java
Stars
43
Forks
33
Avg merge
1m
Merged PRs (30d)
1

Description

#### Describe the feature

- Since Vert.x 5.0 is deprecating the callback model, I was wondering **if the callbacks used in methods like `succeeding` and `failing` would stop working in 5.0** (or maybe I have not understood the deprecation properly)
- I found out about the existence of the methods `assertComplete` and `assertFailed` developed by @slinkydeveloper from their [blog](https://slinkydeveloper.com/Assertions-With-Vertx-Futures-And-JUnit5/), which allow for testing with the help of Futures instead of the callbacks
- However, there isn't any official documentation about these methods in the official docs

#### Use cases

- Including documentation for this may help those who are looking to move away from `Handler` -style callbacks in JUnit tests
- If `succeeding`, `failing` are getting deprecated, then `assertComplete` and `assertFailing` would be the only methods usable (I think I am wrong here)

#### Contribution

- I can try to add documentation based on @slinkydeveloper's blog post

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.