Make BaselineCustomColumn expose "GetValue" as a public API (#1387)

- Add ability to generate baseline columns based on custom metrics
- Expose the existing GetValue method as public
- Closes #1385

Author: damageboy

build.sh

@@ -92,4 +92,4 @@ fi
 ###########################################################################
 
 # Start Cake
-exec mono "$CAKE_EXE" build.cake --verbosity=$VERBOSITY --configuration=$CONFIGURATION --target=$TARGET $DRYRUN "${SCRIPT_ARGUMENTS[@]}"
+exec mono "$CAKE_EXE" build.cake --verbosity=$VERBOSITY --configuration=$CONFIGURATION --target=$TARGET $DRYRUN "${SCRIPT_ARGUMENTS[@]}"

src/BenchmarkDotNet/Columns/BaselineCustomColumn.cs

@@ -1,6 +1,8 @@
+using System.Collections.Generic;
 using BenchmarkDotNet.Mathematics;
 using BenchmarkDotNet.Reports;
 using BenchmarkDotNet.Running;
+using JetBrains.Annotations;
 
 namespace BenchmarkDotNet.Columns
 {
@@ -19,12 +21,16 @@ public string GetValue(Summary summary, BenchmarkCase benchmarkCase)
                 return "?";
 
             var baselineStat = summary[baseline].ResultStatistics;
+            var baselineMetrics = summary[baseline].Metrics;
             var currentStat = summary[benchmarkCase].ResultStatistics;
+            var currentMetrics = summary[benchmarkCase].Metrics;
 
-            return GetValue(summary, benchmarkCase, baselineStat, currentStat, isBaseline);
+            return GetValue(summary, benchmarkCase, baselineStat, baselineMetrics, currentStat, currentMetrics, isBaseline);
         }
 
-        internal abstract string GetValue(Summary summary, BenchmarkCase benchmarkCase, Statistics baseline, Statistics current, bool isBaseline);
+        [PublicAPI]
+        public abstract string GetValue(Summary summary, BenchmarkCase benchmarkCase, Statistics baseline, IReadOnlyDictionary<string, Metric> baselineMetrics,
+            Statistics current, IReadOnlyDictionary<string, Metric> currentMetrics, bool isBaseline);
 
         public bool IsAvailable(Summary summary) => summary.HasBaselines();
         public bool AlwaysShow => true;

src/BenchmarkDotNet/Columns/BaselineRatioColumn.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Linq;
 using BenchmarkDotNet.Extensions;
 using BenchmarkDotNet.Mathematics;
@@ -44,7 +45,8 @@ public override string ColumnName
             }
         }
 
-        internal override string GetValue(Summary summary, BenchmarkCase benchmarkCase, Statistics baseline, Statistics current, bool isBaseline)
+        public override string GetValue(Summary summary, BenchmarkCase benchmarkCase, Statistics baseline, IReadOnlyDictionary<string, Metric> baselineMetrics,
+            Statistics current, IReadOnlyDictionary<string, Metric> currentMetrics, bool isBaseline)
         {
             var ratio = GetRatioStatistics(current, baseline);
             if (ratio == null)

src/BenchmarkDotNet/Columns/BaselineScaledColumn.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Linq;
 using BenchmarkDotNet.Extensions;
 using BenchmarkDotNet.Mathematics;
@@ -41,7 +42,8 @@ public override string ColumnName
             }
         }
 
-        internal override string GetValue(Summary summary, BenchmarkCase benchmarkCase, Statistics baseline, Statistics current, bool isBaseline)
+        public override string GetValue(Summary summary, BenchmarkCase benchmarkCase, Statistics baseline, IReadOnlyDictionary<string, Metric> baselineMetrics,
+            Statistics current, IReadOnlyDictionary<string, Metric> currentMetrics, bool isBaseline)
         {
             double mean = isBaseline ? 1 : Statistics.DivMean(current, baseline);
 

src/BenchmarkDotNet/Columns/StatisticalTestColumn.cs

@@ -1,4 +1,5 @@
 using System;
+using System.Collections.Generic;
 using System.Linq;
 using BenchmarkDotNet.Mathematics;
 using BenchmarkDotNet.Mathematics.StatisticalTesting;
@@ -26,7 +27,8 @@ public StatisticalTestColumn(StatisticalTestKind kind, Threshold threshold, bool
         public override string Id => nameof(StatisticalTestColumn) + "." + Kind + "." + Threshold + "." + (ShowPValues ? "WithDetails" : "WithoutDetails");
         public override string ColumnName => $"{Kind}({Threshold.ToString().Replace(" ", "")}){(ShowPValues ? "/p-values" : "")}";
 
-        internal override string GetValue(Summary summary, BenchmarkCase benchmarkCase, Statistics baseline, Statistics current, bool isBaseline)
+        public override string GetValue(Summary summary, BenchmarkCase benchmarkCase, Statistics baseline, IReadOnlyDictionary<string, Metric> baselineMetrics,
+            Statistics current, IReadOnlyDictionary<string, Metric> currentMetrics, bool isBaseline)
         {
             var x = baseline.OriginalValues.ToArray();
             var y = current.OriginalValues.ToArray();

tests/BenchmarkDotNet.Tests/Columns/StatisticalTestColumnTests.cs

@@ -1,7 +1,9 @@
-using System.Linq;
+using System.Collections.Generic;
+using System.Linq;
 using BenchmarkDotNet.Columns;
 using BenchmarkDotNet.Mathematics;
 using BenchmarkDotNet.Mathematics.StatisticalTesting;
+using BenchmarkDotNet.Reports;
 using Xunit;
 
 namespace BenchmarkDotNet.Tests.Columns
@@ -59,8 +61,10 @@ private static void Compare(StatisticalTestKind statisticalTestKind, ThresholdUn
         {
             var sut = new StatisticalTestColumn(statisticalTestKind, Threshold.Create(thresholdUnit, thresholdValue));
 
-            Assert.Equal(expectedResult, sut.GetValue(null, null, new Statistics(baseline), new Statistics(current), isBaseline: true));
-            Assert.Equal(expectedResult, sut.GetValue(null, null, new Statistics(baseline), new Statistics(current), isBaseline: false));
+            var emptyMetrics = new Dictionary<string, Metric>();
+
+            Assert.Equal(expectedResult, sut.GetValue(null, null, new Statistics(baseline), emptyMetrics, new Statistics(current), emptyMetrics, isBaseline: true));
+            Assert.Equal(expectedResult, sut.GetValue(null, null, new Statistics(baseline), emptyMetrics, new Statistics(current), emptyMetrics, isBaseline: false));
         }
     }
 }