dotnet/BenchmarkDotNet

Ability to configure benchmark class name in outputs

Open

#1,447 opened on 2020年5月2日

GitHub で見る
 (6 comments) (1 reaction) (0 assignees)C# (11,415 stars) (1,054 forks)batch import
Hacktoberfesthelp wantedup-for-grabs

説明

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.

コントリビューターガイド

技術スタック
csharp
領域
performance
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
C# programmingBenchmarkDotNet attributesAttribute and reflection concepts
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60
調査方針
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.
Ability to configure benchmark class name in outputs · dotnet/BenchmarkDotNet#1447 | Good First Issue