Allow arbitrary data in Details map in results #1130
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
zubron
commented
Jun 9, 2020
| @@ -58,6 +58,7 @@ func manualProcessFile(pluginDir, currentFile string) (Item, error) { | |||
|
|
|||
| rootObj.Status = resultObj.Status | |||
| rootObj.Items = resultObj.Items | |||
| rootObj.Details = resultObj.Details | |||
There was a problem hiding this comment.
Including this as this field wasn't being set on the root item. It's covered in the new test in manual_test.go.
zubron
force-pushed
the
allow-arbitrary-details-in-results
branch
4 times, most recently
from
35516dc to
180f9c5
Compare
The previous `Details` structure in the Sonobuoy results format was a
`map[string]string`. As we are creating more plugins that are providing
reports in the Sonobuoy results format, this structure is limiting. To
allow more flexibility, the type is being changed to
`map[string]interface{}` to allow plugins to provide arbitrary data in
the `Details` field.
The version of the YAML library used when parsing the results in a
results tarball has been upgraded to v3. This is due to the fact that it
unmarshals data into a `map[string]interface{}` type when all the keys
are strings. In v2, the behaviour was to always marshal to
`map[interface{}]interface{}`. This is important as if the keys are not
strings then marshalling to JSON will fail when using the `--detailed`
mode of the `results` command.
Signed-off-by: Bridget McErlean <[email protected]>
zubron
force-pushed
the
allow-arbitrary-details-in-results
branch
from
180f9c5 to
de8e23a
Compare
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.
What this PR does / why we need it:
The previous
Detailsstructure in the Sonobuoy results format was amap[string]string. As we are creating more plugins that are providingreports in the Sonobuoy results format, this structure is limiting. To
allow more flexibility, the type is being changed to
map[string]interface{}to allow plugins to provide arbitrary data inthe
Detailsfield.The version of the YAML library used when parsing the results in a
results tarball has been upgraded to v3. This is due to the fact that it
unmarshals data into a
map[string]interface{}type when all the keysare strings. In v2, the behaviour was to always marshal to
map[interface{}]interface{}. This is important as if the keys are notstrings then marshalling to JSON will fail when using the
--detailedmode of the
resultscommand.See: go-yaml/yaml#384 and go-yaml/yaml#591.
Signed-off-by: Bridget McErlean [email protected]
Release note: