Export benchmark results

README.md

@@ -1,2 +1,82 @@
-# BenchView
-A solution to view and keep track of benchmarking results in C#
+# GlassView
+
+A solution to view and keep track of benchmarking results of dotnet projects.
+
+This is still a project very much in it's infancy. But when it matures, it is supposed to export [BenchmarkDotNet](https://github.com/dotnet/BenchmarkDotNet) results such that they can be tracked over time. This should - if all goes according to plans -- allow teams to keep track of the performance characteristics of a project. Just as many teams already do with correctness and quality aspects by keeping trach of test results (coverage) and code quality metrics.
+
+## Vision
+
+The end product should be some interactive web interface that can run "anywhere" which enables analysis of your benchmark results.
+
+- [ ] Export benchmark results as json to some local directory.
+  - [x] Via a library (ToDo #12: nuget pending)
+  - [ ] Completely decoupled without any dll dependencies
+- [ ] Ingestion into some service(?) that creates (static) views.
+- [ ] Interactive web interface.
+- [ ] IDE integration (Visual Studio Code)?
+- [ ] Statistics suite with which,
+  - [ ] simple queries against past runs can be issued.
+  - [ ] regressions and trends can be detected and visualised
+- [ ] Integration into Ci/Cd systems (pipelines)
+
+For a complete and more detailed list, please check out our [issues](https://github.com/atmoos/GlassView/issues).
+
+## Current Set-Up
+
+Reference the nuget package `Atmoos.GlassView.Export` and modify your benchmarking project as follows:
+
+```csharp
+/* in: YourProject/Program.cs */
+// other usings...
+using Atmoos.GlassView.Export;
+using Microsoft.Extensions.Configuration;
+
+var configuration = new ConfigurationBuilder().AddJsonFile("appsettings.json").Build();
+
+IGlassView exporter = GlassView.Configure(configuration);
+
+// dotnet run -c Release --project 'YourProject/'
+var summary = BenchmarkSwitcher.FromAssembly(typeof(Program).Assembly).Run(args);
+
+await exporter.Export(summary);
+```
+
+## Configuration
+
+[Configuration](https://github.com/atmoos/GlassView/blob/main/source/GlassView.Export/Configuration/Configuration.cs) allows for optional configuration of:
+
+- The export directory.
+- Json formatting options.
+
+Without any configuration, the benchmark results are exported to `./BenchmarkDotNet.Artifacts/GlassView/`.
+
+A minimal `GlassView` configuration section might look something like this:
+
+```json
+{
+  "GlassView": {
+    "Export": {
+      "Directory": {
+        "Path": "Your/Export/Directory/"
+      }
+    }
+  }
+}
+```
+
+## Quick Start
+
+If you just want to get going and manually want to check for exported data, you can do so by using a `Program.cs` similar to this:
+
+```csharp
+/* in: YourProject/Program.cs */
+// other usings...
+using Atmoos.GlassView.Export;
+
+IGlassView exporter = GlassView.Default(); // exports to ./BenchmarkDotNet.Artifacts/GlassView/
+
+// dotnet run -c Release --project 'YourProject/'
+var summary = BenchmarkSwitcher.FromAssembly(typeof(Program).Assembly).Run(args);
+
+await exporter.Export(summary);
+```

documentation/Design.md

@@ -1,4 +1,37 @@
 # BenchView Design
 
-**ToDo**
+```mermaid
+---
+title: High Level Dependency Graph
+---
+classDiagram
+    Core <.. Services
+    Core <.. Export
+    Export <.. Benchmark
+    Library <.. Benchmark
+    namespace AtmoosGlassView {
+        class Core{
+            + Models
+            +Serialization()
+        }
+        class Services{
+            +Run(config)
+        }
+        class Export{
+            +Export(summary, config)
+        }
+    }
 
+    namespace User {
+        class Library{
+            + Shared
+        }
+        class Benchmark{
+            ~RunBenchmark()
+        }
+    }
+    note for Core "Library of shared\ntypes between <b>Export</b>\nand <b>Services</b>"
+    note for Services "Any service needed\nto realize tracking of\nbenchmarks."
+    note for Export "User configures how the\nexport of their benchmarks\nis to happen. Configured\nvia appsettings.json"
+    note for Benchmark "User benchmarking project of <b>Library</b>."
+```

source/GlassView.Benchmark/GlassView.Benchmark.csproj

@@ -0,0 +1,35 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <Import Project="../GlassView.Build.props" />
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+  </PropertyGroup>
+
+  <PropertyGroup>
+    <PlatformTarget>AnyCPU</PlatformTarget>
+    <DebugType>pdbonly</DebugType>
+    <DebugSymbols>true</DebugSymbols>
+    <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+    <Optimize>true</Optimize>
+    <Configuration>Release</Configuration>
+    <IsPackable>false</IsPackable>
+    <!-- Not bothering about null is handy for benchmarking projects... -->
+    <Nullable>disable</Nullable> 
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="BenchmarkDotNet" Version="0.13.12" />
+    <PackageReference Include="BenchmarkDotNet.Diagnostics.Windows" Version="0.13.12" Condition="'$(OS)' == 'Windows_NT'" />
+    <PackageReference Include="Microsoft.Extensions.Configuration.Json" Version="8.0.0" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\GlassView.Export\GlassView.Export.csproj" />
+    <ProjectReference Include="..\GlassView.Core\GlassView.Core.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Update="appsettings.json" CopyToOutputDirectory="PreserveNewest" />
+  </ItemGroup>
+
+</Project>

source/GlassView.Benchmark/OtherTestBenchmark.cs

@@ -0,0 +1,19 @@
+using System;
+using System.Linq;
+using BenchmarkDotNet.Attributes;
+
+namespace Atmoos.GlassView.Benchmark;
+
+[ShortRunJob]
+[IterationCount(7)]
+[MemoryDiagnoser]
+public class OtherTestBenchmark
+{
+    private const Int32 count = 8096;
+
+    [Benchmark(Baseline = true), BenchmarkCategory("SomeCat")]
+    public void SumStrings() => Thread.Sleep(7);
+
+    [Benchmark, BenchmarkCategory("OtherCat")]
+    public void SumChars() => Thread.Sleep(9);
+}

source/GlassView.Benchmark/Program.cs

@@ -0,0 +1,20 @@
+using BenchmarkDotNet.Columns;
+using BenchmarkDotNet.Configs;
+using BenchmarkDotNet.Running;
+using Microsoft.Extensions.Configuration;
+using Atmoos.GlassView.Export;
+
+using static BenchmarkDotNet.Columns.StatisticColumn;
+
+var configuration = new ConfigurationBuilder()
+    .AddJsonFile("appsettings.json", optional: false, reloadOnChange: false)
+    .Build();
+
+IGlassView exporter = GlassView.Configure(configuration);
+
+// dotnet run -c Release --project GlassView.Benchmark/
+var config = DefaultConfig.Instance.HideColumns(StdDev, Median, Kurtosis, BaselineRatioColumn.RatioStdDev);
+
+var summary = BenchmarkSwitcher.FromAssembly(typeof(Program).Assembly).Run(args, config);
+
+await exporter.Export(summary).ConfigureAwait(ConfigureAwaitOptions.None);

source/GlassView.Benchmark/TestBenchmark.cs

@@ -0,0 +1,22 @@
+using System;
+using System.Linq;
+using BenchmarkDotNet.Attributes;
+
+namespace Atmoos.GlassView.Benchmark;
+
+[ShortRunJob]
+[IterationCount(7)]
+[MemoryDiagnoser]
+public class TestBenchmark
+{
+    [Params(54, 42)]
+    public Int32 Count { get; set; }
+
+    [Benchmark(Baseline = true), BenchmarkCategory("SomeCat")]
+    public Int32 SumIntegers() => Integers(Count).Sum();
+
+    [Benchmark, BenchmarkCategory("OtherCat")]
+    public Double SumDoubles() => Doubles(Count).Sum();
+    private static Double[] Doubles(Int32 count) => Enumerable.Range(0, count).Select(i => i - count / 2d).ToArray();
+    private static Int32[] Integers(Int32 count) => Enumerable.Range(0, count).Select(i => i - count / 2).ToArray();
+}

source/GlassView.Benchmark/appsettings.json

@@ -0,0 +1,12 @@
+{
+  "GlassView": {
+    "Export": {
+      "JsonFormatting": {
+        "Indented": true
+      },
+      "Directory": {
+        "Path": "BenchmarkDotNet.Artifacts/GlassView/"
+      }
+    }
+  }
+}

source/GlassView.Build.props

@@ -0,0 +1,13 @@
+<Project>
+
+  <PropertyGroup>
+    <TargetFramework>net8.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup Condition="$(IsPackable)">
+    <InternalsVisibleTo Include="$(AssemblyName).Test" />
+  </ItemGroup>
+
+</Project>

source/GlassView.Core.Test/Convenience.cs

@@ -0,0 +1,11 @@
+using System.Text.Json;
+
+namespace Atmoos.GlassView.Core.Test;
+
+public static class Convenience
+{
+    private static readonly JsonSerializerOptions options = new JsonSerializerOptions() { WriteIndented = true }.EnableGlassView();
+
+    public static String Serialize<T>(this T value) => JsonSerializer.Serialize(value, options);
+    public static T Deserialize<T>(this String json) => JsonSerializer.Deserialize<T>(json, options) ?? throw new ArgumentException("Deserialization failed.", nameof(json));
+}

source/GlassView.Core.Test/GlassView.Core.Test.csproj

@@ -0,0 +1,17 @@
+<Project Sdk="Microsoft.NET.Sdk">
+  <Import Project="../GlassView.Build.props" />
+  <Import Project="../GlassView.Test.props" />
+
+  <PropertyGroup>
+    <RootNamespace>Atmoos.GlassView.Core.Test</RootNamespace>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\GlassView.Core\GlassView.Core.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Update="Resources\TestBenchmark.json" CopyToOutputDirectory="PreserveNewest" />
+  </ItemGroup> 
+
+</Project>

source/GlassView.Core.Test/GlobalUsings.cs

@@ -0,0 +1 @@
+global using Xunit;