Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Associate findings with changes or with new unfixed array #25

Merged
merged 3 commits into from
Apr 9, 2024

Conversation

drdavella
Copy link
Member

@drdavella drdavella commented Apr 3, 2024

For diagnostic and storytelling purposes, it is desirable for downstream consumers to know which findings are associated with which changes, and which findings were not fixed, where they were attempted, and for what reason.

This update includes the following modifications:

  • detectionTool no longer contains finding metadata. It is purely for metadata about the tool itself. Eventually we might add other fields like version, date, etc.
  • change now has a fixedFinding property
  • We added a new array to result that represents unfixed findings, which include a reason for being unfixed

@drdavella drdavella marked this pull request as ready for review April 4, 2024 01:26
@drdavella drdavella requested a review from nahsra April 4, 2024 01:26
@drdavella drdavella changed the title Make reason we failed to fix more informative Associate findings with changes or with new unfixed array Apr 5, 2024
@@ -177,6 +182,10 @@
"type": "array",
"description": "The package actions that were needed to support changes to the file",
"items": { "$ref": "#/definitions/packageAction" }
},
"finding": {
"$ref": "#/definitions/detector/fixedFinding",
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still not sure whether this needs to be an array.

Copy link
Contributor

@nahsra nahsra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider approving new implementation here!

pixee/codetf-java-bindings#18

nahsra added a commit to pixee/codemodder-java that referenced this pull request Apr 8, 2024
This change populates CodeTF with new remediation metadata specified
[here](pixee/codemodder-specs#25 (review)).
@drdavella drdavella merged commit d54e1e9 into main Apr 9, 2024
2 checks passed
@drdavella drdavella deleted the update-failure-reason branch April 9, 2024 13:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants