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

Add optional remediation field to changeset #16

Closed
wants to merge 1 commit into from

Conversation

drdavella
Copy link
Member

Add optional metadata fields that can be populated by Codemodder when remediating findings from external tools.

This is currently unused by upstream tools but it may be useful to capture this metadata and could be useful going forward.

@drdavella drdavella requested review from nahsra and ryandens February 26, 2024 02:30
@@ -48,8 +48,15 @@
}
]
}
]
},
Copy link
Contributor

Choose a reason for hiding this comment

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

  • It seems like this information is duplicative to the codemod namespace. For instance, codeql:java/whatever implies the some of the information here. Do we care?
  • How do we report the other stuff (the findings that were not fixed)? Should that be a subset at the root of a codemod's section of the CodeTF? E.g.:
"codemod" : "codeql:java/whatever",
"summary: "Description of rule/fix..",
"findings" : [
   { 
     "resultId" : "zxc-1",
     "outcome" : "FAILED_LOCATION_NOT_FOUND",
     "resultFile" : "my-codeql-sarif.sarif"
   },
   { 
     "resultId" : "zxc-2",
     "outcome" : "FAILED_SOURCE_NOT_FIXABLE",
     "resultFile" : "my-codeql-sarif.sarif"
   },
]
  • I would record that resultId is a String and will contain vendor-specific ID values with an unpredictable character set.

@nahsra nahsra removed the request for review from ryandens February 28, 2024 16:22
@nahsra
Copy link
Contributor

nahsra commented Feb 28, 2024

Will revisit as part of #17 .

@nahsra nahsra closed this Feb 28, 2024
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