feat: Export and json-tag fields of manifest.OciImageManifestResponse{} #82
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
Setting the json tags is needed as we marshal this struct in the cel-policy, `kw.oci.getManifest()` function to return it as map. To honour this new contract with the json tags, mark fields as exported. This also simplifies creating mocks with this type struct without type casting. Signed-off-by: Víctor Cuadrado Juan <vcuadradojuan@suse.de> Co-authored-by: Fabrizio Sestito <fabrizio.sestito@suse.com>
viccuad
commented
May 15, 2024
| @@ -8,30 +8,30 @@ import ( | |||
| ) | |||
|
|
|||
| type OciImageManifestResponse struct { | |||
| image *specs.Manifest | |||
| index *specs.Index | |||
| Image *specs.Manifest `json:"image"` | |||
There was a problem hiding this comment.
Exporting these fields is needed because the json lib cannot see them using reflect unless they are in the same package. A workaround would be to create a new helper unexported type ociImageManifestResponse{} with exported fields, but at this point, why not change it here.
fabriziosestito
approved these changes
May 17, 2024
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.
Description
Relates to kubewarden/cel-policy#31
Setting the json tags is needed as we marshal this struct in the cel-policy,
kw.oci.getManifest()function to return it as map.To honour this new contract with the json tags, mark fields as exported.
This also simplifies creating mocks with this type struct without type casting.
Note that API is still backwards compatible as we were using the fields via the getters, which are untouched. Plus, cel-policy seems to be the first consumer of this.
Test
CI, and the followup cel-policy PR.
Additional Information
Tradeoff
Potential improvement