Incorporate schema changes for versionControlDetails.mappedTo and rule.deprecatedIds

src/ReleaseHistory.md

@@ -224,6 +224,8 @@
 * FEATURE: Fortify FPR converter improvements.
 * API Non-BREAKING: Remove uniqueness requirement from 'result.locations'.
 * API NON-BREAKING: Add 'run.newlineSequences' to schema. https://github.com/oasis-tcs/sarif-spec/issues/169
+* API NON-BREAKING: Add 'rule.deprecatedIds' to schema. https://github.com/oasis-tcs/sarif-spec/issues/293
+* API NON-BREAKING: Add 'versionControlDetails.mappedTo'. https://github.com/oasis-tcs/sarif-spec/issues/248
 * API NON-BREAKING: Add result.rank'. Add 'ruleConfiguration.defaultRank'.
 * 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

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

@@ -19,6 +19,8 @@ public abstract class TestSkimmerBase : SkimmerBase<TestAnalysisContext>
 
         public override string Id => throw new NotImplementedException();
 
+        public override IList<string> DeprecatedIds => throw new NotImplementedException();
+
         public override Message FullDescription => throw new NotImplementedException();
 
         protected override ResourceManager ResourceManager => throw new NotImplementedException();

src/Sarif.Driver.UnitTests/TestRuleBase.cs

@@ -3,7 +3,6 @@
 
 using System;
 using System.Collections.Generic;
-using Microsoft.CodeAnalysis.Sarif.Readers;
 
 namespace Microsoft.CodeAnalysis.Sarif.Driver
 {
@@ -22,22 +21,19 @@ public virtual SupportedPlatform SupportedPlatforms
         public Uri HelpUri { get; set; }
 
         public abstract string Id { get; }
+        public virtual IList<string> DeprecatedIds => null;
 
-        public virtual ResultLevel DefaultLevel { get { return ResultLevel.Warning; } }
+        public virtual ResultLevel DefaultLevel => ResultLevel.Warning;
 
-        public virtual Message Name { get { return new Message { Text = this.GetType().Name }; } }
+        public virtual Message Name => new Message { Text = this.GetType().Name };
 
-        public virtual Message FullDescription { get { return new Message { Text = this.GetType().Name + " full description." }; } }
+        public virtual Message FullDescription => new Message { Text = this.GetType().Name + " full description." };
 
-        public virtual Message ShortDescription { get { return new Message { Text = this.GetType().Name + " short description." }; } }
+        public virtual Message ShortDescription => new Message { Text = this.GetType().Name + " short description." };
 
         public IDictionary<string, string> MessageFormats
-        {
-            get
-            {
-                return new Dictionary<string, string> { { nameof(SdkResources.NotApplicable_InvalidMetadata), SdkResources.NotApplicable_InvalidMetadata } };
-            }
-        }
+            => new Dictionary<string, string> { { nameof(SdkResources.NotApplicable_InvalidMetadata), SdkResources.NotApplicable_InvalidMetadata } };
+
 
         internal override IDictionary<string, SerializedPropertyInfo> Properties { get; set; }
 
@@ -54,11 +50,11 @@ public RuleConfiguration Configuration
             }
         }
 
-        public IDictionary<string, string> MessageStrings { get { return new Dictionary<string, string>(); } }
+        public IDictionary<string, string> MessageStrings => new Dictionary<string, string>();
 
-        public IDictionary<string, string> RichMessageStrings { get { return new Dictionary<string, string>(); } }
+        public IDictionary<string, string> RichMessageStrings => new Dictionary<string, string>();
 
-        public Message Help { get { return new Message() { Text = "[Empty]" }; } }
+        public Message Help => new Message() { Text = "[Empty]" };
 
         public abstract void Analyze(TestAnalysisContext context);
 
@@ -70,7 +66,6 @@ public virtual AnalysisApplicability CanAnalyze(TestAnalysisContext context, out
 
         public virtual void Initialize(TestAnalysisContext context)
         {
-
         }
     }
 }

src/Sarif.Driver/Sdk/SkimmerBase.cs

@@ -67,6 +67,9 @@ private Dictionary<string, string> InitializeRichMessageStrings()
 
         abstract public string Id { get; }
 
+        // This one isn't abstract because there's no point in forcing every skimmer to implement it.
+        public virtual IList<string> DeprecatedIds => null;
+
         abstract public Message FullDescription { get; }
 
         public virtual Message ShortDescription

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

@@ -38,7 +38,11 @@
           "branch": "master",
           "tag": "beta1",
           "revisionId": "abcdabcdabcdabcdabcdabcdabcdabcdabcdabcd",
-          "timestamp": "2016-07-16T00:00:00Z"
+          "timestamp": "2016-07-16T00:00:00Z",
+          "mappedTo": {
+            "uri": "/example",
+            "uriBaseId": "SRCROOT"
+          }
         }
       ],
       "originalUriBaseIds": { "TOOLS_ROOT": "file:///bin/tools/" },
@@ -401,14 +405,6 @@
               ]
             }
           ],
-          "provenance": {
-            "firstDetectionTimeUtc": "2018-07-15T14:20:42Z",
-            "firstDetectionRunInstanceGuid": "8F62D8A0-C14F-4516-9959-1A663BA6FB99",
-            "lastDetectionTimeUtc": "2018-07-16T14:20:42Z",
-            "lastDetectionRunInstanceGuid": "BC650830-A9FE-44CB-8818-AD6C387279A0",
-            "invocationIndex": 0,
-            "conversionSources": []
-          },
           "fixes": [
             {
               "description": {
@@ -439,6 +435,10 @@
         "rules": {
           "C2001": {
             "id": "C2001",
+            "deprecatedIds": [
+              "C0001",
+              "C1001"
+            ],
             "shortDescription": {
               "text": "A variable was used without being initialized."
             },

src/Sarif.Multitool.FunctionalTests/TestData/UriBaseIdRequiresRelativeUri/Invalid.sarif

@@ -243,6 +243,16 @@
           ]
         }
       ],
+      "versionControlProvenance": [
+        {
+          "repositoryUri": "https://github.com/example-corp/browser",
+          "revisionId": "de67ef7",
+          "mappedTo": {
+            "uri": "file:///C:/src/file.c",
+            "uriBaseId": "%SRCROOT%"
+          }
+        }
+      ],
       "properties": {
         "expectedResults": {
           "resultLocationPointers": [
@@ -266,7 +276,8 @@
             "runs[0].results[0].relatedLocations[0].physicalLocation.fileLocation.uri",
             "runs[0].results[0].codeFlows[0].threadFlows[0].locations[0].location.physicalLocation.fileLocation.uri",
             "runs[0].results[0].stacks[0].frames[0].location.physicalLocation.fileLocation.uri",
-            "runs[0].results[0].fixes[0].fileChanges[0].fileLocation.uri"
+            "runs[0].results[0].fixes[0].fileChanges[0].fileLocation.uri",
+            "runs[0].versionControlProvenance[0].mappedTo.uri"
           ]
         }
       }

src/Sarif.Multitool.FunctionalTests/TestData/UriBaseIdRequiresRelativeUri/Valid.sarif

@@ -243,6 +243,16 @@
           ]
         }
       ],
+      "versionControlProvenance": [
+        {
+          "repositoryUri": "https://github.com/example-corp/browser",
+          "revisionId": "de67ef7",
+          "mappedTo": {
+            "uri": "/browser",
+            "uriBaseId": "%SRCROOT%"
+          }
+        }
+      ],
       "properties": {
         "expectedResults": {
           "resultLocationPointers": []

src/Sarif.Multitool/Rules/SarifValidationSkimmerBase.cs

@@ -835,6 +835,11 @@ private void Visit(Tool tool, string toolPointer)
         private void Visit(VersionControlDetails versionControlDetails, string versionControlDetailsPointer)
         {
             Analyze(versionControlDetails, versionControlDetailsPointer);
+
+            if (versionControlDetails.MappedTo != null)
+            {
+                Visit(versionControlDetails.MappedTo, versionControlDetailsPointer.AtProperty(SarifPropertyName.MappedTo));
+            }
         }
 
         private Region GetRegionFromJPointer(string jPointer)

src/Sarif.Multitool/SarifPropertyName.cs

@@ -38,6 +38,7 @@ public static class SarifPropertyName
         public const string Location = "location";
         public const string Locations = "locations";
         public const string LogicalLocations = "logicalLocations";
+        public const string MappedTo = "mappedTo";
         public const string Message = "message";
         public const string MessageStrings = "messageStrings";
         public const string Nodes = "nodes";

src/Sarif.UnitTests/Visitors/RebaseUriVisitorTests.cs

@@ -209,7 +209,7 @@ public void RebaseUriVisitor_VisitFileData_RebasesAllTheThings()
             visitor.FileDataKeys.Where(k => k != null && k.StartsWith(uriRootText)).Count().Should().Be(3);
             visitor.FileDataKeys.Where(k => k != null && k.StartsWith("#" + toolsRootBaseId + "#")).Count().Should().Be(1);
 
-            int uriCount = 16;
+            int uriCount = 17;
 
             visitor.FileLocationUriBaseIds.Count.Should().Be(uriCount);
             visitor.FileLocationUriBaseIds.Where(u => u == null).Count().Should().Be(13);
@@ -240,7 +240,7 @@ public void RebaseUriVisitor_VisitFileData_RebasesAllTheThings()
             visitor.FileLocationUriBaseIds.Where(u => u == toolsRootBaseId).Count().Should().Be(3);
             visitor.FileLocationUriBaseIds.Where(u => u == agentRootBaseId).Count().Should().Be(11);
 
-            visitor.FileLocationUris.Count.Should().Be(17);
+            visitor.FileLocationUris.Count.Should().Be(uriCount + 1);
 
             // The AGENT_ROOT originalUriBaseId is the last thing that will include the uriRootText value
             visitor.FileLocationUris.Where(u => u != null && u.StartsWith(uriRootText)).Count().Should().Be(1);

src/Sarif/Autogenerated/IRule.cs

@@ -19,6 +19,11 @@ public partial interface IRule
         /// </summary>
         string Id { get; }
 
+        /// <summary>
+        /// An array of stable, opaque identifiers by which this rule was known in some previous version of the analysis tool.
+        /// </summary>
+        IList<string> DeprecatedIds { get; }
+
         /// <summary>
         /// A rule identifier that is understandable to an end user.
         /// </summary>

src/Sarif/Autogenerated/Rule.cs

@@ -39,6 +39,12 @@ public SarifNodeKind SarifNodeKind
         [DataMember(Name = "id", IsRequired = false, EmitDefaultValue = false)]
         public string Id { get; set; }
 
+        /// <summary>
+        /// An array of stable, opaque identifiers by which this rule was known in some previous version of the analysis tool.
+        /// </summary>
+        [DataMember(Name = "deprecatedIds", IsRequired = false, EmitDefaultValue = false)]
+        public IList<string> DeprecatedIds { get; set; }
+
         /// <summary>
         /// A rule identifier that is understandable to an end user.
         /// </summary>
@@ -107,6 +113,9 @@ public Rule()
         /// <param name="id">
         /// An initialization value for the <see cref="P: Id" /> property.
         /// </param>
+        /// <param name="deprecatedIds">
+        /// An initialization value for the <see cref="P: DeprecatedIds" /> property.
+        /// </param>
         /// <param name="name">
         /// An initialization value for the <see cref="P: Name" /> property.
         /// </param>
@@ -134,9 +143,9 @@ public Rule()
         /// <param name="properties">
         /// An initialization value for the <see cref="P: Properties" /> property.
         /// </param>
-        public Rule(string id, Message name, Message shortDescription, Message fullDescription, IDictionary<string, string> messageStrings, IDictionary<string, string> richMessageStrings, RuleConfiguration configuration, Uri helpUri, Message help, IDictionary<string, SerializedPropertyInfo> properties)
+        public Rule(string id, IEnumerable<string> deprecatedIds, Message name, Message shortDescription, Message fullDescription, IDictionary<string, string> messageStrings, IDictionary<string, string> richMessageStrings, RuleConfiguration configuration, Uri helpUri, Message help, IDictionary<string, SerializedPropertyInfo> properties)
         {
-            Init(id, name, shortDescription, fullDescription, messageStrings, richMessageStrings, configuration, helpUri, help, properties);
+            Init(id, deprecatedIds, name, shortDescription, fullDescription, messageStrings, richMessageStrings, configuration, helpUri, help, properties);
         }
 
         /// <summary>
@@ -155,7 +164,7 @@ public Rule(Rule other)
                 throw new ArgumentNullException(nameof(other));
             }
 
-            Init(other.Id, other.Name, other.ShortDescription, other.FullDescription, other.MessageStrings, other.RichMessageStrings, other.Configuration, other.HelpUri, other.Help, other.Properties);
+            Init(other.Id, other.DeprecatedIds, other.Name, other.ShortDescription, other.FullDescription, other.MessageStrings, other.RichMessageStrings, other.Configuration, other.HelpUri, other.Help, other.Properties);
         }
 
         ISarifNode ISarifNode.DeepClone()
@@ -176,9 +185,20 @@ private ISarifNode DeepCloneCore()
             return new Rule(this);
         }
 
-        private void Init(string id, Message name, Message shortDescription, Message fullDescription, IDictionary<string, string> messageStrings, IDictionary<string, string> richMessageStrings, RuleConfiguration configuration, Uri helpUri, Message help, IDictionary<string, SerializedPropertyInfo> properties)
+        private void Init(string id, IEnumerable<string> deprecatedIds, Message name, Message shortDescription, Message fullDescription, IDictionary<string, string> messageStrings, IDictionary<string, string> richMessageStrings, RuleConfiguration configuration, Uri helpUri, Message help, IDictionary<string, SerializedPropertyInfo> properties)
         {
             Id = id;
+            if (deprecatedIds != null)
+            {
+                var destination_0 = new List<string>();
+                foreach (var value_0 in deprecatedIds)
+                {
+                    destination_0.Add(value_0);
+                }
+
+                DeprecatedIds = destination_0;
+            }
+
             if (name != null)
             {
                 Name = new Message(name);

src/Sarif/Autogenerated/RuleEqualityComparer.cs

@@ -33,6 +33,27 @@ public bool Equals(Rule left, Rule right)
                 return false;
             }
 
+            if (!object.ReferenceEquals(left.DeprecatedIds, right.DeprecatedIds))
+            {
+                if (left.DeprecatedIds == null || right.DeprecatedIds == null)
+                {
+                    return false;
+                }
+
+                if (left.DeprecatedIds.Count != right.DeprecatedIds.Count)
+                {
+                    return false;
+                }
+
+                for (int index_0 = 0; index_0 < left.DeprecatedIds.Count; ++index_0)
+                {
+                    if (left.DeprecatedIds[index_0] != right.DeprecatedIds[index_0])
+                    {
+                        return false;
+                    }
+                }
+            }
+
             if (!Message.ValueComparer.Equals(left.Name, right.Name))
             {
                 return false;
@@ -147,6 +168,18 @@ public int GetHashCode(Rule obj)
                     result = (result * 31) + obj.Id.GetHashCode();
                 }
 
+                if (obj.DeprecatedIds != null)
+                {
+                    foreach (var value_6 in obj.DeprecatedIds)
+                    {
+                        result = result * 31;
+                        if (value_6 != null)
+                        {
+                            result = (result * 31) + value_6.GetHashCode();
+                        }
+                    }
+                }
+
                 if (obj.Name != null)
                 {
                     result = (result * 31) + obj.Name.ValueGetHashCode();
@@ -166,12 +199,12 @@ public int GetHashCode(Rule obj)
                 {
                     // Use xor for dictionaries to be order-independent.
                     int xor_0 = 0;
-                    foreach (var value_6 in obj.MessageStrings)
+                    foreach (var value_7 in obj.MessageStrings)
                     {
-                        xor_0 ^= value_6.Key.GetHashCode();
-                        if (value_6.Value != null)
+                        xor_0 ^= value_7.Key.GetHashCode();
+                        if (value_7.Value != null)
                         {
-                            xor_0 ^= value_6.Value.GetHashCode();
+                            xor_0 ^= value_7.Value.GetHashCode();
                         }
                     }
 
@@ -182,12 +215,12 @@ public int GetHashCode(Rule obj)
                 {
                     // Use xor for dictionaries to be order-independent.
                     int xor_1 = 0;
-                    foreach (var value_7 in obj.RichMessageStrings)
+                    foreach (var value_8 in obj.RichMessageStrings)
                     {
-                        xor_1 ^= value_7.Key.GetHashCode();
-                        if (value_7.Value != null)
+                        xor_1 ^= value_8.Key.GetHashCode();
+                        if (value_8.Value != null)
                         {
-                            xor_1 ^= value_7.Value.GetHashCode();
+                            xor_1 ^= value_8.Value.GetHashCode();
                         }
                     }
 
@@ -213,12 +246,12 @@ public int GetHashCode(Rule obj)
                 {
                     // Use xor for dictionaries to be order-independent.
                     int xor_2 = 0;
-                    foreach (var value_8 in obj.Properties)
+                    foreach (var value_9 in obj.Properties)
                     {
-                        xor_2 ^= value_8.Key.GetHashCode();
-                        if (value_8.Value != null)
+                        xor_2 ^= value_9.Key.GetHashCode();
+                        if (value_9.Value != null)
                         {
-                            xor_2 ^= value_8.Value.GetHashCode();
+                            xor_2 ^= value_9.Value.GetHashCode();
                         }
                     }
 

src/Sarif/Autogenerated/SarifRewritingVisitor.cs

@@ -873,6 +873,7 @@ public virtual VersionControlDetails VisitVersionControlDetails(VersionControlDe
         {
             if (node != null)
             {
+                node.MappedTo = VisitNullChecked(node.MappedTo);
             }
 
             return node;