Performance benchmarking and testing framework for .NET applications :chart_with_upwards_trend:
NBench 2.0.0 is a major departure from NBench 1.2 and preceding versions, and these changes were done in order to support NBench's future as a cutting-edge, cross-platform performance testing and macro benchmarking framework:
dotnet nbench and NBench.Runner are both now deprecated - NBench is now run from directly inside a console application created by end-users. This makes it easier to configure, debug, and create benchmarks on new .NET Core platforms without having to wait for additional instrumentation or tooling from NBench itself.TestPackage class.For a full set of changes, please see the NBench 2.0.0 milestone on Github.
2.0.1 Notes:
For a full set of changes, please see the NBench 2.0.1 milestone on Github.
This list of changes was auto generated.
NBench 2.0.0 is a major departure from NBench 1.2 and preceding versions, and these changes were done in order to support NBench's future as a cutting-edge, cross-platform performance testing and macro benchmarking framework:
dotnet nbench and NBench.Runner are both now deprecated - NBench is now run from directly inside a console application created by end-users. This makes it easier to configure, debug, and create benchmarks on new .NET Core platforms without having to wait for additional instrumentation or tooling from NBench itself.TestPackage class.For a full set of changes, please see the NBench 2.0.0 milestone on Github.
Introduces the dotnet-nbench package, which allows all NBench packages to be executed via the dotnet CLI regardless of how many frameworks are targeted by a particular project.
You can read more about the details of how the dotnet-nbench package works here: https://github.com/Petabridge/NBench/blob/master/README.md#running-nbench-tests-with-dotnet-nbench
Support for .NET Core 2.0 and 2.1 All NBench runners now ship with native support for .NET Core 2.0 and .NET Core 2.1.
Fixes several major issues with the NBench.Runner executable and being able to support .NET Core dependencies. This is the first set of fixes in a series of ongoing changes designed to help make NBench more user-friendly, extensible, and capable of all manner of interesting performance-related tasks.
New Feature: Explicitly Settable Counters
Counter instances can now be explicitly set to increment or decrement by a known value:
var counter = new Counter(new AtomicCounter(), new CounterMetricName("foo"));
counter.Increment(10);
counter.Decrement(2);
Console.WriteLine(counter.Current); // will print out 8
This release resolves an issue with NuGet deployment of our .NET Core versions of the NBench.Runner executable. As a standalone .NET Core executable, the .NET Core runtime must be packaged in the same folder as the .exe. This release ensures that the .NET Core runtime is downloaded along with our .NET Core NBench Runner executables.
This release resolves issues with NuGet deployment of the dedicated NBench.Runner.DotNetCli runner that was originally designed to be used for .NET Core projects. The issue is detailed by #200 and resolved with PR #201.
Important breaking change:
NBench.Runner.DotNetCli is being deprecated (temporarily) as the supported means of running the NBench runner with a benchmark assembly that targets .NET Core. Instead, the original NBench.Runner will come packaged with 2 additional executables that are compatible with .NET Core. Originally, per the instructions on the README, to run the .NET 4.5.2 you would run the following commands:
PS> Install-Package NBench.Runner
PS> .\packages\NBench.Runner\NBench.Runner.exe .\src\bin\Debug\MyPerfTests.dll output-directory="C:\Perf
Since the new NBench.Runner NuGet package ships the additional .NET Core runner, the folder structure of the downloaded runner is as follows:
lib/
net452/
NBench.Runner.exe
netcoreapp1.1/
win7-x64/
NBench.Runner.exe
debian8-x64/
NBench.Runner
The above way to run the .NET 4.5.2 runner, hence, changes to:
PS> Install-Package NBench.Runner
PS> .\packages\NBench.Runner\lib\net452\NBench.Runner.exe .\src\bin\Debug\net452\MyPerfTests.dll output-directory="C:\Perf
For .NET Core support (meaning running a benchmark that has been targeted for netcoreapp1.1 or netstandard1.6, you will run the appropriate NBench.Runner.exe for your architecture:
PS> Install-Package NBench.Runner
PS> .\packages\NBench.Runner\lib\netcoreapp1.1\win7-x64\NBench.Runner.exe .\src\bin\Debug\netcoreapp1.1\MyPerfTests.dll output-directory="C:\Perf
or, on Debian 8:
PS> Install-Package NBench.Runner
PS> .\packages\NBench.Runner\lib\netcoreapp1.1\debian8-x64\NBench.Runner.exe .\src\bin\Debug\netcoreapp1.1\MyPerfTests.dll output-directory="C:\Perf
Plans will be made to re-introduce support for NBench.Runner.DotNetCli which allows for the usage of NBench as a DotNetCliToolReference.
This release resolves issues: #182 and #192 relating to the NBench.Runner.DotNetCli (the NBench Runner that can execute benchmarks for assemblies that target .NET Core). The root cause was that the runner was unable to execute .NET Core benchmarks that had external dependencies.
Other changes include:
netcoreapp1.1
If you are using the .NET Core CLI runner for NBench and encountered this issue, please be sure to update your <DotNetCliToolReference> to v1.0.2:
<ItemGroup>
<DotNetCliToolReference Include="NBench.Runner.DotNetCli" Version="1.0.2" />
</ItemGroup>