Skip to content

Fix unhandled exception when running invalid type-based benchmark with arguments #2880

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

Merged
merged 3 commits into from
Nov 29, 2025
Merged

Fix unhandled exception when running invalid type-based benchmark with arguments #2880

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7392914
"Fix unhandled exception when running invalid type-based benchmark wi…
Shrinidhi203 Nov 28, 2025
38d9b36
Fix StyleCop SA1028: Remove trailing whitespace
Shrinidhi203 Nov 28, 2025
e390fa3
"Add assertion for failure in test per maintainer feedback"
Shrinidhi203 Nov 29, 2025
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
17 changes: 13 additions & 4 deletions src/BenchmarkDotNet/Running/BenchmarkRunnerDirty.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,14 +86,23 @@ public static Summary RunSource(string source, IConfig? config = null)

[MethodImpl(MethodImplOptions.NoInlining)]
private static Summary RunWithDirtyAssemblyResolveHelper(Type type, IConfig? config, string[]? args)
=> (args == null
{
var summaries = args == null
? BenchmarkRunnerClean.Run(new[] { BenchmarkConverter.TypeToBenchmarks(type, config) })
: new BenchmarkSwitcher(new[] { type }).RunWithDirtyAssemblyResolveHelper(args, config, false))
.Single();
: new BenchmarkSwitcher(new[] { type }).RunWithDirtyAssemblyResolveHelper(args, config, false);

return summaries.SingleOrDefault()
?? Summary.ValidationFailed($"No benchmarks found in type '{type.Name}'", string.Empty, string.Empty);
}

[MethodImpl(MethodImplOptions.NoInlining)]
private static Summary RunWithDirtyAssemblyResolveHelper(Type type, MethodInfo[] methods, IConfig? config = null)
=> BenchmarkRunnerClean.Run(new[] { BenchmarkConverter.MethodsToBenchmarks(type, methods, config) }).Single();
{
var summaries = BenchmarkRunnerClean.Run(new[] { BenchmarkConverter.MethodsToBenchmarks(type, methods, config) });

return summaries.SingleOrDefault()
?? Summary.ValidationFailed($"No benchmarks found in type '{type.Name}'", string.Empty, string.Empty);
}

[MethodImpl(MethodImplOptions.NoInlining)]
private static Summary[] RunWithDirtyAssemblyResolveHelper(Assembly assembly, IConfig? config, string[]? args)
Expand Down
35 changes: 26 additions & 9 deletions tests/BenchmarkDotNet.Tests/Running/RunningEmptyBenchmarkTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,25 +42,32 @@ public class RunningEmptyBenchmarkTests
/// </summary>
[Theory]
[InlineData(null)]
//[InlineData(new object[] { new string[] { " " } })]
[InlineData(new object[] { new string[] { " " } })]
public void GenericTypeWithoutBenchmarkAttribute_ThrowsValidationError_WhenNoBenchmarkAttribute(string[]? args)
{
GetConfigWithLogger(out var logger, out var config);

var summary = BenchmarkRunner.Run<EmptyBenchmark>(config, args);

if (args == null)
{
Assert.True(summary.HasCriticalValidationErrors);
Assert.Contains(summary.ValidationErrors, validationError => validationError.Message == GetValidationErrorForType(typeof(EmptyBenchmark)));
Assert.Contains(GetValidationErrorForType(typeof(EmptyBenchmark)), logger.GetLog());
}
else
{
// When args is provided and type is invalid, we get a ValidationFailed summary
// instead of an unhandled exception (fix for issue #2724)
Assert.NotNull(summary);
Assert.Contains("No benchmarks found", summary.Title);
}

Assert.Contains(GetValidationErrorForType(typeof(EmptyBenchmark)), logger.GetLog());
}
#pragma warning restore BDN1000

[Theory]
[InlineData(null)]
//[InlineData(new object[] { new string[] { " " } })]
[InlineData(new object[] { new string[] { " " } })]
public void GenericTypeWithBenchmarkAttribute_RunsSuccessfully(string[]? args)
{
GetConfigWithLogger(out var logger, out var config);
Expand All @@ -79,16 +86,26 @@ public void GenericTypeWithBenchmarkAttribute_RunsSuccessfully(string[]? args)
/// </summary>
[Theory]
[InlineData(null)]
//[InlineData(new object[] { new string[] { " " } })]
[InlineData(new object[] { new string[] { " " } })]
public void TypeWithoutBenchmarkAttribute_ThrowsValidationError_WhenNoBenchmarkAttribute(string[]? args)
{
GetConfigWithLogger(out var logger, out var config);


var summary = BenchmarkRunner.Run(typeof(EmptyBenchmark), config, args);
Assert.True(summary.HasCriticalValidationErrors);
Assert.Contains(summary.ValidationErrors, validationError => validationError.Message == GetValidationErrorForType(typeof(EmptyBenchmark)));
Assert.Contains(GetValidationErrorForType(typeof(EmptyBenchmark)), logger.GetLog());

if (args == null)
{
Assert.True(summary.HasCriticalValidationErrors);
Assert.Contains(summary.ValidationErrors, validationError => validationError.Message == GetValidationErrorForType(typeof(EmptyBenchmark)));
Assert.Contains(GetValidationErrorForType(typeof(EmptyBenchmark)), logger.GetLog());
}
else
{
// When args is provided and type is invalid, we get a ValidationFailed summary
// instead of an unhandled exception (fix for issue #2724)
Assert.NotNull(summary);
Assert.Contains("No benchmarks found", summary.Title);
}
}
#pragma warning restore BDN1000

Expand Down