Eliminate need to specify the SARIF contract resolver. All serializat…

src/Sarif.Converters.UnitTests/ConverterTestsBase.cs

@@ -27,13 +27,8 @@ public SarifLog RunTestCase(string inputData, string expectedResult, bool pretty
             // provided an ability to apply additional attributes to emitted code, 
             // we wouldn't be required to do this. Filed an issue on this.
             // https://github.com/Microsoft/jschema/issues/6
-
-            var settings = new JsonSerializerSettings()
-            {
-                ContractResolver = SarifContractResolver.Instance
-            };
-
-            var log = JsonConvert.DeserializeObject<SarifLog>(actualJson, settings);
+
+            var log = JsonConvert.DeserializeObject<SarifLog>(actualJson);
 
             // Pretty-printed JSON literals can consume significant space in test code,
             // so we'll provide an option to collapse into minimal form

src/Sarif.Converters/FxCopConverter.cs

@@ -84,7 +84,7 @@ public override void Convert(Stream input, IResultLogWriter output, OptionallyEm
 
             if (rules.Count > 0)
             {
-                var rulesDictionary = new Dictionary<string, IRule>();
+                IDictionary<string, IRule> rulesDictionary = new Dictionary<string, IRule>();
 
                 foreach (Rule rule in rules)
                 {

src/Sarif.Driver.UnitTests/Sdk/AnalyzeCommandBaseTests.cs

@@ -517,12 +517,7 @@ public void AnalyzeCommand_ReportsWarningOnUnsupportedPlatformForRuleAndNoRulesL
 
                 command.RuntimeErrors.Should().Be(runtimeConditions);
 
-                JsonSerializerSettings settings = new JsonSerializerSettings()
-                {
-                    ContractResolver = SarifContractResolver.Instance
-                };
-
-                SarifLog log = JsonConvert.DeserializeObject<SarifLog>(File.ReadAllText(path), settings);
+                SarifLog log = JsonConvert.DeserializeObject<SarifLog>(File.ReadAllText(path));
                 Assert.NotNull(log);
                 Assert.Equal<int>(1, log.Runs.Count);
 

src/Sarif.Driver.UnitTests/TestRuleBase.cs

@@ -54,13 +54,11 @@ public RuleConfiguration Configuration
             }
         }
 
-        public string RichDescription => throw new NotImplementedException();
-
         public IDictionary<string, string> MessageStrings { get { return new Dictionary<string, string>(); } }
 
         public IDictionary<string, string> RichMessageStrings { get { return new Dictionary<string, string>(); } }
 
-        public Message Help => throw new NotImplementedException();
+        public Message Help { get { return new Message() { Text = "[Empty]" }; } }
 
         public abstract void Analyze(TestAnalysisContext context);
 

src/Sarif.Driver/FileHelpers.cs

@@ -15,28 +15,24 @@ namespace Microsoft.CodeAnalysis.Sarif.Driver
     /// </summary>
     static class FileHelpers
     {
-        public static T ReadSarifFile<T>(string filePath)
+        public static T ReadSarifFile<T>(string filePath, IContractResolver contractResolver = null)
         {
-            return ReadSarifFile<T>(filePath, SarifContractResolver.Instance);
-        }
+            string logText = File.ReadAllText(filePath);
 
-        public static T ReadSarifFile<T>(string filePath, IContractResolver contractResolver)
-        {
-            JsonSerializerSettings settings = new JsonSerializerSettings()
+            var settings = new JsonSerializerSettings
             {
-                ContractResolver = contractResolver
+                ContractResolver  = contractResolver,
             };
 
-            string logText = File.ReadAllText(filePath);
 
-            return JsonConvert.DeserializeObject<T>(logText, settings);
+            return JsonConvert.DeserializeObject<T>(logText);
         }
 
-        public static void WriteSarifFile<T>(T sarifFile, string outputName, Formatting formatting)
+        public static void WriteSarifFile<T>(T sarifFile, string outputName, Formatting formatting = Formatting.None, IContractResolver contractResolver = null)
         {
             var settings = new JsonSerializerSettings
             {
-                ContractResolver = SarifContractResolver.Instance,
+                ContractResolver = contractResolver,
                 Formatting = formatting
             };
 

src/Sarif.Driver/Sdk/ExportRulesMetadataCommandBase.cs

@@ -155,7 +155,6 @@ private void OutputSarifRulesMetada(string outputFilePath, ImmutableArray<IRule>
 
             var settings = new JsonSerializerSettings()
             {
-                ContractResolver = SarifContractResolver.Instance,
                 Formatting = Newtonsoft.Json.Formatting.Indented,
             };
 

src/Sarif.FunctionalTests/PropertyBagConverterTests.cs

@@ -30,21 +30,16 @@ public void PropertyBagConverter_RoundTripsStringPropertyWithEscapedCharacters()
     }
   ]
 }";
-            var serializerSettings = new JsonSerializerSettings
-            {
-                ContractResolver = SarifContractResolver.Instance,
-                Formatting = Formatting.Indented
-            };
-
-            SarifLog deserializedLog = JsonConvert.DeserializeObject<SarifLog>(originalLog, serializerSettings);
+            var settings = new JsonSerializerSettings { Formatting = Formatting.Indented };
+            SarifLog deserializedLog = JsonConvert.DeserializeObject<SarifLog>(originalLog);
             Run run = deserializedLog.Runs[0];
 
             int integerProperty = run.GetProperty<int>("int");
             integerProperty.Should().Be(42);
             string stringProperty = run.GetProperty<string>("string");
             stringProperty.Should().Be("'\"\\'");
 
-            string reserializedLog = JsonConvert.SerializeObject(deserializedLog, serializerSettings);
+            string reserializedLog = JsonConvert.SerializeObject(deserializedLog, settings);
 
             reserializedLog.Should().Be(originalLog);
         }

src/Sarif.FunctionalTests/SarifConverterTests.cs

@@ -107,7 +107,6 @@ private static void EnrichSarifLog(string actualFilePath)
             JsonSerializerSettings settings = new JsonSerializerSettings()
             {
                 Formatting = Formatting.Indented,
-                ContractResolver = SarifContractResolver.Instance
             };
 
             string logText = File.ReadAllText(actualFilePath);

src/Sarif.FunctionalTests/SarifLogEqualityComparerTests.cs

@@ -23,15 +23,10 @@ public void ValueEquals_ReturnsTrueForTwoIdenticalLogObjects()
             const string ComprehensiveTestSamplePath = @"v2\SpecExamples\Comprehensive.sarif";
             string comprehensiveTestSampleContents = File.ReadAllText(ComprehensiveTestSamplePath);
 
-            JsonSerializerSettings settings = new JsonSerializerSettings
-            {
-                ContractResolver = SarifContractResolver.Instance
-            };
+            SarifLog expectedLog = JsonConvert.DeserializeObject<SarifLog>(comprehensiveTestSampleContents);
+            SarifLog actualLog = JsonConvert.DeserializeObject<SarifLog>(comprehensiveTestSampleContents);
 
-            SarifLog expected = JsonConvert.DeserializeObject<SarifLog>(comprehensiveTestSampleContents, settings);
-            SarifLog actual = JsonConvert.DeserializeObject<SarifLog>(comprehensiveTestSampleContents, settings);
-
-            expected.ValueEquals(actual).Should().BeTrue();
+            expectedLog.ValueEquals(actualLog).Should().BeTrue();
         }
     }
 }

src/Sarif.FunctionalTests/v2/SpecExamples/Comprehensive.sarif

@@ -20,6 +20,15 @@
           "copyright": "Copyright (c) 2016 by Example Corporation. All rights reserved."
         }
       },
+      "versionControlProvenance": [
+        {
+          "uri": "https://github.com/contoso/example",
+          "branch": "master",
+          "tag": "beta1",
+          "revisionId": "abcdabcdabcdabcdabcdabcdabcdabcdabcdabcd",
+          "timestamp": "2016-07-16T00:00:00Z"
+        }
+      ],
       "originalUriBaseIds": { "TOOLS_ROOT": "file:///bin/tools/" },
       "invocations": [
         {
@@ -150,7 +159,8 @@
         "#TOOLS_ROOT#codescanner/config/collections.rsp": {
           "contents": {
             "text": "\"-input src/collections/*.cpp -log out/collections.sarif -rules all -disable C9999\"."
-          }
+          },
+          "lastModifiedTime": "2016-07-16T05:37:57Z"
         }
       },
       "logicalLocations": {
@@ -253,7 +263,12 @@
                           "text": "Variable \"ptr\" declared."
                         }
                       },
-                      "module": "platform"
+                      "module": "platform",
+                      "executionOrder": 1,
+                      "timestamp": "2016-07-16T08:01:00Z",
+                      "kind": "declaration",
+                      "nestingLevel": 0,
+                      "state": { "value": "[Not initialized}" }
                     },
                     {
                       "step": 2,
@@ -272,7 +287,9 @@
                         },
                         "fullyQualifiedLogicalName": "collections::list:add"
                       },
-                      "module": "platform"
+                      "module": "platform",
+                      "executionOrder": 2,
+                      "timestamp": "2016-07-16T08:02:00Z"
                     },
                     {
                       "step": 3,
@@ -294,7 +311,10 @@
                           "text": "Uninitialized variable \"ptr\" passed to method \"add_core\"."
                         }
                       },
-                      "module": "platform"
+                      "module": "platform",
+                      "executionOrder": 3,
+                      "timestamp": "2016-07-16T08:03:00Z",
+                      "kind": "call"
                     }
                   ]
                 }

src/Sarif.Multitool.FunctionalTests/Rules/SkimmerTestsBase.cs

@@ -15,18 +15,12 @@ public abstract class SkimmerTestsBase<TSkimmer> : SarifMultitoolTestBase
         where TSkimmer : SkimmerBase<SarifValidationContext>, new()
     {
         private readonly string _testDirectory;
-        private readonly JsonSerializerSettings _jsonSerializerSettings;
         private const string ExpectedResultsPropertyName = "expectedResults";
 
         public SkimmerTestsBase()
         {
             string ruleName = typeof(TSkimmer).Name;
             _testDirectory = Path.Combine(Environment.CurrentDirectory, TestDataDirectory, ruleName);
-
-            _jsonSerializerSettings = new JsonSerializerSettings
-            {
-                ContractResolver = SarifContractResolver.Instance
-            };
         }
 
         // For the moment, we support two different test designs.
@@ -54,7 +48,7 @@ protected void Verify(string testFileName)
 
             string inputLogContents = File.ReadAllText(targetPath);
 
-            SarifLog inputLog = JsonConvert.DeserializeObject<SarifLog>(inputLogContents, _jsonSerializerSettings);
+            SarifLog inputLog = JsonConvert.DeserializeObject<SarifLog>(inputLogContents);
 
             var skimmer = new TSkimmer();
 
@@ -106,7 +100,7 @@ protected void Verify(string testFileName)
             if (inputLog.Runs[0].TryGetProperty(ExpectedResultsPropertyName, out ExpectedValidationResults expectedResults))
             {
                 // The custom property exists. Use the new, preferred verification method.
-                SarifLog outputLog = JsonConvert.DeserializeObject<SarifLog>(actualLogContents, _jsonSerializerSettings);
+                SarifLog outputLog = JsonConvert.DeserializeObject<SarifLog>(actualLogContents);
                 Verify(outputLog.Runs[0], expectedResults);
                 resultsWereVerified = true;
             }

src/Sarif.Multitool.FunctionalTests/SarifMultitoolTestBase.cs

@@ -31,13 +31,8 @@ protected static string MakeActualFilePath(string testDirectory, string testFile
         // we perform a selective compare of just the elements we care about.
         protected static void SelectiveCompare(string actualLogContents, string expectedLogContents)
         {
-            var settings = new JsonSerializerSettings()
-            {
-                ContractResolver = SarifContractResolver.Instance
-            };
-
-            SarifLog actualLog = JsonConvert.DeserializeObject<SarifLog>(actualLogContents, settings);
-            SarifLog expectedLog = JsonConvert.DeserializeObject<SarifLog>(expectedLogContents, settings);
+            SarifLog actualLog = JsonConvert.DeserializeObject<SarifLog>(actualLogContents);
+            SarifLog expectedLog = JsonConvert.DeserializeObject<SarifLog>(expectedLogContents);
 
             SelectiveCompare(actualLog, expectedLog);
         }

src/Sarif.Multitool/Rules/DoNotUseFriendlyNameAsRuleId.cs

@@ -27,7 +27,7 @@ public class DoNotUseFriendlyNameAsRuleId : SarifValidationSkimmerBase
             nameof(RuleResources.SARIF1001_Default)
         };
 
-        protected override void Analyze(Rule rule, string ruleKey, string rulePointer)
+        protected override void Analyze(IRule rule, string ruleKey, string rulePointer)
         {
             if (rule.Id != null &&
                 rule.Name != null &&

src/Sarif.Multitool/Rules/MessagesShouldEndWithPeriod.cs

@@ -34,7 +34,7 @@ protected override IEnumerable<string> MessageResourceNames
             }
         }
 
-        protected override void Analyze(Rule rule, string ruleKey, string rulePointer)
+        protected override void Analyze(IRule rule, string ruleKey, string rulePointer)
         {
             AnalyzeMessageStrings(rule.MessageStrings, rulePointer, SarifPropertyName.MessageStrings);
             AnalyzeMessageStrings(rule.RichMessageStrings, rulePointer, SarifPropertyName.RichMessageStrings);

src/Sarif.Multitool/Rules/SarifValidationSkimmerBase.cs

@@ -120,7 +120,7 @@ protected virtual void Analyze(Result result, string resultPointer)
         {
         }
 
-        protected virtual void Analyze(Rule rule, string ruleKey, string rulePointer)
+        protected virtual void Analyze(IRule rule, string ruleKey, string rulePointer)
         {
         }
         protected virtual void Analyze(Run run, string runPointer)
@@ -542,7 +542,7 @@ private void Visit(Resources resources, string resourcesPointer)
             }
         }
 
-        private void Visit(Rule rule, string ruleKey, string rulePointer)
+        private void Visit(IRule rule, string ruleKey, string rulePointer)
         {
             Analyze(rule, ruleKey, rulePointer);
         }

src/Sarif.Multitool/Rules/UriMustBeAbsolute.cs

@@ -48,7 +48,7 @@ protected override void Analyze(Result result, string resultPointer)
             }
         }
 
-        protected override void Analyze(Rule rule, string ruleKey, string rulePointer)
+        protected override void Analyze(IRule rule, string ruleKey, string rulePointer)
         {
             AnalyzeUri(rule.HelpUri, rulePointer.AtProperty(SarifPropertyName.HelpUri));
         }

src/Sarif.Multitool/Rules/UrisMustBeValid.cs

@@ -84,7 +84,7 @@ protected override void Analyze(Result result, string resultPointer)
             }
         }
 
-        protected override void Analyze(Rule rule, string ruleKey, string rulePointer)
+        protected override void Analyze(IRule rule, string ruleKey, string rulePointer)
         {
             AnalyzeUri(rule.HelpUri, rulePointer.AtProperty(SarifPropertyName.HelpUri));
         }

src/Sarif.Multitool/ValidateCommand.cs

@@ -75,15 +75,10 @@ protected override SarifValidationContext CreateContext(ValidateOptions options,
 
         private static SarifLog Deserialize(string logContents)
         {
-            JsonSerializerSettings settings = new JsonSerializerSettings
-            {
-                ContractResolver = SarifContractResolver.Instance
-            };
-
             SarifLog log = null;
             try
             {
-                return JsonConvert.DeserializeObject<SarifLog>(logContents, settings);
+                return JsonConvert.DeserializeObject<SarifLog>(logContents);
             }
             catch (JsonSerializationException)
             {

src/Sarif.TestUtilities/FileDiffingTests.cs

@@ -33,7 +33,6 @@ protected static bool AreEquivalentSarifLogs(string actualSarif, string expected
 
             JsonSerializerSettings settings = new JsonSerializerSettings()
             {
-                ContractResolver = SarifContractResolver.Instance,
                 Formatting = Formatting.Indented
             };
 

src/Sarif.UnitTests/Baseline/ResultMatching/ResultMatchingBaselinerTests.cs

@@ -58,11 +58,18 @@ public void ResultMatchingBaseliner_BaselinesTwoSimpleSarifLogs()
                 AbsentResultProperties.Should().ContainKey("Run");
                 AbsentResultProperties["Run"].Should().BeEquivalentTo(baselineLog.Runs[0].InstanceGuid);
 
-                calculatedNextBaseline.Runs[0].Results.Where(r => r.BaselineState == BaselineState.Existing).Should().HaveCount(currentLog.Runs[0].Results.Count - 1);
 
-                calculatedNextBaseline.Runs[0].Results.Where(r => r.BaselineState == BaselineState.Existing).First().TryGetProperty(SarifLogResultMatcher.ResultMatchingResultPropertyName, out Dictionary<string, string> CurrentResultProperties).Should().BeTrue();
-                CurrentResultProperties.Should().ContainKey("Run");
-                CurrentResultProperties["Run"].Should().BeEquivalentTo(currentLog.Runs[0].InstanceGuid);
+                int existingCount = currentLog.Runs[0].Results.Count - 1;
+                calculatedNextBaseline.Runs[0].Results.Where(r => r.BaselineState == BaselineState.Existing).Count().Should().Be(existingCount);
+
+                if (existingCount > 0)
+                {
+                    // In the event that we generated a SARIF run of only a single result, we will not have an 'existing' match
+                    // since we adjusted the sole result value by adding a property to it.
+                    calculatedNextBaseline.Runs[0].Results.Where(r => r.BaselineState == BaselineState.Existing).First().TryGetProperty(SarifLogResultMatcher.ResultMatchingResultPropertyName, out Dictionary<string, string> CurrentResultProperties).Should().BeTrue();
+                    CurrentResultProperties.Should().ContainKey("Run");
+                    CurrentResultProperties["Run"].Should().BeEquivalentTo(currentLog.Runs[0].InstanceGuid);
+                }
 
                 calculatedNextBaseline.Runs[0].Results.Where(r => r.BaselineState == BaselineState.New).Should().HaveCount(1);