Adding rule SARIF2005 #1926
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| // Copyright (c) Microsoft. All rights reserved. | ||
| // Licensed under the MIT license. See LICENSE file in the project root for full license information. | ||
|
|
||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Text.RegularExpressions; | ||
|
|
||
| using Microsoft.Json.Pointer; | ||
|
|
||
| namespace Microsoft.CodeAnalysis.Sarif.Multitool.Rules | ||
| { | ||
| public class ProvideHelpfulToolInformation : SarifValidationSkimmerBase | ||
| { | ||
| /// <summary> | ||
| /// SARIF2005 | ||
| /// </summary> | ||
| public override string Id => RuleId.ProvideHelpfulToolInformation; | ||
|
|
||
| /// <summary> | ||
| /// Placeholder (full description). | ||
| /// </summary> | ||
| public override MultiformatMessageString FullDescription => new MultiformatMessageString { Text = RuleResources.SARIF2005_ProvideHelpfulToolInformation_FullDescription_Text }; | ||
|
|
||
| protected override IEnumerable<string> MessageResourceNames => new string[] { | ||
| nameof(RuleResources.SARIF2005_ProvideHelpfulToolInformation_Warning_ProvideToolVersion_Text), | ||
| nameof(RuleResources.SARIF2005_ProvideHelpfulToolInformation_Warning_ProvideConciseToolName_Text), | ||
| nameof(RuleResources.SARIF2005_ProvideHelpfulToolInformation_Warning_UseNumericToolVersions_Text) | ||
| }; | ||
|
|
||
| public override FailureLevel DefaultLevel => FailureLevel.Warning; | ||
|
|
||
| private static readonly Regex s_versionRegex = new Regex(@"^\d+\.\d+.*", RegexOptions.Compiled | RegexOptions.CultureInvariant); | ||
|
|
||
| protected override void Analyze(Tool tool, string toolPointer) | ||
| { | ||
| if (tool.Driver != null) | ||
| { | ||
| AnalyzeToolDriver(tool.Driver, toolPointer.AtProperty(SarifPropertyName.Driver)); | ||
| } | ||
| } | ||
|
|
||
| private void AnalyzeToolDriver(ToolComponent toolComponent, string toolDriverPointer) | ||
| { | ||
| // ProvideConciseToolName: Ensure that tool.driver.name isn't more than 3 words long | ||
| if (!string.IsNullOrEmpty(toolComponent.Name)) | ||
| { | ||
| const int MaxWords = 3; | ||
| int wordCount = toolComponent.Name.Split(new char[] { ' ' }, StringSplitOptions.RemoveEmptyEntries).Length; | ||
| if (wordCount > MaxWords) | ||
| { | ||
| string driverNamePointer = toolDriverPointer.AtProperty(SarifPropertyName.Name); | ||
|
|
||
| // {0}: Placeholder '{1}' '{2}' '{3}' | ||
| LogResult( | ||
| driverNamePointer, | ||
| nameof(RuleResources.SARIF2005_ProvideHelpfulToolInformation_Warning_ProvideConciseToolName_Text), | ||
|
There was a problem hiding this comment.
Let's do one more thing. Let's add an argument which is the actual tool driver name. Let's make that argument 1, argument 2 is the word count, and argument 3 is the actual word count. Don't forget to update the placeholder resource string. #Closed |
||
| toolComponent.Name, | ||
| wordCount.ToString(), | ||
| MaxWords.ToString()); | ||
| } | ||
| } | ||
|
|
||
| // ProvideToolVersion: Either tool.driver.version or tool.driver.semanticVersion should be there. | ||
| if (string.IsNullOrWhiteSpace(toolComponent.Version) && string.IsNullOrWhiteSpace(toolComponent.SemanticVersion)) | ||
| { | ||
| // {0}: Placeholder | ||
| LogResult( | ||
| toolDriverPointer, | ||
| nameof(RuleResources.SARIF2005_ProvideHelpfulToolInformation_Warning_ProvideToolVersion_Text)); | ||
| } | ||
| else | ||
| { | ||
| // UseNumericToolVersions | ||
| if (!string.IsNullOrWhiteSpace(toolComponent.Version)) | ||
| { | ||
| AnalyzeVersion(toolComponent.Version, toolDriverPointer.AtProperty(SarifPropertyName.Version)); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private void AnalyzeVersion(string version, string pointer) | ||
| { | ||
| if (!s_versionRegex.IsMatch(version)) | ||
| { | ||
| // {0}: Placeholder '{1}' | ||
| LogResult( | ||
| pointer, | ||
| nameof(RuleResources.SARIF2005_ProvideHelpfulToolInformation_Warning_UseNumericToolVersions_Text), | ||
| version); | ||
| } | ||
| } | ||
| } | ||
| } | ||
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
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Our convention is to put the
Systemusings first. #Closed