Improve test reproducibility #1195
Merged
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
simogasp
previously requested changes
Jul 26, 2022
p12tic
force-pushed
the
reproducible-tests-eigen-rand
branch
2 times, most recently
from
d626376
to
1d572b1
Compare
src/aliceVision/numeric/numeric.hpp
Outdated
| * In order to introduce variation in test execution, ALICEVISION_TEST_RANDOM_SEED environment | ||
| * variable can be set to an integer value. | ||
| */ | ||
| void makeRandomOperationsReproducibleInTests(); |
There was a problem hiding this comment.
I would suggest to remove the "inTests" from the generic function name:
Suggested change
| void makeRandomOperationsReproducibleInTests(); | |
| void makeRandomOperationsReproducible(); |
Even if it's only used in tests for now, it is not specific to unit tests in itself.
Same for the env var: ALICEVISION_TEST_RANDOM_SEED => ALICEVISION_RANDOM_SEED.
There was a problem hiding this comment.
Indeed, that's correct. Fixed now, thanks.
Many tests call Vec*::Random() and similar functions from Eigen, which make the tests not reproducible. This is problematic, because the tests become unstable and even if some of them sometimes fail indicating a problem, it's hard to debug and fix the failure as the exact conditions of the failing test are not known. Initializing random number generators to a static seed fixes the issue.
p12tic
force-pushed
the
reproducible-tests-eigen-rand
branch
from
1d572b1
to
ace04e0
Compare
fabiencastan
approved these changes
Aug 1, 2022
fabiencastan
dismissed
simogasp’s stale review
requested changes have been done
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.
Many tests call Vec*::Random() and similar functions from Eigen, which make the tests not reproducible. This is problematic, because the tests become unstable and even if some of them sometimes fail indicating a problem, it's hard to debug and fix the failure as the exact conditions of the failing test are not known. Initializing random number generators to a static seed fixes the issue.
In order to introduce variation in test execution,
ALICEVISION_TEST_RANDOM_SEEDenvironment variable can be set to an integer value. This effectively allows to keep the previous behavior, because this value can be set to a different integer on each test execution.