JetBrains dotCover

https://www.jetbrains.com/help/dotcover
Admin
JetBrains dotCover is a .NET unit test runner and code coverage tool that analyzes how much of your...
Tokens:22,106
Snippets:389
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Verify dotCover installation

Source: https://www.jetbrains.com/help/dotcover/Coverage-Analysis-with-Command-Line-Tool.html

Displays the help menu to confirm the tool is installed and accessible.

```bash
dotCover help
```

--------------------------------

### Launch Visual Studio Experimental Instance

Source: https://www.jetbrains.com/help/dotcover/Installation_Guide.html

Use this command-line parameter to start a specific experimental instance of Visual Studio.

```bash
devenv.exe /rootSuffix <InstanceName>
```

--------------------------------

### Install dotCover as a local .NET tool

Source: https://www.jetbrains.com/help/dotcover/Coverage-Analysis-with-Command-Line-Tool.html

Installs the dotCover command-line tool to a specific directory for project-level usage.

```bash
dotnet tool install JetBrains.dotCover.CommandLineTools --tool-path "some/path"
```

--------------------------------

### Install dotCover as a global .NET tool

Source: https://www.jetbrains.com/help/dotcover/Coverage-Analysis-with-Command-Line-Tool.html

Installs the dotCover command-line tool globally for use across all projects on the machine.

```bash
dotnet tool install --global JetBrains.dotCover.CommandLineTools
```

--------------------------------

### Example .runsettings file for NUnit parameters

Source: https://www.jetbrains.com/help/dotcover/Reference__Options__Tools__Unit_Testing__NUnit.html

An XML configuration file defining test run parameters that can be combined with dotCover settings.

```xml
<?xml version="1.0" encoding="utf-8" ?>
<RunSettings>
    <TestRunParameters>
        <Parameter name ="param1" value="value1" />
    </TestRunParameters>
</RunSettings>
```

--------------------------------

### Install dotCover console runner as a .NET global tool

Source: https://www.jetbrains.com/help/dotcover/Whats_New.html

Install the console runner globally to analyze coverage in .NET Core projects and unit tests.

```bash
dotnet tool install --global JetBrains.dotCover.GlobalTools --version 2021.1.0
```

--------------------------------

### View Migration Status in Settings File

Source: https://www.jetbrains.com/help/dotcover/Sharing_Configuration_Options.html

Example of the XML entry added to a .dotSettings file to indicate that a specific migration has been applied.

```xml
<s:Boolean x:Key="/Default/Environment/SettingsMigration/IsMigratorApplied/[migration_ID]/@EntryIndexedValue">True</s:Boolean>
```

--------------------------------

### Get help for a command

Source: https://www.jetbrains.com/help/dotcover/dotCover__Console_Runner_Commands.html

Displays information about a specific command in the console.

```text
dotCover help cover
```

--------------------------------

### Configure Log Level in Visual Studio

Source: https://www.jetbrains.com/help/dotcover/Introduction__Troubleshooting.html

Use this argument when starting Visual Studio to set the verbosity level of the dotCover log.

```text
/ReSharper.LogLevel [Normal|Verbose|Trace]
```

--------------------------------

### Build .NET solution

Source: https://www.jetbrains.com/help/dotcover/Coverage-Analysis-with-Command-Line-Tool.html

Initial step to compile the .NET project before running coverage analysis.

```bash
dotnet build
```

--------------------------------

### Run tests with coverage for same framework

Source: https://www.jetbrains.com/help/dotcover/Coverage-Analysis-with-Command-Line-Tool.html

Execute tests and generate coverage output in a single session for projects using the same framework.

```bash
dotCover cover --snapshot-output snapshot.dcvr -- test --no-build
```

```bash
dotCover cover --xml-report-output report.xml -- test --no-build
```

--------------------------------

### Cover command usage and options

Source: https://www.jetbrains.com/help/dotcover/dotCover__Console_Runner_Commands.html

Provides the full syntax, options, and configuration parameters for the cover command.

```text
dotCover cover — Run coverage analysis on a specified application or test project
=================================================================================

Usage:
  dotCover cover <options> [-- <target arguments>]
  dotCover cover @<args-file> [@<args-file2> ...] [<options>]

Description:
  Runs coverage analysis for the specified executable, .NET test project, or any dotnet command.
  If no executable is specified, dotCover will try to automatically run 'dotnet'.

Options:
  --target-executable <path>
      Path to the application or test runner to analyze.
      If omitted, dotCover will auto-detect the 'dotnet' CLI.

  --target-arguments <args>
      Command-line arguments to pass to the target executable.
      You can omit the parameter and specify them after a double dash: -- arg1 arg2

  --target-working-directory <path>
      Application working directory. By default, it's the target’s directory.

  --snapshot-output <path>
      Path to save the raw coverage snapshot ('.dcvr'). Autogenerated if omitted.

Filter options:
  --exclude-assemblies <list>
      Comma-separated list of assembly names to exclude from analysis. Wildcards (*) allowed, e.g., *.Tests
      You can specify this option multiple times; all values will be combined.

  --exclude-attributes <list>
      Comma-separated list of fully qualified attribute names.
      Code marked with these will be excluded, e.g., System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverageAttribute
      Wildcards (*) allowed. You can specify this option multiple times; all values will be combined.

  --exclude-processes <list>
      Comma-separated list of process names to ignore during analysis. Wildcards (*) allowed.
      You can specify this option multiple times; all values will be combined.

Report options:
  --json-report-output <path>
      Paths to save formatted JSON report.

  --json-report-covering-tests-scope <level>
      Granularity for including covering tests in JSON reports: [none|assembly|type|method|statement]

  --xml-report-output <path>
      Paths to save formatted XML report.

  --xml-report-covering-tests-scope <level>
      Granularity for including covering tests in XML reports: [none|assembly|type|method|statement]

Advanced options:
  --temporary-directory <path>
      Directory for temporary files. By default, it's the system temp folder.

  --use-api
      Control the coverage session using the profiler API.

  --no-ngen
      Disable loading of NGen images during coverage.

  --log-file <path>
      Enable logging and specify the path to the log file.

Notes:
  - You can use response files with the '@<args-file>' syntax to simplify command lines.

Examples:
  dotCover cover --json-report-output report.json -- test
  dotCover cover @args.txt
```

--------------------------------

### Define coverage arguments for different frameworks

Source: https://www.jetbrains.com/help/dotcover/Coverage-Analysis-with-Command-Line-Tool.html

Create response files to specify execution details for individual test projects.

```text
--target-executable "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\Common7\IDE\MSTest.exe"
--target-arguments "TestProject1.dll"
--target-working-directory "D:\Projects\MyApp\bin\Debug"
--snapshot-output Snapshot1.dcvr
```

```text
--target-executable "C:\Tools\NUnit\nunit3-console.exe"
--target-arguments "TestProject2.dll"
--target-working-directory "D:\Projects\MyApp\bin\Debug"
--snapshot-output Snapshot2.dcvr
```

--------------------------------

### Use a response file for dotCover configuration

Source: https://www.jetbrains.com/help/dotcover/Coverage-Analysis-with-Command-Line-Tool.html

Executes dotCover using a response file to manage complex parameter sets.

```bash
dotCover cover @args.txt
```

--------------------------------

### dotCover help

Source: https://www.jetbrains.com/help/dotcover/dotCover__Console_Runner_Commands.html

Displays help information for dotCover CLI commands.

```APIDOC
## dotCover help

### Description
Displays detailed help for a specific dotCover command.

### Usage
dotCover help [<command>]

### Parameters
- **command** (string) - Optional - The specific command to get help for (e.g., cover, merge, report, version, help).

### Examples
dotCover help cover
```

--------------------------------

### Run coverage analysis with dotCover

Source: https://www.jetbrains.com/help/dotcover/Coverage-Analysis-with-Command-Line-Tool.html

Executes a coverage analysis session and generates an XML report for the specified project.

```bash
dotCover cover --xml-report-output AppCoverageReport.xml -- test "C:\MyProject\MainTests.csproj"
```

--------------------------------

### Display and Export dotCover Version

Source: https://www.jetbrains.com/help/dotcover/dotCover__Console_Runner_Commands.html

Commands to display the current version or save it to a text file.

```bash
dotCover version
```

```bash
dotCover version --text-output version.txt
```

--------------------------------

### Run coverage analysis for .NET projects

Source: https://www.jetbrains.com/help/dotcover/Coverage-Analysis-with-Command-Line-Tool.html

Executes tests and generates coverage snapshots or reports for .NET projects.

```bash
dotCover cover --snapshot-output snapshot.dcvr -- test --no-build
```

```bash
dotCover cover --xml-report-output report.xml -- test
```

```bash
dotCover cover @"~/config/config.txt"
```

--------------------------------

### Generate coverage reports

Source: https://www.jetbrains.com/help/dotcover/dotCover__Console_Runner_Commands.html

Create formatted XML or JSON reports from a coverage snapshot.

```bash
dotCover report --snapshot-source merged.dcvr --xml-report-output report.xml
```

```bash
dotCover report @report-args.txt
```

--------------------------------

### Merge and report coverage snapshots

Source: https://www.jetbrains.com/help/dotcover/Coverage-Analysis-with-Command-Line-Tool.html

Combine multiple coverage snapshots into one and generate a final XML report.

```bash
dotCover merge --snapshot-source Snapshot1.dcvr,Snapshot2.dcvr --snapshot-output MergedSnapshots.dcvr
```

```bash
dotCover report --snapshot-source MergedSnapshots.dcvr --xml-report-output CoverageReport.xml
```

--------------------------------

### Run coverage analysis for .NET Framework projects

Source: https://www.jetbrains.com/help/dotcover/Coverage-Analysis-with-Command-Line-Tool.html

Executes tests using a specific test runner for .NET Framework projects.

```bash
dotCover cover --target-executable "D:\Program Files\NUnit 2.6\bin\nunit-console.exe"
  --target-arguments "D:\Projects\TheApplication\bin\Debug\AppTests.dll"
  --snapshot-output snapshot.dcvr
```

```bash
dotCover cover --target-executable "D:\Program Files\NUnit 2.6\bin\nunit-console.exe"
  --target-arguments "D:\Projects\TheApplication\bin\Debug\AppTests.dll"
  --xml-report-output report.xml
```

```bash
dotCover cover @"D:\Config\config.txt"
```

--------------------------------

### Run coverage for separate projects

Source: https://www.jetbrains.com/help/dotcover/Coverage-Analysis-with-Command-Line-Tool.html

Execute coverage analysis using the previously defined response files.

```bash
dotCover cover @args1.txt
dotCover cover @args2.txt
```

--------------------------------

### Merge coverage snapshots

Source: https://www.jetbrains.com/help/dotcover/dotCover__Console_Runner_Commands.html

Combine multiple .dcvr files into a single snapshot using direct arguments or a response file.

```bash
dotCover merge --snapshot-source run1.dcvr,run2.dcvr --snapshot-output merged.dcvr
```

```bash
dotCover merge @merge-args.txt
```

--------------------------------

### Generate per-test coverage report with dotCover console runner

Source: https://www.jetbrains.com/help/dotcover/Whats_New.html

Use the IncludePerTestInfo parameter to collect coverage data for individual tests in supported runners.

```bash
dotCover.exe dotnet --output=AppCoverageReport.xml --reportType=XML --IncludePerTestInfo=Method -- test "C:\MyProject\MainTests.csproj"
```
Tokens:
Raw