Fix BA2027.EnableSourceLink cause ExceptionLoadingPdb
#988
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
…` error when the PDB file is missing.
shaopeng-gh
requested review from
michaelcfanning and
marmegh
as code owners
stacywray
reviewed
Feb 29, 2024
ReleaseHistory.md
Outdated
| @@ -18,6 +18,7 @@ | |||
| * DEP: Update `Sarif.Sdk` submodule from [bc8cb57 to fd6e615](https://github.com/microsoft/sarif-sdk/compare/bc8cb57...fd6e615). Reference [SARIF SDK Release History](https://github.com/microsoft/sarif-sdk/blob/fd6e615/ReleaseHistory.md). | |||
| * NEW: Add `--disable-telemetry` argument to disable telemetry collection. | |||
| * BUG: Fix `ERR998.ExceptionInAnalyze`: `InvalidOperationException: Unrecognized crypto HRESULT: 0x80096011` for check `BA2022.SignSecurely` when the signature is malformed, by adding missing error code to error description mappings. [969](https://github.com/microsoft/binskim/pull/969) | |||
| * BUG: Fix `BA2027.EnableSourceLink` unexpectedly cause `ExceptionLoadingPdb` error when the PDB file is missing. [988](https://github.com/microsoft/binskim/pull/988) | |||
There was a problem hiding this comment.
- Change "cause" to "causes"
- Add a period to the end of the line after the 988 link. The BUG above is also missing a period at the end after 969.
stacywray
suggested changes
Feb 29, 2024
shaopeng-gh
commented
Feb 29, 2024
| { | ||
| public class RulePropertyTests | ||
| { | ||
| private static readonly string[] ExpectedLogPdbLoadExceptionRules = new string[] |
There was a problem hiding this comment.
Please see PR desc.
shaopeng-gh
commented
Mar 1, 2024
There was a problem hiding this comment.
The old test was based on BA2027 throw that error, now that is fixed, so need to change to another file triggered by other rules.
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.
Fix
BA2027.EnableSourceLinkunexpectedly causeExceptionLoadingPdberror when the PDB file is missing.Please see details in #986
The cause is this PR [WIP] Add BA2027.EnableSourceLink
missed setting
LogPdbLoadException=> false. (Pattern found from other rules)I used the get history version to locate this exact PR changed the behavior.
Fix: add it, and add tests to prevent future new rules missing the same property set.
Additionally, I have question about other existing rules that have this
LogPdbLoadExceptionas true.Are they bugs? What condition we want this true / false? This is a question about original design when we introduce this flag.
Let me know I can create a bug if need fixes.