NCover Profiler Task¶
Perform a code coverage profile using NCover.
tip
NCover is a commerical application that will profile code while unit tests are running. The tool is available from http://www.ncover.com/.
info : Supported Versions
CruiseControl.NET only supports NCover 3.x currently.
Version¶
Available from version 1.5
Examples¶
1<ncoverProfile>
2 <executable>C:\Program Files\NCover\NCover.Console.exe</executable>
3 <program>tools\nunit\nunit-console.exe</program>
4 <testProject>myproject.test.dll</testProject>
5 <workingDir>build\unittests</workingDir>
6 <includedAssemblies>myproject.*.dll</includedAssemblies>
7</ncoverProfile>Configuration Elements¶
| Element | Description | Type | Required | Default | Version |
| applicationLoadWait | The amount of time that NCover will wait for the application to start up. Maps to //wal |
Int32 | No | None | 1.5 |
| baseDir | The base directory to use. All relative parameters will be relative to this parameter. | String | No | Project Working Directory | 1.5 |
| buildId | A custom build id to attach. Maps to //bi |
String | No | The build label | 1.5 |
| coverageFile | The location to write the coverage file to. If relative, this will be relative to baseDir. Maps to //x |
String | No | Coverage.xml | 1.5 |
| coverageMetric | The coverage metric to use. Maps to //ct |
String | No | None | 1.5 |
| iis | Whether to cover IIS or not. Maps to //iis |
Boolean | No | false | 1.5 |
| description | Description used for the visualisation of the buildstage, if left empty the process name will be shown. | String | No | The task/publisher name. | 1.5 |
| disableAutoexclusion | Whether to turn off autoexclusion or not. Maps to //na |
Boolean | No | false | 1.5 |
| dynamicValues | The dynamic values to use for the task. | Dynamic Values array | No | None | 1.5 |
| environment | A set of environment variables set for commands that are executed. Each variable should be specified as . |
Environment Variable array | No | ||
| excludedAssemblies | The assemblies to exclude. Maps to //eas |
String | No | None | 1.5 |
| excludedAttributes | The attributes to exclude. Maps to //ea |
String | No | None | 1.5 |
| excludedFiles | The files to exclude. Maps to //ef |
String | No | None | 1.5 |
| excludedMethods | The methods to exclude. Maps to //em |
String | No | None | 1.5 |
| excludedTypes | The types to exclude. Maps to //et |
String | No | None | 1.5 |
| executable | The executable to use. | String | No | Ncover.Console | 1.5 |
| includedAssemblies | The assemblies to include. Maps to //ias |
String | No | None | 1.5 |
| includedAttributes | The attributes to include. Maps to //ia |
String | No | None | 1.5 |
| includedFiles | The files to include. Maps to //if |
String | No | None | 1.5 |
| includedTypes | The types to include. Maps to //it |
String | No | None | 1.5 |
| logFile | The location of the NCover log file. If relative, this will be relative to baseDir. Maps to //l |
String | No | None | 1.5 |
| logLevel | The profiler log level. Maps to //ll |
String - one of: * Default * None * Normal * Verbose |
No | Default | 1.5 |
| priority | The priority class of the spawned process. | String - one of: * Normal * Idle * High * RealTime * BelowNormal * AboveNormal |
No | Normal | 1.5 |
| processModule | The module to process. Maps to //pm |
String | No | None | 1.5 |
| programParameters | The parameters to pass to the program. | String | No | None | 1.5 |
| program | The program to execute and collect coverage stats from. | String | Yes | n/a | 1.5 |
| projectName | The name of the project (used in the HTML report). Maps to //p |
String | No | None | 1.5 |
| publish | Whether to publish the output files or not. | Boolean | No | true | 1.5 |
| register | Temporarily enable NCover. Maps to //reg |
Boolean | No | false | 1.5 |
| serviceTimeout | The timeout period for covering a service. Maps to //st |
Int32 | No | None | 1.5 |
| settingsFile | The location to read the settings from. If relative, this will be relative to baseDir. Maps to //cr |
String | No | None | 1.5 |
| symbolSearch | The symbol search policy to use. Maps to //ssp |
String | No | None | 1.5 |
| testProject | The project that contains the tests. If relative, this will be relative to baseDir. | String | No | None | 1.5 |
| timeout | The time-out period in seconds. If the task does no finish running in this time it will be terminated. | Int32 | No | 600 | 1.5 |
| trendFile | The location to write the trend file to. Maps to //at |
String | No | None | 1.5 |
| windowsService | The windows service to cover. Maps to //svc |
String | No | None | 1.5 |
| workingDir | The working directory to use. If relative, this will be relative to baseDir. Maps to //w |
String | No | None | 1.5 |
Notes¶
This task calls NCover.Console to perform the profiling. Full details on this tool is available at http://docs.ncover.com/ref/3-0/ncover-console/. Additional details on the mapped arguments can be found there.
Automatically Generated¶
Documentation generated on Monday, 26 May 2014 at 7:18:04 AM