Skip to content

docs: document assertComplete and assertFailure for Future-based tests - #168

Open
arimu1 wants to merge 1 commit into
eclipse-vertx:masterfrom
arimu1:docs/140-assert-complete-failed
Open

docs: document assertComplete and assertFailure for Future-based tests#168
arimu1 wants to merge 1 commit into
eclipse-vertx:masterfrom
arimu1:docs/140-assert-complete-failed

Conversation

@arimu1

@arimu1 arimu1 commented Jul 27, 2026

Copy link
Copy Markdown

Summary

  • Document VertxTestContext#assertComplete and #assertFailure in the module manual (index.adoc).
  • Add runnable examples (usingAssertComplete, usingAssertFailure) included via docgen, matching existing style.
  • Explain how these Future-chain helpers fit the Vert.x 5 move away from callback-based Handler<AsyncResult<T>> testing.

Fixes #140

Test plan

  • Examples follow the same patterns as existing Examples tests and unit tests in VertxTestContextTest.
  • AsciiDoc section uses {@link examples.Examples#...} includes and callout markers consistent with neighboring sections.
  • CI docgen/build (maintainer merge path).

Contributor note

Eclipse Contributor Agreement (ECA) will be signed by the human contributor before merge.

Made with Cursor

@arimu1

arimu1 commented Jul 27, 2026

Copy link
Copy Markdown
Author

Updated docs per review: removed the incorrect claim that assertComplete / assertFailure create checkpoints. They only failNow on the unexpected outcome; tests still need completeNow (or an explicit checkpoint). Also softened the Vert.x 5 / callback framing.

@arimu1

arimu1 commented Jul 27, 2026

Copy link
Copy Markdown
Author

Rewrote commits to use my Eclipse-linked email (af.nawfal@gmail.com) so the ECA check can resolve the author. Please re-run / wait for eclipsefdn/eca.

@arimu1
arimu1 force-pushed the docs/140-assert-complete-failed branch 2 times, most recently from 93e7ff6 to 3553379 Compare July 27, 2026 09:56
@arimu1

arimu1 commented Jul 27, 2026

Copy link
Copy Markdown
Author

Temporarily closing to re-trigger Eclipse ECA validation after rewriting author email + Signed-off-by.

@arimu1 arimu1 closed this Jul 27, 2026
@arimu1 arimu1 reopened this Jul 27, 2026
@arimu1

arimu1 commented Jul 27, 2026

Copy link
Copy Markdown
Author

ECA still fails because Eclipse has no account for af.nawfal@gmail.com (commits + Signed-off-by are already on that address).

Next step for me: create/login at https://accounts.eclipse.org with that email, sign the ECA at https://accounts.eclipse.org/user/eca, link GitHub arimu1, then hit Revalidate on https://api.eclipse.org/git/eca/status/gh/eclipse-vertx/vertx-junit5/168

@arimu1
arimu1 force-pushed the docs/140-assert-complete-failed branch from ba6e2c1 to 0937d0f Compare July 27, 2026 09:58
@arimu1

arimu1 commented Jul 28, 2026

Copy link
Copy Markdown
Author

@eclipse-fdn-bot recheck

Document VertxTestContext.assertComplete / assertFailure for Future-based
tests, including that they only failNow on the unexpected outcome and do
not create checkpoints (tests still need completeNow or a checkpoint).

Fixes eclipse-vertx#140

Signed-off-by: arimu1 <af.nawfal@gmail.com>
@arimu1
arimu1 force-pushed the docs/140-assert-complete-failed branch from 0937d0f to 74a6de0 Compare July 28, 2026 14:18
@arimu1

arimu1 commented Jul 28, 2026

Copy link
Copy Markdown
Author

@eclipse-fdn-bot recheck

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.

Include documentation for assertComplete and assertFailure methods

1 participant