コマンドラインからのカバレッジ分析

コンピューター上のすべてのプロジェクトのグローバルツールとして

• 実行:

  dotnet tool install --global JetBrains.dotCover.CommandLineTools --version 2024.2.0

特定のプロジェクト / ディレクトリのローカルツールとして

• 実行:

  dotnet tool install JetBrains.dotCover.CommandLineTools --version 2024.2.0 --tool-path "some/path"

1. 必要な単体テストプロジェクトを開き、JetBrains.dotCover.CommandLineTools(英語) パッケージへの参照を追加します。例:

   Install-Package JetBrains.dotCover.CommandLineTools -Version 2024.2.0

2. CI/CD サーバーで、NuGet パッケージを復元するビルドステップを追加します。

3. CI/CD サーバーで、dotnet dotCover.dll ... などのコマンドラインツールを使用するビルドステップを追加します。

1. 必要なオペレーティングシステム用の dotCover コマンドラインツールパッケージをダウンロードします。

2. アーカイブを抽出します。

スタブ構成ファイルを生成するには

• 実行:

  dotCover help <command name> <configuration stub file>

  例: dotnet の場合:

  dotCover.exe help dotnet C:\Temp\MyConfig.xml

設定ファイルに基づいてカバレッジ分析を実行するには

• カスタムパラメーター値を含む構成ファイルを dotCover コマンドに提供します。例: dotnet の場合:

  dotCover.exe dotnet C:\Temp\MyConfig.xml

  XML 構成ファイルで定義された相対パスは、このファイルの場所を基準として扱われます。

1. ソリューションフォルダーを開きます。

2. ソリューションを構築します。

   dotnet build

3. カバレッジ分析でテストを実行する:

   dotnet dotcover cover-dotnet -- test --no-build

   dotnet dotcover .NET ツールは、dotCover.exe および dotCover.sh と同じコマンドとパラメーターのセットをサポートします。例: レポート型を指定するには、すべてのツールで --ReportType パラメーターを使用します。

   dotnet dotcover cover-dotnet --ReportType=XML -- test

   XML ファイルを使用して dotCover.exe を構成し、それを引き続き使用する場合は、ファイルへのパスを指定します。

   dotnet dotcover cover-dotnet "C:\config\config.xml" -- test

1. dotCover.exe/dotCover.sh が配置されているディレクトリに移動します。

2. コンソールに次のコマンドを入力します。

   dotCover.exe dotnet --output=AppCoverageReport.html --reportType=HTML -- test "C:\MyProject\MainTests.csproj"

   ここに:

   • --output はレポートのファイル名です

   • --reportType はレポートのタイプです (この場合、HTML レポートを生成します)

   • 最後の -- test "C:\MyProject\MainTests.csproj" は dotnet に渡される引数です。これは --targetArguments="test \"C:\MyProject\MainTests.csproj\"" のショートカットです

3. コマンドラインツールの動作が完了すると、dotCover コマンドラインツールと同じディレクトリに AppCoverageReport.html ファイルが作成されます。このファイルを開いて、Web ブラウザーでカバレッジ結果を調べます。

• カバレッジ分析から項目を除外 / 含めるには、--filters パラメーターを指定してコマンドラインツールを実行する必要があります。例: (簡潔にするために、フィルター以外のパラメーターは省略します):

  dotCover.exe ... --filters=-:module=AdditionalTests;-:type=MainTests.Unit*; -:type=MainTests.IntegrationTests;function=TestFeature1;

  この例は、XML 構成例と同等です。セミコロン (;) はフィルターエントリだけでなく、フィルターエントリ内の項目も区切ることに注意してください。

• -: で始まるエントリは、+: で始まるエントリを除外します（その逆もあります）。

• モジュールのみを除外 / インクルードする必要がある場合は、module キーワードを省略できます。

  dotCover.exe ... --filters=-:AdditionalTests;

• それらの属性に基づいてクラスとメソッドを除外するには、--attributeFilters パラメーターを使用する必要があります。例: System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverageAttribute 属性でマークされたメソッドをフィルターにかける:

  dotCover.exe ... --attributeFilters=System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverageAttribute;

  セミコロン (;) は区切り文字として機能します。

• 特定のエンティティ (モジュール、クラス、メソッド) をカバレッジレポートから除外し、他のエンティティを保持するには、対応するエントリを ExcludeFilters ノードに追加します。例:

  ... <Filters> <ExcludeFilters> <FilterEntry> <ModuleMask>AdditionalTests</ModuleMask> </FilterEntry> <FilterEntry> <ClassMask>MainTests.Unit*</ClassMask> </FilterEntry> <FilterEntry> <ClassMask>MainTests.IntegrationTests</ClassMask> <FunctionMask>TestFeature1</FunctionMask> </FilterEntry> </ExcludeFilters> </Filters>

  ここに:

  • <ModuleMask>AdditionalTests</ModuleMask> - 対応するモジュールからのすべてのテストは除外されます。ここ AdditionalTests は拡張子のないアセンブリ名です。

  • <ClassMask>MainTests.Unit*</ClassMask> - 名前が MainTests.Unit で始まるすべてのクラスが除外されます。

  • <ClassMask>MainTests.IntegrationTests</ClassMask> <FunctionMask>TestFeature1</FunctionMask> - MainTests.IntegrationTests クラスの TestFeature1 メソッドは除外されます。FunctionMask は常にメソッドのショートネームを含まなければならないことに注意してください。FilterEntry の要素を省略すると、dotCover はこれをワイルドカードと見なします。例: この特別な場合に ClassMask を削除すると、dotCover はすべての TestFeature1 メソッド（すべてのモジュールとクラスに属する）を除外します。

• または、同じ種類の他のすべてを除外しながら、目的の項目のみを含めるには、IncludeFilters ノードに対応するエントリを追加します。

• もう 1 つのオプションは、属性に基づいてクラスとメソッドをフィルターすることです。例: System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverageAttribute 属性でマークされたメソッドをフィルターするには、coverage.xml 構成ファイルに次のコードを追加します。

  ... <AttributeFilters> <AttributeFilterEntry> <ClassMask>System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverageAttribute</ClassMask> </AttributeFilterEntry> </AttributeFilters>