dotnet/BenchmarkDotNet

Ability to configure benchmark class name in outputs

Open

#1 447 ouverte le 2 mai 2020

Voir sur GitHub
 (6 commentaires) (1 réaction) (0 assignés)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.

Guide contributeur

Stack technique
csharp
Domaine
performance
Type d'issue
feature
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 days
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
stale
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
clear
Prérequis
C# programmingBenchmarkDotNet attributesAttribute and reflection concepts
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60
Direction de recherche
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.