fix: Remove scanResult from json output [MAGMA-1280] #2502
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
|
snaftaly
force-pushed
the
fix/remove-scan-results-from-json
branch
3 times, most recently
from
f4546fe
to
b38a9db
Compare
snaftaly
changed the title
snaftaly
force-pushed
the
fix/remove-scan-results-from-json
branch
from
b38a9db
to
2e876eb
Compare
snaftaly
changed the title
ghost
approved these changes
Jan 5, 2022
snaftaly
force-pushed
the
fix/remove-scan-results-from-json
branch
from
9d0db8b
to
96e72bb
Compare
The scanResult object was added to the json output where it should only have been added to calculate the the dockerfile warning string. This change removes the scanResult from the json output as it was not supposed to be exposed.
This refactor is done to not have a special case for array vs single result when formatting the results for JSON output. Note: dataToSend will now take the jsonData after formatting rather than the data before formatting. Since the formatting only changes the vulnerbilities and removes the unwanted scanResult, and since the vulnerbilities are removed from dataToSend before it is used, this change will not affect the CLI bahvior except for removing the unwanted scanResult.
snaftaly
force-pushed
the
fix/remove-scan-results-from-json
branch
from
96e72bb
to
b4bd660
Compare
Renaming the object as in IaC the logic does more than mapping the results.
Rename test fixtures used in format-test-results to align with the variable name change. This is done in a separate commit so it's clearer in git history that the files were changed and then renamed rather than deleted and created new files.
snaftaly
force-pushed
the
fix/remove-scan-results-from-json
branch
from
b4bd660
to
1949818
Compare
This was referenced Aug 30, 2022
This was referenced Mar 29, 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.
What does this PR do?
This PR removes the scanResult object from the json output.
It also refactors the code that creates the json output, therefore it's recommended to review it commit by commit.
How should this be manually tested?
Run:
snyk container test node:aplineAny background context you want to provide?
In a previous PR (#2093) the scanResult object was added in order to calculate the appropriate dockerfile analysis warning message shown in the textual output.
As a result the scanResult was also shown in the json output, although it was not intended to.
What are the relevant tickets?
https://snyksec.atlassian.net/browse/MAGMA-1280