Support DBNull in netstandard1.3 assembly (#394)

dougbu · web-flow · commit cb7628ff7018 · 2023-03-01T16:53:44.000-08:00
* Support `DBNull` in `netstandard1.3` assembly - available from the System.Data.Common package - extend `DBNull` testing to include `net6.0` - s/NETCOREAPP/NETCOREAPP2_1/ where possible - fix comments in `HttpValueCollectionTest` - comments about `DBNull` there were incorrect * !fixup! Add `$(System.JobId)` to artifact names - `publish` / `PublishPipelineArtifact@1` task doesn't overwrite an existing build artifact - bit different from `PublishBuildArtifacts@1` - follow guidance at <https://learn.microsoft.com/en-us/azure/devops/pipelines/artifacts/pipeline-artifacts?view=azure-devops&tabs=yaml-task#q-can-i-delete-pipeline-artifacts-when-re-running-failed-jobs>
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -79,7 +79,7 @@ jobs:
     displayName: Build
 
   - publish: ./bin/$(_Configuration)/Test/TestResults/
-    artifact: $(_Configuration) Test Results
+    artifact: $(_Configuration) Test Results $(System.JobId)
     condition: and(always(), ne(variables._BuildTarget, 'Build'))
     continueOnError: true
     displayName: Upload test results
@@ -95,6 +95,6 @@ jobs:
       testRunTitle: $(_Configuration)
 
   - publish: ./artifacts/
-    artifact: $(_Configuration) Logs
+    artifact: $(_Configuration) Logs $(System.JobId)
     condition: always()
     displayName: Upload logs
diff --git a/src/System.Net.Http.Formatting.ns1_3/System.Net.Http.Formatting.ns1_3.csproj b/src/System.Net.Http.Formatting.ns1_3/System.Net.Http.Formatting.ns1_3.csproj
@@ -17,6 +17,7 @@
   <ItemGroup>
     <PackageReference Include="System.Collections.Specialized" Version="4.3.0" />
     <PackageReference Include="System.ComponentModel.EventBasedAsync" Version="4.3.0" />
+    <PackageReference Include="System.Data.Common" Version="4.3.0" />
     <PackageReference Include="System.Diagnostics.Contracts" Version="4.3.0" />
     <PackageReference Include="System.Memory" Version="4.5.5" />
     <PackageReference Include="System.Runtime.Serialization.Json" Version="4.3.0" />
diff --git a/src/System.Net.Http.Formatting/Formatting/BsonMediaTypeFormatter.cs b/src/System.Net.Http.Formatting/Formatting/BsonMediaTypeFormatter.cs
@@ -73,7 +73,6 @@ public sealed override int MaxDepth
             }
         }
 
-#if !NETSTANDARD1_3 // DBNull not supported in netstandard1.3; no need to override there
         /// <inheritdoc />
         public override Task<object> ReadFromStreamAsync(Type type, Stream readStream, HttpContent content, IFormatterLogger formatterLogger)
         {
@@ -101,7 +100,6 @@ public override Task<object> ReadFromStreamAsync(Type type, Stream readStream, H
                 return base.ReadFromStreamAsync(type, readStream, content, formatterLogger);
             }
         }
-#endif
 
         /// <inheritdoc />
         public override object ReadFromStream(Type type, Stream readStream, Encoding effectiveEncoding,
@@ -234,14 +232,13 @@ public override void WriteToStream(Type type, object value, Stream writeStream,
 
             if (value == null)
             {
-                // Cannot serialize null at the top level.  Json.Net throws Newtonsoft.Json.JsonWriterException : Error
-                // writing Null value. BSON must start with an Object or Array. Path ''.  Fortunately
+                // Cannot serialize null at the top level. Json.Net throws Newtonsoft.Json.JsonWriterException : Error
+                // writing Null value. BSON must start with an Object or Array. Path ''. Fortunately
                 // BaseJsonMediaTypeFormatter.ReadFromStream(Type, Stream, HttpContent, IFormatterLogger) treats zero-
                 // length content as null or the default value of a struct.
                 return;
             }
 
-#if !NETSTANDARD1_3 // DBNull not supported in netstandard1.3
             if (value == DBNull.Value)
             {
                 // ReadFromStreamAsync() override above converts null to DBNull.Value if given Type is DBNull; normally
@@ -252,7 +249,6 @@ public override void WriteToStream(Type type, object value, Stream writeStream,
                 // rather than null, and not meet the receiver's expectations.
                 return;
             }
-#endif
 
             // See comments in ReadFromStream() above about this special case and the need to include byte[] in it.
             // Using runtime type here because Json.Net will throw during serialization whenever it cannot handle the
diff --git a/test/System.Net.Http.Formatting.Test/Formatting/BsonMediaTypeFormatterTests.cs b/test/System.Net.Http.Formatting.Test/Formatting/BsonMediaTypeFormatterTests.cs
@@ -392,7 +392,6 @@ public async Task ReadFromStreamAsync_RoundTripsWriteToStreamAsync_PerhapsJObjec
             }
         }
 
-#if !Testing_NetStandard1_3 // DBNull not supported in netstandard1.3
         // Test alternate null value
         [Theory]
         [TestDataSet(typeof(JsonMediaTypeFormatterTests), "DBNullAsObjectTestDataCollection", TestDataVariations.AllSingleInstances)]
@@ -408,7 +407,7 @@ public async Task ReadFromStreamAsync_RoundTripsWriteToStreamAsync_DBNullAsNull(
             Assert.Null(readObj);
         }
 
-#if !NETCOREAPP // DBNull not serializable on .NET Core 2.1 except at top level (using BsonMediaTypeformatter special case).
+#if !NETCOREAPP2_1 // DBNull not serializable on .NET Core 2.1 except at top level (using BsonMediaTypeformatter special case).
         [Theory]
         [TestDataSet(typeof(JsonMediaTypeFormatterTests), "DBNullAsObjectTestDataCollection", TestDataVariations.AsDictionary)]
         public async Task ReadFromStreamAsync_RoundTripsWriteToStreamAsync_DBNullAsNull_Dictionary(Type variationType, object testData)
@@ -512,7 +511,6 @@ public async Task ReadFromStreamAsync_RoundTripsWriteToStreamAsync_DBNull()
             // Only BSON case where DBNull.Value round-trips
             Assert.Equal(testData, readObj);
         }
-#endif
 
         private class TestBsonMediaTypeFormatter : BsonMediaTypeFormatter
         {
diff --git a/test/System.Net.Http.Formatting.Test/Formatting/DataContractJsonMediaTypeFormatterTests.cs b/test/System.Net.Http.Formatting.Test/Formatting/DataContractJsonMediaTypeFormatterTests.cs
@@ -159,7 +159,7 @@ public async Task ReadFromStreamAsync_RoundTripsWriteToStreamAsync_KnownTypes(Ty
             }
         }
 
-#if !NETCOREAPP // DBNull not serializable on .NET Core 2.1.
+#if !NETCOREAPP2_1 // DBNull not serializable on .NET Core 2.1.
         // Test alternate null value
         [Fact]
         public async Task ReadFromStreamAsync_RoundTripsWriteToStreamAsync_DBNull()
diff --git a/test/System.Net.Http.Formatting.Test/Formatting/JsonMediaTypeFormatterTests.cs b/test/System.Net.Http.Formatting.Test/Formatting/JsonMediaTypeFormatterTests.cs
@@ -367,7 +367,7 @@ public async Task ReadFromStreamAsync_RoundTripsWriteToStreamAsync(Type variatio
             }
         }
 
-#if !NETCOREAPP // DBNull not serializable on .NET Core 2.1.
+#if !NETCOREAPP2_1 // DBNull not serializable on .NET Core 2.1.
         // Test alternate null value; always serialized as "null"
         [Theory]
         [TestDataSet(typeof(JsonMediaTypeFormatterTests), "DBNullAsObjectTestDataCollection", TestDataVariations.AllSingleInstances)]
diff --git a/test/System.Net.Http.Formatting.Test/Formatting/XmlMediaTypeFormatterTests.cs b/test/System.Net.Http.Formatting.Test/Formatting/XmlMediaTypeFormatterTests.cs
@@ -36,7 +36,7 @@ public class XmlMediaTypeFormatterTests : MediaTypeFormatterTestBase<XmlMediaTyp
                 Int32.MaxValue,
                 Int64.MinValue,
                 Int64.MaxValue,
-#if !NETCOREAPP // DBNull not serializable on .NET Core 2.1.
+#if !NETCOREAPP2_1 // DBNull not serializable on .NET Core 2.1.
                 DBNull.Value,
 #endif
             });
@@ -478,7 +478,7 @@ public async Task ReadFromStream_AsyncRoundTripsWriteToStreamUsingDataContractSe
             }
         }
 
-#if !NETCOREAPP // DBNull not serializable on .NET Core 2.1.
+#if !NETCOREAPP2_1 // DBNull not serializable on .NET Core 2.1.
         [Fact]
         public async Task ReadFromStreamAsync_RoundTripsWriteToStreamAsyncUsingDataContractSerializer_DBNull()
         {
diff --git a/test/System.Net.Http.Formatting.Test/Internal/HttpValueCollectionTest.cs b/test/System.Net.Http.Formatting.Test/Internal/HttpValueCollectionTest.cs
@@ -12,7 +12,7 @@ namespace System.Net.Http.Internal
 {
     public class HttpValueCollectionTest
     {
-#if !NETCOREAPP // Unused on .NET Core 2.1.
+#if !NETCOREAPP // Unused on .NET Core.
         private static readonly int _maxCollectionKeys = 1000;
 #endif
 
@@ -21,7 +21,7 @@ private static HttpValueCollection CreateInstance()
             return HttpValueCollection.Create();
         }
 
-#if !NETCOREAPP
+#if !NETCOREAPP // Unsupported on .NET Core.
         private static void RunInIsolation(Action action)
         {
             AppDomainUtils.RunInSeparateAppDomain(action);
@@ -132,7 +132,7 @@ public void Create_CreatesEmptyCollection()
             Assert.Empty(nvc);
         }
 
-#if !NETCOREAPP // DBNull not serializable on .NET Core 2.1.
+#if !NETCOREAPP // Able to run on a separate AppDomain only on .NET Framework.
         // This set of tests requires running on a separate appdomain so we don't
         // touch the static property MediaTypeFormatter.MaxHttpCollectionKeys.
         [Fact]

Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,6 @@ public sealed override int MaxDepth`
`73`	`73`	`}`
`74`	`74`	`}`
`75`	`75`
`76`		`-#if !NETSTANDARD1_3 // DBNull not supported in netstandard1.3; no need to override there`
`77`	`76`	`/// <inheritdoc />`
`78`	`77`	`public override Task<object> ReadFromStreamAsync(Type type, Stream readStream, HttpContent content, IFormatterLogger formatterLogger)`
`79`	`78`	`{`
`@@ -101,7 +100,6 @@ public override Task<object> ReadFromStreamAsync(Type type, Stream readStream, H`
`101`	`100`	`return base.ReadFromStreamAsync(type, readStream, content, formatterLogger);`
`102`	`101`	`}`
`103`	`102`	`}`
`104`		`-#endif`
`105`	`103`
`106`	`104`	`/// <inheritdoc />`
`107`	`105`	`public override object ReadFromStream(Type type, Stream readStream, Encoding effectiveEncoding,`
`@@ -234,14 +232,13 @@ public override void WriteToStream(Type type, object value, Stream writeStream,`
`234`	`232`
`235`	`233`	`if (value == null)`
`236`	`234`	`{`
`237`		`- // Cannot serialize null at the top level. Json.Net throws Newtonsoft.Json.JsonWriterException : Error`
`238`		`- // writing Null value. BSON must start with an Object or Array. Path ''. Fortunately`
	`235`	`+ // Cannot serialize null at the top level. Json.Net throws Newtonsoft.Json.JsonWriterException : Error`
	`236`	`+ // writing Null value. BSON must start with an Object or Array. Path ''. Fortunately`
`239`	`237`	`// BaseJsonMediaTypeFormatter.ReadFromStream(Type, Stream, HttpContent, IFormatterLogger) treats zero-`
`240`	`238`	`// length content as null or the default value of a struct.`
`241`	`239`	`return;`
`242`	`240`	`}`
`243`	`241`
`244`		`-#if !NETSTANDARD1_3 // DBNull not supported in netstandard1.3`
`245`	`242`	`if (value == DBNull.Value)`
`246`	`243`	`{`
`247`	`244`	`// ReadFromStreamAsync() override above converts null to DBNull.Value if given Type is DBNull; normally`
`@@ -252,7 +249,6 @@ public override void WriteToStream(Type type, object value, Stream writeStream,`
`252`	`249`	`// rather than null, and not meet the receiver's expectations.`
`253`	`250`	`return;`
`254`	`251`	`}`
`255`		`-#endif`
`256`	`252`
`257`	`253`	`// See comments in ReadFromStream() above about this special case and the need to include byte[] in it.`
`258`	`254`	`// Using runtime type here because Json.Net will throw during serialization whenever it cannot handle the`
Original file line number	Diff line number	Diff line change
`@@ -392,7 +392,6 @@ public async Task ReadFromStreamAsync_RoundTripsWriteToStreamAsync_PerhapsJObjec`
`392`	`392`	`}`
`393`	`393`	`}`
`394`	`394`
`395`		`-#if !Testing_NetStandard1_3 // DBNull not supported in netstandard1.3`
`396`	`395`	`// Test alternate null value`
`397`	`396`	`[Theory]`
`398`	`397`	`[TestDataSet(typeof(JsonMediaTypeFormatterTests), "DBNullAsObjectTestDataCollection", TestDataVariations.AllSingleInstances)]`
`@@ -408,7 +407,7 @@ public async Task ReadFromStreamAsync_RoundTripsWriteToStreamAsync_DBNullAsNull(`
`408`	`407`	`Assert.Null(readObj);`
`409`	`408`	`}`
`410`	`409`
`411`		`-#if !NETCOREAPP // DBNull not serializable on .NET Core 2.1 except at top level (using BsonMediaTypeformatter special case).`
	`410`	`+#if !NETCOREAPP2_1 // DBNull not serializable on .NET Core 2.1 except at top level (using BsonMediaTypeformatter special case).`
`412`	`411`	`[Theory]`
`413`	`412`	`[TestDataSet(typeof(JsonMediaTypeFormatterTests), "DBNullAsObjectTestDataCollection", TestDataVariations.AsDictionary)]`
`414`	`413`	`public async Task ReadFromStreamAsync_RoundTripsWriteToStreamAsync_DBNullAsNull_Dictionary(Type variationType, object testData)`
`@@ -512,7 +511,6 @@ public async Task ReadFromStreamAsync_RoundTripsWriteToStreamAsync_DBNull()`
`512`	`511`	`// Only BSON case where DBNull.Value round-trips`
`513`	`512`	`Assert.Equal(testData, readObj);`
`514`	`513`	`}`
`515`		`-#endif`
`516`	`514`
`517`	`515`	`private class TestBsonMediaTypeFormatter : BsonMediaTypeFormatter`
`518`	`516`	`{`
Original file line number	Diff line number	Diff line change
`@@ -159,7 +159,7 @@ public async Task ReadFromStreamAsync_RoundTripsWriteToStreamAsync_KnownTypes(Ty`
`159`	`159`	`}`
`160`	`160`	`}`
`161`	`161`
`162`		`-#if !NETCOREAPP // DBNull not serializable on .NET Core 2.1.`
	`162`	`+#if !NETCOREAPP2_1 // DBNull not serializable on .NET Core 2.1.`
`163`	`163`	`// Test alternate null value`
`164`	`164`	`[Fact]`
`165`	`165`	`public async Task ReadFromStreamAsync_RoundTripsWriteToStreamAsync_DBNull()`
Original file line number	Diff line number	Diff line change
`@@ -367,7 +367,7 @@ public async Task ReadFromStreamAsync_RoundTripsWriteToStreamAsync(Type variatio`
`367`	`367`	`}`
`368`	`368`	`}`
`369`	`369`
`370`		`-#if !NETCOREAPP // DBNull not serializable on .NET Core 2.1.`
	`370`	`+#if !NETCOREAPP2_1 // DBNull not serializable on .NET Core 2.1.`
`371`	`371`	`// Test alternate null value; always serialized as "null"`
`372`	`372`	`[Theory]`
`373`	`373`	`[TestDataSet(typeof(JsonMediaTypeFormatterTests), "DBNullAsObjectTestDataCollection", TestDataVariations.AllSingleInstances)]`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public class XmlMediaTypeFormatterTests : MediaTypeFormatterTestBase<XmlMediaTyp`
`36`	`36`	`Int32.MaxValue,`
`37`	`37`	`Int64.MinValue,`
`38`	`38`	`Int64.MaxValue,`
`39`		`-#if !NETCOREAPP // DBNull not serializable on .NET Core 2.1.`
	`39`	`+#if !NETCOREAPP2_1 // DBNull not serializable on .NET Core 2.1.`
`40`	`40`	`DBNull.Value,`
`41`	`41`	`#endif`
`42`	`42`	`});`
`@@ -478,7 +478,7 @@ public async Task ReadFromStream_AsyncRoundTripsWriteToStreamUsingDataContractSe`
`478`	`478`	`}`
`479`	`479`	`}`
`480`	`480`
`481`		`-#if !NETCOREAPP // DBNull not serializable on .NET Core 2.1.`
	`481`	`+#if !NETCOREAPP2_1 // DBNull not serializable on .NET Core 2.1.`
`482`	`482`	`[Fact]`
`483`	`483`	`public async Task ReadFromStreamAsync_RoundTripsWriteToStreamAsyncUsingDataContractSerializer_DBNull()`
`484`	`484`	`{`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ namespace System.Net.Http.Internal`
`12`	`12`	`{`
`13`	`13`	`public class HttpValueCollectionTest`
`14`	`14`	`{`
`15`		`-#if !NETCOREAPP // Unused on .NET Core 2.1.`
	`15`	`+#if !NETCOREAPP // Unused on .NET Core.`
`16`	`16`	`private static readonly int _maxCollectionKeys = 1000;`
`17`	`17`	`#endif`
`18`	`18`
`@@ -21,7 +21,7 @@ private static HttpValueCollection CreateInstance()`
`21`	`21`	`return HttpValueCollection.Create();`
`22`	`22`	`}`
`23`	`23`
`24`		`-#if !NETCOREAPP`
	`24`	`+#if !NETCOREAPP // Unsupported on .NET Core.`
`25`	`25`	`private static void RunInIsolation(Action action)`
`26`	`26`	`{`
`27`	`27`	`AppDomainUtils.RunInSeparateAppDomain(action);`
`@@ -132,7 +132,7 @@ public void Create_CreatesEmptyCollection()`
`132`	`132`	`Assert.Empty(nvc);`
`133`	`133`	`}`
`134`	`134`
`135`		`-#if !NETCOREAPP // DBNull not serializable on .NET Core 2.1.`
	`135`	`+#if !NETCOREAPP // Able to run on a separate AppDomain only on .NET Framework.`
`136`	`136`	`// This set of tests requires running on a separate appdomain so we don't`
`137`	`137`	`// touch the static property MediaTypeFormatter.MaxHttpCollectionKeys.`
`138`	`138`	`[Fact]`