dotnet/BenchmarkDotNet

Ability to configure benchmark class name in outputs

Open

#1,447 创建于 2020年5月2日

在 GitHub 查看
 (6 评论) (1 反应) (0 负责人)C# (11,415 star) (1,054 fork)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
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
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