ReportGenerator
ReportGenerator_5.4.1
強力なコードカバレッジの視覚化
ReportGenerator は、coverlet、OpenCover、dotCover、Visual Studio、NCover、Cobertura、JaCoCo、Clover、gcov、または lcov によって生成されたカバレッジ レポートを、さまざまな形式の人間が判読できるレポートに変換します。
レポートにはカバレッジ割り当てが表示され、ソース コードのどの行がカバーされているかが視覚化されます。
ReportGenerator は、複数のカバレッジ ファイルを 1 つのレポートに結合することをサポートしています。
HTML レポートのサンプルを参照する
ReportGenerator は、完全な .NET Framework および .NET Core で動作するコマンドライン ツールです。
オンライン構成ツールを使用すると、すぐに開始できます。
| パッケージ | プラットフォーム | 設置・使用方法 |
|---|---|---|
| レポートジェネレーター | .NET Core >=8.0 .NET フレームワーク 4.7 | プロジェクトが.NET Frameworkまたは.NET Coreに基づいており、コマンド ラインまたはビルド スクリプト経由でReportGenerator を使用する場合は、このパッケージを使用します。 使用法 dotnet $(UserProfile).nugetpackagesreportgeneratorxyztoolsnet8.0ReportGenerator.dll [options]$(UserProfile).nugetpackagesreportgeneratorxyztoolsnet8.0ReportGenerator.exe [options]$(UserProfile).nugetpackagesreportgeneratorxyztoolsnet47ReportGenerator.exe [options] |
| dotnet-reportgenerator-globaltool | .NET Core >=8.0 | プロジェクトが.NET Coreに基づいており、 ReportGenerator を(グローバル) 'DotnetTool' として使用する場合は、このパッケージを使用します。 インストール dotnet tool install -g dotnet-reportgenerator-globaltooldotnet tool install dotnet-reportgenerator-globaltool --tool-path toolsdotnet new tool-manifestdotnet tool install dotnet-reportgenerator-globaltool使用法 reportgenerator [options]toolsreportgenerator.exe [options]dotnet reportgenerator [options] |
| ReportGenerator.Core | .NET標準2.0 | ReportGeneratorのカスタムプラグインを作成する場合、またはコード ベース内でReportGenerator を呼び出し/実行する場合は、このパッケージを使用します。 プラグイン開発 カスタムレポート カスタム履歴ストレージ |
| Azure DevOps 拡張機能 | .NET Core >=8.0 | Azure DevOps 拡張機能をビルド パイプラインに追加します。 もっと詳しく知る |
| GitHub アクション | .NET Core >=8.0 | GitHub アクションをビルド パイプラインに追加します。 もっと詳しく知る |
オンライン構成ツールを使用すると、すぐに開始できます。
より高度な設定については wiki に記載されています。
Parameters:
["]-reports:<report>[;<report>][;<report>]["]
["]-targetdir:<target directory>["]
[["]-reporttypes:<Html|HtmlSummary|...>[;<Html|HtmlSummary|...>]["]]
[["]-sourcedirs:<directory>[;<directory>][;<directory>]["]]
[["]-historydir:<history directory>["]]
[["]-plugins:<plugin>[;<plugin>][;<plugin>]["]]
[["]-assemblyfilters:<(+|-)filter>[;<(+|-)filter>][;<(+|-)filter>]["]]
[["]-classfilters:<(+|-)filter>[;<(+|-)filter>][;<(+|-)filter>]["]]
[["]-filefilters:<(+|-)filter>[;<(+|-)filter>][;<(+|-)filter>]["]]
[["]-riskhotspotassemblyfilters:<(+|-)filter>[;<(+|-)filter>][;<(+|-)filter>]["]]
[["]-riskhotspotclassfilters:<(+|-)filter>[;<(+|-)filter>][;<(+|-)filter>]["]]
[["]-verbosity:<Verbose|Info|Warning|Error|Off>["]]
[["]-title:<title>["]]
[["]-tag:<tag>["]]
[["]-license:<license>["]]
Explanations:
Reports: The coverage reports that should be parsed (separated by semicolon).
Globbing is supported.
Target directory: The directory where the generated report should be saved.
Report types: The output formats and scope (separated by semicolon).
Values: Badges, Clover, Cobertura, CsvSummary,
MarkdownSummary, MarkdownAssembliesSummary, MarkdownSummaryGithub, MarkdownDeltaSummary
OpenCover
Html, Html_Light, Html_Dark, Html_BlueRed
HtmlChart, HtmlInline, HtmlSummary, Html_BlueRed_Summary
HtmlInline_AzurePipelines, HtmlInline_AzurePipelines_Light, HtmlInline_AzurePipelines_Dark
JsonSummary, CodeClimate, Latex, LatexSummary, lcov, MHtml, SvgChart, SonarQube, TeamCitySummary
TextSummary, TextDeltaSummary
Xml, XmlSummary
Source directories: Optional directories which contain the corresponding source code (separated by semicolon).
The source directories are used if coverage report contains classes without path information.
Globbing is not supported.
History directory: Optional directory for storing persistent coverage information.
Can be used in future reports to show coverage evolution.
Plugins: Optional plugin files for custom reports or custom history storage (separated by semicolon).
Assembly filters: Optional list of assemblies that should be included or excluded in the report.
Class filters: Optional list of classes that should be included or excluded in the report.
File filters: Optional list of files that should be included or excluded in the report.
Risk hotspot assembly filters: Optional list of assemblies that should be included or excluded in the risk hotspots.
Risk hotspot class filters: Optional list of classes that should be included or excluded in the risk hotspots.
Exclusion filters take precedence over inclusion filters.
Wildcards are allowed.
Verbosity: The verbosity level of the log messages.
Values: Verbose, Info, Warning, Error, Off
Title: Optional title.
Tag: Optional tag or build version.
License: Optional license for PRO version. Get your license here: https://reportgenerator.io/pro
License can also be supplied via 'REPORTGENERATOR_LICENSE' environment variable.
Default values:
-reporttypes:Html
-assemblyfilters:+*
-classfilters:+*
-filefilters:+*
-riskhotspotassemblyfilters:+*
-riskhotspotclassfilters:+*
-verbosity:Info
Examples:
"-reports:coverage.xml" "-targetdir:C:report"
"-reports:target**.xml" "-targetdir:C:report" -reporttypes:Latex;HtmlSummary -title:IntegrationTest -tag:v1.4.5
"-reports:coverage1.xml;coverage2.xml" "-targetdir:report" "-sourcedirs:C:MyProject" -plugins:CustomReports.dll
"-reports:coverage.xml" "-targetdir:C:report" "-assemblyfilters:+Included;-Excluded.*"
上記のパラメータはすべて、.netconfig ファイルの[ReportGenerator]セクションに保存することもできます。例:
[ ReportGenerator ]
reports = coverage.xml
targetdir = " C: \ report "
reporttypes = Latex,HtmlSummary
assemblyfilters = +Test,-Test
classfilters = +Test2,-Test2すべての複数オプションは、次のように複数の単数エントリとして指定することもできます。
[ ReportGenerator ]
report = coverage1.xml
report = coverage2.xml
reporttype = Latex
reporttype = HtmlSummary
assemblyfilter = +Test
assemblyfilter = -Test
classfilter = +Test2
classfilter = -Test2
filefilter = +cs
filefilter = -vb
riskhotspotassemblyfilter = +Test
riskhotspotassemblyfilter = -Test
riskhotspotclassfilter = +Test2
riskhotspotclassfilter = -Test2
sourcedir = src
sourcedir = testdotnet-config CLI を使用すると、値の追加/削除は簡単に行えます。
# set a single-valued variable
dotnet config reportgenerator.reporttypes Latex ; HtmlSummary
# add to multi-valued variable
dotnet config --add reportgenerator.report coverage3.xml
# clear all multi-valued entries for a variable
dotnet config --unset-all reportgenerator.assemblyfilterもちろん、 .netconfigファイルを手動で編集することも同様に簡単です。
MSBuild タスクも存在します。
<? xml version = " 1.0 " encoding = " utf-8 " ?>
< Project DefaultTargets = " Coverage " xmlns = " http://schemas.microsoft.com/developer/msbuild/2003 " ToolsVersion = " 4.0 " >
< ItemGroup >
< PackageReference Include = " ReportGenerator " Version = " x.y.z " />
</ ItemGroup >
< Target Name = " Coverage " >
< ItemGroup >
< CoverageFiles Include = " OpenCover.xml " />
</ ItemGroup >
< ReportGenerator ProjectDirectory = " $(MSBuildProjectDirectory) " ReportFiles = " @(CoverageFiles) " TargetDirectory = " report " ReportTypes = " Html;Latex " HistoryDirectory = " history " Plugins = " CustomReports.dll " AssemblyFilters = " +Include;-Excluded " VerbosityLevel = " Verbose " />
</ Target >
</ Project > MSBuild タスク パラメーターは、 .netconfigを使用する場合はこれで補完できます。つまり、 .netconfig経由でパラメータが提供されている場合はパラメータを省略できます。これは、MSBuild タスクに現在のプロジェクトの動的な値のみが提供される、ソリューション内の複数のプロジェクト間で固定設定を再利用する場合に便利です。
次の.netconfigがあるとします。
[ ReportGenerator ]
reporttypes = Html ; Latex
targetdirectory = report
historydirectory = history
assemblyfilters = +Include ; -Excluded
verbosityLevel = Verbose上記のターゲットは次のように単純化できます。
< Target Name = " Coverage " >
< ItemGroup >
< CoverageFiles Include = " OpenCover.xml " />
</ ItemGroup >
< ReportGenerator ProjectDirectory = " $(MSBuildProjectDirectory) "
ReportFiles = " @(CoverageFiles) "
Plugins = " CustomReports.dll " />
</ Target >ReportGenerator は、いくつかの入出力形式をサポートしています。
Wiki ではさまざまな出力形式について説明しています。また、サポートされているすべての出力形式のサンプル レポートをダウンロードすることもできます。
カスタム形式が必要な場合は、プラグインを作成できます。
| 入力フォーマット | 出力フォーマット |
|---|---|
|
|
スクリーンショットは、生成されたレポートの 2 つのスニペットを示しています。
バッジ-reporttypes:Badges使用すると、SVG 形式のバッジを生成できます。
例：
すべてのバッジを見る
Visual Studio でカバレッジを視覚化するために、次の拡張機能が存在します。
| 名前 | カバレッジツール | リンク |
|---|---|---|
| Coverlet レポート VS2022 の実行 | 掛け布団 | GitHub 市場 |
| FineCodeCoverage | カバーレット、オープンカバー | GitHub 市場 |
Nugetのダウンロード
GitHub のスター
著者: ダニエル・パルメ
ブログ: www.palmmedia.de
Twitter: @ダニエルパルメ
