fix: fix flaky test io.dropwizard.health.HealthCheckConfigValidatorTest#startValidationsShouldFailIfAHealthCheckConfiguredButNotRegistered #1
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.
Problem:
The HealthCheckConfigValidator#startValidationsShouldFailIfAHealthCheckConfiguredButNotRegistered test is flaky due to the use of the non-deterministic Set<> instance used in the class HealthCheckConfigValidator.
HealthCheckConfigValidator is intended to throw an exception with an error message containing specific words. Due to the use of a Set to generate the error message, this error message is not deterministic because the ordering, in which the elements are returned from the Set, is not deterministic. This results in a flaky test.
The flaky test was found by using the NonDex tool.
Solution:
Instead of checking if the error message contains an array with a specific ordering of the expected strings, check if the error message contains either the one or the other ordering (random ordering as intended by the use of Sets).
Result:
The test is deterministic and not flaky. This improves the quality of the test and reduces the time to search for the bug during future development.
Reproduce: