The Gradle task to execute Jtest.

Attributes

Parameter Details

config

The name of a test configuration. The following configuration types are supported:

• built-in test configurations, for example "builtin://Recommended Rules"
• dtp test configurations, for example "dtp://New Config"
• user-defined test configurations, for example "user://Your Config"

User-defined test configurations should be stored in the <INSTALL_DIR>/configs/user directory as *.properties files.

dataUpdate

Allows you to manually update compilation data collected from the build.

• Supported actions: prepend, append, and set.
• Supported data types: classpath, bootpath, sourcepath, resourcepath, binarypath, sourcecode (set only) and encoding (set only)
• Scope: all collected projects data will be updated

See Manual Customization of Compilation Data and Compilation Data Model for more information.

exclude

Specifies 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/**

include

Specifies 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/**

includes

A list of include parameters. 

• Type: java.lang.String[]
• Since: 1.1.0
• Required: No
• User property: jtest.includes

jvmArgs

Specifies a space-separated list of additional arguments to be passed directly to the Java Virtual Machine (JVM) that runs jtestcli in the background of the jtest-gradle-plugin. This option is useful for configuring JVM-level properties, such as locale, encoding, or system properties that influence Jtest execution.

Usage:

-Djtest.jvmArgs="<-Dproperty1=value> <-Dproperty2=value>"

Example:

-Djtest.jvmArgs="-Duser.language=zh -Duser.country=CN"

• Type: string[]
• Since: 2023.1
• Required: No
• User property is: jtest.jvmArgs

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.

projectNameTemplate

The project name template. By default, the following pattern is used to create project names in json: "group: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.

Parameter Type Details

The 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.

Compilation Type

• Attribute: Compilation
• A nested object

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.

jtest {
        home = "path/to/jtest"
        resources = [
                "**.java",
                "myGradleProjectName/src/com/mycompany/models/**/*.properties"
        ]
}

String Type

• Attribute: Exclude
• Specifies a subset of files or packages from the selected resources that will be excluded from analysis.

jtest {
    home = "path/to/jtest"
    exclude = "com/mycompany/models/**/NotInteresting*.properties"
}

See Compilation Data Model for more information.

The Gradle task to collect coverage with Jtest.

Note: Jtest Agent cannot be used simultaneously with the JaCoCo plugin or with an externally attached JaCoCo agent.

Parameters

Parameter Details

coverage

The default is:

jtest { 
  /* other parameters  */ 
  coverage { 
    skip = false 
    includes = [ 'package/**' ] 
    excludes = [ ] 
    testIncludes = [ 'package/Test.class' ] 
    testExcludes = [ ] 
  } 
}

runtimeDataLocation

The default is: ${basedir}/parasoft/jtest-instrument/runtimedata.data

metadataLocation

The default is: ${basedir}/parasoft/jtest-instrument/metadata.data

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
• opentelemetry-javaagent.jar and jtest-otel-ext.jar - files used in multiuser coverage mode: the original OpenTelemetry Java agent and the Jtest extension for it. This extension collects data necessary to assign collected coverage to a particular user. The files are copied from the <INSTALL_DIR>/integration/coverage directory.

Parameters

Parameter Details

exclude

Specifies 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/**

include

Specifies 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/**

jvmArgs

Specifies a space-separated list of additional arguments to be passed directly to the Java Virtual Machine (JVM) that runs jtestcli in the background of the jtest-gradle-plugin. This option is useful for configuring JVM-level properties, such as locale, encoding, or system properties that influence Jtest execution.

Usage:

-Djtest.jvmArgs="<-Dproperty1=value> <-Dproperty2=value>"

Example:

-Djtest.jvmArgs="-Duser.language=zh -Duser.country=CN"

• Type: string[]
• Since: 2023.1
• Required: No
• User property is: jtest.jvmArgs

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.

projectNameTemplate

The project name template. By default, the following pattern is used to create project names in json: "group: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.

Parameter Type Details

The 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.

Compilation Type

• Attribute: Compilation
• A nested object

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.

jtest {
        home = "path/to/jtest"
        resources = [
                "**.java",
                "myGradleProjectName/src/com/mycompany/models/**/*.properties"
        ]
}

String Type

• Attribute: Exclude
• Specifies a subset of files or packages from the selected resources that will be excluded from analysis.

jtest {
    home = "path/to/jtest"
    exclude = "com/mycompany/models/**/NotInteresting*.properties"
}

See Compilation Data Model for more information.

This goal is provided by the test impact analysis plugin shipped with Jtest and allows you to perform change-based testing of your project (see Test Impact Analysis).

Required Parameters

Optional Parameters