In this section:
dotTEST DTP Engine ships with the coverage.exe
tool that facilitates collecting coverage information from .NET managed code during execution of standalone applications. Running coverage.exe
launches a wizard that allows you to specify the necessary information in the GUI. Alternatively, you can provide the information with the dedicated command line options.
Additionally, dotTEST ships with a component called the coverage agent, which can be enabled or disabled when coverage information is being collected. Enabling the coverage agent allows you to connect with the Coverage Agent Manager (CAM) - a web interface for measuring coverage with a wide range of testing techniques; see the Coverage Agent Manager (CAM) section of the DTP documentation for details.
Both workflows, with and without the coverage agent, enable you to generate a local coverage report and upload the results to DTP.
[INSTALL_DIR]\coverage.exe
tool and specify the following information:Specify if you want to collect coverage information with or without the Coverage Agent:
- If you enable the Use Coverage Agent option, enable or disable the Collect coverage without admin privileges option (see Collecting Coverage without Admin Privileges), then skip steps 5-7 and click Finish.
- If you enable the Without Coverage Agent option (default), proceed to steps 5-7.
-solution
or -project
switches that will be passed to the dotTEST executable so that it can locate sources. See Configuring the Test Scope for more information about the switches.Enable or disable the Remove old coverage data before each run option. This option is enabled by default.
By default, dynamic coverage information that was collected during previous executions is deleted. Disabling this option will prevent removing the data from previous runs. |
monitorCoverage.bat
script ( if enabled, the application must be manually launched with the script generated by the wizard in the location specified in step 3).You can run coverage.exe
with the dedicated command line options to specify the information necessary for collecting application coverage:
coverage.exe -app [path] -workingDir [path] -appArgs [arguments] -commandsDir [path] -scope [dotTEST scope switch] -clr [version] -run |
The following options are available:
Option Name | Value | Description |
---|---|---|
-app | [path] | Specifies the full path to the application. |
-workingDir | [path] | Specifies the path to the working directory. |
-appArgs | [argument] | Specifies the application command line arguments. |
-commandsDir | [path] | Specifies the directory for the *.bat scripts generated by the coverage tool. |
-scope |
| Specifies the scope of the coverage to import by providing
See Configuring the Test Scope for more information about the switches. |
-clr |
| Specifies the .NET CLR version used by the application; |
-run | none | Automatically launches the monitorCoverage.bat script (optional; you can also open the directory specified with the -commandDir option and manually run the script). |
-doNotRemoveOldCoverage | none | Specifies that old coverage data is not deleted before each run. If this option is not specified, coverage data collected during previous runs is deleted by default. |
-withCoverageAgent | none | Specifies that coverage is collected with the Coverage Agent. |
If you configure the coverage wizard to run without the coverage agent, the tool creates the following scripts in the directory specified as the Target scripts directory (see Configuring the Coverage Wizard):
monitorCoverage.bat
runs and monitors the applicationimportCoverage.bat
imports and reports coverage datamonitorCoverage.bat
script (skip this step if you launched the coverage wizard with the Run application immediately option enabled). This will run the specified application.importCoverage.bat
script to generate the report in the following location: [Target scripts directory]\reports.If you configure the coverage wizard to run with the coverage agent, the tool creates the following scripts in the directory specified as the Target scripts directory (see Configuring the Coverage Wizard):
monitorCoverage.bat
runs and monitors the applicationrunCamAgent.bat
runs the Coverage AgentRun the runCamAgent.bat
script to launch the Coverage Agent.
Do not close the Coverage Agent process until you stop working with CAM. |
Run the monitorCoverage.bat
script to launch the application.
Connect with Coverage Agent Manager and perform testing.
Download coverage and test results; see Coverage Agent Manager (CAM) section of the DTP documentation for details.
Close the application.
By default, dotTEST requires admin privileges to collect coverage with Coverage Agent, but you can configure the tool to collect coverage by users without admin privileges.
Run the runCamAgentInit.bat
script with admin privileges to setup and initialize the Coverage Agent. This will enable the users without admin privileges to perform testing with CAM, as described in Collecting Coverage with Coverage Agent.
When testing is completed, run the runCamAgentUninit.bat
script to stop the process.
To view coverage information collected with CAM, you need to upload the test results and coverage to DTP.
To upload the coverage to DTP, you need to merge the runtime coverage that you downloaded from CAM with the static coverage generated by the Coverage Agent. To properly merge and upload the coverage data, ensure that the required settings are configured in the .properties file (see Configuration Overview):
report.coverage.images
- Specifies a set of tags that are used to create coverage images in DTP. A coverage image is a unique identifier for aggregating coverage data from runs with the same build ID. DTP supports up to three coverage images per report.session.tag
- Specifies a unique identifier for the test run and is used to distinguish different runs on the same build.build.id
- Specifies a build identifier used to label results. It may be unique for each build, but it may also label several test sessions executed during a specified build.report.coverage.limit
(optional) - Specifies the lower coverage threshold. Coverage results lower than this value are highlighted in the report (the default value is 40
).Generate the static coverage file by running the following test configuration on the solution:
dottestcli.exe -config "builtin://Collect Static Coverage" -solution SOLUTION_PATH |
The dottestcli console output will indicate where the static coverage data is saved:
Saving static coverage information into: 'C:\Users\[USER]\Documents\Parasoft\dotTEST\Coverage\Static\[FILE].data |
Copy the runtime coverage and static coverage files to a directory on the same machine and run dottestcli
using the -runtimeCoverage
and -staticCoverage
switches to specify the location of the files:
dottestcli.exe -runtimeCoverage [path] -staticCoverage [path] -report [path] -publish -settings [path] |
The coverage data will be automatically uploaded to DTP.
You can use the Coverage Explorer in DTP to review the application coverage achieved during test execution. See the DTP documentation for details on viewing coverage information.