Skip to content

Commit 936e73e

Browse files
paulmedynskicheenamalhotra
paulmedynski
authored and
cheenamalhotra
committed
Fix xUnit Theory serialization warnings (#3186)
* User Story 33279: Fix xUnit Theory serialization warnings - Suppressed xUnit discovery data enumeration warnings in Function and Manual test projects. - Fixed xUnit test data enumeration warnings specific to .NET Framework (enums in the GAC). - Added targets to run Windows and Unix tests. - Cleaned up test run command lines for improved maintenance and runtime logging.
1 parent 8b320de commit 936e73e

File tree

17 files changed

+683
-246
lines changed

17 files changed

+683
-246
lines changed

‎build.proj‎

Lines changed: 98 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -177,21 +177,109 @@
177177
</Target>
178178

179179
<!-- Tests -->
180+
181+
<!-- Run all unit tests applicable to the host OS. -->
180182
<Target Name="RunTests" DependsOnTargets="RunFunctionalTests;RunManualTests"/>
181-
<Target Name="RunFunctionalTests">
182-
<!-- Windows -->
183-
<Exec ConsoleToMsBuild="true" Command="$(DotnetPath)dotnet test &quot;@(FunctionalTestsProj)&quot; -p:Configuration=$(Configuration) -p:Target$(TFGroup)Version=$(TF) -p:ReferenceType=$(ReferenceType) --no-build -v n --collect &quot;Code coverage&quot; -p:TestSet=$(TestSet) --results-directory $(ResultsDirectory) -p:TestTargetOS=Windows$(TargetGroup) --filter &quot;category!=non$(TargetGroup)tests&amp;category!=failing&amp;category!=nonwindowstests&quot; &quot;--logger:trx;LogFilePrefix=Functional-Windows$(TargetGroup)-$(TestSet)&quot;" Condition="'$(IsEnabledWindows)' == 'true'"/>
184-
<!-- Unix -->
185-
<Exec ConsoleToMsBuild="true" Command="$(DotnetPath)dotnet test &quot;@(FunctionalTestsProj)&quot; -p:Configuration=$(Configuration) -p:TargetNetCoreVersion=$(TF) -p:ReferenceType=$(ReferenceType) --no-build -v n -p:TestSet=$(TestSet) --results-directory $(ResultsDirectory) -p:TestTargetOS=Unixnetcoreapp --collect &quot;Code coverage&quot; --filter &quot;category!=nonnetcoreapptests&amp;category!=failing&amp;category!=nonlinuxtests&amp;category!=nonuaptests&quot; &quot;--logger:trx;LogFilePrefix=Functional-Unixnetcoreapp-$(TestSet)&quot;" Condition="'$(IsEnabledWindows)' != 'true'"/>
183+
184+
<!-- Run all Functional tests applicable to the host OS. -->
185+
<Target Name="RunFunctionalTests" DependsOnTargets="RunFunctionalTestsWindows;RunFunctionalTestsUnix"/>
186+
187+
<!-- Run all Functional tests applicable to Windows. -->
188+
<Target Name="RunFunctionalTestsWindows" Condition="'$(IsEnabledWindows)' == 'true'">
189+
<PropertyGroup>
190+
<TestCommand>
191+
$(DotnetPath)dotnet test "@(FunctionalTestsProj)"
192+
--no-build
193+
-v n
194+
-p:Configuration=$(Configuration)
195+
-p:Target$(TFGroup)Version=$(TF)
196+
-p:ReferenceType=$(ReferenceType)
197+
-p:TestSet=$(TestSet)
198+
-p:TestTargetOS=Windows$(TargetGroup)
199+
--collect "Code coverage"
200+
--results-directory $(ResultsDirectory)
201+
--filter "category!=non$(TargetGroup)tests&amp;category!=failing&amp;category!=nonwindowstests"
202+
--logger:"trx;LogFilePrefix=Functional-Windows$(TargetGroup)-$(TestSet)"
203+
</TestCommand>
204+
<TestCommand>$(TestCommand.Replace($([System.Environment]::NewLine), " "))</TestCommand>
205+
</PropertyGroup>
206+
<Message Text=">>> Running Functional test for Windows via command: $(TestCommand)"/>
207+
<Exec ConsoleToMsBuild="true" Command="$(TestCommand)"/>
208+
</Target>
209+
210+
<!-- Run all Functional tests applicable to Unix. -->
211+
<Target Name="RunFunctionalTestsUnix" Condition="'$(IsEnabledWindows)' != 'true'">
212+
<PropertyGroup>
213+
<TestCommand>
214+
$(DotnetPath)dotnet test "@(FunctionalTestsProj)"
215+
--no-build
216+
-v n
217+
-p:Configuration=$(Configuration)
218+
-p:TargetNetCoreVersion=$(TF)
219+
-p:ReferenceType=$(ReferenceType)
220+
-p:TestSet=$(TestSet)
221+
-p:TestTargetOS=Unixnetcoreapp
222+
--collect "Code coverage"
223+
--results-directory $(ResultsDirectory)
224+
--filter "category!=nonnetcoreapptests&amp;category!=failing&amp;category!=nonlinuxtests&amp;category!=nonuaptests"
225+
--logger:"trx;LogFilePrefix=Functional-Unixnetcoreapp-$(TestSet)"
226+
</TestCommand>
227+
<TestCommand>$(TestCommand.Replace($([System.Environment]::NewLine), " "))</TestCommand>
228+
</PropertyGroup>
229+
<Message Text=">>> Running Functional test for Unix via command: $(TestCommand)"/>
230+
<Exec ConsoleToMsBuild="true" Command="$(TestCommand)"/>
231+
</Target>
232+
233+
<!-- Run all Manual tests applicable to the host OS. -->
234+
<Target Name="RunManualTests" DependsOnTargets="RunManualTestsWindows;RunManualTestsUnix"/>
235+
236+
<!-- Run all Manual tests applicable to Windows. -->
237+
<Target Name="RunManualTestsWindows" Condition="'$(IsEnabledWindows)' == 'true'">
238+
<PropertyGroup>
239+
<TestCommand>
240+
$(DotnetPath)dotnet test "@(ManualTestsProj)"
241+
--no-build
242+
-v n
243+
-p:Configuration=$(Configuration)
244+
-p:Target$(TFGroup)Version=$(TF)
245+
-p:ReferenceType=$(ReferenceType)
246+
-p:TestSet=$(TestSet)
247+
-p:TestTargetOS=Windows$(TargetGroup)
248+
--collect "Code coverage"
249+
--results-directory $(ResultsDirectory)
250+
--filter "category!=non$(TargetGroup)tests&amp;category!=failing&amp;category!=nonwindowstests"
251+
--logger:"trx;LogFilePrefix=Manual-Windows$(TargetGroup)-$(TestSet)"
252+
</TestCommand>
253+
<TestCommand>$(TestCommand.Replace($([System.Environment]::NewLine), " "))</TestCommand>
254+
</PropertyGroup>
255+
<Message Text=">>> Running Manual test for Windows via command: $(TestCommand)"/>
256+
<Exec ConsoleToMsBuild="true" Command="$(TestCommand)"/>
186257
</Target>
187258

188-
<Target Name="RunManualTests">
189-
<!-- Windows -->
190-
<Exec ConsoleToMsBuild="true" Command="$(DotnetPath)dotnet test &quot;@(ManualTestsProj)&quot; -p:Configuration=$(Configuration) -p:Target$(TFGroup)Version=$(TF) -p:ReferenceType=$(ReferenceType) --no-build -l &quot;console;verbosity=normal&quot; --collect &quot;Code coverage&quot; -p:TestSet=$(TestSet) --results-directory $(ResultsDirectory) -p:TestTargetOS=Windows$(TargetGroup) --filter &quot;category!=non$(TargetGroup)tests&amp;category!=failing&amp;category!=nonwindowstests&quot; &quot;--logger:trx;LogFilePrefix=Manual-Windows$(TargetGroup)-$(TestSet)&quot;" Condition="'$(IsEnabledWindows)' == 'true'"/>
191-
<!-- Unix -->
192-
<Exec ConsoleToMsBuild="true" Command="$(DotnetPath)dotnet test &quot;@(ManualTestsProj)&quot; -p:Configuration=$(Configuration) -p:TargetNetCoreVersion=$(TF) -p:ReferenceType=$(ReferenceType) --no-build -l &quot;console;verbosity=normal&quot; --collect &quot;Code coverage&quot; -p:TestSet=$(TestSet) --results-directory $(ResultsDirectory) -p:TestTargetOS=Unixnetcoreapp --filter &quot;category!=nonnetcoreapptests&amp;category!=failing&amp;category!=nonlinuxtests&amp;category!=nonuaptests&quot; &quot;--logger:trx;LogFilePrefix=Manual-Unixnetcoreapp-$(TestSet)&quot;" Condition="'$(IsEnabledWindows)' != 'true'"/>
259+
<!-- Run all Manual tests applicable to Unix. -->
260+
<Target Name="RunManualTestsUnix" Condition="'$(IsEnabledWindows)' != 'true'">
261+
<PropertyGroup>
262+
<TestCommand>
263+
$(DotnetPath)dotnet test "@(ManualTestsProj)"
264+
--no-build
265+
-v n
266+
-p:Configuration=$(Configuration)
267+
-p:TargetNetCoreVersion=$(TF)
268+
-p:ReferenceType=$(ReferenceType)
269+
-p:TestSet=$(TestSet)
270+
-p:TestTargetOS=Unixnetcoreapp
271+
--collect "Code coverage"
272+
--results-directory $(ResultsDirectory)
273+
--filter "category!=nonnetcoreapptests&amp;category!=failing&amp;category!=nonlinuxtests&amp;category!=nonuaptests"
274+
--logger:"trx;LogFilePrefix=Manual-Unixnetcoreapp-$(TestSet)"
275+
</TestCommand>
276+
<TestCommand>$(TestCommand.Replace($([System.Environment]::NewLine), " "))</TestCommand>
277+
</PropertyGroup>
278+
<Message Text=">>> Running Manual test for Unix via command: $(TestCommand)"/>
279+
<Exec ConsoleToMsBuild="true" Command="$(TestCommand)"/>
193280
</Target>
194281

282+
<!-- Clean -->
195283
<Target Name="Clean">
196284
<RemoveDir Directories='$([System.IO.Directory]::GetDirectories(".","artifacts", SearchOption.AllDirectories))' />
197285
<RemoveDir Directories='$([System.IO.Directory]::GetDirectories(".","bin", SearchOption.AllDirectories))' />

‎eng/pipelines/common/templates/steps/pre-build-step.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@ steps:
2929
displayName: 'Start SQLBrowser'
3030

3131
- task: NuGetToolInstaller@1
32-
displayName: 'Use NuGet '
32+
displayName: 'Use NuGet'

‎eng/pipelines/common/templates/steps/update-config-file-step.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ parameters:
126126

127127
steps:
128128
# All properties should be added here, and this template should be used for any manipulation of the config.json file.
129-
- powershell: |
129+
- pwsh: |
130130
$jdata = Get-Content -Raw "config.default.json" | ConvertFrom-Json
131131
foreach ($p in $jdata)
132132
{
@@ -186,7 +186,7 @@ steps:
186186
displayName: 'Update config.json'
187187

188188
- ${{ if eq(parameters.debug, true) }}:
189-
- powershell: |
189+
- pwsh: |
190190
$jdata = Get-Content -Raw "config.json" | ConvertFrom-Json
191191
foreach ($p in $jdata)
192192
{

‎src/Microsoft.Data.SqlClient/tests/FunctionalTests/AlwaysEncryptedTests/SqlColumnEncryptionCertificateStoreProviderShould.cs‎

Lines changed: 28 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,16 @@ public void EncryptAndDecryptDataSuccessfully()
217217
}
218218

219219
[Theory]
220-
[CEKEncryptionReversalParameters]
220+
[MemberData(
221+
nameof(CEKEncryptionReversalData)
222+
#if NETFRAMEWORK
223+
// .NET Framework puts system enums in something called the Global
224+
// Assembly Cache (GAC), and xUnit refuses to serialize enums that
225+
// live there. So for .NET Framework, we disable enumeration of the
226+
// test data to avoid warnings on the console when running tests.
227+
, DisableDiscoveryEnumeration = true
228+
#endif
229+
)]
221230
[PlatformSpecific(TestPlatforms.Windows)]
222231
public void TestCEKEncryptionReversal(StoreLocation certificateStoreLocation, String certificateStoreNameAndLocation)
223232
{
@@ -370,8 +379,13 @@ public void TestCustomKeyProviderListSetter()
370379
}
371380

372381
[Theory]
382+
[MemberData(
383+
nameof(ValidCertificatePathsData)
384+
#if NETFRAMEWORK
385+
, DisableDiscoveryEnumeration = true
386+
#endif
387+
)]
373388
[PlatformSpecific(TestPlatforms.Windows)]
374-
[ValidCertificatePathsParameters]
375389
public void TestValidCertificatePaths(string certificateStoreNameAndLocation, object location)
376390
{
377391
StoreLocation certificateStoreLocation;
@@ -490,33 +504,25 @@ public override IEnumerable<Object[]> GetData(MethodInfo testMethod)
490504
}
491505
}
492506

493-
public class CEKEncryptionReversalParameters : DataAttribute
507+
public static IEnumerable<object[]> CEKEncryptionReversalData()
494508
{
495-
public override IEnumerable<Object[]> GetData(MethodInfo testMethod)
509+
yield return new object[2] { StoreLocation.CurrentUser, CurrentUserMyPathPrefix };
510+
// use localmachine cert path only when current user is Admin.
511+
if (ColumnEncryptionCertificateFixture.IsAdmin)
496512
{
497-
yield return new object[2] { StoreLocation.CurrentUser, CurrentUserMyPathPrefix };
498-
// use localmachine cert path only when current user is Admin.
499-
if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows) && CertificateFixture.IsAdmin)
500-
{
501-
yield return new object[2] { StoreLocation.LocalMachine, LocalMachineMyPathPrefix };
502-
}
513+
yield return new object[2] { StoreLocation.LocalMachine, LocalMachineMyPathPrefix };
503514
}
504515
}
505516

506-
507-
public class ValidCertificatePathsParameters : DataAttribute
517+
public static IEnumerable<object[]> ValidCertificatePathsData()
508518
{
509-
510-
public override IEnumerable<Object[]> GetData(MethodInfo testMethod)
519+
yield return new object[2] { CurrentUserMyPathPrefix, StoreLocation.CurrentUser };
520+
// use localmachine cert path (or an incomplete path, which defaults to localmachine) only when current user is Admin.
521+
if (ColumnEncryptionCertificateFixture.IsAdmin)
511522
{
512-
yield return new object[2] { CurrentUserMyPathPrefix, StoreLocation.CurrentUser };
513-
yield return new object[2] { MyPathPrefix, null };
514-
yield return new object[2] { @"", null };
515-
// use localmachine cert path only when current user is Admin.
516-
if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows) && CertificateFixture.IsAdmin)
517-
{
518-
yield return new object[2] { LocalMachineMyPathPrefix, StoreLocation.LocalMachine };
519-
}
523+
yield return new object[2] { MyPathPrefix, StoreLocation.LocalMachine };
524+
yield return new object[2] { @"", StoreLocation.LocalMachine };
525+
yield return new object[2] { LocalMachineMyPathPrefix, StoreLocation.LocalMachine };
520526
}
521527
}
522528

‎src/Microsoft.Data.SqlClient/tests/FunctionalTests/AmbientTransactionFailureTest.cs‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
using System;
66
using System.Runtime.InteropServices;
7+
using System.Threading;
78
using System.Threading.Tasks;
89
using System.Transactions;
910
using Xunit;
@@ -75,7 +76,12 @@ public class AmbientTransactionFailureTest
7576
};
7677

7778
[ConditionalTheory(nameof(s_isNotArmProcess))] // https://github.com/dotnet/corefx/issues/21598
78-
[MemberData(nameof(ExceptionTestDataForSqlException))]
79+
[MemberData(
80+
nameof(ExceptionTestDataForSqlException),
81+
// xUnit can't consistently serialize the data for this test, so we
82+
// disable enumeration of the test data to avoid warnings on the
83+
// console.
84+
DisableDiscoveryEnumeration = true)]
7985
public void TestSqlException(Action<string> connectAction, string connectionString)
8086
{
8187
Assert.Throws<SqlException>(() =>

‎src/Microsoft.Data.SqlClient/tests/FunctionalTests/SqlClientFactoryTest.cs‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,12 @@ public void InstanceTest()
3131
};
3232

3333
[Theory]
34-
[MemberData(nameof(FactoryMethodTestData))]
34+
[MemberData(
35+
nameof(FactoryMethodTestData),
36+
// xUnit can't consistently serialize the data for this test, so we
37+
// disable enumeration of the test data to avoid warnings on the
38+
// console.
39+
DisableDiscoveryEnumeration = true)]
3540
public void FactoryMethodTest(Func<object> factory, Type expectedType, bool singleton)
3641
{
3742
object value1 = factory();

‎src/Microsoft.Data.SqlClient/tests/FunctionalTests/SqlCommandSetTest.cs‎

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
using System;
2+
using System.Collections.Generic;
23
using System.Data;
34
using System.Reflection;
45
using Xunit;
@@ -29,9 +30,26 @@ public void AppendCommandWithEmptyString_Throws()
2930
VerifyException<InvalidOperationException>(ex, "CommandText property has not been initialized");
3031
}
3132

33+
public static IEnumerable<object[]> CommandTypeData()
34+
{
35+
return new object[][]
36+
{
37+
new object[] { CommandType.TableDirect },
38+
new object[] { (CommandType)5 }
39+
};
40+
}
41+
3242
[Theory]
33-
[InlineData(CommandType.TableDirect)]
34-
[InlineData((CommandType)5)]
43+
[MemberData(
44+
nameof(CommandTypeData)
45+
#if NETFRAMEWORK
46+
// .NET Framework puts system enums in something called the Global
47+
// Assembly Cache (GAC), and xUnit refuses to serialize enums that
48+
// live there. So for .NET Framework, we disable enumeration of the
49+
// test data to avoid warnings on the console when running tests.
50+
, DisableDiscoveryEnumeration = true
51+
#endif
52+
)]
3553
public void AppendBadCommandType_Throws(CommandType commandType)
3654
{
3755
var cmdSet = CreateInstance();

‎src/Microsoft.Data.SqlClient/tests/FunctionalTests/SqlDataRecordTest.cs‎

Lines changed: 21 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,13 @@ public void GetChar_ThrowsNotSupported()
320320
}
321321

322322
[Theory]
323-
[ClassData(typeof(GetUdtTypeTestData))]
323+
[MemberData(
324+
nameof(GetUdtTypeTestData.Get),
325+
MemberType = typeof(GetUdtTypeTestData),
326+
// xUnit can't consistently serialize the data for this test, so we
327+
// disable enumeration of the test data to avoid warnings on the
328+
// console.
329+
DisableDiscoveryEnumeration = true)]
324330
public void GetUdt_ReturnsValue(Type udtType, object value, string serverTypeName)
325331
{
326332
SqlMetaData[] metadata = new SqlMetaData[] { new SqlMetaData(nameof(udtType.Name), SqlDbType.Udt, udtType, serverTypeName) };
@@ -333,7 +339,10 @@ public void GetUdt_ReturnsValue(Type udtType, object value, string serverTypeNam
333339
}
334340

335341
[Theory]
336-
[ClassData(typeof(GetXXXBadTypeTestData))]
342+
[MemberData(
343+
nameof(GetXXXBadTypeTestData.Get),
344+
MemberType = typeof(GetXXXBadTypeTestData),
345+
DisableDiscoveryEnumeration = true)]
337346
public void GetXXX_ThrowsIfBadType(Func<SqlDataRecord, object> getXXX)
338347
{
339348
SqlMetaData[] metaData = new SqlMetaData[]
@@ -347,7 +356,10 @@ public void GetXXX_ThrowsIfBadType(Func<SqlDataRecord, object> getXXX)
347356
}
348357

349358
[Theory]
350-
[ClassData(typeof(GetXXXCheckValueTestData))]
359+
[MemberData(
360+
nameof(GetXXXCheckValueTestData.Get),
361+
MemberType = typeof(GetXXXCheckValueTestData),
362+
DisableDiscoveryEnumeration = true)]
351363
public void GetXXX_ReturnValue(SqlDbType dbType, object value, Func<SqlDataRecord, object> getXXX)
352364
{
353365
SqlMetaData[] metaData = new SqlMetaData[]
@@ -361,9 +373,9 @@ public void GetXXX_ReturnValue(SqlDbType dbType, object value, Func<SqlDataRecor
361373
}
362374
}
363375

364-
public class GetXXXBadTypeTestData : IEnumerable<object[]>
376+
public class GetXXXBadTypeTestData
365377
{
366-
public IEnumerator<object[]> GetEnumerator()
378+
public static IEnumerable<object[]> Get()
367379
{
368380
yield return new object[] { new Func<SqlDataRecord, object>(r => r.GetGuid(0)) };
369381
yield return new object[] { new Func<SqlDataRecord, object>(r => r.GetInt16(0)) };
@@ -376,31 +388,21 @@ public IEnumerator<object[]> GetEnumerator()
376388
yield return new object[] { new Func<SqlDataRecord, object>(r => r.GetDateTimeOffset(0)) };
377389
yield return new object[] { new Func<SqlDataRecord, object>(r => r.GetTimeSpan(0)) };
378390
}
379-
380-
IEnumerator IEnumerable.GetEnumerator()
381-
{
382-
return GetEnumerator();
383-
}
384391
}
385392

386-
public class GetUdtTypeTestData : IEnumerable<object[]>
393+
public class GetUdtTypeTestData
387394
{
388-
public IEnumerator<object[]> GetEnumerator()
395+
public static IEnumerable<object[]> Get()
389396
{
390397
yield return new object[] { typeof(SqlGeography), SqlGeography.Point(43, -81, 4326), "Geography" };
391398
yield return new object[] { typeof(SqlGeometry), SqlGeometry.Point(43, -81, 4326), "Geometry" };
392399
yield return new object[] { typeof(SqlHierarchyId), SqlHierarchyId.Parse("/"), "HierarchyId" };
393400
}
394-
395-
IEnumerator IEnumerable.GetEnumerator()
396-
{
397-
return GetEnumerator();
398-
}
399401
}
400402

401-
public class GetXXXCheckValueTestData : IEnumerable<object[]>
403+
public class GetXXXCheckValueTestData
402404
{
403-
public IEnumerator<object[]> GetEnumerator()
405+
public static IEnumerable<object[]> Get()
404406
{
405407
yield return new object[] { SqlDbType.UniqueIdentifier, Guid.NewGuid(), new Func<SqlDataRecord, object>(r => r.GetGuid(0)) };
406408
yield return new object[] { SqlDbType.SmallInt, (short)123, new Func<SqlDataRecord, object>(r => r.GetInt16(0)) };
@@ -417,11 +419,6 @@ public IEnumerator<object[]> GetEnumerator()
417419
yield return new object[] { SqlDbType.SmallDateTime, DateTime.Now, new Func<SqlDataRecord, object>(r => r.GetDateTime(0)) };
418420
yield return new object[] { SqlDbType.TinyInt, (byte)1, new Func<SqlDataRecord, object>(r => r.GetByte(0)) };
419421
}
420-
421-
IEnumerator IEnumerable.GetEnumerator()
422-
{
423-
return GetEnumerator();
424-
}
425422
}
426423
[SqlServer.Server.SqlUserDefinedType(SqlServer.Server.Format.UserDefined)]
427424
public class TestUdt {}

0 commit comments

Comments
 (0)