This topic explains how to run a test from the C/C++test command line interface (cpptestcli), which is described in Command Line Interface (cli).

Sections include:

Prerequisites

The command line mode requires a command line interface license (available with C/C++test Automation Edition).

• We strongly recommend that you configure C/C++test preferences and team Test Configurations as described in the Configuration before you start testing.

• For command line execution, you will need to ensure that the installation directory is on the path, or launch cpptest with the full path to the executable (for example, c:\parasoft\c++test\cpptestcli.exe).Before you can test code with C/C++test, it must be added to an Eclipse C/C++ project. For instructions on creating a new project, see Creating a Project.

• Before you perform the initial test, we strongly recommend that you review and modify project options. For details on how to do this, see Settings (Options) Files.

• For cpptestcli to email each developer a report that contains only the errors/results related to his or her work, one of the following conditions must be true:

  • You have configured C/C++test to compute code authorship based on source control data AND your project is under a supported source control system AND each developer’s source control username + the mail domain (specified using an options file and the -settings option described in -settings %SETTINGS_FILE%) matches the developer’s email address.

  • You have configured C/C++test to compute code authorship based on local user AND each user name + the mail domain (specified using an options file and the -settings option described in -settings %SETTINGS_FILE%) matches the developer’s email address.

Setup Overview

Parasoft C/C++test Professional has two user modes: interactive desktop usage in the GUI and command line mode via the command line interface (CLI). The CLI interface is a standard feature of the Automation Edition. 

CLI mode is typically used to perform regular or continuous code analysis and test in conjunction with regular/continuous builds or as a part of an automatic regression test infrastructure. C/C++test CLI can be invokedon the specified project resourcesAs part of the CLI execution, C/C++test can perform one or more of the following:

• Static analysis of code, including checks against a configured coding policy, analysis of possible runtime bugs, and metrics analysis.

• Execution of unit tests

• Analysis of SCM code repository to identify code changes since the last run and initiate code review sessions on updated code.
• Generation of reports and their distribution to a central report server and/or to individual developers and managers, according to specified reporting configurations.

As part of the execution, C/C++test can use your SCM client (if supported) to automatically retrieve file modification information from the SCM system and generate tasks for specific individuals based on results of code analysis and executed tests.

Specific execution options for C/C++test are controlled via Test Configurations and Preferences.

Test Configurations can be sourced from the built in set, or created using C/C++test interactive mode in the GUI. We suggest using the built-in configurations as starting templates for customer-specific configurations.

Preferences can be configured from the C/C++test GUI. Most of the preference settings can also be supplied with a configuration file that is provided as a parameter to a CLI call. A table of the configuration file preference settings is available in Settings (Options) Files. C/C++test preferences set from the GUI are applied by default. These can be overridden — on an individual basis—by preference values contained in the configuration file used with a given run. This enables you to have a basic set of preferences configured for all CLI runs, and then vary individual settings as necessary by providing an additional configuration file for a specific run with a given Test Configuration. This can be useful, for example, to include different information in reports for different runs, or to change options for email distribution of reports, including report names, email headings, etc.

Step 1: Configure Preferences

C/C++test preferences are accessed through the Parasoft> Preferences menu. Start by configuring the following preferences:

• License: Specify the license or License Sever settings.
• DTP: Specify your DTP server settings.
• Source Controls: These settings enable automatic mapping of the tool results to the individuals who last changed the affected code or test artifact. Check your source control system, and use the instructions in Connecting to Source Control to set the options appropriate for your SCM.
• Scope and Authorship: Check the appropriate options for your environment as described in Configuring Task Assignment and Code Authorship Settings.

• Reports: The following options are enabled by default and are a good starting point:

  • Detailed report for developers (includes task breakdown with details).

  • Overview of tasks by authors (summary table).

  • Suppressions Details (applies to static analysis only).

• E-mails: Enter settings that will be used to send emails with reports. This needs to be an existing email account on an email server accessible from the C/C++test test machine.

• Reports> Email Notifications:

  • If desired, enable Send Reports by Email. Email distribution will use the settings for E-mails above.

  • Manager reports contain a rollup of all test results generated by C/C++test Developer reports contain only results for individual developers. Enable options and specify email addresses accordingly.

Step 2: Customize Test Configurations

Create a custom Test Configuration as described in Configuring Test Configurations.

Step 3: Create a settings File

Create a settings file as described in Settings (Options) Files.

Step 4: Activate CLI in the Currently-Running Build System (e.g., batch script)

For example, your command line may resemble the following:

• cpptestcli -data "c:\MyWorkspace" -resource "ProjectToTest" -config builtin://ShouldHaveRules -publish -settings acme_policy.settings

cli Usage

The general procedure for testing from the command line is as follows:

• Use the cpptestcli utility, with appropriate options, to launch analysis in the command-line mode. A complete list of options is provided in cli Options. Key options are:

  • -data: Specifies the Eclipse workspace location.

  • -config: Specifies Test Configuration.
  • -resource: Specifies the resource (e.g., project, folder, file) to be tested.
  • -publish: Publishes test results to DTP.
  • -report: Generates a report.
  • -settings: Passes advanced settings for Parasoft DTP/mail reporting. Options are described in Settings (Options) Files.

cli Invocation

The general form of invocation for cpptestcli is:

• cpptestcli [OPTIONS]

Typically, invocations follow this pattern:

• cpptestcli -data "c:\MyWorkspace" -resource "ProjectToTest" -config builtin://ShouldHaveRules -publish

Using -data to Specify Your Eclipse Workspace

If you are not in the same directory as the Eclipse workspace that you want to test, you need to use cpptestcli with the -data option. For example, this Windows command tests the C/C++test Example project by applying the "My Configuration" Test Configuration, generates a report of results, and saves that report in the c:\reports\Report1 directory

cpptestcli -data "c:\Documents and Settings\cynthia\ApplicationData\Parasoft\C++test\workspace" -resource "C++test Example" -config user://"My Configuration" -report c:\reports\Report1

If you are in the same directory as the workspace that you want to test, you can call cpptestcli without the-data option. For example, this Windows command tests the C++test Example project by applying the My Configuration Test Configuration, generates a report of results, and saves that report in the c:\reports\Report1 directory:

cpptestcli -resource "C++test Example" -config user://"My Configuration" -report c:\reports\Report1

cli Options

Available cpptestcli options are listed in the following tables.

General Options

• -config %CONFIG_URL% - Specifies that you want to run the Test Configuration available at %CONFIG_URL%.
 This parameter is required except when importing projects. %CONFIG_URL% is interpreted as a URL, the name of a Test Configuration, or the path to a local file. Examples:
  • By filename:
    -config "mylocalconfig.properties"
  • By URL:
    -config "http://intranet.acme.com/cpptest/team_config.properties"
  • Built-in configurations:
    -config "builtin://Demo Configuration"
-config "Demo Configuration"
  • User-defined configurations:
    -config "user://My First Configuration"
  • Team configurations:
    -config "team://Team Configuration"
-config "team://teamconfig.properties"
• -help - Displays help information. Does not run testing.
• -settings %SETTINGS_FILE% - Reads the options file %SETTINGS_FILE% for global preferences. These settings specify details such as Parasoft DTP settings and email settings.
  The options file is a properties file. These files can control reporting preferences (who should reports be sent to, how should those reports be labelled, what mail server and domain should be used, etc.), Parasoft DTP settings, email settings, and more. 

Multiple settings files can be applied. The settings specified in an earlier file will be overwritten by a later file. 

This option can be used to import settings into the GUI from the command line using the executable that starts C/C++test (cpptest.exe or eclipse.exe). When used in this manner, all settings in the properties file replace those currently in the workspace. For example: 

cpptest.exe -settings local.settings

• -property <key>=<value> - Allows you to configure a single setting directly in the command line. Use the following format: key=value.

  You can use this option multiple times to configure several settings on the same command line. Earlier entries with the same key will be overwritten. For example:

  • -property session.tag=sa_linux -property report.dtp.publish=true -property techsupport.auto_creation=true

Entries specified through the -settings option will always be overwritten by the -property option settings (regardless of the order in which these options are used in the command line).

This option can be used to import settings into the GUI from the command line using the executable that starts C/C++test (cpptest.exe or eclipse.exe). When used in this manner, all settings that you specify replace those currently in the workspace. For example: 

cpptestcli.exe -property report.test_params=true

• -nobuild - Prevents C/C++test from rebuilding the project before testing it. Use this option if the project is already built before the test run.
• -fail - Fails the build by returning a non-zero exit code if violations or setup problems are reported (see Command Line Exit Codes for details about exit codes returned if the process fails).
  
• -publish - Publishes the report to DTP. You can enable sending reports to DTP in the GUI or in the command line mode; see Connecting to DTP.
• -report %REPORT_FILE% - Generates an XML report to the given file %REPORT_FILE% and adds an HTML report (or one or more reports in other formats, if specified using the report.format option) with the same name (and a different extension) in the same directory.
  All of the following commands will produce an HTML report filename.html and an XML report filename.xml.
  • -report filename.xml
  • -report filename.htm
  • -report filename.html

  If the specified path ends with an ".html"/".htm"/".xml" extension, it will be treated as a path to the report file to generate. Otherwise, it will be treated as a path to a directory where reports should be generated.
  If the file name is explicitly specified in the command and a file with this name already exists in the specified location, the previous report will be overwritten. If your command doesn’t explicitly specify a file name, the existing report file will not be overwritten—the new file will be named repXXXX.html, where XXXX is a random number.
  If the -report option is not specified, reports will be generated with the default names "report.xml/html" in the current directory.

• -dtp.autoconfig %PROJECT_NAME@BASE_URL% - Pulls settings stored on the DTP server (recommended for ease of maintenance — especially if you do not already have a locally stored settings file). 
  For example:
  -dtp.autoconfig Project1@https://dtp.company.com:8443

• -encodepass <plainpassword> - Generates an encoded version of a given password. Prints the message 'Encrypted password: <encpass>' and terminates the cli application.
  If your nightly process will send emails, you can use this option to encrypt the required passwords.

• -showdetails - Prints detailed test progress information.
  

• -showsettings - Prints the current settings and customizations along with the information where each of them is configured (e.g. in the settings.properties file). See Configuring Settings for the list of settings you can configure.

• -appconsole stdout|% OUTPUT_FILE% - Redirects C/C++test's console output to standard output or an %OUTPUT_FILE% file. 
  Examples:
  -appconsole stdout (console redirected to the standard output)
  -appconsole console.out (console redirected to console.out file)

• -list-compilers - Prints a list of valid compiler family values. 

• -list-configs - Prints a list of valid Test Configuration values. 

• -bdf - Specifies the path to an existing build data file (.bdf) or another project definition file to collect the input scope. See Using cpptestscan or cpptesttrace to Create a Build Data File for information about creating build data files. The option also supports JSON formatted files generated by the CMake build system when running static analysis. Use of the -bdf option to specify a JSON file for unit test execution is not currently supported.  

• -include %PATTERN%, -exclude %PATTERN% - Specifies files to be included/excluded during testing. 
  You must specify a file name or path after this option.
  Patterns specify file names, with the wildcards *and ? accepted, and the special wildcard ** used to specify one or more path name segments. Syntax for the patterns is similar to that of Ant filesets.
  Examples:
  -include **/Bank.cpp (test Bank.cpp files)

  -include **/ATM/Bank/*.cpp (test all .cpp files in folder ATM/Bank)

  -include c:/ATM/Bank/Bank.cpp (test only the c:/ATM/Bank/Bank.cpp file)

  -exclude **/internal/** (test everything except classes that have path with folder "internal")

  -exclude **/*Test.cpp (test everything, but files that end with Test.cpp)

  Additionally if a pattern is a file with a .lst extension, it is treated as a file with a list of patterns.
  For example, if you use -include c:/include.lst and include.lst contains the following (each line is treated as single pattern):
  **/Bank.cpp

  **/ATM/Bank/*.cpp

  c:/ATM/Bank/Bank.cpp

  then it has same effect as specifying:
  -include **/Bank.cpp -include **/ATM/Bank/*.cpp

  -include c:/ATM/Bank/Bank.cpp"

Options for Importing and Creating Projects

Options for Testing Projects Available in the C/C++test for Eclipse Workbench

Settings (Options) Files

Settings files can be passed at the command line to control options for reporting, task assignment, licensing, and more. This allows you to:

• Configure and use different setting configurations for different projects.
• Extend or override team-wide settings as needed (for example, for settings that involve local paths).
• Adjust settings without having to open the GUI.

You can create different options files for different projects, then use the -settings option to indicate which file should be used for the current command line test.

See Configuring Settings for information about settings files and the list of available settings.