Adding SARIF V1 read capability to compiler telemetry #613
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
marmegh
commented
Mar 11, 2022
|
|
||
| fileSystem.Verify(fileSystem => fileSystem.FileOpenRead(sarifLogPath), Times.Once); | ||
| sendItems.Count.Should().Be(1); | ||
| } |
There was a problem hiding this comment.
This is the added test.
Used the Native_x86_VS2019_SDL_Enabled.exe to generate a SARIF v1 output (in addition to the SARIF V2 used in the baseline tests).
Mocked the fileSystem to return this sarif output and verified that the fileSystem was called exactly one time as expected.
Finally, verified that we generated the single telemetry event as expected when calling CompilerDataLogger.Disepose(). #Resolved
marmegh
commented
Mar 11, 2022
| } | ||
|
|
||
| return sarifLog; | ||
| } |
There was a problem hiding this comment.
This is the bulk of the code change, loading based on SARIF version. #Resolved
There was a problem hiding this comment.
Need to add test for SARIF V2, as well.
src/ReleaseHistory.md
Outdated
| @@ -5,6 +5,7 @@ | |||
| * FEATURE: Add new PE `CV_CFL_LANG` language code for `ALIASOBJ` and `Rust`. [530](https://github.com/microsoft/binskim/pull/530) | |||
| * BUGFIX: Fix `BA2014.DoNotDisableStackProtectionForFunctions` to eliminate false positive reports that `GsDriverEntry` has disabled the stack protector. [551](https://github.com/microsoft/binskim/pull/551) | |||
| * BREAKING: Rename `BA2026.EnableAdditionalSdlSecurityChecks` to `BA2026.EnableMicrosoftCompilerSdlSwitch` to clarify rule purpose. [#586](https://github.com/microsoft/binskim/pull/586) | |||
| * BUGFIX: Fix inability to emit `SummaryEvent` when SARIF V1. [613](https://github.com/microsoft/binskim/pull/613) | |||
Merged
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.
Many customers have a strong dependency on SARIF V1 and are therefore unable to utilize the full compiler telemetry functionality. This change addresses this by adding capacity to distinguish SARIF version and convert before logging telemetry summary if needed. Additionally, test coverage was added to verify the reading and telemetry logging in this situation.