Add note about duplicate test execution with @Suite #5080
Conversation
Users are surprised to see that their tests are executed twice[1]. This is the natural consequence of using a test engine to define a suite. We can at least let them know in the documentation. 1. #4327
mpkorstanje
force-pushed
the
rien/junit-platform-suite-engine-documentation
branch
from
076b9c3 to
c0a8776
Compare
mpkorstanje
changed the title
documentation/src/docs/asciidoc/user-guide/advanced-topics/junit-platform-suite-engine.adoc
Outdated
Show resolved
Hide resolved
documentation/src/docs/asciidoc/user-guide/advanced-topics/junit-platform-suite-engine.adoc
Outdated
Show resolved
Hide resolved
| ===== Duplicate test execution | ||
|
|
||
| Tests in a suite are executed in addition to the tests executed by every other test | ||
| engine. This can result in the same tests being executed twice. |
There was a problem hiding this comment.
Should we add sth. like the following?
Moreover, different suites may contain the same tests, potentially with different setups.
There was a problem hiding this comment.
Maybe it is time to add a drawing or two. I'll come back to that. Something along the lines of:
There was a problem hiding this comment.
@mpkorstanje Do you have time to add the drawing for 6.0.1 or should we move this PR to 6.1.0-M1?
There was a problem hiding this comment.
I've moved it to 6.1.0-M1. We don't have to rush this one. It's not a bug.
There was a problem hiding this comment.
Should we add sth. like the following?
Done.
…uite-engine-documentation
…it-platform-suite-engine.adoc Co-authored-by: Marc Philipp <[email protected]>
| object "Jupiter Test Engine" | ||
| object "Suite Test Engine" | ||
| object "Cucumber Test Engine" | ||
| object "Spock Test Engine" |
There was a problem hiding this comment.
I've intentionally chosen to make the diagrams sketches with concrete examples. I don't think an exact class diagram will help clarify much here.
| generateApiTables, | ||
| generateStandaloneConsoleLauncherShadowedArtifactsFile, | ||
| componentDiagram | ||
| plantUmlOutputDirectory |
There was a problem hiding this comment.
@marcphilipp I'm not sure if this is the right way to do this.
Users are surprised to see that their tests are executed twice[1]. This is the natural consequence of using a test engine to define a suite.
We can at least let them know in the documentation.
I hereby agree to the terms of the JUnit Contributor License Agreement.
Definition of Done
@APIannotations