Handle class setup failures preventing previously failed methods from retrying #177
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
pshevche
requested review from
leonard84,
snoopcheri,
marcphilipp and
jean-andre-gauthier
pshevche
force-pushed
the
pshevche/flaky-setup-prevents-method-retry
branch
from
d904726
to
7ea416d
Compare
jean-andre-gauthier
approved these changes
Feb 27, 2023
leonard84
approved these changes
Feb 27, 2023
| if (Files.exists(marker)) { | ||
| int counter = Integer.parseInt(new String(Files.readAllBytes(marker))); | ||
| ++counter; | ||
| Files.write(marker, Integer.toString(counter).getBytes()); |
There was a problem hiding this comment.
Suggested change
| Files.write(marker, Integer.toString(counter).getBytes()); | |
| marker.text = counter |
There was a problem hiding this comment.
❗ This is a Java class that we create in the build workspace to simplify creation of test classes, so this won't work.
| Path marker = Paths.get("build/marker.file." + id); | ||
| try { | ||
| if (Files.exists(marker)) { | ||
| int counter = Integer.parseInt(new String(Files.readAllBytes(marker))); |
There was a problem hiding this comment.
You probably need the groovy-nio as test dependency for the nice Path extension methods.
Suggested change
| int counter = Integer.parseInt(new String(Files.readAllBytes(marker))); | |
| int counter = Integer.parseInt(marker.text)); |
There was a problem hiding this comment.
Same here, it is a plain Java class written alongside test classes.
| throw new RuntimeException("fail me!"); | ||
| } | ||
| } else { | ||
| Files.write(marker, "0".getBytes()); |
There was a problem hiding this comment.
Suggested change
| Files.write(marker, "0".getBytes()); | |
| marker.text = 0 |
| @@ -78,6 +78,24 @@ abstract class AbstractPluginFuncTest extends Specification { | |||
| throw new java.io.UncheckedIOException(e); | |||
| } | |||
| } | |||
|
|
|||
| public static void flakyAssertPassFailPass(String id) { | |||
| Path marker = Paths.get("build/marker.file." + id); | |||
There was a problem hiding this comment.
Suggested change
| Path marker = Paths.get("build/marker.file." + id); | |
| Path marker = Paths.get("build/marker.file.$id"); |
| @@ -132,6 +150,10 @@ abstract class AbstractPluginFuncTest extends Specification { | |||
| return "acme.FlakyAssert.flakyAssert(\"${StringEscapeUtils.escapeJava(id)}\", $failures);" | |||
| } | |||
|
|
|||
| static String flakyAssertPassFailPass(String id = "id") { | |||
| return "acme.FlakyAssert.flakyAssertPassFailPass(\"${StringEscapeUtils.escapeJava(id)}\");" | |||
There was a problem hiding this comment.
🤔 you could use """ or as string delimiters to avoid having to use escapes for \"
pshevche
force-pushed
the
pshevche/flaky-setup-prevents-method-retry
branch
from
4ef7870
to
df2e94a
Compare
Signed-off-by: Pavlo Shevchenko <[email protected]>
Signed-off-by: Pavlo Shevchenko <[email protected]>
Signed-off-by: Pavlo Shevchenko <[email protected]>
Signed-off-by: Pavlo Shevchenko <[email protected]>
Signed-off-by: Pavlo Shevchenko <[email protected]>
Signed-off-by: Pavlo Shevchenko <[email protected]>
pshevche
force-pushed
the
pshevche/flaky-setup-prevents-method-retry
branch
from
df2e94a
to
0ce11ad
Compare
marcphilipp
approved these changes
Feb 27, 2023
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.
Summary
If class setup fails, then test methods that failed in the previous execution won't be retried. In this case, we used to throw an error since we did not retry things that should be retried. This PR solves the issue by clearing the list of to-be-retried methods if class-level failure occurs. In this case, the entire class will be retried anyways, so it is safe to just clear that list. If previous run had other lifecycle errors, we track those to ensure we report successful execution of those.