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

サーバー上にdotCover Console Runnerを設定するには

1. JetBrainsのWebサイトのdotCoverコマンドラインツールパッケージをダウンロード。

2. コンソールランナーを設定するマシンにアーカイブをコピーします。

3. アーカイブからディレクトリにファイルを抽出し、そこからConsole Runner実行可能ファイル dotCover.exeを起動します。

単体テストプロジェクトをカバーするには (.NET フレームワーク)

1. ユニットテストプロジェクトをビルドします。

2. dotcover.exe があるディレクトリに移動します。

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

   dotcover cover /TargetExecutable="D:\Program Files\NUnit 2.6\bin\nunit-console.exe" /TargetArguments="D:\Projects\TheApplication\bin\Debug\AppTests.dll" /Output="AppCoverageReport.html" /ReportType="HTML"

   説明:

   • TargetExecutable は、単体テストフレームワークランナーへのパスです。

   • TargetArguments は、ランナー（コンパイル済みユニットテストアセンブリ）に渡される引数です。これらの引数にスペースが含まれるパスが含まれる場合は、追加の二重引用符とバックスラッシュを使用してエスケープする必要があることに注意してください（例： ... /TargetArguments="\"D:\My Projects\My Application\bin\Debug\AppTests.dll""）

   • Output はレポートファイル名です。

   • ReportType はレポートのタイプです (この場合、HTMLレポートを生成する)

4. コンソールランナーが終了すると、AppCoverageReport.html ファイルはdotCoverコンソールランナーと同じディレクトリに表示されます。このファイルを開いて、Webブラウザのカバレッジ結果を調べます。

5. また、XMLファイルでパラメータを渡すこともできます。これを行うには、コマンドラインで dotcover help cover coverage.xml と入力します。

6. 生成された coverage.xml ファイルを開き、設定パラメータを指定します。例：設定ファイルは次のようになります。

   <?xml version="1.0" encoding="utf-8"?> <AnalyseParams> <TargetExecutable>D:\Program Files\NUnit 2.6\bin\nunit-console.exe</TargetExecutable> <TargetArguments>D:\Projects\TheApplication\bin\Debug\AppTests.dll</TargetArguments> <Output>AppCoverageReport.html</Output> <ReportType>html</ReportType> </AnalyseParams>

7. dotcover cover coverage.xml を使用して、指定されたパラメータでカバレッジを実行します。

単体テストプロジェクトをカバーするには (.NETコア)

1. ユニットテストプロジェクトをビルドします。

2. dotcover.exe があるディレクトリに移動します。

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

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

   where:

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

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

   • 最後の-- test "C:\MyProject\MainTests.csproj" は dotnetに渡される引数です。実際には、--TargetArguments="test \"C:\MyProject\MainTests.csproj\"" に置き換えることができますが、はるかに長くなります。

   • おそらく、コマンドライン引数にUnixスタイルの構文を使用していることに気づいたでしょう。Windowsでもこの構文を使用できます。例：以下はWindowsで交換可能です（ただしmacOSおよびLinuxでは不可）： /TempDir:"../myDir" および --tempDir="../myDir"

4. コンソールランナーが終了すると、AppCoverageReport.html ファイルはdotCoverコンソールランナーと同じディレクトリに表示されます。このファイルを開いて、Webブラウザのカバレッジ結果を調べます。

dotnet.exeを使用して単体テストプロジェクト（.NET Core）をカバーするには (ステップ 1〜4はプロジェクトごとに1回行われます)

1. 公式のnuget.orgサイトで、JetBrains.dotCover.DotNetCliTool(英語)パッケージを見つけてください。

2. 単体テストプロジェクトでこのパッケージを参照しないでください。代わりに、.csproj ファイルを開き、パッケージ名とバージョンを含む行を ItemGroup 要素に追加します。例：

   <ItemGroup> <DotNetCliToolReference Include="JetBrains.dotCover.DotNetCliTool" Version="2019.2.0.1" /> </ItemGroup>

3. コマンドラインで、単体テストプロジェクトを含むディレクトリに移動します。

4. 実行

   dotnet restore
   これにより、コンピューターにdotCoverコマンドラインツールがダウンロードされます。

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

   dotnet dotcover test

XML設定ファイルを使用してカバレッジフィルタを設定するには

• カバレッジレポートから一部のアイテム（モジュール、クラス、メソッド）を除外し、他のすべてを保持するには、対応するエントリを 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>

コマンドライン引数を使用してカバレッジフィルタを設定するには

• カバレッジ分析から項目を除外/含めるには、/Filters パラメータを使用してコンソールランナーを実行する必要があります。たとえば（簡単にするため、カバレッジターゲットに関連するパラメータは省略しています）。

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

  この例は、上記の XML構成例と同じです。セミコロン（;）は、フィルター項目だけでなく、フィルター項目内の項目も区切ることに注意してください。

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

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

  dotCover.exe cover ... /Filters=-:AdditionalTests;

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

  dotCover.exe cover ... /AttributeFilters=System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverageAttribute;

  セミコロン（;）はセパレータとして機能します。

別の手順で複数のプロジェクトのカバレッジを実行するには

1. 各テストプロジェクトでカバー (c)コマンドを実行するための2つの構成ファイルを作成します。MSTestを使用する TestProject1 の testProject1.xml ：

   <?xml version="1.0" encoding="utf-8"?> <CoverageParams> <TargetExecutable>C:\Program Files (x86)\Microsoft Visual Studio 12.0\Common7\IDE\MSTest.exe</TargetExecutable> <TargetArguments>TestProject1.dll</TargetArguments> <TargetWorkingDir>D:\Projects\TheApplication\bin\Debug</TargetWorkingDir> <Output>Snapshot1.dcvr</Output> </CoverageParams>

   NUnitを使用する TestProject2 の場合は testProject2.xml ：

   <?xml version="1.0" encoding="utf-8"?> <CoverageParams> <TargetExecutable>D:\Program Files\NUnit 2.6\bin\nunit-console.exe</TargetExecutable> <TargetArguments>TestProject2.dll</TargetArguments> <TargetWorkingDir>D:\Projects\TheApplication\bin\Debug</TargetWorkingDir> <Output>Snapshot2.dcvr</Output> </CoverageParams>

2. 用意されている構成ファイル dotcover c testProject1.xml と dotcover c testProject2.xmlを使用して、各テストプロジェクトで cover (c) コマンドを実行します。結果として、2つのカバレッジスナップショット、Snapshot1.dcvr と Snapshot2.dcvrが得られます。

3. マージ (m)コマンドを実行して両方のスナップショットをマージします。
   dotcover m merge.xml
   merge.xml は設定ファイルです。

   <?xml version="1.0" encoding="utf-8"?> <MergeParams> <Source>Snapshot1.dcvr</Source> <Source>Snapshot2.dcvr</Source> <Output>MergedSnapshots.dcvr</Output> </MergeParams>

4. マージされたスナップショットからHTMLテストレポートを作成するには、報告する (r)コマンドを実行する

   dotcover r report.xml
   ここで、report.xml は構成ファイルです。
   <?xml version="1.0" encoding="utf-8"?> <ReportParams> <Source>MergedSnapshots.dcvr</Source> <Output>CoverageReport.html</Output> <ReportType>html</ReportType> </ReportParams>