From db73b5acf02956079ee0430838f553951d1a38ef Mon Sep 17 00:00:00 2001 From: Larry Golding Date: Thu, 3 Oct 2019 09:25:36 -0700 Subject: [PATCH] Correct a comment related to #1689. --- src/ReleaseHistory.md | 46 +++++++++---------- .../PropertyBagConverterTests.cs | 2 +- 2 files changed, 24 insertions(+), 24 deletions(-) diff --git a/src/ReleaseHistory.md b/src/ReleaseHistory.md index ebad8cd08..d7a85d70a 100644 --- a/src/ReleaseHistory.md +++ b/src/ReleaseHistory.md @@ -185,33 +185,33 @@ * API BREAKING: Rename `message.messageId` property to `message.id`. https://github.com/oasis-tcs/sarif-spec/issues/352 ## **v2.0.0-csd.2.beta.2019.04-03.0** [Sdk](https://www.nuget.org/packages/Sarif.Sdk/2.0.0-csd.2.beta.2019.04-03.0) | [Driver](https://www.nuget.org/packages/Sarif.Driver/2.0.0-csd.2.beta.2019.04-03.0) | [Converters](https://www.nuget.org/packages/Sarif.Converters/2.0.0-csd.2.beta.2019.04-03.0)) | [Multitool](https://www.nuget.org/packages/Sarif.Multitool/2.0.0-csd.2.beta.2019.04-03.0)) -* API NON-BREAKING: Introduce new localization mechanism (post ballot changes). https://github.com/oasis-tcs/sarif-spec/issues/338 -* API BREAKING: Add `address` property to a `location` object (post ballot changes). https://github.com/oasis-tcs/sarif-spec/issues/302 -* API NON-BREAKING: Define result `taxonomies`. https://github.com/oasis-tcs/sarif-spec/issues/314 -* API NON-BREAKING: Define a `reportingDescriptorReference` object. https://github.com/oasis-tcs/sarif-spec/issues/324 -* API BREAKING: Change `run.graphs` and `result.graphs` from objects to arrays. https://github.com/oasis-tcs/sarif-spec/issues/326 -* API BREAKING: External property file related renames (post ballot changes). https://github.com/oasis-tcs/sarif-spec/issues/335 -* API NON-BREAKING: Allow toolComponents to be externalized. https://github.com/oasis-tcs/sarif-spec/issues/337 -* API BREAKING: Rename all `instanceGuid` properties to `guid`. https://github.com/oasis-tcs/sarif-spec/issues/341 -* API NON-BREAKING: Add `reportingDescriptor.deprecatedNames` and `deprecatedGuids` to match `deprecatedIds` property. https://github.com/oasis-tcs/sarif-spec/issues/346 -* API NON-BREAKING: Add `referencedOnCommandLine` as a role. https://github.com/oasis-tcs/sarif-spec/issues/347 -* API NON-BREAKING: Rename `reportingConfigurationOverride` to `configurationOverride`. https://github.com/oasis-tcs/sarif-spec/issues/350 +* API NON-BREAKING: Introduce new localization mechanism (post ballot changes). [oasis-tcs/sarif-spec#338](https://github.com/oasis-tcs/sarif-spec/issues/338) +* API BREAKING: Add `address` property to a `location` object (post ballot changes). [oasis-tcs/sarif-spec#302](https://github.com/oasis-tcs/sarif-spec/issues/302) +* API NON-BREAKING: Define result `taxonomies`. [oasis-tcs/sarif-spec#314](https://github.com/oasis-tcs/sarif-spec/issues/314) +* API NON-BREAKING: Define a `reportingDescriptorReference` object. [oasis-tcs/sarif-spec#324](https://github.com/oasis-tcs/sarif-spec/issues/324) +* API BREAKING: Change `run.graphs` and `result.graphs` from objects to arrays. [oasis-tcs/sarif-spec#326](https://github.com/oasis-tcs/sarif-spec/issues/326) +* API BREAKING: External property file related renames (post ballot changes). [oasis-tcs/sarif-spec#335](https://github.com/oasis-tcs/sarif-spec/issues/335) +* API NON-BREAKING: Allow toolComponents to be externalized. [oasis-tcs/sarif-spec#337](https://github.com/oasis-tcs/sarif-spec/issues/337) +* API BREAKING: Rename all `instanceGuid` properties to `guid`. [oasis-tcs/sarif-spec#341](https://github.com/oasis-tcs/sarif-spec/issues/341) +* API NON-BREAKING: Add `reportingDescriptor.deprecatedNames` and `deprecatedGuids` to match `deprecatedIds` property. [oasis-tcs/sarif-spec#346](https://github.com/oasis-tcs/sarif-spec/issues/346) +* API NON-BREAKING: Add `referencedOnCommandLine` as a role. [oasis-tcs/sarif-spec#347](https://github.com/oasis-tcs/sarif-spec/issues/347) +* API NON-BREAKING: Rename `reportingConfigurationOverride` to `configurationOverride`. [oasis-tcs/sarif-spec#350](https://github.com/oasis-tcs/sarif-spec/issues/350) ## **v2.0.0-csd.2.beta.2019.02-20** [Sdk](https://www.nuget.org/packages/Sarif.Sdk/2.0.0-csd.2.beta.2019.02-20) | [Driver](https://www.nuget.org/packages/Sarif.Driver/2.0.0-csd.2.beta.2019.02-20) | [Converters](https://www.nuget.org/packages/Sarif.Converters/2.0.0-csd.2.beta.2019.02-20)) | [Multitool](https://www.nuget.org/packages/Sarif.Multitool/2.0.0-csd.2.beta.2019.02-20)) * COMMAND-LINE BREAKING: Rename `--sarif-version` to `--sarif-output-version`. Remove duplicative tranform `--target-version` command-line argument. * COMMAND-LINE NON-BREAKING: add `--inline` option to multitool `rebaseuri` verb, to write output directly into input files. -* API NON-BREAKING: Add additional properties to `toolComponent`. https://github.com/oasis-tcs/sarif-spec/issues/336 -* API NON-BREAKING: Provide a caching mechanism for duplicated code flow data. https://github.com/oasis-tcs/sarif-spec/issues/320 -* API NON-BREAKING: Add `inlineExternalPropertyFiles` at the log level. https://github.com/oasis-tcs/sarif-spec/issues/321 -* API NON-BREAKING: Update logical location kinds to accommodate XML and JSON paths. https://github.com/oasis-tcs/sarif-spec/issues/291 -* API NON-BREAKING: Define result taxonomies. https://github.com/oasis-tcs/sarif-spec/issues/314 -* API BREAKING: Remove `invocation.attachments`, now replaced by `run.tool.extensions`. https://github.com/oasis-tcs/sarif-spec/issues/327 -* API NON-BREAKING: Introduce new localization mechanism. https://github.com/oasis-tcs/sarif-spec/issues/338 -* API BREAKING: Remove `tool.language` and localization support. https://github.com/oasis-tcs/sarif-spec/issues/325 -* API NON-BREAKING: Add additional properties to toolComponent. https://github.com/oasis-tcs/sarif-spec/issues/336 -* API BREAKING: Rename `invocation.toolNotifications` and `invocation.configurationNotifications` to `toolExecutionNotifications` and `toolConfigurationNotifications`. https://github.com/oasis-tcs/sarif-spec/issues/330 -* API BREAKING: Add address property to a location object (and other nodes). https://github.com/oasis-tcs/sarif-spec/issues/302 -* API BREAKING: External property file related renames. https://github.com/oasis-tcs/sarif-spec/issues/335 +* API NON-BREAKING: Add additional properties to `toolComponent`. [oasis-tcs/sarif-spec#336](https://github.com/oasis-tcs/sarif-spec/issues/336) +* API NON-BREAKING: Provide a caching mechanism for duplicated code flow data. [oasis-tcs/sarif-spec#320](https://github.com/oasis-tcs/sarif-spec/issues/320) +* API NON-BREAKING: Add `inlineExternalPropertyFiles` at the log level. [oasis-tcs/sarif-spec#321](https://github.com/oasis-tcs/sarif-spec/issues/321) +* API NON-BREAKING: Update logical location kinds to accommodate XML and JSON paths. [oasis-tcs/sarif-spec#291](https://github.com/oasis-tcs/sarif-spec/issues/291) +* API NON-BREAKING: Define result taxonomies. [oasis-tcs/sarif-spec#314](https://github.com/oasis-tcs/sarif-spec/issues/314) +* API BREAKING: Remove `invocation.attachments`, now replaced by `run.tool.extensions`. [oasis-tcs/sarif-spec#327](https://github.com/oasis-tcs/sarif-spec/issues/327) +* API NON-BREAKING: Introduce new localization mechanism. [oasis-tcs/sarif-spec#338](https://github.com/oasis-tcs/sarif-spec/issues/338) +* API BREAKING: Remove `tool.language` and localization support. [oasis-tcs/sarif-spec#325](https://github.com/oasis-tcs/sarif-spec/issues/325) +* API NON-BREAKING: Add additional properties to toolComponent. [oasis-tcs/sarif-spec#336](https://github.com/oasis-tcs/sarif-spec/issues/336) +* API BREAKING: Rename `invocation.toolNotifications` and `invocation.configurationNotifications` to `toolExecutionNotifications` and `toolConfigurationNotifications`. [oasis-tcs/sarif-spec#330](https://github.com/oasis-tcs/sarif-spec/issues/330) +* API BREAKING: Add address property to a location object (and other nodes). [oasis-tcs/sarif-spec#302](https://github.com/oasis-tcs/sarif-spec/issues/302) +* API BREAKING: External property file related renames. [oasis-tcs/sarif-spec#335](https://github.com/oasis-tcs/sarif-spec/issues/335) ## **v2.0.0-csd.2.beta.2019.01-24.1** [Sdk](https://www.nuget.org/packages/Sarif.Sdk/2.0.0-csd.2.beta.2019.01-24.1) | [Driver](https://www.nuget.org/packages/Sarif.Driver/2.0.0-csd.2.beta.2019.01-24.1) | [Converters](https://www.nuget.org/packages/Sarif.Converters/2.0.0-csd.2.beta.2019.01-24.1)) | [Multitool](https://www.nuget.org/packages/Sarif.Multitool/2.0.0-csd.2.beta.2019.01-24.1)) * BUGFIX: `region.charOffset` default value should be -1 (invalid value) rather than 0. Fixes an issue where `region.charLength` is > 0 but `region.charOffset` is absent (because its value of 0 was incorrectly elided due to being the default value). diff --git a/src/Test.FunctionalTests.Sarif/PropertyBagConverterTests.cs b/src/Test.FunctionalTests.Sarif/PropertyBagConverterTests.cs index fafe8f1d6..db777a117 100644 --- a/src/Test.FunctionalTests.Sarif/PropertyBagConverterTests.cs +++ b/src/Test.FunctionalTests.Sarif/PropertyBagConverterTests.cs @@ -78,7 +78,7 @@ public void PropertyBagConverter_RoundTrip() // In addition to checking the individual properties (which is nice for explicitness), // we redundantly check that the entire SarifLog objects match. // THIS ASSERTION IS COMMENTED OUT BECAUSE OF https://github.com/microsoft/sarif-sdk/issues/1689, - // "Generated code for property bag comparison is incorrect." + // "Round-tripped log comparison fails if property bag contains DateTime." //originalLog.ValueEquals(deserializedLog).Should().BeTrue(); string reserializedLogContents = JsonConvert.SerializeObject(deserializedLog, settings);