batches/executor: fix TestCreateChangesetSpecs#556
Merged
Conversation
The `specWith()` and `taskWith()` helpers inadvertently mutate `defaultChangesetSpec` and `defaultTask` fields, rather than isolating their changes to just the returned spec and task, respectively. Practically speaking, this means that all tests have the same spec and task based on the last element in the `tests` slice, which means that all the test cases end up testing the same, identical thing. Instead, we must deep copy the spec and task before invoking the mutator function. I've chosen to pull in a third party package (specifically, copystructure) for this: naïvely using JSON to marshal and unmarshal doesn't work because most of the interesting task fields are excluded when marshalled to JSON.
scjohns
pushed a commit
that referenced
this pull request
Apr 24, 2023
The `specWith()` and `taskWith()` helpers inadvertently mutate `defaultChangesetSpec` and `defaultTask` fields, rather than isolating their changes to just the returned spec and task, respectively. Practically speaking, this means that all tests have the same spec and task based on the last element in the `tests` slice, which means that all the test cases end up testing the same, identical thing. Instead, we must deep copy the spec and task before invoking the mutator function. I've chosen to pull in a third party package (specifically, copystructure) for this: naïvely using JSON to marshal and unmarshal doesn't work because most of the interesting task fields are excluded when marshalled to JSON.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
The
specWith()andtaskWith()helpers inadvertently mutatedefaultChangesetSpecanddefaultTaskfields, rather than isolating their changes to just the returned spec and task, respectively. Practically speaking, this means that all tests have the same spec and task based on the last element in thetestsslice, which means that all the test cases end up testing the same, identical thing.Instead, we must deep copy the spec and task before invoking the mutator function. I've chosen to pull in a third party package (specifically, copystructure) for this: naïvely using JSON to marshal and unmarshal doesn't work because most of the interesting task fields are excluded when marshalled to JSON.