SARIF OM changes for nullable int batch 1

ReleaseHistory.md

@@ -1,5 +1,6 @@
 # SARIF Package Release History (SDK, Driver, Converters, and Multitool)
 ## **v4.2.0** UNRELEASED
+* BRK: Update `Artifact.Offset`, `Invocation.ExitCode`, `Invocation.ExitSignalNumber`, `Invocation.ProcessId`, `Result.OccurrenceCount`, `EdgeTraversal.StepOverEdgeCount`, `Notification.ThreadId`, `StackFrame.ThreadId`, `ThreadFlowLocation.NestingLevel`, and `WebResponse.StatusCode` properties from `int` to `int?` type. [#2650](https://github.com/microsoft/sarif-sdk/pull/2650)
 * BRK: Command-line argument `automationGuid` renamed to `automation-guid`. [#2647](https://github.com/microsoft/sarif-sdk/pull/2647)
 * BRK: Command-line argument `automationId` renamed to `automation-id`. [#2647](https://github.com/microsoft/sarif-sdk/pull/2647)
 * BRK: Update `AnalyzeOptionsBase` `Quiet`, `Recurse`, `LogEnvironment`, and `RichReturnCode` properties to bool? type. [#2644](https://github.com/microsoft/sarif-sdk/pull/2644)
@@ -14,6 +15,7 @@
 * BUG: Generate `IAnalysisLogger.AnalyzingTarget` callbacks from `MulthreadedAnalyzeCommandBase`. [#2637](https://github.com/microsoft/sarif-sdk/pull/2637)
 * BUG: Persist `fileRegionsCache` parameter in `SarifLogger` to support retrieving hash data. [#2639](https://github.com/microsoft/sarif-sdk/pull/2639)
 * BUG: Allow override of `FailureLevels` and `ResultKinds` in context objects. [#2639](https://github.com/microsoft/sarif-sdk/pull/2639)
+* NEW: Update `Microsoft.Json.Schema.*` packages from 2.1.0.0 to 2.3.0.0. [#2650](https://github.com/microsoft/sarif-sdk/pull/2650)
 * NEW: Add `AnalyzeContext.VersionControlProvenance` property. [#2646](https://github.com/microsoft/sarif-sdk/pull/2646)
 * NEW: Add `DefaultTraces.ResultsSummary` property that drives naive results summary in console logger. [#2643](https://github.com/microsoft/sarif-sdk/pull/2643)
 * NEW: Prove `AnalyzeContextBase.Inline` helper. [#2643](https://github.com/microsoft/sarif-sdk/pull/2643)

src/Samples/SarifToCsv/SarifCsvColumnWriters.cs

@@ -106,7 +106,7 @@ private static Dictionary<string, Action<WriteContext>> BuildWriters()
             writers["Kind"] = (c) => { c.Writer.Write(c.Result.Kind.ToString()); };
             writers["Level"] = (c) => { c.Writer.Write(c.Result.Level.ToString()); };
             writers["Message.Text"] = (c) => { c.Writer.Write(c.Result.Message?.Text ?? ""); };
-            writers["OccurrenceCount"] = (c) => { c.Writer.Write(c.Result.OccurrenceCount); };
+            writers["OccurrenceCount"] = (c) => { c.Writer.Write(c.Result.OccurrenceCount?.ToString() ?? ""); };
             writers["PartialFingerprints"] = (c) => { c.Writer.Write(String.Join("; ", c.Result.PartialFingerprints?.Values ?? Array.Empty<string>())); };
             writers["Provenance"] = (c) => { c.Writer.Write(c.Result.Provenance?.ToString() ?? ""); };
             writers["Rank"] = (c) => { c.Writer.Write(c.Result.Rank.ToString()); };

src/Sarif.Converters/StaticDriverVerifierConverter.cs

@@ -225,6 +225,11 @@ private void ProcessLine(string logFileLine, ref int nestingLevel, Result result
                     }
                 }
 
+                if (threadFlowLocation.NestingLevel == 0)
+                {
+                    threadFlowLocation.NestingLevel = null;
+                }
+
                 string separatorText = "^====Auto=====";
                 string state = tokens[STATE];
                 string[] stateTokens = state.Split(new string[] { separatorText }, StringSplitOptions.RemoveEmptyEntries);

src/Sarif.Multitool.Library/Sarif.Multitool.Library.csproj

@@ -15,9 +15,9 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Azure.Kusto.Data" Version="10.0.3" />
-    <PackageReference Include="Microsoft.Json.Pointer" Version="2.1.0" />
-    <PackageReference Include="Microsoft.Json.Schema" Version="2.1.0" />
-    <PackageReference Include="Microsoft.Json.Schema.Validation" Version="2.1.0" />
+    <PackageReference Include="Microsoft.Json.Pointer" Version="2.3.0" />
+    <PackageReference Include="Microsoft.Json.Schema" Version="2.3.0" />
+    <PackageReference Include="Microsoft.Json.Schema.Validation" Version="2.3.0" />
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
     <PackageReference Include="Newtonsoft.Json" Version="12.0.3" />
     <PackageReference Include="System.Threading.Channels" Version="5.0.0" />

src/Sarif/Autogenerated/Address.cs

@@ -15,7 +15,7 @@ namespace Microsoft.CodeAnalysis.Sarif
     /// A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).
     /// </summary>
     [DataContract]
-    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.1.0.0")]
+    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.3.0.0")]
     public partial class Address : PropertyBagHolder, ISarifNode
     {
         public static IEqualityComparer<Address> ValueComparer => AddressEqualityComparer.Instance;
@@ -49,13 +49,13 @@ public virtual SarifNodeKind SarifNodeKind
         /// </summary>
         [DataMember(Name = "relativeAddress", IsRequired = false, EmitDefaultValue = false)]
         [JsonProperty(DefaultValueHandling = DefaultValueHandling.IgnoreAndPopulate)]
-        public virtual int? RelativeAddress { get; set; } // NOTYETAUTOGENERATED: Property should be nullable int. https://github.com/Microsoft/jschema/issues/112
+        public virtual int? RelativeAddress { get; set; }
 
         /// <summary>
         /// The number of bytes in this range of addresses.
         /// </summary>
         [DataMember(Name = "length", IsRequired = false, EmitDefaultValue = false)]
-        public virtual int? Length { get; set; } // NOTYETAUTOGENERATED: Property should be nullable int. https://github.com/Microsoft/jschema/issues/112
+        public virtual int? Length { get; set; }
 
         /// <summary>
         /// An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values.
@@ -79,7 +79,7 @@ public virtual SarifNodeKind SarifNodeKind
         /// The byte offset of this address from the absolute or relative address of the parent object.
         /// </summary>
         [DataMember(Name = "offsetFromParent", IsRequired = false, EmitDefaultValue = false)]
-        public virtual int? OffsetFromParent { get; set; } // NOTYETAUTOGENERATED: Property should be nullable int. https://github.com/Microsoft/jschema/issues/112
+        public virtual int? OffsetFromParent { get; set; }
 
         /// <summary>
         /// The index within run.addresses of the cached object for this address.
@@ -109,7 +109,6 @@ public virtual SarifNodeKind SarifNodeKind
         public Address()
         {
             AbsoluteAddress = -1;
-            RelativeAddress = -1;
             Index = -1;
             ParentIndex = -1;
         }

src/Sarif/Autogenerated/AddressComparer.cs

@@ -10,7 +10,7 @@ namespace Microsoft.CodeAnalysis.Sarif
     /// <summary>
     /// Defines methods to support the comparison of objects of type Address for sorting.
     /// </summary>
-    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.1.0.0")]
+    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.3.0.0")]
     internal sealed class AddressComparer : IComparer<Address>
     {
         internal static readonly AddressComparer Instance = new AddressComparer();

src/Sarif/Autogenerated/AddressEqualityComparer.cs

@@ -10,7 +10,7 @@ namespace Microsoft.CodeAnalysis.Sarif
     /// <summary>
     /// Defines methods to support the comparison of objects of type Address for equality.
     /// </summary>
-    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.1.0.0")]
+    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.3.0.0")]
     internal sealed class AddressEqualityComparer : IEqualityComparer<Address>
     {
         internal static readonly AddressEqualityComparer Instance = new AddressEqualityComparer();
@@ -108,8 +108,16 @@ public int GetHashCode(Address obj)
             unchecked
             {
                 result = (result * 31) + obj.AbsoluteAddress.GetHashCode();
-                result = (result * 31) + obj.RelativeAddress.GetHashCode();
-                result = (result * 31) + obj.Length.GetHashCode();
+                if (obj.RelativeAddress != null)
+                {
+                    result = (result * 31) + obj.RelativeAddress.GetHashCode();
+                }
+
+                if (obj.Length != null)
+                {
+                    result = (result * 31) + obj.Length.GetHashCode();
+                }
+
                 if (obj.Kind != null)
                 {
                     result = (result * 31) + obj.Kind.GetHashCode();
@@ -125,7 +133,11 @@ public int GetHashCode(Address obj)
                     result = (result * 31) + obj.FullyQualifiedName.GetHashCode();
                 }
 
-                result = (result * 31) + obj.OffsetFromParent.GetHashCode();
+                if (obj.OffsetFromParent != null)
+                {
+                    result = (result * 31) + obj.OffsetFromParent.GetHashCode();
+                }
+
                 result = (result * 31) + obj.Index.GetHashCode();
                 result = (result * 31) + obj.ParentIndex.GetHashCode();
                 if (obj.Properties != null)

src/Sarif/Autogenerated/Artifact.cs

@@ -14,7 +14,7 @@ namespace Microsoft.CodeAnalysis.Sarif
     /// A single artifact. In some cases, this artifact might be nested within another artifact.
     /// </summary>
     [DataContract]
-    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.1.0.0")]
+    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.3.0.0")]
     public partial class Artifact : PropertyBagHolder, ISarifNode
     {
         public static IEqualityComparer<Artifact> ValueComparer => ArtifactEqualityComparer.Instance;
@@ -59,7 +59,7 @@ public virtual SarifNodeKind SarifNodeKind
         /// The offset in bytes of the artifact within its containing artifact.
         /// </summary>
         [DataMember(Name = "offset", IsRequired = false, EmitDefaultValue = false)]
-        public virtual int Offset { get; set; }
+        public virtual int? Offset { get; set; }
 
         /// <summary>
         /// The length of the artifact in bytes.
@@ -171,7 +171,7 @@ public Artifact()
         /// <param name="properties">
         /// An initialization value for the <see cref="P:Properties" /> property.
         /// </param>
-        public Artifact(Message description, ArtifactLocation location, int parentIndex, int offset, int length, ArtifactRoles roles, string mimeType, ArtifactContent contents, string encoding, string sourceLanguage, IDictionary<string, string> hashes, DateTime lastModifiedTimeUtc, IDictionary<string, SerializedPropertyInfo> properties)
+        public Artifact(Message description, ArtifactLocation location, int parentIndex, int? offset, int length, ArtifactRoles roles, string mimeType, ArtifactContent contents, string encoding, string sourceLanguage, IDictionary<string, string> hashes, DateTime lastModifiedTimeUtc, IDictionary<string, SerializedPropertyInfo> properties)
         {
             Init(description, location, parentIndex, offset, length, roles, mimeType, contents, encoding, sourceLanguage, hashes, lastModifiedTimeUtc, properties);
         }
@@ -213,7 +213,7 @@ private ISarifNode DeepCloneCore()
             return new Artifact(this);
         }
 
-        protected virtual void Init(Message description, ArtifactLocation location, int parentIndex, int offset, int length, ArtifactRoles roles, string mimeType, ArtifactContent contents, string encoding, string sourceLanguage, IDictionary<string, string> hashes, DateTime lastModifiedTimeUtc, IDictionary<string, SerializedPropertyInfo> properties)
+        protected virtual void Init(Message description, ArtifactLocation location, int parentIndex, int? offset, int length, ArtifactRoles roles, string mimeType, ArtifactContent contents, string encoding, string sourceLanguage, IDictionary<string, string> hashes, DateTime lastModifiedTimeUtc, IDictionary<string, SerializedPropertyInfo> properties)
         {
             if (description != null)
             {

src/Sarif/Autogenerated/ArtifactChange.cs

@@ -12,7 +12,7 @@ namespace Microsoft.CodeAnalysis.Sarif
     /// A change to a single artifact.
     /// </summary>
     [DataContract]
-    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.1.0.0")]
+    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.3.0.0")]
     public partial class ArtifactChange : PropertyBagHolder, ISarifNode
     {
         public static IEqualityComparer<ArtifactChange> ValueComparer => ArtifactChangeEqualityComparer.Instance;

src/Sarif/Autogenerated/ArtifactChangeComparer.cs

@@ -10,7 +10,7 @@ namespace Microsoft.CodeAnalysis.Sarif
     /// <summary>
     /// Defines methods to support the comparison of objects of type ArtifactChange for sorting.
     /// </summary>
-    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.1.0.0")]
+    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.3.0.0")]
     internal sealed class ArtifactChangeComparer : IComparer<ArtifactChange>
     {
         internal static readonly ArtifactChangeComparer Instance = new ArtifactChangeComparer();

src/Sarif/Autogenerated/ArtifactChangeEqualityComparer.cs

@@ -10,7 +10,7 @@ namespace Microsoft.CodeAnalysis.Sarif
     /// <summary>
     /// Defines methods to support the comparison of objects of type ArtifactChange for equality.
     /// </summary>
-    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.1.0.0")]
+    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.3.0.0")]
     internal sealed class ArtifactChangeEqualityComparer : IEqualityComparer<ArtifactChange>
     {
         internal static readonly ArtifactChangeEqualityComparer Instance = new ArtifactChangeEqualityComparer();

src/Sarif/Autogenerated/ArtifactComparer.cs

@@ -10,7 +10,7 @@ namespace Microsoft.CodeAnalysis.Sarif
     /// <summary>
     /// Defines methods to support the comparison of objects of type Artifact for sorting.
     /// </summary>
-    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.1.0.0")]
+    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.3.0.0")]
     internal sealed class ArtifactComparer : IComparer<Artifact>
     {
         internal static readonly ArtifactComparer Instance = new ArtifactComparer();

src/Sarif/Autogenerated/ArtifactContent.cs

@@ -12,7 +12,7 @@ namespace Microsoft.CodeAnalysis.Sarif
     /// Represents the contents of an artifact.
     /// </summary>
     [DataContract]
-    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.1.0.0")]
+    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.3.0.0")]
     public partial class ArtifactContent : PropertyBagHolder, ISarifNode
     {
         public static IEqualityComparer<ArtifactContent> ValueComparer => ArtifactContentEqualityComparer.Instance;

src/Sarif/Autogenerated/ArtifactContentComparer.cs

@@ -10,7 +10,7 @@ namespace Microsoft.CodeAnalysis.Sarif
     /// <summary>
     /// Defines methods to support the comparison of objects of type ArtifactContent for sorting.
     /// </summary>
-    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.1.0.0")]
+    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.3.0.0")]
     internal sealed class ArtifactContentComparer : IComparer<ArtifactContent>
     {
         internal static readonly ArtifactContentComparer Instance = new ArtifactContentComparer();

src/Sarif/Autogenerated/ArtifactContentEqualityComparer.cs

@@ -10,7 +10,7 @@ namespace Microsoft.CodeAnalysis.Sarif
     /// <summary>
     /// Defines methods to support the comparison of objects of type ArtifactContent for equality.
     /// </summary>
-    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.1.0.0")]
+    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.3.0.0")]
     internal sealed class ArtifactContentEqualityComparer : IEqualityComparer<ArtifactContent>
     {
         internal static readonly ArtifactContentEqualityComparer Instance = new ArtifactContentEqualityComparer();

src/Sarif/Autogenerated/ArtifactEqualityComparer.cs

@@ -10,7 +10,7 @@ namespace Microsoft.CodeAnalysis.Sarif
     /// <summary>
     /// Defines methods to support the comparison of objects of type Artifact for equality.
     /// </summary>
-    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.1.0.0")]
+    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.3.0.0")]
     internal sealed class ArtifactEqualityComparer : IEqualityComparer<Artifact>
     {
         internal static readonly ArtifactEqualityComparer Instance = new ArtifactEqualityComparer();
@@ -150,7 +150,11 @@ public int GetHashCode(Artifact obj)
                 }
 
                 result = (result * 31) + obj.ParentIndex.GetHashCode();
-                result = (result * 31) + obj.Offset.GetHashCode();
+                if (obj.Offset != null)
+                {
+                    result = (result * 31) + obj.Offset.GetHashCode();
+                }
+
                 result = (result * 31) + obj.Length.GetHashCode();
                 result = (result * 31) + obj.Roles.GetHashCode();
                 if (obj.MimeType != null)

src/Sarif/Autogenerated/ArtifactLocation.cs

@@ -14,7 +14,7 @@ namespace Microsoft.CodeAnalysis.Sarif
     /// Specifies the location of an artifact.
     /// </summary>
     [DataContract]
-    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.1.0.0")]
+    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.3.0.0")]
     public partial class ArtifactLocation : PropertyBagHolder, ISarifNode
     {
         public static IEqualityComparer<ArtifactLocation> ValueComparer => ArtifactLocationEqualityComparer.Instance;

src/Sarif/Autogenerated/ArtifactLocationComparer.cs

@@ -10,7 +10,7 @@ namespace Microsoft.CodeAnalysis.Sarif
     /// <summary>
     /// Defines methods to support the comparison of objects of type ArtifactLocation for sorting.
     /// </summary>
-    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.1.0.0")]
+    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.3.0.0")]
     internal sealed class ArtifactLocationComparer : IComparer<ArtifactLocation>
     {
         internal static readonly ArtifactLocationComparer Instance = new ArtifactLocationComparer();

src/Sarif/Autogenerated/ArtifactLocationEqualityComparer.cs

@@ -10,7 +10,7 @@ namespace Microsoft.CodeAnalysis.Sarif
     /// <summary>
     /// Defines methods to support the comparison of objects of type ArtifactLocation for equality.
     /// </summary>
-    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.1.0.0")]
+    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.3.0.0")]
     internal sealed class ArtifactLocationEqualityComparer : IEqualityComparer<ArtifactLocation>
     {
         internal static readonly ArtifactLocationEqualityComparer Instance = new ArtifactLocationEqualityComparer();

src/Sarif/Autogenerated/ArtifactRoles.cs

@@ -10,7 +10,7 @@ namespace Microsoft.CodeAnalysis.Sarif
     /// Values specifying the roles played by the file in the analysis.
     /// </summary>
     [Flags]
-    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.1.0.0")]
+    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.3.0.0")]
     public enum ArtifactRoles
     {
         None,

src/Sarif/Autogenerated/Attachment.cs

@@ -13,7 +13,7 @@ namespace Microsoft.CodeAnalysis.Sarif
     /// An artifact relevant to a result.
     /// </summary>
     [DataContract]
-    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.1.0.0")]
+    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.3.0.0")]
     public partial class Attachment : PropertyBagHolder, ISarifNode
     {
         public static IEqualityComparer<Attachment> ValueComparer => AttachmentEqualityComparer.Instance;

src/Sarif/Autogenerated/AttachmentComparer.cs

@@ -10,7 +10,7 @@ namespace Microsoft.CodeAnalysis.Sarif
     /// <summary>
     /// Defines methods to support the comparison of objects of type Attachment for sorting.
     /// </summary>
-    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.1.0.0")]
+    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.3.0.0")]
     internal sealed class AttachmentComparer : IComparer<Attachment>
     {
         internal static readonly AttachmentComparer Instance = new AttachmentComparer();

src/Sarif/Autogenerated/AttachmentEqualityComparer.cs

@@ -10,7 +10,7 @@ namespace Microsoft.CodeAnalysis.Sarif
     /// <summary>
     /// Defines methods to support the comparison of objects of type Attachment for equality.
     /// </summary>
-    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.1.0.0")]
+    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.3.0.0")]
     internal sealed class AttachmentEqualityComparer : IEqualityComparer<Attachment>
     {
         internal static readonly AttachmentEqualityComparer Instance = new AttachmentEqualityComparer();

src/Sarif/Autogenerated/BaselineState.cs

@@ -8,7 +8,7 @@ namespace Microsoft.CodeAnalysis.Sarif
     /// <summary>
     /// The state of a result relative to a baseline of a previous run.
     /// </summary>
-    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.1.0.0")]
+    [GeneratedCode("Microsoft.Json.Schema.ToDotNet", "2.3.0.0")]
     public enum BaselineState
     {
         None,