Skip to content

Fix ParamColumn null representation #2122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
YegorStepanov wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix ParamColumn null representation #2122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions src/BenchmarkDotNet/Columns/ParamColumn.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,15 @@ public ParamColumn(string columnName, int priorityInCategory = 0)
}

public bool IsDefault(Summary summary, BenchmarkCase benchmarkCase) => false;
public string GetValue(Summary summary, BenchmarkCase benchmarkCase) =>
benchmarkCase.Parameters.Items.FirstOrDefault(item => item.Name == ColumnName)?.ToDisplayText(summary.Style) ??
ParameterInstance.NullParameterTextRepresentation;
public string GetValue(Summary summary, BenchmarkCase benchmarkCase)
{
var parameter = benchmarkCase.Parameters.Items.FirstOrDefault(item => item.Name == ColumnName);

if (parameter is null)
return ParameterInstance.UnknownParameterTextRepresentation;

return parameter.ToDisplayText(summary.Style) ?? ParameterInstance.NullParameterTextRepresentation;
}

public bool IsAvailable(Summary summary) => true;
public bool AlwaysShow => true;
Expand Down
3 changes: 2 additions & 1 deletion src/BenchmarkDotNet/Parameters/ParameterInstance.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ namespace BenchmarkDotNet.Parameters
{
public class ParameterInstance : IDisposable
{
public const string NullParameterTextRepresentation = "?";
public const string NullParameterTextRepresentation = "Null";
Copy link
Collaborator

@timcassell timcassell Nov 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about "<null>"? Makes it more obvious that it's actual null and not the string value "Null".

Copy link
Contributor Author

@YegorStepanov YegorStepanov Nov 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It better to make it in lowercase Null -> null.

<null>

I like any option except ?.
Although the string value still can be \<null\>.
In addition, we can use a different color for special values (only suitable for the console output)

Copy link
Collaborator

@timcassell timcassell Nov 11, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although the string value still can be \<null\>.

I don't think it needs to be escaped. The XML serializer will automatically escape those to &lt; &gt;. Unless we don't want those escaped in XML, then maybe (null) instead.

Copy link
Contributor Author

@YegorStepanov YegorStepanov Nov 11, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, github markdown doesn't like <> characters and removes them if they are not escaped. I forgot to remove escaping when I added the single quotes.

Copy link
Contributor Author

@YegorStepanov YegorStepanov Nov 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks a little odd to me.

    Method | ParamProperty |     Mean |   Error |  StdDev |
---------- |-------------- |---------:|--------:|--------:|
 Benchmark |        <null> | 102.0 ns | 6.09 ns | 1.58 ns | ^
 Benchmark |         False | 202.0 ns | 6.09 ns | 1.58 ns | ^
 Benchmark |          True | 302.0 ns | 6.09 ns | 1.58 ns | ^

    Method | ParamProperty |     Mean |   Error |  StdDev |
---------- |-------------- |---------:|--------:|--------:|
 Benchmark |        <null> | 102.0 ns | 6.09 ns | 1.58 ns | ^
 Benchmark |             A | 202.0 ns | 6.09 ns | 1.58 ns | ^
 Benchmark |             B | 302.0 ns | 6.09 ns | 1.58 ns | ^
 Benchmark |             C | 402.0 ns | 6.09 ns | 1.58 ns | ^

    Method | ParamProperty |     Mean |   Error |  StdDev |
---------- |-------------- |---------:|--------:|--------:|
 Benchmark |        <null> | 102.0 ns | 6.09 ns | 1.58 ns | ^
 Benchmark |             0 | 202.0 ns | 6.09 ns | 1.58 ns | ^

Copy link
Collaborator

@timcassell timcassell Nov 22, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it looks good. But I guess that's just a matter of preference.

[Edit] But I think I like (null) better.

    Method | ParamProperty |     Mean |   Error |  StdDev |
---------- |-------------- |---------:|--------:|--------:|
 Benchmark |        (null) | 102.0 ns | 6.09 ns | 1.58 ns | ^
 Benchmark |         False | 202.0 ns | 6.09 ns | 1.58 ns | ^
 Benchmark |          True | 302.0 ns | 6.09 ns | 1.58 ns | ^

    Method | ParamProperty |     Mean |   Error |  StdDev |
---------- |-------------- |---------:|--------:|--------:|
 Benchmark |        (null) | 102.0 ns | 6.09 ns | 1.58 ns | ^
 Benchmark |             A | 202.0 ns | 6.09 ns | 1.58 ns | ^
 Benchmark |             B | 302.0 ns | 6.09 ns | 1.58 ns | ^
 Benchmark |             C | 402.0 ns | 6.09 ns | 1.58 ns | ^

    Method | ParamProperty |     Mean |   Error |  StdDev |
---------- |-------------- |---------:|--------:|--------:|
 Benchmark |        (null) | 102.0 ns | 6.09 ns | 1.58 ns | ^
 Benchmark |             0 | 202.0 ns | 6.09 ns | 1.58 ns | ^

public const string UnknownParameterTextRepresentation = "?";

[PublicAPI] public ParameterDefinition Definition { get; }

Expand Down
2 changes: 1 addition & 1 deletion ...aluesApprovalTests.BenchmarkShouldProduceSummary.WithAllValuesOfNullableBool.approved.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Frequency=2531248 Hz, Resolution=395.0620 ns, Timer=TSC

Method | ParamProperty | Mean | Error | StdDev |
---------- |-------------- |---------:|--------:|--------:|
Benchmark | ? | 102.0 ns | 6.09 ns | 1.58 ns | ^
Benchmark | Null | 102.0 ns | 6.09 ns | 1.58 ns | ^
Benchmark | False | 202.0 ns | 6.09 ns | 1.58 ns | ^
Benchmark | True | 302.0 ns | 6.09 ns | 1.58 ns | ^

Expand Down
2 changes: 1 addition & 1 deletion ...aluesApprovalTests.BenchmarkShouldProduceSummary.WithAllValuesOfNullableEnum.approved.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Frequency=2531248 Hz, Resolution=395.0620 ns, Timer=TSC

Method | ParamProperty | Mean | Error | StdDev |
---------- |-------------- |---------:|--------:|--------:|
Benchmark | ? | 102.0 ns | 6.09 ns | 1.58 ns | ^
Benchmark | Null | 102.0 ns | 6.09 ns | 1.58 ns | ^
Benchmark | A | 202.0 ns | 6.09 ns | 1.58 ns | ^
Benchmark | B | 302.0 ns | 6.09 ns | 1.58 ns | ^
Benchmark | C | 402.0 ns | 6.09 ns | 1.58 ns | ^
Expand Down
2 changes: 1 addition & 1 deletion ...sApprovalTests.BenchmarkShouldProduceSummary.WithNotAllowedNullableTypeError.approved.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Frequency=2531248 Hz, Resolution=395.0620 ns, Timer=TSC

Method | ParamProperty | Mean | Error | StdDev |
---------- |-------------- |---------:|--------:|--------:|
Benchmark | ? | 102.0 ns | 6.09 ns | 1.58 ns | ^
Benchmark | Null | 102.0 ns | 6.09 ns | 1.58 ns | ^
Benchmark | 0 | 202.0 ns | 6.09 ns | 1.58 ns | ^

Errors: 1
Expand Down
57 changes: 57 additions & 0 deletions tests/BenchmarkDotNet.Tests/Columns/ParamColumnTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Globalization;
using System.Linq;
using BenchmarkDotNet.Columns;
using BenchmarkDotNet.Configs;
using BenchmarkDotNet.Environments;
using BenchmarkDotNet.Jobs;
using BenchmarkDotNet.Parameters;
using BenchmarkDotNet.Reports;
using BenchmarkDotNet.Running;
using BenchmarkDotNet.Validators;
using Xunit;

namespace BenchmarkDotNet.Tests.Columns
{
public class ParamColumnTests
{
[Theory]
[InlineData("Field", "Field", "str", "str")]
[InlineData("Field", "Field", true, "True")]
[InlineData("Field", "Field", null, ParameterInstance.NullParameterTextRepresentation)]
[InlineData("Field", "F", "str", ParameterInstance.UnknownParameterTextRepresentation)]
public void GetValueTest(string columnName, string parameterName, object parameterValue, string expected)
{
var instance = CreateParameterInstance(parameterName, parameterValue);
var summary = CreateMockSummary(instance);

var column = new ParamColumn(columnName);
var actual = column.GetValue(summary, summary.BenchmarksCases.First(), summary.Style);
Assert.Equal(expected, actual);
}

private static ParameterInstance CreateParameterInstance(string name, object value)
{
var summaryStyle = new SummaryStyle(TestCultureInfo.Instance, false, null, null);

var parameterType = value?.GetType() ?? typeof(object);
var definition = new ParameterDefinition(name, false, new[] { value }, false, parameterType, 0);
return new ParameterInstance(definition, definition.Values.First(), summaryStyle);
}

private static Summary CreateMockSummary(ParameterInstance instance)
{
var benchmarkCase = new BenchmarkCase(
new Descriptor(null, null),
Job.Dry,
new ParameterInstances(new ParameterInstance[] { instance }),
ImmutableConfigBuilder.Create(new ManualConfig()));

var benchmarkReport = new BenchmarkReport(true, benchmarkCase, null, null, null, null);
return new Summary("", new[] { benchmarkReport }.ToImmutableArray(), HostEnvironmentInfo.GetCurrent(),
"", "", TimeSpan.Zero, CultureInfo.InvariantCulture, ImmutableArray<ValidationError>.Empty, ImmutableArray<IColumnHidingRule>.Empty);
}
}
}