dotnet/BenchmarkDotNet

Ability to configure benchmark class name in outputs

Open

#1,447 opened on May 2, 2020

View on GitHub
 (6 comments) (1 reaction) (0 assignees)C# (1,054 forks)batch import
Hacktoberfesthelp wantedup-for-grabs

Repository metrics

Stars
 (11,415 stars)
PR merge metrics
 (Avg merge 2d) (27 merged PRs in 30d)

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.

Contributor guide

Research direction
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.
Tech stack
csharp
Domain
performance
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C# programmingBenchmarkDotNet attributesAttribute and reflection concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60