Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Content Zone
maxLevel2
minLevel2
locationtop
typeflat
separatorpipe

Full name: com.parasoft.jtest:jtest-maven-plugin:2020.1.0:jtest

This goal should be used as a Maven report. It collects the build data and executes Jtest with the configured parameters (see Configuring the Jtest Plugin for Maven). It is called at the end of the build session and collects the aggregated data of every project. The goal works as an aggregator, which means it is not tied to a build lifecycle phase.

Attributes

  • Requires a Maven project to be executed.
  • Executes as an aggregator plugin.
  • Requires dependency resolution of artifacts in scope: compile.
  • Since version: 1.0.0

Parameters

NameAccepted values / data typeSinceDescription
compilationPlexusConfiguration1.0.4A description of manual configuration data (see Manual Customization of Compilation Data)
compilationsPlexusConfiguration1.0.4A list of descriptions of manual configuration data (see Manual Customization of Compilation Data)
configString1.0.0

The name of a built-in, DTP, or user-defined test configuration.

User property is: jtest.config

dataUpdateString1.2.9

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

User property is: jtest.dataUpdate

excludeString1.0.0

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

excludes
1.1.0

A list of exclude parameters.

User property is: jtest.excludes

failtrue | false

1.0.0  

Fails the build if any violation is reported.

Default value is: false

User property is: jtest.fail

forceTestReportsImporttrue | false
1.0.0

Ensures that test results are imported from the default location if the Jtest Plugin fails to recognize the existing test plugin (for example, Surefire) in the Maven environment.

Default value is: false

User property is: jtest.forceTestReportsImport

homePath1.1.0

Specifies the Jtest installation directory.

User property is: jtest.home

ignoredIds


1.0.4

A list of ignored compilation IDs.

User property is: jtest.ignoredids

includeString1.0.0

Specifies a subset of files or packages from the selected resources that will be included during analysis.

User property is: jtest.include

includes
1.1.0

A list of include parameters.

User property is: jtest.includes

projectNameTemplateString1.0.0

The project name template. This parameter allows you to configure the pattern with the options [groupId], [artifactId], [version], and [basedir].

User property is: jtest.projectNameTemplate

publishtrue | false1.0.0

Enables reporting results of local analysis to the DTP server.

User property is: jtest.publish

reportPath1.0.0

Specifies the directory where the report will be created.

User property is: jtest.report

resourceString1.0.0

Specifies the input scope for analysis. If no resources are specified, Jtest will analyze resources from every built project.

User property is: jtest.resource

resources
1.1.0

A list of resource parameters.

User property is: jtest.resources

settingsPath1.0.0

An absolute or relative path to the *properties file that includes custom configuration settings.

User property is: jtest.settings

settingsList
1.0.0

A list of settings parameters.

User property is: jtest.settingsList

showDetailstrue | false1.0.0

Displays detailed progress information.

User property is: jtest.showdetails

showSettingstrue | false1.0.0

Prints the current settings and customizations.

User property is: jtest.showsettings

skiptrue | false1.1.0

Allows you to skip the Jtest execution phase. If set to true, only the jtest.data.json data file is generated.

Default value is: false

User property is: jtest.skip

Parameter Details

Anchor
compilation
compilation
compilation

A description of manual configuration data (see Manual Customization of Compilation Data).

  • Type: org.codehaus.plexus.configuration.PlexusConfiguration
  • Since: 1.0.4
  • Required: No

Anchor
compilations
compilations
compilations

A list of descriptions of manual configuration data (see Manual Customization of Compilation Data)

  • Type: org.codehaus.plexus.configuration.PlexusConfiguration
  • Since: 1.0.4
  • Required: No

Anchor
config
config
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.

  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User property: jtest.config

Anchor
dataUpdate
dataUpdate
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
  • Type: java.lang.String
  • Since: 1.2.9
  • Required: No
  • User property: jtest.dataUpdate

See Manual Customization of Compilation Data and Compilation Data Model for details.

Anchor
exclude
exclude
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/**

  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User property: jtest.exclude

Anchor
excludes
excludes
excludes

A list of exclude parameters. Can be configured by property since Maven 3.0.3.

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

Anchor
fail
fail
fail

Fails the build if any violation is reported.

  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • Default: false
  • User property: jtest.fail

Anchor
forceTestReportsImport
forceTestReportsImport
forceTestReportsImport

Ensures that test results are imported from the default location if the Jtest Plugin fails to recognize the existing test plugin (for example, Surefire) in the Maven environment.

Info
iconfalse

We recommend using this parameter with the "clean" goal to prevent the Jtest Plugin from importing test results from previous executions.

  • Type: java.lang.Boolean
  • Since: 1.0.0
  • Required: No
  • Default: false
  • User property: jtest.forceTestReportsImport

Anchor
home
home
home

Jtest installation directory.

  • Type: java.io.File
  • Since: 1.1.0
  • Required: No
  • User property: jtest.home

Anchor
ignoredIds
ignoredIds
ignoredIds

A list of ignored compilation IDs. Supported by Maven since 3.0.3.

  • Type: java.lang.String[]
  • Since: 1.0.4
  • Required: No
  • User property: jtest.ignoredids

Anchor
include
include
include

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

  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User property: jtest.include

Anchor
includes
includes
includes

A list of include parameters. Can be configured by property since Maven 3.0.3.

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

Anchor
projectNameTemplate
projectNameTemplate
projectNameTemplate

The project name template. By default, the following pattern is used to create project names in json: :"groupId:artifactId ". This parameter allows you to configure the pattern with the options [groupId], [artifactId], [version] and [basedir], for example, to make a project name compatible with the project name in Eclipse.

Warning
iconfalse

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.

  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User property: jtest.projectNameTemplate

Anchor
publish
publish
publish

Enables reporting results of local analysis to the DTP server.

  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User property: jtest.publish

Anchor
report
report
report

  • Type: java.io.File
  • Since: 1.0.0
  • Required: No
  • User property: jtest.report


Anchor
resource
resource
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)

(info) The Jtest Plugin for Maven resolves ${ProjectName} to ${artifactId}:${groupId}.

  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User property: jtest.resource

Anchor
resources
resources
resources

A list of resource parameters. Can be configured by property since Maven 3.0.3.

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

Anchor
settings
settings
settings

An absolute or relative path to the *properties file that includes custom configuration settings.

Info
iconfalse

Some of the setting names may not be consistent with the settings dedicated for the build system plugins. See Configuration Settings for details.

  • Type: java.io.File
  • Since: 1.0.0
  • Required: No
  • User property: jtest.settings

Anchor
settingsList
settingsList
settingsList

A list of settings parameters. Supported by Maven since 3.0.3. Can be configured by property since Maven 3.0.3.

  • Type: java.io.File[]
  • Since: 1.0.0
  • Required: No
  • User property: jtest.settingsList

Anchor
showDetails
showDetails
showDetails

Displays detailed progress information.

  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: jtest.showdetails

Anchor
showSettings
showSettings
showSettings

Prints the current settings and customizations along with the information where each of them is configured (e.g. in the jtest.properties file).

  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User property: jtest.showsettings

Anchor
skip
skip
skip

Allows you to skip the Jtest execution phase. If set to true, only the jtest.data.json data file is generated.

  • Type: java.lang.String
  • Since: 1.1.0
  • Required: No
  • Default: false
  • User property: jtest.skip

...

Table of Content Zone
maxLevel2
minLevel2
locationtop
typeflat
separatorpipe

Full name: com.parasoft.jtest:jtest-maven-plugin:2020.1.0:monitor

This goal should be used as a Maven report. It 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.
Info
iconfalse
titleCommand Line Execution

Ensure that tests and classes are compiled before executing the jtest:monitor goal from command line (the compile phase).

Attributes

  • Requires a Maven project to be executed.
  • Executes as an aggregator plugin.
  • Requires dependency resolution of artifacts in scope: compile.
  • Since version: 1.2.4

Optional Parameters

NameAccepted values / data typeSinceDescription
agentServerEnabledtrue | false1.2.4

A switch that allows you to enable the Agent server.

Default value is: true

User property is: jtest.agentServerEnabled

autostartAgenttrue | false1.0.7

A switch to automatically enable collecting coverage.

Default value is: true

User property is: jtest.autostartAgent

compilationPlexusConfiguration1.0.4A description of manual configuration data (see Manual Customization of Compilation Data)
compilationsPlexusConfiguration1.0.4A list of descriptions of manual configuration data (see Manual Customization of Compilation Data)
coverage
1.2.4

The coverage configuration block. You can nest the following parameters:

  • 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.skip - (Boolean) Disables collecting coverage if enabled.

Glob patterns are matched to relative paths of *.class files from classpath (the path separator: / )

dataUpdateString1.2.9

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

User property is: jtest.dataUpdate

enableJacocotrue | false

Allows you to enable or disable line collecting coverage with the Jacoco engine.

Default value is: false

User property is: jtest.enableJacoco

excludeString1.0.0

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

excludes


1.1.0

A list of exclude parameters.

User property is: jtest.excludes

homePath1.1.0

Specifies the Jtest installation directory.

User property is: jtest.home

ignoredIds
1.0.4

A list of ignored compilation IDs.

User property is: jtest.ignoredids

includeString1.0.0

Specifies a subset of files or packages form the selected resources that will be included during analysis.

User property is: jtest.include

includes
 1.1.0

A list of include parameters.

User property is: jtest.includes

monitorLocationPath1.2.4

The path to the location where the monitor package will be created.

Default value is: ${project.build.directory}/jtest/monitor/monitor.zip

User property is: jtest.monitorLocation

projectNameTemplateString1.2.4

The project name template.

User property is: jtest.projectNameTemplate

publishtrue | false1.0.0

Enables reporting results of local analysis to the DTP server.

User property is: jtest.publish

resourceString1.0.0

Specifies the input scope for analysis. If no resources are specified, Jtest will analyze resources from every built project.

User property is: jtest.resource

resources
1.1.0

A list of resource parameters.

User property is: jtest.resources

settingsPath1.0.0

An absolute or relative path to the *properties file that includes custom configuration settings.

User property is: jtest.settings

settingsList
1.0.0

A list of settings parameters.

User property is: jtest.settingsList

showDetailstrue | false1.0.0

Displays detailed progress information.

User property is: jtest.showdetails

showSettingstrue | false1.0.0

Prints the current settings and customizations.

User property is: jtest.showsettings

skiptrue | false1.1.0

Allows you to skip the Jtest execution phase. If set to true, only the jtest.data.json data file is generated.

Default value is: false

User property is: jtest.skip

Parameter Details

Anchor
agentServerEnabled_2
agentServerEnabled_2
agentServerEnabled

A switch that allows you to enable the Agent server.

  • Type: boolean
  • Since: 1.2.4
  • Required: No
  • User Property: jtest.agentServerEnabled
  • Default: true

Anchor
autostartAgent_2
autostartAgent_2
autostartAgent

A switch to automatically enable collecting coverage.

  • Type: boolean
  • Since: 1.0.7
  • Required: Yes
  • User Property: jtest.autostartAgent
  • Default: true

Anchor
compilation_2
compilation_2
compilation

A description of manual configuration data (see Manual Customization of Compilation Data).

  • Type: org.codehaus.plexus.configuration.PlexusConfiguration
  • Since: 1.0.4
  • Required: No

Anchor
compilations_2
compilations_2
compilations

A list of descriptions of manual configuration data (see Manual Customization of Compilation Data)

  • Type: org.codehaus.plexus.configuration.PlexusConfiguration
  • Since: 1.0.4
  • Required: No

Anchor
coverage_2
coverage_2
coverage

  • jtest.coverage.skip - Disables collecting coverage.

The following parameters specify classes that will be instrumented (coverage will be collected only for instrumented classes):

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

Glob patterns are matched to relative paths of *.class files from classpath (the path separator: / )

  • Type: com.parasoft.jtest.plugin.CoverageConfig
  • Since: 1.2.4
  • Required: No

Anchor
dataUpdate_2
dataUpdate_2
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
  • Type: java.lang.String
  • Since: 1.2.9
  • Required: No
  • User property:jtest.dataUpdate

See Manual Customization of Compilation Data and Compilation Data Model for details.

Anchor
enableJacoco_2
enableJacoco_2
enableJacoco

  • Type: boolean
  • Since: 2021.1.0
  • Required: No
  • Default: false
  • User Property: jtest.enableJacoco

Anchor
exclude_2
exclude_2
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/**

  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User property: jtest.exclude

Anchor
excludes_2
excludes_2
excludes

A list of exclude parameters. Can be configured by property since Maven 3.0.3.

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

Anchor
home_2
home_2
home

Jtest installation directory.

  • Type: java.io.File
  • Since: 1.1.0
  • Required: No
  • User property: jtest.home

Anchor
ignoredIds_2
ignoredIds_2
ignoredIds

A list of ignored compilation IDs. Supported by Maven since 3.0.3.

  • Type: java.lang.String[]
  • Since: 1.0.4
  • Required: No
  • User property: jtest.ignoredids

Anchor
include_2
include_2
include

Specifies a subset of files or packages from 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/**

  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User property: jtest.include

Anchor
includes_2
includes_2
includes

A list of include parameters. Can be configured by property since Maven 3.0.3.

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

Anchor
monitorLocation_2
monitorLocation_2
monitorLocation

The path to the location where the monitor package will be created.

  • Type: java.io.File
  • Since: 1.2.4
  • Required: No
  • User property: jtest.monitorLocation
  • Default: ${project.build.directory}/jtest/monitor/monitor.zip

Anchor
projectNameTemplate_2
projectNameTemplate_2
projectNameTemplate

The project name template. By default, the following pattern is used to create project names in json: :"groupId:artifactId ". This parameter allows you to configure the pattern with the options [groupId], [artifactId], [version] and [basedir], for example, to make a project name compatible with the project name in Eclipse.

Warning
iconfalse

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.

  • Type: java.lang.String
  • Since: 1.2.4
  • Required: No
  • User Property: jtest.projectNameTemplate

Anchor
publish_2
publish_2
publish

Enables reporting results of local analysis to the DTP server.

  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User property: jtest.publish

Anchor
resource_2
resource_2
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)

(info) The Jtest Plugin for Maven resolves ${ProjectName} to ${artifactId}:${groupId}.

  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User property: jtest.resource

Anchor
resources_2
resources_2
resources

A list of resource parameters. Can be configured by property since Maven 3.0.3.

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

Anchor
settings_2
settings_2
settings

An absolute or relative path to the *properties file that includes custom configuration settings.

Info
iconfalse

Some of the setting names may not be consistent with the settings dedicated for the build system plugins. See Configuration Settings for details.

  • Type: java.io.File
  • Since: 1.0.0
  • Required: No
  • User property: jtest.settings

Anchor
settingsList_2
settingsList_2
settingsList

A list of settings parameters. Supported by Maven since 3.0.3. Can be configured by property since Maven 3.0.3.

  • Type: java.io.File[]
  • Since: 1.0.0
  • Required: No
  • User property: jtest.settingsList

Anchor
showDetails_2
showDetails_2
showDetails

Displays detailed progress information.

  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User Property: jtest.showdetails

Anchor
showSettings_2
showSettings_2
showSettings

Prints the current settings and customizations along with the information where each of them is configured (e.g. in the jtest.properties file).

  • Type: java.lang.String
  • Since: 1.0.0
  • Required: No
  • User property: jtest.showsettings

Anchor
skip_2
skip_2
skip

Allows you to skip the Jtest execution phase. If set to true, only the jtest.data.json data file is generated.

  • Type: java.lang.String
  • Since: 1.1.0
  • Required: No
  • Default: false
  • User property: jtest.skip

...