dotnet/BenchmarkDotNet

Ability to configure benchmark class name in outputs

Open

Aperta il 2 mag 2020

Vedi su GitHub
 (6 commenti) (1 reazione) (0 assegnatari)C# (11.415 star) (1054 fork)batch import
Hacktoberfesthelp wantedup-for-grabs

Descrizione

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.

Guida contributor

Tech stack
csharp
Dominio
performance
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 days
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
C# programmingBenchmarkDotNet attributesAttribute and reflection concepts
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60
Direzione di ricerca
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.