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.

Sign up for GitHub

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

Jump to bottom

Remove 'open' from list of valid rule configuration default values. #1158

Merged
merged 1 commit into from
Dec 6, 2018
Merged

Remove 'open' from list of valid rule configuration default values. #1158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 19 additions & 18 deletions src/ReleaseHistory.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,25 +204,26 @@
## **v2.0.0-csd.2.beta.2018.10.10** [Sdk](https://www.nuget.org/packages/Sarif.Sdk/2.0.0-csd.2.beta.2018.10.10) | [Driver](https://www.nuget.org/packages/Sarif.Driver/2.0.0-csd.2.beta.2018.10.10) | [Converters](https://www.nuget.org/packages/Sarif.Converters/2.0.0-csd.2.beta.2018.10.10)) | [Multitool](https://www.nuget.org/packages/Sarif.Multitool/2.0.0-csd.2.beta.2018.10.10))
* FEATURE:Add --sarif-version command to driver (to transform SARIF output to v1 format)
* BUGFIX: Drop erroneous persistence of redaction tokens as files objects.
* API NON-BREAKING: Add result.occurrenceCount (denotes # of occurrences of an identical results within an analysisRun)
* API NON-BREAKING: Add run.externalFiles object to schema. Sync generally to OASIS TC schema.
* API BREAKING: originalUriBaseIds is now a dictionary of file locations, not strings.
* API BREAKING: Suffix invocation.startTime, invocation.endTime, file.lastModifiedTime and notification.time with Utc (startTimeUtc, endTimeUtc, etc.).
* API BREAKING: threadflowLocation.timestamp renamed to 'executionTimeUtc'.
* API BREAKING: versionControlDetails.timestamp renamed to 'asOfTimeUtc'.
* API BREAKING: versionControlDetails.uri renamed to 'repositoryUri'.
* API BREAKING: versionControlDetails.tag renamed to 'revisionTag'
* API BREAKING: exception.message type converted from string to message object.
* API BREAKING: file.hashes is now a string/string dictionary, not an array of 'hash' objects (the type for which is deleted)
* API BREAKING: run.instanceGuid, run.correlationGuid, run.logicalId, run.description combined into new run.id 'runAutomationDetails' object instance.
* API BREAKING: run.automationLogicalId subsumed by run.aggregateIds, an array of 'runAutomationDetails' objects.
* API BREAKING: Remove threadFlowLocation.step
* API BREAKING: invocation.workingDirectory is now a FileLocation object (and not a URI expressed as a string)
* API NON-BREAKING: Add 'result.occurrenceCount' (denotes # of occurrences of an identical results within an analysisRun)
* API NON-BREAKING: Add 'run.externalFiles' object to schema. Sync generally to OASIS TC schema.
* API BREAKING: 'originalUriBaseIds' is now a dictionary of file locations, not strings.
* API BREAKING: Suffix 'invocation.startTime', 'invocation.endTime', 'file.lastModifiedTime' and 'notification.time' with Utc ('startTimeUtc', 'endTimeUtc', etc.).
* API BREAKING: 'threadflowLocation.timestamp' renamed to 'executionTimeUtc'.
* API BREAKING: 'versionControlDetails.timestamp' renamed to 'asOfTimeUtc'.
* API BREAKING: 'versionControlDetails.uri' renamed to 'repositoryUri'.
* API BREAKING: 'versionControlDetails.tag' renamed to 'revisionTag'
* API BREAKING: 'exception.message' type converted from string to message object.
* API BREAKING: 'file.hashes' is now a string/string dictionary, not an array of 'hash' objects (the type for which is deleted)
* API BREAKING: 'run.instanceGuid', 'run.correlationGuid', 'run.logicalId', 'run.description' combined into new 'runAutomationDetails' object instance defined at 'run.id'.
* API BREAKING: 'run.automationLogicalId' subsumed by 'run.aggregateIds', an array of 'runAutomationDetails' objects.
* API BREAKING: Remove 'threadFlowLocation.step'
* API BREAKING: 'invocation.workingDirectory' is now a FileLocation object (and not a URI expressed as a string)

## **v2.0.0-csd.2.beta.2018.11.28** [Sdk](https://www.nuget.org/packages/Sarif.Sdk/2.0.0-csd.2.beta.2018.11.28) | [Driver](https://www.nuget.org/packages/Sarif.Driver/2.0.0-csd.2.beta.2018.11.28) | [Converters](https://www.nuget.org/packages/Sarif.Converters/2.0.0-csd.2.beta.2018.11.28)) | [Multitool](https://www.nuget.org/packages/Sarif.Multitool/2.0.0-csd.2.beta.2018.11.28))
* BUGFIX: Result matching improvements in properties persistence
* FEATURE: Fortify FPR converter improvements
* API NON-BREAKING: Add run.newlineSequences to schema. https://github.com/oasis-tcs/sarif-spec/issues/169
* API BREAKING: remove run.architecture https://github.com/oasis-tcs/sarif-spec/issues/262
* API BREAKING: result.message is now a required property https://github.com/oasis-tcs/sarif-spec/issues/283
* API BREAKING: rename tool.fileVersion to tool.dottedQuadFileVersion https://github.com/oasis-tcs/sarif-spec/issues/274
* API NON-BREAKING: Add 'run.newlineSequences' to schema. https://github.com/oasis-tcs/sarif-spec/issues/169
* API BREAKING: remove 'run.architecture' https://github.com/oasis-tcs/sarif-spec/issues/262
* API BREAKING: 'result.message' is now a required property https://github.com/oasis-tcs/sarif-spec/issues/283
* API BREAKING: rename 'tool.fileVersion' to 'tool.dottedQuadFileVersion' https://github.com/oasis-tcs/sarif-spec/issues/274
* API BREAKING: remove 'open' from valid rule default configuration levels. https://github.com/oasis-tcs/sarif-spec/issues/288. The transformer remaps this value to 'note'.
1 change: 1 addition & 0 deletions src/Sarif.FunctionalTests/v2/ObsoleteFormats/ComprehensivePrereleaseTwoZeroZero.sarif
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -429,6 +429,7 @@
"rules": {
"C2001": {
"id": "C2001",
"configuration": {"defaultLevel": "open"},
"shortDescription": {
"text": "A variable was used without being initialized."
},
Expand Down
3 changes: 1 addition & 2 deletions src/Sarif/Autogenerated/RuleConfigurationDefaultLevel.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ public enum RuleConfigurationDefaultLevel
None,
Note,
Warning,
Error,
Open
Error
}
}
3 changes: 1 addition & 2 deletions src/Sarif/CodeGenHints.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -609,8 +609,7 @@
"memberNames": [
"Note",
"Warning",
"Error",
"Open"
"Error"
]
}
},
Expand Down
2 changes: 1 addition & 1 deletion src/Sarif/Schemata/sarif-schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1440,7 +1440,7 @@
"defaultLevel": {
"description": "Specifies the default severity level of the result.",
"default": "warning",
"enum": [ "note", "warning", "error", "open" ]
"enum": [ "note", "warning", "error" ]
},

"parameters": {
Expand Down
33 changes: 33 additions & 0 deletions src/Sarif/Writers/PrereleaseCompatibilityTransformer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,12 +116,45 @@ private static bool ApplyChangesFromTC25ThroughTC28(JObject sarifLog)
{
modifiedLog |= RenameProperty((JObject)conversion["tool"], previousName: "fileVersion", newName: "dottedQuadFileVersion");
}

// Remove 'open' from rule configuration default level enumeration
// https://github.com/oasis-tcs/sarif-spec/issues/288
JObject resources = (JObject)run["resources"];
modifiedLog |= RemapRuleDefaultLevelFromOpenToNote(resources);

}
}

return modifiedLog;
}

private static bool RemapRuleDefaultLevelFromOpenToNote(JObject resources)
{
bool modifiedResources = false;

if (resources == null) { return modifiedResources; }

JObject rules = (JObject)resources["rules"];
if (rules == null ) { return modifiedResources; }

foreach (JProperty rule in rules.Values<JProperty>())
{
JObject configuration = (JObject)rule.Value["configuration"];
if (configuration == null) { continue; }

if ("open".Equals((string)configuration["defaultLevel"]))
Copy link

Choose a reason for hiding this comment

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

Equals [](start = 27, length = 6)

Ordinal comparison

{
// We remap 'open' to 'note'. 'open' is an indicator that analysis is unresolved, i.e.,
// the question of whether a weakness exists is not yet determined. 'note' is the most
// reasonable level to associate with this class of report, if it is emitted. In
// practice, we don't expect that a current producer exists who is in this condition.
configuration["defaultLevel"] = "note";
}
}

return modifiedResources;
}

private static bool ApplyCoreTransformations(JObject sarifLog)
{
bool modifiedLog = UpdateSarifLogVersion(sarifLog);
Expand Down