UniqueArgumentsValidator.cs

// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
// See the LICENSE file in the project root for more information.

using BenchmarkDotNet.Validators;
using System.Collections.Generic;
using System.Linq;
using BenchmarkDotNet.Running;
using BenchmarkDotNet.Exporters;

namespace BenchmarkDotNet.Extensions
{
    public class UniqueArgumentsValidator : IValidator
    {
        public bool TreatsWarningsAsErrors => true;

        public IAsyncEnumerable<ValidationError> ValidateAsync(ValidationParameters validationParameters)
        {
            return validationParameters.Benchmarks
                .Where(benchmark => benchmark.HasArguments || benchmark.HasParameters)
                .GroupBy(benchmark => (benchmark.Descriptor.Type, benchmark.Descriptor.WorkloadMethod, benchmark.Job))
                .Where(sameBenchmark =>
                {
                    int numberOfUniqueTestCases = sameBenchmark.Distinct(new BenchmarkArgumentsComparer()).Count();
                    int numberOfTestCases = sameBenchmark.Count();

                    return numberOfTestCases != numberOfUniqueTestCases;
                })
                .Select(duplicate => new ValidationError(true, $"Benchmark Arguments should be unique, {duplicate.Key.Type}.{duplicate.Key.WorkloadMethod} has duplicate arguments.", duplicate.First()))
                .ToAsyncEnumerable();
        }

        private class BenchmarkArgumentsComparer : IEqualityComparer<BenchmarkCase>
        {
            public bool Equals(BenchmarkCase x, BenchmarkCase y)
            {
                if (FullNameProvider.GetBenchmarkName(x).Equals(FullNameProvider.GetBenchmarkName(y), System.StringComparison.Ordinal))
                    return true;

                return System.Linq.Enumerable.SequenceEqual(
                    x.Parameters.Items.Select(argument => argument.Value), 
                    y.Parameters.Items.Select(argument => argument.Value));
            }

            public int GetHashCode(BenchmarkCase obj)
                => FullNameProvider.GetBenchmarkName(obj).GetHashCode();
        }
    }
}