Update xunit version to 2.4 and target NS2.0 (#269)

* Revert "Revert "Update xUnit and CommandLineParser NuGet packages to stable versions (#257)" (#262)" * Target NS2.0 and increase xunit to 2.4 * Add temporary forked CLP package
microsoft · Jul 21, 2018 · df2a359 · df2a359
1 parent 9d19c5b
commit df2a359
Show file tree

Hide file tree

Showing 24 changed files with 114 additions and 72 deletions.
diff --git a/BuildForPublication.cmd b/BuildForPublication.cmd
@@ -5,7 +5,7 @@
 setlocal EnableDelayedExpansion
   set errorlevel=
   set BuildConfiguration=Release
-  set VersionSuffix=beta-build0019
+  set VersionSuffix=beta-build0020
 
   REM Check that git is on path.
   where.exe /Q git.exe || (

diff --git a/build.cmd b/build.cmd
@@ -72,7 +72,7 @@ setlocal
   cd /d %~dp0tests\simpleharness
   call :dotnet_build || exit /b 1
 
-  for %%v in (netcoreapp1.0 netcoreapp1.1 netcoreapp2.0 net461) do (
+  for %%v in (netcoreapp2.0 net461) do (
     dotnet.exe publish -c %BuildConfiguration% --framework "%%v"                            || exit /b 1
     pushd ".\bin\%BuildConfiguration%\%%v\publish"
     if "%%v" == "net461" (
@@ -90,7 +90,7 @@ setlocal
   cd /d %~dp0tests\scenariobenchmark
   call :dotnet_build || exit /b 1
 
-  for %%v in (netcoreapp1.0 netcoreapp1.1 netcoreapp2.0 net461) do (
+  for %%v in (netcoreapp2.0 net461) do (
     dotnet.exe publish -c %BuildConfiguration% --framework "%%v"                          || exit /b 1
     pushd ".\bin\%BuildConfiguration%\%%v\publish"
     if "%%v" == "net461" (

diff --git a/dotnet-install.cmd b/dotnet-install.cmd
@@ -39,7 +39,7 @@ setlocal
   )
 
   echo Executing dotnet installer script "%DotNet_Path%\dotnet-install.ps1"
-  for %%v in (1.0.0 1.1.0 2.0.0) do (
+  for %%v in (2.0.0) do (
     echo Installing dotnet sdk version %%~v
     powershell -NoProfile -ExecutionPolicy unrestricted -Command "&'%DotNet_Path%\dotnet-install.ps1' -InstallDir '%DotNet_Path%' -Version '%%~v'" || (
       call :print_error_message Failed to install dotnet shared runtime %%~v

diff --git a/src/version.props b/src/version.props
@@ -1,6 +1,6 @@
 <Project>
   <PropertyGroup>
     <MicrosoftDiagnosticsTracingLibraryVersion>2.0.5</MicrosoftDiagnosticsTracingLibraryVersion>
-    <XunitPackageVersion>2.2.0-beta2-build3300</XunitPackageVersion>
+    <XunitPackageVersion>2.4.0</XunitPackageVersion>
   </PropertyGroup>
 </Project>
diff --git a/src/xunit.performance.api/ConsoleDiagnosticMessageSink.cs b/src/xunit.performance.api/ConsoleDiagnosticMessageSink.cs
@@ -11,12 +11,23 @@ namespace Microsoft.Xunit.Performance.Api
     /// This is the message sink that receives IDiagnosticMessage messages from
     /// the XunitFrontController.
     /// </summary>
-    internal sealed class ConsoleDiagnosticMessageSink : TestMessageVisitor<IDiagnosticMessage>
+    internal sealed class ConsoleDiagnosticMessageSink : TestMessageSink
     {
-        protected override bool Visit(IDiagnosticMessage diagnosticMessage)
+        public ConsoleDiagnosticMessageSink()
         {
-            WriteErrorLine(diagnosticMessage.Message);
-            return true;
+            Diagnostics.DiagnosticMessageEvent += OnDiagnosticMessageEvent;
+        }
+
+        private static void OnDiagnosticMessageEvent(MessageHandlerArgs<IDiagnosticMessage> args)
+        {
+            WriteErrorLine(args.Message.Message);
+        }
+
+        public override void Dispose()
+        {
+            Diagnostics.DiagnosticMessageEvent -= OnDiagnosticMessageEvent;
+
+            base.Dispose();
         }
     }
 }
diff --git a/...ance.api/PerformanceTestMessageVisitor.cs → ...ormance.api/PerformanceTestMessageSink.cs b/...ance.api/PerformanceTestMessageVisitor.cs → ...ormance.api/PerformanceTestMessageSink.cs
@@ -3,26 +3,30 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Reflection;
+using System.Threading;
 using Xunit;
 using Xunit.Abstractions;
 
 namespace Microsoft.Xunit.Performance.Api
 {
-    internal sealed class PerformanceTestMessageVisitor : TestMessageVisitor<IDiscoveryCompleteMessage>
+    internal sealed class PerformanceTestMessageSink : TestMessageSink
     {
-        public PerformanceTestMessageVisitor()
+        public PerformanceTestMessageSink()
         {
+            Finished = new ManualResetEvent(false);
             Tests = new List<PerformanceTestMessage>();
+            Discovery.TestCaseDiscoveryMessageEvent += OnTestCaseDiscoveryMessageEvent;
+            Discovery.DiscoveryCompleteMessageEvent += OnDiscoveryCompleteMessageEvent;
         }
 
         public List<PerformanceTestMessage> Tests { get; }
 
-        protected override bool Visit(ITestCaseDiscoveryMessage testCaseDiscovered)
+        private void OnTestCaseDiscoveryMessageEvent(MessageHandlerArgs<ITestCaseDiscoveryMessage> args)
         {
-            var testCase = testCaseDiscovered.TestCase;
+            var testCase = args.Message.TestCase;
             if (string.IsNullOrEmpty(testCase.SkipReason)) /* TODO: Currently there are not filters */
             {
-                var testMethod = testCaseDiscovered.TestMethod;
+                var testMethod = args.Message.TestMethod;
                 var metrics = new List<PerformanceMetricInfo>();
                 var attributesInfo = GetMetricAttributes(testMethod);
 
@@ -38,12 +42,16 @@ protected override bool Visit(ITestCaseDiscoveryMessage testCaseDiscovered)
                 {
                     Tests.Add(new PerformanceTestMessage
                     {
-                        TestCase = testCaseDiscovered.TestCase,
+                        TestCase = args.Message.TestCase,
                         Metrics = metrics
                     });
                 }
             }
-            return true;
+        }
+
+        private void OnDiscoveryCompleteMessageEvent(MessageHandlerArgs<IDiscoveryCompleteMessage> args)
+        {
+            Finished.Set();
         }
 
         private static IEnumerable<IAttributeInfo> GetMetricAttributes(ITestMethod testMethod)
@@ -78,5 +86,15 @@ private static Type GetType(string assemblyName, string typeName)
 
             return null;
         }
+
+        public override void Dispose()
+        {
+            Discovery.DiscoveryCompleteMessageEvent -= OnDiscoveryCompleteMessageEvent;
+            Discovery.TestCaseDiscoveryMessageEvent -= OnTestCaseDiscoveryMessageEvent;
+
+            base.Dispose();
+        }
+
+        public ManualResetEvent Finished { get; }
     }
 }
diff --git a/src/xunit.performance.api/XunitBenchmark.cs b/src/xunit.performance.api/XunitBenchmark.cs
@@ -18,16 +18,16 @@ public static XUnitPerformanceMetricData GetMetadata(
                 appDomainSupport: AppDomainSupport.Denied,
                 diagnosticMessageSink: new ConsoleDiagnosticMessageSink()))
             {
-                using (var testMessageVisitor = new PerformanceTestMessageVisitor())
+                using (var testMessageSink = new PerformanceTestMessageSink())
                 {
                     controller.Find(
                         includeSourceInformation: false,
-                        messageSink: testMessageVisitor,
+                        messageSink: testMessageSink,
                         discoveryOptions: TestFrameworkOptions.ForDiscovery());
-                    testMessageVisitor.Finished.WaitOne();
+                    testMessageSink.Finished.WaitOne();
 
                     var testProviders =
-                        from test in testMessageVisitor.Tests
+                        from test in testMessageSink.Tests
                         from metric in test.Metrics.Cast<PerformanceMetric>()
                         from provider in metric.ProviderInfo
                         select provider;
@@ -38,7 +38,7 @@ from provider in metric.ProviderInfo
                         userProviders = ProviderInfo.Merge(userProviders.Concat(performanceMetricInfo.ProviderInfo));
 
                     // Inject performance metrics into the tests
-                    foreach (var test in testMessageVisitor.Tests)
+                    foreach (var test in testMessageSink.Tests)
                     {
                         test.Metrics = collectDefaultMetrics ?
                             test.Metrics.Union(performanceMetricInfos, new PerformanceMetricInfoComparer()) :
@@ -47,7 +47,7 @@ from provider in metric.ProviderInfo
 
                     return new XUnitPerformanceMetricData {
                         Providers = ProviderInfo.Merge(testProviders.Concat(userProviders)),
-                        PerformanceTestMessages = testMessageVisitor.Tests,
+                        PerformanceTestMessages = testMessageSink.Tests,
                     };
                 }
             }

diff --git a/src/xunit.performance.api/xunit.performance.api.csproj b/src/xunit.performance.api/xunit.performance.api.csproj
@@ -4,21 +4,18 @@
 
   <PropertyGroup>
     <AssemblyTitle>xunit.performance.api</AssemblyTitle>
-    <TargetFrameworks>netstandard1.6;net461</TargetFrameworks>
-    <TargetFrameworks Condition="'$(OS)' != 'Windows_NT'">netstandard1.6</TargetFrameworks>
+    <TargetFrameworks>netstandard2.0;net461;netcoreapp2.0</TargetFrameworks>
     <Title>xUnit Performance Api</Title>
     <RootNamespace>Microsoft.Xunit.Performance.Api</RootNamespace>
+    <IsPackable>true</IsPackable>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="CommandLineParser" Version="2.1.1-beta" />
+    <PackageReference Include="CommandLineParser.NS20" Version="2.3.1" />
     <PackageReference Include="Microsoft.3rdpartytools.MarkdownLog" Version="0.10.0-alpha-experimental" />
     <PackageReference Include="Microsoft.Diagnostics.Tracing.TraceEvent" Version="$(MicrosoftDiagnosticsTracingLibraryVersion)">
       <IncludeAssets>All</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="System.ValueTuple" Version="4.3.1" />
-    <PackageReference Include="System.Xml.XmlSerializer" Version="4.3.0" />
-    <PackageReference Include="System.Diagnostics.Process" Version="4.3.0" />
     <PackageReference Include="xunit.runner.utility" Version="$(XunitPackageVersion)" />
   </ItemGroup>
 

diff --git a/src/xunit.performance.core/xunit.performance.core.csproj b/src/xunit.performance.core/xunit.performance.core.csproj
@@ -4,8 +4,9 @@
 
   <PropertyGroup>
     <AssemblyTitle>xunit.performance.core</AssemblyTitle>
-    <TargetFramework>netstandard1.3</TargetFramework>
+    <TargetFramework>netstandard2.0</TargetFramework>
     <Title>xUnit Performance Core</Title>
+    <IsPackable>true</IsPackable>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/src/xunit.performance.execution/AllocatedBytesForCurrentThread.cs b/src/xunit.performance.execution/AllocatedBytesForCurrentThread.cs
@@ -1,11 +1,11 @@
-using System;
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System;
 using System.Reflection;
 
 namespace Microsoft.Xunit.Performance.Execution
 {
-    /// <summary>
-    ///
-    /// </summary>
     internal static class AllocatedBytesForCurrentThread
     {
         /// <summary>

diff --git a/src/xunit.performance.execution/BenchmarkDiscoverer.cs b/src/xunit.performance.execution/BenchmarkDiscoverer.cs
@@ -1,7 +1,6 @@
 // Copyright (c) Microsoft. All rights reserved.
 // Licensed under the MIT license. See LICENSE file in the project root for full license information.
 
-using System;
 using System.Collections.Generic;
 using Xunit.Abstractions;
 using Xunit.Sdk;
@@ -10,7 +9,7 @@ namespace Microsoft.Xunit.Performance
 {
     internal class BenchmarkDiscoverer : TheoryDiscoverer, ITraitDiscoverer
     {
-        private IMessageSink _diagnosticMessageSink;
+        private readonly IMessageSink _diagnosticMessageSink;
 
         public BenchmarkDiscoverer(IMessageSink diagnosticMessageSink)
             : base(diagnosticMessageSink)
@@ -21,14 +20,15 @@ public BenchmarkDiscoverer(IMessageSink diagnosticMessageSink)
         public override IEnumerable<IXunitTestCase> Discover(ITestFrameworkDiscoveryOptions discoveryOptions, ITestMethod testMethod, IAttributeInfo benchmarkAttribute)
         {
             var defaultMethodDisplay = discoveryOptions.MethodDisplayOrDefault();
+            var defaultMethodDisplayOptions = discoveryOptions.MethodDisplayOptionsOrDefault();
 
             //
             // Special case Skip, because we want a single Skip (not one per data item), and a skipped test may
             // not actually have any data (which is quasi-legal, since it's skipped).
             //
             if (benchmarkAttribute.GetNamedArgument<string>("Skip") != null)
             {
-                yield return new XunitTestCase(_diagnosticMessageSink, defaultMethodDisplay, testMethod);
+                yield return new XunitTestCase(_diagnosticMessageSink, defaultMethodDisplay, defaultMethodDisplayOptions, testMethod);
                 yield break;
             }
 
@@ -45,14 +45,14 @@ public override IEnumerable<IXunitTestCase> Discover(ITestFrameworkDiscoveryOpti
                     // TheoryDiscoverer returns one of these if it cannot enumerate the cases now.
                     // We'll return a BenchmarkTestCase with no data associated.
                     //
-                    yield return new BenchmarkTestCase(_diagnosticMessageSink, defaultMethodDisplay, testMethod, benchmarkAttribute);
+                    yield return new BenchmarkTestCase(_diagnosticMessageSink, defaultMethodDisplay, defaultMethodDisplayOptions, testMethod, benchmarkAttribute);
                 }
                 else
                 {
                     //
                     // This is a test case with data
                     //
-                    yield return new BenchmarkTestCase(_diagnosticMessageSink, defaultMethodDisplay, testMethod, benchmarkAttribute, theoryCase.TestMethodArguments);
+                    yield return new BenchmarkTestCase(_diagnosticMessageSink, defaultMethodDisplay, defaultMethodDisplayOptions, testMethod, benchmarkAttribute, theoryCase.TestMethodArguments);
                 }
             }
         }

diff --git a/src/xunit.performance.execution/BenchmarkTestCase.cs b/src/xunit.performance.execution/BenchmarkTestCase.cs
@@ -17,8 +17,8 @@ internal class BenchmarkTestCase : XunitTestCase
         [Obsolete("Called by the de-serializer; should only be called by deriving classes for de-serialization purposes")]
         public BenchmarkTestCase() { }
 
-        public BenchmarkTestCase(IMessageSink diagnosticMessageSink, TestMethodDisplay defaultMethodDisplay, ITestMethod testMethod, IAttributeInfo attr, object[] testMethodArguments = null)
-            : base(diagnosticMessageSink, defaultMethodDisplay, testMethod, testMethodArguments)
+        public BenchmarkTestCase(IMessageSink diagnosticMessageSink, TestMethodDisplay defaultMethodDisplay, TestMethodDisplayOptions defaultMethodDisplayOptions, ITestMethod testMethod, IAttributeInfo attr, object[] testMethodArguments = null)
+            : base(diagnosticMessageSink, defaultMethodDisplay, defaultMethodDisplayOptions, testMethod, testMethodArguments)
         {
             DiscoverArguments = testMethodArguments == null;
         }

diff --git a/src/xunit.performance.execution/BenchmarkTestInvoker.cs b/src/xunit.performance.execution/BenchmarkTestInvoker.cs
@@ -45,8 +45,7 @@ protected override object CallTestMethod(object testClassInstance)
                 {
                     var result = TestMethod.Invoke(testClassInstance, TestMethodArguments);
 
-                    var task = result as Task;
-                    if (task != null)
+                    if (result is Task task)
                     {
                         await task;
                         success = true;
@@ -83,7 +82,7 @@ internal sealed class BenchmarkIteratorImpl : BenchmarkIterator
             private int _currentIteration;
             private bool _currentIterationMeasurementStarted;
             private bool _currentIterationMeasurementStopped;
-            private int _maxIterations;
+            private readonly int _maxIterations;
 
             internal string IterationStopReason { get; private set; }
 

diff --git a/src/xunit.performance.execution/xunit.performance.execution.csproj b/src/xunit.performance.execution/xunit.performance.execution.csproj
@@ -4,10 +4,10 @@
 
   <PropertyGroup>
     <AssemblyTitle>xunit.performance.execution</AssemblyTitle>
-    <TargetFrameworks>netstandard1.5;net461</TargetFrameworks>
-    <TargetFrameworks Condition="'$(OS)' != 'Windows_NT'">netstandard1.5</TargetFrameworks>
+    <TargetFramework>netstandard2.0</TargetFramework>
     <Title>xUnit Performance Execution</Title>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+    <IsPackable>true</IsPackable>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/src/xunit.performance.metrics/xunit.performance.metrics.csproj b/src/xunit.performance.metrics/xunit.performance.metrics.csproj
@@ -4,9 +4,9 @@
 
   <PropertyGroup>
     <AssemblyTitle>xunit.performance.metrics</AssemblyTitle>
-    <TargetFrameworks>netstandard1.6;net461</TargetFrameworks>
-    <TargetFrameworks Condition="'$(OS)' != 'Windows_NT'">netstandard1.6</TargetFrameworks>
+    <TargetFramework>netstandard2.0</TargetFramework>
     <Title>xUnit Performance Metrics</Title>
+    <IsPackable>true</IsPackable>
   </PropertyGroup>
 
   <ItemGroup>
@@ -15,7 +15,6 @@
 
   <ItemGroup>
     <PackageReference Include="Microsoft.Diagnostics.Tracing.TraceEvent" Version="$(MicrosoftDiagnosticsTracingLibraryVersion)" />
-    <PackageReference Include="System.Runtime.Serialization.Formatters" Version="4.3.0" />
   </ItemGroup>
 
 </Project>
diff --git a/tests/scenariobenchmark/Program.cs b/tests/scenariobenchmark/Program.cs
@@ -1,11 +1,13 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
 using Microsoft.Xunit.Performance.Api;
 using System;
 using System.Collections.Generic;
 using System.Diagnostics;
 using System.Runtime.InteropServices;
 
-
-namespace simpleharness
+namespace scenariobenchmark
 {
     public class Program
     {

diff --git a/tests/scenariobenchmark/scenariobenchmark.csproj b/tests/scenariobenchmark/scenariobenchmark.csproj
@@ -6,8 +6,8 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFrameworks>netcoreapp1.0;netcoreapp1.1;netcoreapp2.0;net461</TargetFrameworks>
-    <TargetFrameworks Condition="'$(OS)' != 'Windows_NT'">netcoreapp1.0;netcoreapp1.1;netcoreapp2.0</TargetFrameworks>
+    <TargetFrameworks>netcoreapp2.0;net461</TargetFrameworks>
+    <TargetFrameworks Condition="'$(OS)' != 'Windows_NT'">netcoreapp2.0</TargetFrameworks>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/tests/simpleharness/EmptyBenchmarkTest.cs b/tests/simpleharness/EmptyBenchmarkTest.cs
@@ -1,4 +1,7 @@
-using Microsoft.Xunit.Performance;
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using Microsoft.Xunit.Performance;
 
 namespace simpleharness
 {

diff --git a/tests/simpleharness/EndToEndTests.cs b/tests/simpleharness/EndToEndTests.cs
@@ -1,3 +1,6 @@
+// Copyright (c) Microsoft. All rights reserved.
+// Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
 using Microsoft.Xunit.Performance;
 
 namespace simpleharness