Document test execution lifecycle regarding user code and extensions

[ptahchiev]

Related Issues

• Improve documentation of DynamicTest lifecycle #386
• Lifecycle Documentation? #426

Deliverables

• Document test execution lifecycle regarding user code (i.e., test classes, test methods, before methods, and after methods) and extensions in the User Guide
• Add a diagram to the User Guide to visualize test lifecycle and where extensions are called.

Original Issue Description

Hello,

I'm using JUnit 4.12 and I have a bunch of selenium tests. All I want is to have a rule that captures a screenshot when the test fails. Just like this guy here:

http://stackoverflow.com/questions/12078982/apply-rule-after-each-test-and-before-each-after-in-junit

Apparently it is not possible to do this with JUnit 4.x Rule because in my @After methods I logout the user and they see the homepage. So when tests fail I always get screenshots of homepage, rather than the page that broke the tests.

I'm reading now about Exception handling extension points here:

http://junit-team.github.io/junit5/

but to me it is still not clear if these extension points will be executed after the @BeforeEach and before the @AfterEach. Can you please clarify that?

Thanks.

[jlink]

Your assumption is correct. ExceptionHandlerExtensionPoints will be invoked first thing if a test method fails.

Am 06.02.2016 um 09:59 schrieb Petar Tahchiev [email protected]:

Hello,

I'm using Junit 4.12 and I have a bunch of selenium tests. All I want is to have a rule that captures a screenshot when the test fails. Just like this guy here:

http://stackoverflow.com/questions/12078982/apply-rule-after-each-test-and-before-each-after-in-junit

Apparently it is not possible to do this with JUnit 4.x Rule because in my @after methods I logout the user and they see the homepage. So when tests fail I always get screenshots of homepage, rather than the page that broke the tests.

I'm reading now about Exception handling extension points here:

http://junit-team.github.io/junit5/

but to me it is still not clear if these extension points will be executed after the @before and before the @after. Can you please clarify that.

Thanks.

—
Reply to this email directly or view it on GitHub.

[marcphilipp]

Does this need better documentation?

[sbrannen]

@marcphilipp, yes, this definitely needs to be fully documented. In general, we will eventually need to document the order in which all extension points are executed with regard to each other, possible interactions, etc.

FYI: I just changed the title of this issue accordingly.

[jlink]

Before putting more effort into documenting extension points and their relative orders, we should first commit to an ordering approach (see #135) and a general approach regarding an invocation extension point (see #157).

[marcphilipp]

Team decision: Add diagram to user guide to visualize test lifecycle and where extensions are called.

[sbrannen]

Currently slated for M2.

[sbrannen]

FYI: I added Related Issues and Deliverables sections to this issue's description and changed the title to reflect the intended scope.

[mmerdes]

in progress

[sbrannen]

Ummm.... wasn't this resolved in 5.0 M4?

[marcphilipp]

From a user perspective: yes. Technically, M4 still contained the broken Keynote file that @mmerdes removed later. I changed it anyway 👍