dotnet/BenchmarkDotNet

Ability to configure benchmark class name in outputs

Offen

#1.447 geöffnet am 02.05.2020

Auf GitHub ansehenContributor Guide
 (6 Kommentare) (1 Reaktion) (0 zugewiesene Personen)C# (1.063 Forks)batch import
Hacktoberfesthelp wantedup-for-grabs

Repository-Metriken

Stars
 (11.480 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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.

Contributor Guide

Research-Richtung
Fügen Sie eine Eigenschaft zu BenchmarkConfig oder ein neues Attribut hinzu, um den Klassennamen in der Ausgabe zu überschreiben, ähnlich wie die Description Eigenschaft bei BenchmarkAttribute.
Tech Stack
csharp
Domain
tooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
C#BenchmarkDotNet
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70