dotnet/BenchmarkDotNet

Ability to configure benchmark class name in outputs

Open

#1,447 opened on May 2, 2020

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

Repository metrics

Stars
 (11,472 stars)
PR merge metrics
 (Avg merge 5d 9h) (20 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
Add a property to BenchmarkConfig or a new attribute to override the class name in output, similar to the Description property on BenchmarkAttribute.
Tech stack
csharp
Domain
tooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C#BenchmarkDotNet
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70