Add around() to Node to allow intercepting the whole execution

[leonard84]

Overview

as discussed with @marcphilipp

---

I hereby agree to the terms of the JUnit Contributor License Agreement.

---

Definition of Done

• There are no TODOs left in the code
• Method preconditions are checked and documented in the method's Javadoc
• Coding conventions (e.g. for logging) have been followed
• Change is covered by automated tests including corner cases, errors, and exception handling
• Public API has Javadoc and @API annotations
• Change is documented in the User Guide and Release Notes
• All continuous integration builds pass

[codecov]

Codecov Report

Merging #1705 into master will increase coverage by <.01%.
The diff coverage is 100%.

@@             Coverage Diff              @@
##             master    #1705      +/-   ##
============================================
+ Coverage     88.44%   88.45%   +<.01%     
- Complexity     3801     3804       +3     
============================================
  Files           345      345              
  Lines          9335     9342       +7     
  Branches        751      751              
============================================
+ Hits           8256     8263       +7     
  Misses          883      883              
  Partials        196      196

Impacted Files	Coverage Δ	Complexity Δ
...nit/platform/engine/support/hierarchical/Node.java	80.76% <100%> (+1.6%)	8 <1> (+1)	⬆️
...form/engine/support/hierarchical/NodeTestTask.java	97.5% <100%> (+0.16%)	27 <7> (+2)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9bb7786...7aa1bdb. Read the comment docs.

[codecov]

Codecov Report

Merging #1705 into master will increase coverage by <.01%.
The diff coverage is 100%.

@@             Coverage Diff              @@
##             master    #1705      +/-   ##
============================================
+ Coverage     88.44%   88.45%   +<.01%     
- Complexity     3801     3804       +3     
============================================
  Files           345      345              
  Lines          9335     9342       +7     
  Branches        751      751              
============================================
+ Hits           8256     8263       +7     
  Misses          883      883              
  Partials        196      196

Impacted Files	Coverage Δ	Complexity Δ
...nit/platform/engine/support/hierarchical/Node.java	80.76% <100%> (+1.6%)	8 <1> (+1)	⬆️
...form/engine/support/hierarchical/NodeTestTask.java	97.5% <100%> (+0.16%)	27 <7> (+2)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9bb7786...7aa1bdb. Read the comment docs.

[codecov]

Codecov Report

Merging #1705 into master will increase coverage by <.01%.
The diff coverage is 100%.

@@             Coverage Diff              @@
##             master    #1705      +/-   ##
============================================
+ Coverage     88.44%   88.45%   +<.01%     
- Complexity     3801     3804       +3     
============================================
  Files           345      345              
  Lines          9335     9342       +7     
  Branches        751      751              
============================================
+ Hits           8256     8263       +7     
  Misses          883      883              
  Partials        196      196

Impacted Files	Coverage Δ	Complexity Δ
...nit/platform/engine/support/hierarchical/Node.java	80.76% <100%> (+1.6%)	8 <1> (+1)	⬆️
...form/engine/support/hierarchical/NodeTestTask.java	97.5% <100%> (+0.16%)	27 <7> (+2)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9bb7786...7aa1bdb. Read the comment docs.

[codecov]

Codecov Report

Merging #1705 into master will increase coverage by <.01%.
The diff coverage is 100%.

@@             Coverage Diff              @@
##             master    #1705      +/-   ##
============================================
+ Coverage     88.44%   88.45%   +<.01%     
- Complexity     3801     3804       +3     
============================================
  Files           345      345              
  Lines          9335     9342       +7     
  Branches        751      751              
============================================
+ Hits           8256     8263       +7     
  Misses          883      883              
  Partials        196      196

Impacted Files	Coverage Δ	Complexity Δ
...nit/platform/engine/support/hierarchical/Node.java	80.76% <100%> (+1.6%)	8 <1> (+1)	⬆️
...form/engine/support/hierarchical/NodeTestTask.java	97.5% <100%> (+0.16%)	27 <7> (+2)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9bb7786...7aa1bdb. Read the comment docs.

[sbrannen]

as discussed with @marcphilipp

Can you please provide a rationale for the proposed change (perhaps linking to an existing issue or discussion) and include that in the commit message as well?

Thanks in advance!

[sbrannen]

Tentatively slated for 5.4 M1 for team discussion.

[marcphilipp]

The rationale is to support Spock's extension model that allows to intercept, i.e. wrap, the whole execution of a test class, method, or invocation.

[sbrannen]

The rationale is to support Spock's extension model that allows to intercept, i.e. wrap, the whole execution of a test class, method, or invocation.

OK. Thanks for the background.

But... doesn't this change then relate to #80 and #157?

And if so, has there been any effort made to ensure that this change would work nicely with those (once implemented)?

[marcphilipp]

I think it's related in a way because both #80 and #157 will require a similar wrapping pattern. However, in both case on a much more fine-grained level, e.g. only the @BeforeEach method or the @Test method. I don't think the Jupiter Nodes will override this around() method and therefore I don't think it will make it any easier or harder to implement #80 and #157.

[sormuras]

Team Decision: Merge it.

[sormuras]

Merge it ... after remaining deliverables are finished:

• Change is documented in the Release Notes

[sbrannen]

I think it's related in a way because both #80 and #157 will require a similar wrapping pattern.

Thanks for the feedback.

However, in both case on a much more fine-grained level, e.g. only the @BeforeEach method or the @Test method. I don't think the Jupiter Nodes will override this around() method and therefore I don't think it will make it any easier or harder to implement #80 and #157.

Well... let's see how it all plays out. 😉

[marcphilipp]

I've added release notes and manually pushed this PR to master in 77c39f2.