Skip to content

Support IEnumerable as benchmark argument #1228

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.

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

Merged
merged 2 commits into from
Aug 20, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 6 additions & 2 deletions src/BenchmarkDotNet/Parameters/ParameterDefinition.cs
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
namespace BenchmarkDotNet.Parameters
using System;

namespace BenchmarkDotNet.Parameters
{
public class ParameterDefinition
{
public string Name { get; }
public bool IsStatic { get; }
public object[] Values { get; }
public bool IsArgument { get; }
public Type ParameterType { get; }

public ParameterDefinition(string name, bool isStatic, object[] values, bool isArgument)
public ParameterDefinition(string name, bool isStatic, object[] values, bool isArgument, Type parameterType)
{
Name = name;
IsStatic = isStatic;
Values = values;
IsArgument = isArgument;
ParameterType = parameterType;
}
}
}
2 changes: 1 addition & 1 deletion src/BenchmarkDotNet/Parameters/SmartParamBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ public SmartArgument(ParameterDefinition[] parameterDefinitions, object value, M

public string ToSourceCode()
{
string cast = $"({Value.GetType().GetCorrectCSharpTypeName()})"; // it's an object so we need to cast it to the right type
string cast = $"({parameterDefinitions[argumentIndex].ParameterType.GetCorrectCSharpTypeName()})"; // it's an object so we need to cast it to the right type

string callPostfix = source is PropertyInfo ? string.Empty : "()";

Expand Down
5 changes: 3 additions & 2 deletions src/BenchmarkDotNet/Running/BenchmarkConverter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,8 @@ IEnumerable<ParameterDefinition> GetDefinitions<TAttribute>(Func<TAttribute, Typ
member.Name,
member.IsStatic,
getValidValues(member.Attribute, member.ParameterType),
false));
false,
member.ParameterType));
}

var paramsDefinitions = GetDefinitions<ParamsAttribute>((attribute, parameterType) => GetValidValues(attribute.Values, parameterType));
Expand All @@ -195,7 +196,7 @@ IEnumerable<ParameterDefinition> GetDefinitions<TAttribute>(Func<TAttribute, Typ
private static IEnumerable<ParameterInstances> GetArgumentsDefinitions(MethodInfo benchmark, Type target)
{
var parameterDefinitions = benchmark.GetParameters()
.Select(parameter => new ParameterDefinition(parameter.Name, false, Array.Empty<object>(), true))
.Select(parameter => new ParameterDefinition(parameter.Name, false, Array.Empty<object>(), true, parameter.ParameterType))
.ToArray();

if (parameterDefinitions.IsEmpty())
Expand Down
25 changes: 25 additions & 0 deletions tests/BenchmarkDotNet.IntegrationTests/ArgumentsTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,31 @@ public void AcceptingArray(int[] array)
}
}

[Theory, MemberData(nameof(GetToolchains))]
public void IEnumerableCanBeUsedAsArgument(IToolchain toolchain) => CanExecute<WithIEnumerable>(toolchain);

public class WithIEnumerable
{
private static IEnumerable<int> Iterator() { yield return 1; }

public IEnumerable<object[]> Sources()
{
yield return new object[] { "Empty", Enumerable.Empty<int>() };
yield return new object[] { "Range", Enumerable.Range(0, 10) };
yield return new object[] { "List", new List<int>() { 1, 2, 3 } };
yield return new object[] { "int[]", new int[] { 1, 2, 3 } };
yield return new object[] { "int[].Select", new int[] { 1, 2, 3 }.Select(i => i) };
yield return new object[] { "int[].Select.Where", new int[] { 1, 2, 3 }.Select(i => i).Where(i => i % 2 == 0) };
yield return new object[] { "Iterator", Iterator() };
yield return new object[] { "Iterator.Select", Iterator().Select(i => i) };
yield return new object[] { "Iterator.Select.Where", Iterator().Select(i => i).Where(i => i % 2 == 0) };
}

[Benchmark]
[ArgumentsSource(nameof(Sources))]
public void Any(string name, IEnumerable<int> source) => source.Any();
}

[Theory, MemberData(nameof(GetToolchains))]
public void JaggedArrayCanBeUsedAsArgument(IToolchain toolchain) => CanExecute<WithJaggedArray>(toolchain);

Expand Down
6 changes: 3 additions & 3 deletions tests/BenchmarkDotNet.Tests/ParameterComparerTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ public void BasicComparisionTest()
{
var comparer = ParameterComparer.Instance;

var sharedDefinition = new ParameterDefinition("Testing", isStatic: false, values: Array.Empty<object>(), isArgument: false);
var sharedDefinition = new ParameterDefinition("Testing", isStatic: false, values: Array.Empty<object>(), isArgument: false, parameterType: null);
var originalData = new[]
{
new ParameterInstances(new[]
Expand Down Expand Up @@ -40,7 +40,7 @@ public void MultiParameterComparisionTest()
{
var comparer = ParameterComparer.Instance;

var sharedDefinition = new ParameterDefinition("Testing", isStatic: false, values: Array.Empty<object>(), isArgument: false);
var sharedDefinition = new ParameterDefinition("Testing", isStatic: false, values: Array.Empty<object>(), isArgument: false, parameterType: null);
var originalData = new[]
{
new ParameterInstances(new[]
Expand Down Expand Up @@ -94,7 +94,7 @@ public void AlphaNumericComparisionTest()
{
var comparer = ParameterComparer.Instance;

var sharedDefinition = new ParameterDefinition("Testing", isStatic: false, values: Array.Empty<object>(), isArgument: false);
var sharedDefinition = new ParameterDefinition("Testing", isStatic: false, values: Array.Empty<object>(), isArgument: false, parameterType: null);
var originalData = new[]
{
new ParameterInstances(new[]
Expand Down
2 changes: 1 addition & 1 deletion tests/BenchmarkDotNet.Tests/ParameterInstanceTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ namespace BenchmarkDotNet.Tests
{
public class ParameterInstanceTests
{
private static readonly ParameterDefinition definition = new ParameterDefinition("Testing", isStatic: false, values: Array.Empty<object>(), isArgument: false);
private static readonly ParameterDefinition definition = new ParameterDefinition("Testing", isStatic: false, values: Array.Empty<object>(), isArgument: false, parameterType: null);

[Theory]
[InlineData(5)]
Expand Down