Add docs, unit tests, and refactor repro test infra #3439
Merged
+452
−57
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.
This PR adds docs, unit tests, and refactors the reproducibility test infrastructure. In adding unit tests and documentation, I've realized that some of the terminology around the repro tests needs revised for certain terminology to be well defined.
In particular, if we consider the situation where commits are reverted, we can end up with multiple and diverging paths (multiple paths with the same reference counter, but made at different periods in development). For example, if our reference counter history looks like (top being most recent):
We could clean up older commits, but I think a safer option is to change the
latest_comparable_paths
to use the (newly) added functioncompute_bins
. I originally used the termbundle
(e.g.,compute_bundles
), which I'm almost leaning towards returning to. It's a longer name but sounds more...tidy.This was previously not an issue when
latest_comparable_paths
waslatest_comparable_path
, because we always grabbed the most recent matched reference to compare against, eliminating this potential issue.I'll update the README once we land on a design that is coherent, but I think it might take a bit more refactoring to get there.