dotnet/BenchmarkDotNet

Ability to configure benchmark class name in outputs

Open

#1.447 aberto em 2 de mai. de 2020

Ver no GitHub
 (6 comments) (1 reaction) (0 assignees)C# (11.415 stars) (1.054 forks)batch import
Hacktoberfesthelp wantedup-for-grabs

Description

An individual benchmark method's name can be overridden for output purposes via the Description property on BenchmarkAttribute (see #1243 for a related issue on this). However, there doesn't seem to be a way to do the same for the entire class.

My use case: we have a superclass of benchmarks being extended for different databases, so an abstract OpenConnectionBenchmarks class gets extended by SqliteOpenConnectionBenchmarks. However, in the outputs (CSV going into a database) it's desirable to have OpenConnectionBenchmarks, as the database is tracked elsewhere.

Guia do colaborador

Pilha de tecnologia
csharp
Domain
performance
Tipo Issue
feature
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 days
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
C# programmingBenchmarkDotNet attributesAttribute and reflection concepts
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60
Direção de pesquisa
First, examine how Description property overrides method name in the output (see issue #1243). Then look at the BenchmarkAttribute class to understand how properties are defined. The output logic for class names is likely in a file like 'BenchmarkReportExporter.cs' or similar. Add a new property (e.g., 'ClassName') to BenchmarkAttribute and use it when generating output reports. Ensure the change is consistent with the existing method name override. Look at the CSV exporter to include the custom class name.