This task scans the build to generate settings for the Jtest Java Agent, and creates a monitor package in location specified with the monitorLocation parameter. The monitor package contains the following: - static_coverage.xml - the file that contains static coverage information
- agent.jar - the Jtest Java coverage agent jar archive
- agent.properties - the agent settings file that contains scope parameters generated during the build process and other attributes
- agent.sh/agent.bat - the script that generates the Jtest Java agent VM arguments necessary to monitor the application
Info |
---|
icon | false |
---|
title | Command Line Execution |
---|
| Ensure that tests and classes are compiled before executing the jtest:monitor task from command line (the compile phase). |
Info |
---|
icon | false |
---|
title | Excluding test classes |
---|
| Gradle does not recognize test classes when the jtest-monitor task is run. To ensure that coverage information for test classes is not collected, it is highly recommended to use jtest.exclude and specify the path to the package that contains test, for example -Djtest.exclude=path:**/test/**. |
ParametersName | Accepted values / data type | Decription | Required |
---|
agentServerEnabled | true | false | A switch that allows you to enable the Agent server. User property is: jtest.agentServerEnabled | No | autostartAgent | true | false | A switch to automatically enable collecting coverage.
User property is: jtest.autostartAgent | No | compilation | Compilation | A description of manual configuration data (see Manual Customization of Compilation Data) | No | coverage |
| A set of parameters that allow you to configure collecting coverage. jtest.coverage.skip - Disables collecting coverage.jtest.coverage.includes - <Glob> patterns to include classes. Coverage information will be collected.jtest.coverage.excludes - <Glob> patterns to exclude classes. Coverage information will not be collected.jtest.coverage.testIncludes - <Glob> patterns to include test classes. Test cases will be assigned with coverage.jtest.coverage.testExcludes - <Glob> patterns to exclude test classes. Test cases will not be assigned with coverage.
|
| exclude | String | Specifies a subset of files or packages from the selected resources that will be excluded from analysis. You can provide the qualified names or use Ant glob patterns to match more filenames. User property is: jtest.exclude | No | excludes | List | A list of exclude parameters. User property is: jtest.excludes | No | home | Path | Jtest installation directory. User property is: jtest.home | Recommended | ignoredIds | List | A list of ignored compilation IDs. User property is: jtest.ignoredids | No | include | String | Specifies a subset of files or packages form the selected resources that will be included during analysis. User property is: jtest.include | No | includes | List | A list of include parameters. User property is: jtest.includes | No | Anchor |
---|
| monitorLocation |
---|
| monitorLocation |
---|
| monitorLocation
| Path | The path to the location where the monitor package will be created. User property is: jtest.monitorLocation | No | publish | true | false | Enables reporting results of local analysis to the DTP server. User property is: jtest.publish | No | report | Path | Specifies the directory where the report will be created. User property is: jtest.report | No | resource | String | Specifies the input scope for analysis. If no resources are specified, Jtest will analyze resources from every built project. User property is: jtest.resource | No | resources | List | A list of resource parameters. User property is: jtest.resources | No | settings | Path | An absolute or relative path to the *properties file that includes custom configuration settings. User property is: jtest.settings | No | settingsList | List | A list of settings parameters. User property is: jtest.settingsList | No | showDetails | true | false | Displays detailed progress information. User property is: jtest.showdetails | No | showSettings | true | false | Prints the current settings and customizations along with the information where each of them is configured (e.g. in the jtest.properties file). User property is: jtest.showsettings | No | projectNameTemplate | String | The project name template. This parameter allows you to configure the pattern with the options [group], [name], [version], [path], and [basedir]. User property is: jtest.projectNameTemplate | No | skip | true | false | Allows you to skip the Jtest execution phase. If set to true , only the jtest.data.json data file is generated. User property is: jtest.skip | No |
Parameter DetailsexcludeSpecifies a subset of files or packages from the selected resources that will be excluded from analysis. You can provide the qualified names. You can use glob patterns to match more filenames. Example 1: The following pattern excludes all files from com.parasoft package and its sub-packages: /com/parasoft/** Example 2: The following pattern excludes all files from the package com.parasoft.jtest, but NOT from its sub-packages: /com/parasoft/jtest/* Example 3: The following pattern excludes all files from the given directory and all subdirectories: path:/home/user/project/src/test/java/** includeSpecifies a subset of files or packages form the selected resources that will be included during analysis. You can use glob patterns to match more filenames. Example 1: The following pattern includes all files from com.parasoft package and its sub-packages: /com/parasoft/** Example 2: The following pattern includes all files from the package com.parasoft.jtest, but NOT from its sub-packages: /com/parasoft/jtest/* Example 3: The following pattern includes all files from the given directory and all subdirectories: path:/home/user/project/src/test/java/** resource
Specifies the input scope for analysis. If no resources are specified, Jtest will analyze resources from every built project. Use the following pattern to specify the paths: ${ProjectName}/my/src/dir/my/package/file.java". You can use the following wildcards: - ? - matches one character
- * - matches zero or more characters, except the path separator (the / character)
- ** - matches entire paths, including the path separator (the / character)
settings
An absolute or relative path to the *properties file that includes custom configuration settings. Info |
---|
| Some of the setting names may not be consistent with the settings dedicated for the build system plugins. See Configuration Settings for details. |
Anchor |
---|
| projectNameTemplate_2 |
---|
| projectNameTemplate_2 |
---|
| projectNameTemplate
The project name template. By default, the following pattern is used to create project names in json: :"groupIdgroup:artifactId name". This parameter allows you to configure the pattern with the options [group], [name], [version], [path], and [basedir], for example, to make a project name compatible with the project name in Eclipse. Warning |
---|
| If you change the pattern for a project that has already been integrated with DTP, DTP will not recognize your project. It will assume that your project after the change of the pattern is a different project. For details, see the DTP documentation. |
Parameter Type DetailsThe following examples assume that the Jtest Plugin for Gradle has been properly configured and applied in the Gradle build script; see Configuring the Jtest Plugin for Gradle. Anchor |
---|
| compilation_type_2 |
---|
| compilation_type_2 |
---|
| Compilation Type- Attribute: Compilation
- A nested object
Code Block |
---|
jtest {
home = "path/to/jtest"
compilation {
id = "main"
override = true
}
} | List Type- Attribute: resources
- Specifies the list of resource patterns to match against resources that are collected during the build.
Code Block |
---|
jtest {
home = "path/to/jtest"
resources = [
"**.java",
"myGradleProjectName/src/com/mycompany/models/**/*.properties"
]
} |
Anchor |
---|
| string_type_2 |
---|
| string_type_2 |
---|
| String Type- Attribute: Exclude
- Specifies a subset of files or packages from the selected resources that will be excluded from analysis.
Code Block |
---|
jtest {
home = "path/to/jtest"
exclude = "com/mycompany/models/**/NotInteresting*.properties"
} |
See Compilation Data Model for more information. |