Page tree

Versions Compared

Key

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

...

Conditional Content
product: (jtest)
product: (jtest)
sv-attr:0A01020401598D973E6641760F8AF4E50A01020401598D973E671AAA268425A3

Overview

Jtest DTP Engine is launched by running jtestcli.exe located in the Jtest installation directory. In the typical workflow, the executable is run from the dedicated plug-ins for the supported build systems, such as Maven,Ant and Gradle, but it can also be run manually the from the command line.

The jtestcli.exe runs on jtest.data.json data files that are automatically generated by the build system plug-ins. If you run jtestcli.exe from the command line, use the -data option to point to the .json data file that will be used for analysis.

Using

Buil

Build System Plug-ins

Typically, the jtestcli.exe is launched from a dedicated Jtest plug-in for Maven, Ant or Gradle. For details, including plugin configuration and troubleshooting, see the Jtest Plugins manual (plugins-manual.html) for build systems is located in the [INSTALL_DIR]/manuals directory.

Info

Add the $XTEST_ITX=714 environment variable to show arguments passed to jtestcli.exe executed by plug-ins.

Using jtestcli from the Command Line

Run jtestcli.exe from the command line to launch Jtest DTP Engine. You must at the minimum include a test configuration and specify the data file location to analyze code. See Configuring Test Configurations and Specifying Test Data Location for more information.

Your command line may resemble the following:

Code Block
jtestcli.exe -settings settings.properties -config "builtin://Recommended Rules" -data demo.data.json -report report

Anchor
Specifying Test Data Location
Specifying Test Data Location
Specifying Test Data Location

Use the -data switch to point directly to a *.json data file object generated by the build system plugin. The automatically-generated *.json data file provides the same information as the workspace in a format specific to Jtest DTP Engine:

Code Block
-data file

Build system plug-ins automatically add the data argument and include the value they generate, so there is no need to add it to the plug-in configuration.

Settings Property Pattern

The path to the data file can be configured with the jtest.data option in the .properties file:

Code Block
jtest.data=[path to file]

Data File Format

The data file (jtest.data.json) is a stream of json objects automatically generated and formatted by Jtest build system plug-ins. It provides the same information about tested projects as the workspace. Each object in the file describes one project. Jtest currently supports the classpath_project common object type. See Configuring the Test Scope for an example.

Example Data File Object 

Code Block
{
          "type":       "classpath_project", 
          "name":       "project_name",
          "location"    "/absolute/path/to/project",
          "compilations":     [
          {
               "sourcepath": [
          "/absolute/path/to/srcdir1"
               ],
               "classpath":     [
          "/absolute/path/to/classdir1", 
          "/absolute/path/to/buildfile.jar"
               ],
               "bootpath":     [
          "absolute/path/to/java/ajavalib.jar"
          ],
               "encoding":     "project_encoding_name",
               "sourcelevel"   "project_source_level"
          },{
               ...
          }
      ]
}
{
     ...
}

Displaying Detailed Progress Information

Use the -showdetails switch to display detailed progress information:

Code Block
-showdetails

Alternatively, you can configure showing detailed information by setting the console.verbosity option to high:

Code Block
console.verbosity.level=high

Ant and Maven Pattern

If you use Ant or Maven, use the following pattern:

Code Block
<showdetails>true</showdetails>

About Error Codes  

Jtest returns error exit codes (other than 0) when the following occurs:

  • Jtest is executed without a license.
  • A test process exits with an internal exception.
  • Command-line is malformed or refers to a resource that does not exist. See Configuring the Test Scope.

You can also use the -fail option to generate an exit code when the analysis reports static analysis findings.

...