Page History

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

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

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

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

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

• 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

Specifies the directory where the report will be created. By default it is ${project.build.directory}/jtest.

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

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

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

• 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.1.0. Can be configured by property since Maven 3.1.0.

• 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