Allow declaring exclusive resources for child nodes #4151
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vdmitrienko
force-pushed
the
#3102_allow_to_inherit_resource_locks
branch
from
c072648
to
933ef57
Compare
1 task
vdmitrienko
commented
Nov 23, 2024
.../src/test/java/org/junit/platform/engine/support/descriptor/ResourceLockAnnotationTests.java
Show resolved
Hide resolved
1 task
marcphilipp
requested changes
Nov 25, 2024
| * <li>a test class | ||
| * - test methods and nested test classes declared in the class.</li> | ||
| * <li>a nested test class | ||
| * - test methods declared in the nested class.</li> |
There was a problem hiding this comment.
Suggested change
| * - test methods declared in the nested class.</li> | |
| * - test methods and nested test classes declared in the nested class.</li> |
| * - test methods and nested test classes declared in the class.</li> | ||
| * <li>a nested test class | ||
| * - test methods declared in the nested class.</li> | ||
| * <li>a test method - considered to have no children.</li> |
There was a problem hiding this comment.
This fails, right? We should document that CHILDREN cannot be used on methods.
There was a problem hiding this comment.
That's right. Added
|
|
||
| Using the `target = CHILDREN` in a class-level `{ResourceLock}` annotation | ||
| has the same semantics as adding an annotation with the same `value` and `mode` | ||
| to each test method declared in this class. |
There was a problem hiding this comment.
Suggested change
| to each test method declared in this class. | |
| to each test method and nested test class declared in this class. |
| has the same semantics as adding an annotation with the same `value` and `mode` | ||
| to each test method declared in this class. | ||
|
|
||
| It may improve parallelization when a test class declares a `READ` lock, |
There was a problem hiding this comment.
Suggested change
| It may improve parallelization when a test class declares a `READ` lock, | |
| This may improve parallelization when a test class declares a `READ` lock, |
| but only a few methods hold a `READ_WRITE` lock. | ||
|
|
||
| Tests in the following example would run in the `SAME_THREAD` if the `{ResourceLock}` | ||
| doesn't have the `target = CHILDREN`. This is because the test class declares a `READ` |
There was a problem hiding this comment.
Suggested change
| doesn't have the `target = CHILDREN`. This is because the test class declares a `READ` | |
| didn't have `target = CHILDREN`. This is because the test class declares a `READ` |
| Tests in the following example would run in the `SAME_THREAD` if the `{ResourceLock}` | ||
| doesn't have the `target = CHILDREN`. This is because the test class declares a `READ` | ||
| shared resource, but one test method holds a `READ_WRITE` lock, | ||
| which forces the `SAME_THREAD` execution mode for all the test methods. |
There was a problem hiding this comment.
Suggested change
| which forces the `SAME_THREAD` execution mode for all the test methods. | |
| which would force the `SAME_THREAD` execution mode for all the test methods. |
@marcphilipp thanks for the review 🙂 Updated according to the comments |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue: #3102
Overview
Allow declaring "shared resources" for direct child nodes via the new
@ResourceLock(target = CHILDREN)attribute.Using the
@ResourceLock(target = CHILDREN)in a class-level annotation has the same semantics as adding an annotation with the samevalueandmodeto each test method and nested test class declared in this class.This may improve parallelization when a test class declares a
READlock, but only a few methods hold aREAD_WRITElock.I hereby agree to the terms of the JUnit Contributor License Agreement.
Definition of Done
@APIannotations