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.
Configuring the Coverage Wizard
- Run the
[INSTALL_DIR]\coverage.exetool and specify the following information:
- Full path to the application
- Command line arguments
- Working directory
- Specify the .NET CLR version used by the application.
- Specify a directory where the scripts generated by the wizard will be saved.
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.
- Define the scope of coverage to import by providing
-projectswitches 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.
- Enable or disable the Run application immediately option to automatically launch the
monitorCoverage.batscript ( if enabled, the application must be manually launched with the script generated by the wizard in the location specified in step 3).
Using the Command Line Options
You can run
coverage.exe with the dedicated command line options to specify the information necessary for collecting application coverage:
The following options are available:
|Specifies the full path to the application.|
|Specifies the path to the working directory.|
|Specifies the application command line arguments.|
|Specifies the directory for the *.bat scripts generated by the coverage tool.|
Specifies the scope of the coverage to import by providing
See Configuring the Test Scope for more information about the switches.
|Specifies the .NET CLR version used by the application;|
|Automatically launches the |
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.
|Specifies that coverage is collected with the Coverage Agent.|
Collecting Coverage without 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.batruns and monitors the application
importCoverage.batimports and reports coverage data
- Run the
monitorCoverage.batscript (skip this step if you launched the coverage wizard with the Run application immediately option enabled). This will run the specified application.
- Interact with the application and perform your tests.
- Close the application.
- Run the
importCoverage.batscript to generate the report in the following location: [Target scripts directory]\reports.
- View the coverage information.
Collecting Coverage with Coverage Agent
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.batruns and monitors the application
runCamAgent.batruns the Coverage Agent
runCamAgent.batscript to launch the Coverage Agent.
Do not close the Coverage Agent process until you stop working with CAM.
monitorCoverage.batscript 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.
- Upload the coverage and test results to DTP, see Uploading Test Results and Coverage to DTP.
- View the coverage information in DTP.
Collecting Coverage without Admin Privileges
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.
- Enable the Collect coverage without admin privileges option (see Configuring the Coverage Wizard) and launch the wizard. As a result, two additional .bat scripts will be generated:
runCamAgentInit.batscript 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.batscript to stop the process.
Uploading Test Results and Coverage to DTP
To view coverage information collected with CAM, you need to upload the test results and coverage to DTP.
Uploading Test Results
- Go to Report Center in the DTP interface.
- Click the gear icon and choose Report Center Settings> Additional Settings> Report Center Administration> Tools> Data Collector Upload Form.
- Click Choose File and browse for the report.xml file that you downloaded from CAM.
- Click the Upload button to upload the file 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):
- Ensure that dotTEST DTP Engine is properly configured, including DTP, scope and authorship settings. See Connecting to DTP, Sending Results and Publishing Source Code to DTP, Configuration.
- Configure the following settings in the dottestcli.properties file in order to properly merge coverage data:
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
Generating the Static Coverage File
Generate the static coverage file by running the following test configuration on the solution:
The dottestcli console output will indicate where the static coverage data is saved:
Merging the Coverage Data and Uploading to DTP
Copy the runtime coverage and static coverage files to a directory on the same machine and run
dottestcli using the
-staticCoverage switches to specify the location of the files:
The coverage data will be automatically uploaded to DTP.
Reviewing Coverage in 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.