Fix intermittent failures in headers tests #145
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
Codecov Report
@@ Coverage Diff @@
## main #145 +/- ##
=======================================
Coverage 92.77% 92.77%
=======================================
Files 10 10
Lines 1024 1024
=======================================
Hits 950 950
Misses 49 49
Partials 25 25 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Split the "iv and partial iv present" test case into separate "iv present" and "partial iv present" cases in headers test. The issue is that validateHeaderParameters takes a map of extracted header parameters and range's over them, validating each one. Ranging over maps in Go does not guarantee a stable order. This meant that ether the "IV" or the "Partial IV" parameter could be checked first in the "iv and partial iv present" test case, resulting in different errors being reported on different runs. The test harness only allows specifying one expected error, so when the order of the header params map iteration switched, the actual and expected errors didn't match resulting in test failure. One way to fix it would be sort map values before iterating over them, however that would be an unnecessary overhead, since the order only matters in the context of the test (where a _specific_ error is expected). Therefore, the alternative solution is to split the test case into two, with only one possible error resulting from each. Also fix the test name to reflect what is actually being tested. Signed-off-by: setrofim <setrofim@gmail.com>
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.
Split the "iv and partial iv present" test case into separate "iv present" and "partial iv present" cases in headers test.
The issue is that validateHeaderParameters takes a map of extracted header parameters and range's over them, validating each one. Ranging over maps in Go does not guarantee a stable order.
This meant that ether the "IV" or the "Partial IV" parameter could be checked first in the "iv and partial iv present" test case, resulting in different errors being reported on different runs.
The test harness only allows specifying one expected error, so when the order of the header params map iteration switched, the actual and expected errors didn't match resulting in test failure.
One way to fix it would be sort map values before iterating over them, however that would be an unnecessary overhead, since the order only matters in the context of the test (where a specific error is expected).
Therefore, the alternative solution is to split the test case into two, with only one possible error resulting from each.