Make mutate constructs immutable.
#1124
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
|
Weird, this is a legit failure that repros for me locally, but not against |
|
Ah, we do, but it's a test bug 🤣 go-containerregistry/pkg/legacy/tarball/write_test.go Lines 302 to 303 in 8388fde |
I noticed that `cosign` was taking advantage of a bug in the mutate package where the `Manifest()` returns a mutable copy of it's internal state, which allowed them to permanently alter the result of `Manifest()`. This mutability violates the philosophy of our abstractions, and should not be allowed, so this change ensures that each of the methods returning state in the `mutate` package return a `.DeepCopy()` instead. In `image` this included the `configFile`, and `manifest`. In `index` this included the `indexManifest`. I have added tests that when the returned copies are mutated, a subsequent invocation of the getter will return a pristine copy. Since I'm not completely heartless, I am also adding a new `mutate.ConfigMediaType` method to enable `cosign` to perform the alteration they want, now that the trick they were using will no longer work. Related: sigstore/cosign#718
mattmoor
force-pushed
the
immutable-fields-in-mutate
branch
from
1a71d2a
to
43e061d
Compare
Codecov Report
@@ Coverage Diff @@
## main #1124 +/- ##
==========================================
- Coverage 75.16% 75.15% -0.02%
==========================================
Files 108 108
Lines 7724 7732 +8
==========================================
+ Hits 5806 5811 +5
- Misses 1363 1364 +1
- Partials 555 557 +2
Continue to review full report at Codecov.
|
All hail not heartless Matt |
imjasonh
approved these changes
Sep 18, 2021
|
Thanks for fixing this! |
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.
I noticed that
cosignwas taking advantage of a bug in the mutate packagewhere the
Manifest()returns a mutable copy of it's internal state, whichallowed them to permanently alter the result of
Manifest(). This mutabilityviolates the philosophy of our abstractions, and should not be allowed, so
this change ensures that each of the methods returning state in the
mutatepackage return a
.DeepCopy()instead. Inimagethis included theconfigFile, andmanifest. Inindexthis included theindexManifest.I have added tests that when the returned copies are mutated, a subsequent
invocation of the getter will return a pristine copy.
Since I'm not completely heartless, I am also adding a new
mutate.ConfigMediaTypemethod to enablecosignto perform the alterationthey want, now that the trick they were using will no longer work.
Related: sigstore/cosign#718