📊 Adds automatic benchmarking

.github/workflows/dotnet-build.yml

@@ -25,6 +25,43 @@ jobs:
       - name: Install dependencies
         run: dotnet restore
       - name: Build
-        run: dotnet build --configuration Release --no-restore
+        run: dotnet build -c Release --no-restore
       - name: Test
         run: dotnet test --no-restore --verbosity normal
+
+  benchmark:
+
+    name: Run benchmarks
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup .NET Core 5.0
+        uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: 5.0.x
+      - name: Install dependencies
+        run: dotnet restore
+      - name: Build
+        run: dotnet build -c Release --no-restore
+      - name: Run benchmarks
+        run: dotnet run --project Bearded.Utilities.Benchmarks -c Release --no-build -- -f '*' --join --exporters json
+      - name: Copy benchmark data to deterministic location
+        run: cp BenchmarkDotNet.Artifacts/results/*-report-full-compressed.json ./new-benchmark-data.json
+      - name: Download previous benchmark data
+        uses: actions/cache@v2
+        with:
+          path: ./benchmarks
+          key: ${{ runner.os }}-benchmark
+      - name: Process benchmark result
+        uses: Happypig375/[email protected]
+        with:
+          tool: 'benchmarkdotnet'
+          output-file-path: ./new-benchmark-data.json
+          external-data-json-path: ./benchmarks/benchmark-data.json
+          fail-on-alert: true
+          comment-on-alert: true
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Persist benchmark data
+        if: github.event_name != 'pull_request'
+        run: cp ./new-benchmark-data.json ./benchmarks/benchmark-data.json

.gitignore

@@ -187,3 +187,6 @@ FakesAssemblies/
 
 # Rider files
 .idea/
+
+# Benchmark outputs
+BenchmarkDotNet.Artifacts/

Bearded.Utilities.Benchmarks/Bearded.Utilities.Benchmarks.csproj

@@ -0,0 +1,18 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <OutputType>Exe</OutputType>
+        <TargetFramework>net5.0</TargetFramework>
+        <LangVersion>8</LangVersion>
+        <Nullable>enable</Nullable>
+    </PropertyGroup>
+
+    <ItemGroup>
+      <PackageReference Include="BenchmarkDotNet" Version="0.13.1" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\Bearded.Utilities\Bearded.Utilities.csproj" />
+    </ItemGroup>
+
+</Project>

Bearded.Utilities.Benchmarks/Linq/Extensions.cs

@@ -0,0 +1,67 @@
+using System;
+using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
+using Bearded.Utilities.Linq;
+using BenchmarkDotNet.Attributes;
+
+namespace Bearded.Utilities.Benchmarks.Linq
+{
+    [SuppressMessage("ReSharper", "ClassCanBeSealed.Global")]
+    public sealed class Extensions
+    {
+        private const int seed = 1337;
+        private const int count = 10000;
+
+        public abstract class ListBenchmark
+        {
+            protected List<int> List { get; }
+            protected Random Random { get; }
+
+            protected ListBenchmark()
+            {
+                List = new List<int>(count);
+                Random = new Random(seed);
+                for (var i = 0; i < count; i++)
+                {
+                    List.Add(Random.Next());
+                }
+            }
+        }
+
+        public class RandomElement : ListBenchmark
+        {
+            [Benchmark]
+            public int GetRandomElement()
+            {
+                return List.RandomElement();
+            }
+        }
+
+        public class RandomSubset : ListBenchmark
+        {
+            [Params(1, 100, count / 2, count - 100, count)]
+            public int SubsetSize { get; set; }
+
+            [Benchmark]
+            public List<int> GetRandomSubset()
+            {
+                return List.RandomSubset(SubsetSize);
+            }
+        }
+
+        public class Shuffle : ListBenchmark
+        {
+            [Benchmark]
+            public void ShuffleInPlace()
+            {
+                List.Shuffle(Random);
+            }
+
+            [Benchmark]
+            public IList<int> Shuffled()
+            {
+                return List.Shuffled(Random);
+            }
+        }
+    }
+}

Bearded.Utilities.Benchmarks/Program.cs

@@ -0,0 +1,13 @@
+using BenchmarkDotNet.Configs;
+using BenchmarkDotNet.Running;
+
+namespace Bearded.Utilities.Benchmarks
+{
+    static class Program
+    {
+        static void Main(string[] args)
+        {
+            BenchmarkSwitcher.FromAssembly(typeof(Program).Assembly).Run(args, new DebugInProcessConfig());
+        }
+    }
+}

Bearded.Utilities.sln

@@ -11,6 +11,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Bearded.Utilities.Testing",
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Bearded.Utilities.Testing.Tests", "Bearded.Utilities.Testing.Tests\Bearded.Utilities.Testing.Tests.csproj", "{D31CF841-95DD-4B6A-887C-930796E7FEDC}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Bearded.Utilities.Benchmarks", "Bearded.Utilities.Benchmarks\Bearded.Utilities.Benchmarks.csproj", "{6078D548-38CD-49B4-B1F7-228DB6325E06}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -33,6 +35,10 @@ Global
 		{D31CF841-95DD-4B6A-887C-930796E7FEDC}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{D31CF841-95DD-4B6A-887C-930796E7FEDC}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{D31CF841-95DD-4B6A-887C-930796E7FEDC}.Release|Any CPU.Build.0 = Release|Any CPU
+		{6078D548-38CD-49B4-B1F7-228DB6325E06}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{6078D548-38CD-49B4-B1F7-228DB6325E06}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{6078D548-38CD-49B4-B1F7-228DB6325E06}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{6078D548-38CD-49B4-B1F7-228DB6325E06}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE