Add new visitor to get deterministic SARIF log by sorting results

src/ReleaseHistory.md

@@ -8,6 +8,7 @@
 * BREAKING: `SarifLogger` now emits an artifacts table entry if `artifactLocation` is not null for tool configuration and tool execution notifications. [#2437](https://github.com/microsoft/sarif-sdk/pull/2437)
 * BUGFIX: Fix `ArgumentException` when `--recurse` is enabled and two file target specifiers generates the same file path. [#2438](https://github.com/microsoft/sarif-sdk/pull/2438)
 * BUGFIX: Fix 'InvalidOperationException' with message `Collection was modified; enumeration operation may not execute` in `MultithreadedAnalyzeCommandBase`, which is raised when analyzing with the `--hashes` switch. [#2447](https://github.com/microsoft/sarif-sdk/pull/2447)
+* FEATURE: Add `--sort-results` argument to `rewrite` command to get sorted SARIF results. [#2422](https://github.com/microsoft/sarif-sdk/pull/2422)
 
 ## **v2.4.12** [Sdk](https://www.nuget.org/packages/Sarif.Sdk/2.4.12) | [Driver](https://www.nuget.org/packages/Sarif.Driver/2.4.12) | [Converters](https://www.nuget.org/packages/Sarif.Converters/2.4.12) | [Multitool](https://www.nuget.org/packages/Sarif.Multitool/2.4.12) | [Multitool Library](https://www.nuget.org/packages/Sarif.Multitool.Library/2.4.12)
 

src/Sarif.Multitool.Library/RewriteCommand.cs

@@ -59,6 +59,11 @@ public int Run(RewriteOptions options)
                 SarifLog reformattedLog = new RemoveOptionalDataVisitor(dataToRemove).VisitSarifLog(actualLog);
                 reformattedLog = new InsertOptionalDataVisitor(dataToInsert, originalUriBaseIds, insertProperties: options.InsertProperties).VisitSarifLog(reformattedLog);
 
+                if (options.SortResults)
+                {
+                    reformattedLog = new SortingVisitor().VisitSarifLog(reformattedLog);
+                }
+
                 if (options.SarifOutputVersion == SarifVersion.OneZeroZero)
                 {
                     var visitor = new SarifCurrentToVersionOneVisitor();

src/Sarif.Multitool.Library/RewriteOptions.cs

@@ -10,5 +10,11 @@ namespace Microsoft.CodeAnalysis.Sarif.Multitool
     [Verb("rewrite", HelpText = "Enrich a SARIF file with additional data.")]
     public class RewriteOptions : SingleFileOptionsBase
     {
+        [Option(
+            's',
+            "sort-results",
+            Default = false,
+            HelpText = "Sort results in the final output file.")]
+        public bool SortResults { get; set; }
     }
 }

src/Sarif/Comparers/ArtifactComparer.cs

@@ -0,0 +1,112 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System.Collections.Generic;
+
+/// <summary>
+/// Note: This comparer may not have all properties compared. Will be replaced by comprehensive
+/// comparer generated by JSchema as part of EqualityComparer in a planned comprehensive solution.
+/// Tracking by issue: https://github.com/microsoft/jschema/issues/141
+/// </summary>
+namespace Microsoft.CodeAnalysis.Sarif.Comparers
+{
+    internal class ArtifactComparer : IComparer<Artifact>
+    {
+        internal static readonly ArtifactComparer Instance = new ArtifactComparer();
+
+        public int Compare(Artifact left, Artifact right)
+        {
+            if (ComparerHelper.CompareReference(left, right, out int compareResult))
+            {
+                return compareResult;
+            }
+
+            compareResult = MessageComparer.Instance.Compare(left.Description, right.Description);
+
+            if (compareResult != 0)
+            {
+                return compareResult;
+            }
+
+            compareResult = ArtifactLocationComparer.Instance.Compare(left.Location, right.Location);
+
+            if (compareResult != 0)
+            {
+                return compareResult;
+            }
+
+            compareResult = left.ParentIndex.CompareTo(right.ParentIndex);
+
+            if (compareResult != 0)
+            {
+                return compareResult;
+            }
+
+            compareResult = left.Offset.CompareTo(right.Offset);
+
+            if (compareResult != 0)
+            {
+                return compareResult;
+            }
+
+            compareResult = left.Length.CompareTo(right.Length);
+
+            if (compareResult != 0)
+            {
+                return compareResult;
+            }
+
+            compareResult = left.Roles.CompareTo(right.Roles);
+
+            if (compareResult != 0)
+            {
+                return compareResult;
+            }
+
+            compareResult = string.Compare(left.MimeType, right.MimeType);
+
+            if (compareResult != 0)
+            {
+                return compareResult;
+            }
+
+            compareResult = ArtifactContentComparer.Instance.Compare(left.Contents, right.Contents);
+
+            if (compareResult != 0)
+            {
+                return compareResult;
+            }
+
+            compareResult = string.Compare(left.Encoding, right.Encoding);
+
+            if (compareResult != 0)
+            {
+                return compareResult;
+            }
+
+            compareResult = string.Compare(left.SourceLanguage, right.SourceLanguage);
+
+            if (compareResult != 0)
+            {
+                return compareResult;
+            }
+
+            compareResult = ComparerHelper.CompareDictionary(left.Hashes, right.Hashes);
+
+            if (compareResult != 0)
+            {
+                return compareResult;
+            }
+
+            compareResult = left.LastModifiedTimeUtc.CompareTo(right.LastModifiedTimeUtc);
+
+            if (compareResult != 0)
+            {
+                return compareResult;
+            }
+
+            // Note: There may be other properties are not compared.
+            return compareResult;
+        }
+    }
+}

src/Sarif/Comparers/ArtifactContentComparer.cs

@@ -0,0 +1,49 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System.Collections.Generic;
+
+/// <summary>
+/// Note: This comparer may not have all properties compared. Will be replaced by comprehensive
+/// comparer generated by JSchema as part of EqualityComparer in a planned comprehensive solution.
+/// Tracking by issue: https://github.com/microsoft/jschema/issues/141
+/// </summary>
+namespace Microsoft.CodeAnalysis.Sarif.Comparers
+{
+    internal class ArtifactContentComparer : IComparer<ArtifactContent>
+    {
+        internal static readonly ArtifactContentComparer Instance = new ArtifactContentComparer();
+
+        public int Compare(ArtifactContent left, ArtifactContent right)
+        {
+            if (ComparerHelper.CompareReference(left, right, out int compareResult))
+            {
+                return compareResult;
+            }
+
+            compareResult = string.Compare(left.Text, right.Text);
+
+            if (compareResult != 0)
+            {
+                return compareResult;
+            }
+
+            compareResult = string.Compare(left.Binary, right.Binary);
+
+            if (compareResult != 0)
+            {
+                return compareResult;
+            }
+
+            compareResult = MultiformatMessageStringComparer.Instance.Compare(left.Rendered, right.Rendered);
+
+            if (compareResult != 0)
+            {
+                return compareResult;
+            }
+
+            // Note: There may be other properties are not compared.
+            return compareResult;
+        }
+    }
+}

src/Sarif/Comparers/ArtifactLocationComparer.cs

@@ -0,0 +1,56 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System.Collections.Generic;
+
+/// <summary>
+/// Note: This comparer may not have all properties compared. Will be replaced by comprehensive
+/// comparer generated by JSchema as part of EqualityComparer in a planned comprehensive solution.
+/// Tracking by issue: https://github.com/microsoft/jschema/issues/141
+/// </summary>
+namespace Microsoft.CodeAnalysis.Sarif.Comparers
+{
+    internal class ArtifactLocationComparer : IComparer<ArtifactLocation>
+    {
+        internal static readonly ArtifactLocationComparer Instance = new ArtifactLocationComparer();
+
+        public int Compare(ArtifactLocation left, ArtifactLocation right)
+        {
+            if (ComparerHelper.CompareReference(left, right, out int compareResult))
+            {
+                return compareResult;
+            }
+
+            compareResult = ComparerHelper.CompareUri(left.Uri, right.Uri);
+
+            if (compareResult != 0)
+            {
+                return compareResult;
+            }
+
+            compareResult = string.Compare(left.UriBaseId, right.UriBaseId);
+
+            if (compareResult != 0)
+            {
+                return compareResult;
+            }
+
+            compareResult = left.Index.CompareTo(right.Index);
+
+            if (compareResult != 0)
+            {
+                return compareResult;
+            }
+
+            compareResult = MessageComparer.Instance.Compare(left.Description, right.Description);
+
+            if (compareResult != 0)
+            {
+                return compareResult;
+            }
+
+            // Note: There may be other properties are not compared.
+            return compareResult;
+        }
+    }
+}

src/Sarif/Comparers/CodeFlowComparer.cs

@@ -0,0 +1,42 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System.Collections.Generic;
+
+/// <summary>
+/// Note: This comparer may not have all properties compared. Will be replaced by comprehensive
+/// comparer generated by JSchema as part of EqualityComparer in a planned comprehensive solution.
+/// Tracking by issue: https://github.com/microsoft/jschema/issues/141
+/// </summary>
+namespace Microsoft.CodeAnalysis.Sarif.Comparers
+{
+    internal class CodeFlowComparer : IComparer<CodeFlow>
+    {
+        internal static readonly CodeFlowComparer Instance = new CodeFlowComparer();
+
+        public int Compare(CodeFlow left, CodeFlow right)
+        {
+            if (ComparerHelper.CompareReference(left, right, out int compareResult))
+            {
+                return compareResult;
+            }
+
+            compareResult = MessageComparer.Instance.Compare(left.Message, right.Message);
+
+            if (compareResult != 0)
+            {
+                return compareResult;
+            }
+
+            compareResult = ComparerHelper.CompareList(left.ThreadFlows, right.ThreadFlows, ThreadFlowComparer.Instance);
+
+            if (compareResult != 0)
+            {
+                return compareResult;
+            }
+
+            // Note: There may be other properties are not compared.
+            return compareResult;
+        }
+    }
+}