Skip to content

Log a warning when an empty benchmark is run #2718

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

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
56 changes: 41 additions & 15 deletions src/BenchmarkDotNet/Running/BenchmarkRunnerClean.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
using BenchmarkDotNet.Jobs;
using BenchmarkDotNet.Loggers;
using BenchmarkDotNet.Mathematics;
using BenchmarkDotNet.Portability;
using BenchmarkDotNet.Reports;
using BenchmarkDotNet.Toolchains;
using BenchmarkDotNet.Toolchains.Parameters;
Expand Down Expand Up @@ -74,9 +73,6 @@ internal static Summary[] Run(BenchmarkRunInfo[] benchmarkRunInfos)
if (validationErrors.Any(validationError => validationError.IsCritical))
return new[] { Summary.ValidationFailed(title, resultsFolderPath, logFilePath, validationErrors.ToImmutableArray()) };

if (!supportedBenchmarks.Any(benchmarks => benchmarks.BenchmarksCases.Any()))
return new[] { Summary.ValidationFailed(title, resultsFolderPath, logFilePath) };

eventProcessor.OnEndValidationStage();

int totalBenchmarkCount = supportedBenchmarks.Sum(benchmarkInfo => benchmarkInfo.BenchmarksCases.Length);
Expand Down Expand Up @@ -579,20 +575,47 @@ private static void LogTotalTime(ILogger logger, TimeSpan time, int executedBenc
private static (BenchmarkRunInfo[], List<ValidationError>) GetSupportedBenchmarks(BenchmarkRunInfo[] benchmarkRunInfos, IResolver resolver)
{
List<ValidationError> validationErrors = new ();
List<BenchmarkRunInfo> runInfos = new (benchmarkRunInfos.Length);

if (benchmarkRunInfos.Length == 0)
{
validationErrors.Add(new ValidationError(true, $"No benchmarks were found."));
return (Array.Empty<BenchmarkRunInfo>(), validationErrors);
}

foreach (var benchmarkRunInfo in benchmarkRunInfos)
{
if (benchmarkRunInfo.BenchmarksCases.Length == 0)
{
validationErrors.Add(new ValidationError(true, $"No [Benchmark] attribute found on '{benchmarkRunInfo.Type.Name}' benchmark case."));
continue;
}

var runInfos = benchmarkRunInfos.Select(info => new BenchmarkRunInfo(
info.BenchmarksCases.Where(benchmark =>
var validBenchmarks = benchmarkRunInfo.BenchmarksCases
.Where(benchmark =>
{
var errors = benchmark.GetToolchain().Validate(benchmark, resolver).ToArray();

var errors = benchmark.GetToolchain()
.Validate(benchmark, resolver)
.ToArray();

validationErrors.AddRange(errors);
return !errors.Any();
}).ToArray(),
info.Type,
info.Config))
.Where(infos => infos.BenchmarksCases.Any())
.ToArray();

return (runInfos, validationErrors);

return errors.Length == 0;
})
.ToArray();

runInfos.Add(
new BenchmarkRunInfo(
validBenchmarks,
benchmarkRunInfo.Type,
benchmarkRunInfo.Config

));


}
return (runInfos.ToArray(), validationErrors);
}

private static string GetRootArtifactsFolderPath(BenchmarkRunInfo[] benchmarkRunInfos)
Expand Down Expand Up @@ -665,6 +688,9 @@ void AddLogger(ILogger logger)
foreach (var logger in benchmarkRunInfo.Config.GetLoggers())
AddLogger(logger);

if (benchmarkRunInfos.Length == 0)
AddLogger(new ConsoleLogger());

AddLogger(streamLogger);

return new CompositeLogger(loggers.Values.ToImmutableHashSet());
Expand Down
26 changes: 26 additions & 0 deletions src/BenchmarkDotNet/Running/TypeFilter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,32 @@ public static (bool allTypesValid, IReadOnlyList<Type> runnable) GetTypesWithRun
{
var validRunnableTypes = new List<Type>();

bool hasRunnableTypeBenchmarks = types.Any(type => type.ContainsRunnableBenchmarks());
bool hasRunnableAssemblyBenchmarks = assemblies.Any(assembly => GenericBenchmarksBuilder.GetRunnableBenchmarks(assembly.GetRunnableBenchmarks()).Length > 0);

if (!hasRunnableTypeBenchmarks && !hasRunnableAssemblyBenchmarks)
{
if (types.Any())
{
foreach (var type in types)
{
logger.WriteLineError($"No [Benchmark] attribute found on '{type.Name}' benchmark case.");
}
return (false, Array.Empty<Type>());
}
else if (assemblies.Any())
{
foreach (var assembly in assemblies)
{
logger.WriteLineError($"No [Benchmark] attribute found on '{assembly.GetName().Name}' assembly.");
}
return (false, Array.Empty<Type>());
}
logger.WriteLineError("No benchmarks were found.");
return (false, Array.Empty<Type>());

}

foreach (var type in types)
{
if (type.ContainsRunnableBenchmarks())
Expand Down
2 changes: 1 addition & 1 deletion src/BenchmarkDotNet/Running/WakeLock.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ namespace BenchmarkDotNet.Running;
internal partial class WakeLock
{
public static WakeLockType GetWakeLockType(BenchmarkRunInfo[] benchmarkRunInfos) =>
benchmarkRunInfos.Select(static i => i.Config.WakeLock).Max();
benchmarkRunInfos.Length == 0 ? WakeLockType.None : benchmarkRunInfos.Select(static i => i.Config.WakeLock).Max();

private static readonly bool OsVersionIsSupported =
// Must be windows 7 or greater
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,9 @@ public class EventProcessorTests
public void WhenUsingEventProcessorAndNoBenchmarks()
{
var events = RunBenchmarksAndRecordEvents(new[] { typeof(ClassEmpty) });
Assert.Single(events);
Assert.Equal(2, events.Count);
Assert.Equal(nameof(EventProcessor.OnStartValidationStage), events[0].EventType);
Assert.Equal(nameof(EventProcessor.OnValidationError), events[1].EventType);
}

[Fact]
Expand Down
Loading
Loading