Use Verify library for approval tests (#2330)

* Used Verify library for approval tests

* Removed unnecessary item group

* Approval -> Verify renaming

* Avoid duplication of directory name for VerifyTests

* Disabled diff tool for better console experience

* Renamed files after classes

* Updated documentation

---------

Co-authored-by: Alina Smirnova <[email protected]>

Author: alinasmirnova

docs/articles/contributing/running-tests.md

@@ -14,8 +14,8 @@ dotnet test -c Release -f net5.0 BenchmarkDotNet.sln
 
 You should be able to run all of tests from your IDE as well.
 
-## Approval Tests
+## Verify Tests
 
-For some unit tests (e.g. for exporter tests) BenchmarkDotNet uses [approval tests'](https://approvaltests.com/) implementation for .NET: [ApprovalTests.Net](https://github.com/approvals/ApprovalTests.Net).
-* The expected value for each test is stored in a `*.approved.txt` file located near the test source file in the repository. ApprovalTests.NET generates approved file's names automatically according test name and its parameters. This files must be added under the source control.
-* It also creates a `*.received` file for each failed test. You can use different reporters for convenient file comparison. By default we use XUnit2Reporter, so you can find test run results on the test runner console as usual. You can add [UseReporter(typeof(KDiffReporter))] on test class and then ApprovalTests will open KDiff for each failed test. This way you can easily understand what's the difference between approved and received values and choose the correct one.
+For some unit tests (e.g. for exporter tests) BenchmarkDotNet uses [Verify](https://github.com/VerifyTests/Verify).
+* The expected value for each test is stored in a `*.verified.txt` file located near the test source file in the repository. Verify generates verified file's names automatically according test name and its parameters. This files must be added under the source control.
+* It also creates a `*.received` file for each failed test. You can use diff tools for convenient file comparison. By default you can find test run results on the test runner console as usual. You can comment out the line ```result.DisableDiff()``` in ```VerifySettingsFactory.Create``` method and then Verify will open KDiff for each failed test. This way you can easily understand what's the difference between verified and received values and choose the correct one.

tests/BenchmarkDotNet.Tests/Attributes/ParamsAllValuesApprovalTests.cs renamed to tests/BenchmarkDotNet.Tests/Attributes/ParamsAllValuesVerifyTests.cs

@@ -2,32 +2,27 @@
 using System.Diagnostics.CodeAnalysis;
 using System.Globalization;
 using System.Linq;
-using System.Runtime.CompilerServices;
 using System.Threading;
-using ApprovalTests;
-using ApprovalTests.Namers;
-using ApprovalTests.Reporters;
+using System.Threading.Tasks;
 using BenchmarkDotNet.Exporters;
 using BenchmarkDotNet.Loggers;
 using BenchmarkDotNet.Tests.Mocks;
 using BenchmarkDotNet.Attributes;
-using BenchmarkDotNet.Tests.XUnit;
+using BenchmarkDotNet.Tests.Builders;
 using BenchmarkDotNet.Validators;
 using JetBrains.Annotations;
+using VerifyXunit;
 using Xunit;
 
 namespace BenchmarkDotNet.Tests.Attributes
 {
-    // In case of failed approval tests, use the following reporter:
-    // [UseReporter(typeof(KDiffReporter))]
-    [UseReporter(typeof(PatchedXUnit2Reporter))]
-    [UseApprovalSubdirectory("ApprovedFiles")]
-    [Collection("ApprovalTests")]
-    public class ParamsAllValuesApprovalTests : IDisposable
+    [Collection("VerifyTests")]
+    [UsesVerify]
+    public class ParamsAllValuesVerifyTests : IDisposable
     {
         private readonly CultureInfo initCulture;
 
-        public ParamsAllValuesApprovalTests() => initCulture = Thread.CurrentThread.CurrentCulture;
+        public ParamsAllValuesVerifyTests() => initCulture = Thread.CurrentThread.CurrentCulture;
 
         [UsedImplicitly]
         public static TheoryData<Type> GetBenchmarkTypes()
@@ -40,10 +35,8 @@ public static TheoryData<Type> GetBenchmarkTypes()
 
         [Theory]
         [MemberData(nameof(GetBenchmarkTypes))]
-        [MethodImpl(MethodImplOptions.NoInlining)]
-        public void BenchmarkShouldProduceSummary(Type benchmarkType)
+        public Task BenchmarkShouldProduceSummary(Type benchmarkType)
         {
-            NamerFactory.AdditionalInformation = benchmarkType.Name;
             Thread.CurrentThread.CurrentCulture = CultureInfo.InvariantCulture;
 
             var logger = new AccumulationLogger();
@@ -60,7 +53,9 @@ public void BenchmarkShouldProduceSummary(Type benchmarkType)
             foreach (var error in errors)
                 logger.WriteLineError("* " + error.Message);
 
-            Approvals.Verify(logger.GetLog());
+            var settings = VerifySettingsFactory.Create();
+            settings.UseTextForParameters(benchmarkType.Name);
+            return Verifier.Verify(logger.GetLog(), settings);
         }
 
         public void Dispose() => Thread.CurrentThread.CurrentCulture = initCulture;

tests/BenchmarkDotNet.Tests/Attributes/ApprovedFiles/ParamsAllValuesApprovalTests.BenchmarkShouldProduceSummary.WithAllValuesOfBool.approved.txt renamed to tests/BenchmarkDotNet.Tests/Attributes/VerifiedFiles/ParamsAllValuesVerifyTests.BenchmarkShouldProduceSummary_WithAllValuesOfBool.verified.txt

@@ -16,12 +16,12 @@
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.2" />
+    <PackageReference Include="Verify.Xunit" Version="20.3.2" />
     <PackageReference Include="xunit" Version="2.4.2" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="ApprovalTests" Version="3.1.0" />
   </ItemGroup>
   <ItemGroup Condition=" '$(TargetFrameworkIdentifier)' == '.NETFramework' ">
     <ProjectReference Include="..\..\src\BenchmarkDotNet.Diagnostics.Windows\BenchmarkDotNet.Diagnostics.Windows.csproj" />