Overview
Based on the significant change in formalizing and exposing the new junit-platform-testkit module, the User Guide should include documentation for the first version of its usage.
Related Issues
- #1356
- #1392
- #1662
- #1663
Deliverables
- [x] Write Javadoc for methods in
EventConditionsandTestExecutionResultConditions. - [x] Document
junit-platform-testkitin the Release Notes. - [x] Document
junit-platform-testkitin the User Guide.
- [x] Include in Dependency Metadata.
- [x] Include in Dependency Diagram.
- [x] Introduce new _JUnit Platform Test Kit_ chapter including high level overview and usage with common use cases as examples.
dotCipher
All 21 comments
Please hold off on starting with the documentation. I want to take a closer look and possibly rename a few things here and there first.
marcphilipp
on 6 Oct 2018
Fair, let me know when I should pull the trigger on it then. Thanks!
dotCipher
on 6 Oct 2018
This issue is currently blocked until #1662 is completed.
sbrannen
on 2 Nov 2018
This issue is currently blocked until #1662 is completed.
1662 is now complete.
sbrannen
on 3 Nov 2018
Please note that I've already taken care of the Javadoc except for methods in ExecutionEventConditions and TestExecutionResultConditions.
sbrannen
on 3 Nov 2018
Please hold off on starting with the documentation. I want to take a closer look and possibly rename a few things here and there first.
@marcphilipp, are you still planning on that in light of the work I did in #1662?
sbrannen
on 3 Nov 2018
Nope, I think we‘re good now thanks to your work. 👍
marcphilipp
on 4 Nov 2018
Nope, I think we‘re good now thanks to your work. 👍
OK... but now this issue is blocked until #1663 is complete. 😉
sbrannen
on 4 Nov 2018
This issue is no longer blocked since #1663 has been resolved.
sbrannen
on 5 Nov 2018
Sorry I was traveling and just saw this. Can I still take point on it now?
dotCipher
on 12 Nov 2018
Sorry I was traveling and just saw this. Can I still take point on it now?
Sure. Go for it!
I do plan to make some improvements to the EngineTestKit API (i.e., I plan to make building of the request _fluent_ as well), but that won't affect the overall work you'll be documenting. Rather, it will only incur minor changes to a few examples likely.
Cheers,
Sam
sbrannen
on 12 Nov 2018
I do plan to make some improvements to the
EngineTestKitAPI (i.e., I plan to make building of the request _fluent_ as well), but that won't affect the overall work you'll be documenting. Rather, it will only incur minor changes to a few examples likely.
FYI: that work has been pushed to master in 252c9da377e8f5f5c10a610e09cb3f08cfe8e24a.
sbrannen
on 17 Nov 2018
Updated deliverables: included Test Kit in Dependency Metadata and Diagram
sormuras
on 10 Dec 2018
_in progress_
sbrannen
on 10 Dec 2018
... I'm working on the Release Notes and User Guide deliverables.
sbrannen
on 10 Dec 2018
Update: ✅ Document junit-platform-testkit in the Release Notes.
sbrannen
on 10 Dec 2018
Apologies on letting this slide, I appreciate your help with it. Thank you!
dotCipher
on 11 Dec 2018
Apologies on letting this slide, I appreciate your help with it.
No worries.
Thank you!
👍
sbrannen
on 11 Dec 2018
In case anyone is interested in seeing the status quo in the User Guide, have a look here:
sbrannen
on 11 Dec 2018
Update: documentation in the User Guide is complete for 5.4 M1.
sbrannen
on 14 Dec 2018
:+1: 👍
sormuras
on 19 Dec 2018
Related issues
PeterWippermann
·
5Comments
jayjupdhig
·
5Comments
otrosien
·
4Comments
lessthanoptimal
·
4Comments
mfulton26
·
3Comments
Most helpful comment
In case anyone is interested in seeing the status quo in the User Guide, have a look here:
https://junit.org/junit5/docs/snapshot/user-guide/#testkit