Implement v2->v1 conversion for rules dictionary (#1228)

microsoft · Jan 22, 2019 · 0f25460 · 0f25460
1 parent e61d654
commit 0f25460
Show file tree

Hide file tree

Showing 8 changed files with 164 additions and 72 deletions.
diff --git a/....UnitTests/TestData/SarifCurrentToVersionOneVisitor/ExpectedOutputs/OneRunWithRules.sarif b/....UnitTests/TestData/SarifCurrentToVersionOneVisitor/ExpectedOutputs/OneRunWithRules.sarif
@@ -10,7 +10,7 @@
       },
       "results": [
         {
-          "ruleId": "C2009",
+          "ruleId": "C2001",
           "message": "Some testing occurred."
         },
         {
@@ -45,10 +45,16 @@
           "defaultLevel": "error",
           "helpUri": "http://www.domain.com/rules/c2002.html"
         },
+        "C2003": {
+          "id": "C2003",
+          "name": "Rule C2003 for C#",
+          "shortDescription": "C# rules were meant to be broken.",
+          "fullDescription": "Rent internal rebellion competence biography photograph."
+        },
         "C2003-1": {
           "id": "C2003",
-          "name": "Rule C2003",
-          "shortDescription": "Rules were meant to be broken.",
+          "name": "Rule C2003 for VB",
+          "shortDescription": "VB rules were meant to be broken.",
           "fullDescription": "Rent internal rebellion competence biography photograph."
         }
       }

diff --git a/....UnitTests/TestData/SarifCurrentToVersionOneVisitor/ExpectedOutputs/ResultLocations.sarif b/....UnitTests/TestData/SarifCurrentToVersionOneVisitor/ExpectedOutputs/ResultLocations.sarif
@@ -8,18 +8,18 @@
         "language": "en-US"
       },
       "logicalLocations": {
-        "collections::list::add": {
-          "name": "add",
-          "parentKey": "collections::list",
-          "kind": "function"
+        "collections": {
+          "kind": "namespace"
         },
         "collections::list": {
           "name": "list",
           "parentKey": "collections",
           "kind": "type"
         },
-        "collections": {
-          "kind": "namespace"
+        "collections::list::add": {
+          "name": "add",
+          "parentKey": "collections::list",
+          "kind": "function"
         }
       },
       "results": [
@@ -101,14 +101,14 @@
         }
       ],
       "rules": {
-        "WEB1079.AttributeValueIsNotQuoted": {
+        "WEB1079": {
           "id": "WEB1079",
           "shortDescription": "The attribute value is not quoted.",
           "messageFormats": {
             "default": "The  value of the '{0}' attribute is not quoted. Wrap the attribute value in single or double quotes."
           }
         },
-        "WEB1066.TagNameIsNotLowercase": {
+        "WEB1066": {
           "id": "WEB1066",
           "shortDescription": "The tag name is not lowercase.",
           "messageFormats": {

diff --git a/...tTests/TestData/SarifCurrentToVersionOneVisitor/ExpectedOutputs/TwoResultsWithFixes.sarif b/...tTests/TestData/SarifCurrentToVersionOneVisitor/ExpectedOutputs/TwoResultsWithFixes.sarif
@@ -156,14 +156,14 @@
         }
       ],
       "rules": {
-        "WEB1079.AttributeValueIsNotQuoted": {
+        "WEB1079": {
           "id": "WEB1079",
           "shortDescription": "The attribute value is not quoted.",
           "messageFormats": {
             "default": "The  value of the '{0}' attribute is not quoted. Wrap the attribute value in single or double quotes."
           }
         },
-        "WEB1066.TagNameIsNotLowercase": {
+        "WEB1066": {
           "id": "WEB1066",
           "shortDescription": "The tag name is not lowercase.",
           "messageFormats": {

diff --git a/src/Sarif.UnitTests/TestData/SarifCurrentToVersionOneVisitor/Inputs/OneRunWithRules.sarif b/src/Sarif.UnitTests/TestData/SarifCurrentToVersionOneVisitor/Inputs/OneRunWithRules.sarif
@@ -9,25 +9,29 @@
       },
       "results": [
         {
-          "ruleId": "C2009",
+          "ruleId": "C2001",
+          "ruleIndex":  0,
           "message": { "text": "Some testing occurred." }
         },
         {
           "ruleId": "C2002",
+          "ruleIndex": 1,
           "message": { "text": "Some testing occurred." }
         },
         {
           "ruleId": "C2003",
+          "ruleIndex": 2,
           "message": { "text": "Some testing occurred." }
         },
         {
-          "ruleId": "C2003-1",
+          "ruleId": "C2003",
+          "ruleIndex": 3,
           "message": { "text": "Some testing occurred." }
         }
       ],
       "resources": {
-        "rules": {
-          "C2001": {
+        "rules": [
+          {
             "id": "C2001",
             "shortDescription": {
               "text": "A variable was used without being initialized."
@@ -39,7 +43,7 @@
               "some_key": "FoxForceFive"
             }
           },
-          "C2002": {
+          {
             "id": "C2002",
             "fullDescription": {
               "text": "Catfish season continuous hen lamb include dose copy grant."
@@ -50,19 +54,31 @@
             },
             "helpUri": "http://www.domain.com/rules/c2002.html"
           },
-          "C2003-1": {
+          {
             "id": "C2003",
             "name": {
-              "text": "Rule C2003"
+              "text": "Rule C2003 for C#"
             },
             "shortDescription": {
-              "text": "Rules were meant to be broken."
+              "text": "C# rules were meant to be broken."
+            },
+            "fullDescription": {
+              "text": "Rent internal rebellion competence biography photograph."
+            }
+          },
+          {
+            "id": "C2003",
+            "name": {
+              "text": "Rule C2003 for VB"
+            },
+            "shortDescription": {
+              "text": "VB rules were meant to be broken."
             },
             "fullDescription": {
               "text": "Rent internal rebellion competence biography photograph."
             }
           }
-        }
+        ]
       }
     }
   ]

diff --git a/src/Sarif.UnitTests/Visitors/SarifCurrentToVersionOneVisitorTests.cs b/src/Sarif.UnitTests/Visitors/SarifCurrentToVersionOneVisitorTests.cs
@@ -44,23 +44,21 @@ protected override string ConstructTestOutputFromInputResource(string inputResou
         [Fact]
         public void SarifTransformerTests_ToVersionOne_OneRunWithFiles() => RunTest("OneRunWithFiles.sarif");
 
-#if TRANSFORM_CODE_AUTHORED
         [Fact]
         public void SarifTransformerTests_ToVersionOne_OneRunWithRules() => RunTest("OneRunWithRules.sarif");
-#endif
+
         [Fact]
         public void SarifTransformerTests_ToVersionOne_OneRunWithBasicInvocation() => RunTest("OneRunWithBasicInvocation.sarif");
 
         [Fact]
         public void SarifTransformerTests_ToVersionOne_NotificationExceptionWithStack() => RunTest("NotificationExceptionWithStack.sarif");
 
-#if TRANSFORM_CODE_AUTHORED
         [Fact]
         public void SarifTransformerTests_ToVersionOne_ResultLocations() => RunTest("ResultLocations.sarif");
 
         [Fact]
         public void SarifTransformerTests_ToVersionOne_TwoResultsWithFixes() => RunTest("TwoResultsWithFixes.sarif");
-#endif
+
         [Fact]
         public void SarifTransformerTests_ToVersionOne_Regions() => RunTest("Regions.sarif");
     }

diff --git a/src/Sarif/Schemata/sarif-schema.json b/src/Sarif/Schemata/sarif-schema.json
@@ -1,6 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
-  "title": "Static Analysis Results Format (SARIF) Version 2.0.0-csd.2.beta.2018-10-10 JSON Schema",
+  "title": "Static Analysis Results Format (SARIF) Version 2.0.0-csd.2.beta.2018-11-28 JSON Schema",
   "description": "Static Analysis Results Format (SARIF) Version 2.0.0-csd.2.beta-2018-11-28 JSON Schema: a standard format for the output of static analysis tools.",
   "additionalProperties": false,
   "type": "object",
@@ -347,7 +347,7 @@
           "description": "An array of external property files containing run.results arrays to be merged with the root log file.",
           "type": "array",
           "minItems": 1,
-          "uniqueItems": true,
+          "uniqueItems": false,
           "items": {
             "$ref": "#/definitions/externalPropertyFile"
           }
@@ -1002,10 +1002,17 @@
         },
 
         "ruleId": {
-          "description": "The stable, unique identifier of the rule (if any) to which this notification is relevant. This member can be used to retrieve rule metadata from the rules dictionary, if it exists.",
+          "description": "The stable, unique identifier of the rule, if any, to which this notification is relevant.",
           "type": "string"
         },
 
+        "ruleIndex": {
+          "description": "The index within the run resources array of the rule object, if any, associated with this notification.",
+          "type": "integer",
+          "default": -1,
+          "minimum": -1
+        },
+
         "physicalLocation": {
           "description": "The file and region relevant to this notification.",
           "$ref": "#/definitions/physicalLocation"
@@ -1274,7 +1281,7 @@
       "properties": {
 
         "ruleId": {
-          "description": "The stable, unique identifier of the rule (if any) to which this notification is relevant. This member can be used to retrieve rule metadata from the rules dictionary, if it exists.",
+          "description": "The stable, unique identifier of the rule, if any, to which this notification is relevant. This member can be used to retrieve rule metadata from the rules dictionary, if it exists.",
           "type": "string"
         },