Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space CPPTDESKDEV and version 10.4.1

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

Sections include:

Table of Contents
maxLevel1

Prerequisites

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

Info
titleExtended Command Line Mode vs. Desktop Command Line Mode

There are two command line interface licenses available for C++test:

  1. Extended Command Line Mode is provided in Server Edition and Server Edition IT, and available for Custom Editions.
  2. Desktop Command Line Mode is available for Custom Editions. The Desktop Command Line Mode provides similar functionality to the Extended Command Line Mode, except that parallel processing is limited to simultaneously executing 8 parallel threads for a given task (e.g. static analysis) in the Desktop Command Line Mode.
  • To access the full functionality available with the Server Edition, you also need to install and configure Parasoft Team Server. 
  • We strongly recommend that you configure C++test preferences (for Team Server, task assignment, reporting, etc.) 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++test, it must be added to a Visual Studio 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 Local 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++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 -localsettings option described in -localsettings %LOCALSETTINGS_FILE%) matches the developer’s email address.

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

Setup Overview

Parasoft C++test 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 Server 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++test CLI can be invoked on a full Visual Studio solution, or one or more projects or source files that are part of a solution. As part of the CLI execution, 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 testsin a given solution.

  • 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++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++test are controlled via Test Configurations and Preferences.

Test Configurations can be sourced from the built in set, or created using C++test interactive mode in the GUI. It is highly recommended that you do not use the built-in configurations (other than for getting started). We suggest using the built in configurations as starting templates for customer-specific configurations, which are then stored on disk or on Parasoft Team Server.

Preferences can be configured from the 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 Local Settings (Options) Files. 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++test preferences and Parasoft Test preferences (which apply across Parasoft products) are accessed through the Parasoft> Preferences menu. Start by configuring the following preferences:

  • License: Specify the license or License Sever settings.
  • Team: Check Enable Team Server. If Team Server is not autodetected, enter the Team Server’s IP address in Server Information> Host Name. If you are running Team Server on the same machine as your Server Edition product, enter localhost . Unless you changed the Team Server default port (18888) when it was installed, do not change the port here. Click Test Connection to verify the correct 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).

    • Generate formatted reports in command line mode.

    • 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++test test machine.

  • Reports> Email Notifications:

    • If desired, enable Send Reports by Email. Regardless of this setting, reports will always be uploaded to Parasoft Team Server for later viewing (controlled by the CLI option). Email distribution will use the settings for E-mails above.

    • Manager reports contain a rollup of all test results generated by 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 and Rules for Policies. See Configuring Test Configurations for details on C++test-specific options.

Step 3: Create a localsettings File

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

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

For example, a sample command line to be added might be:

  • cpptestcli -solution "c:\MySolution" -resource "ProjectToTest" -config builtin://ShouldHaveRules -publishteamserver -localsettings acme_policy.settings
The reports will be sent after each batch run, and trend reports will be populated with data. The reports will also be available for viewing via Parasoft> Explore> Team Server Reports.

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:
    • -config: Specifies Test Configuration.
    • -resource: Specifies the resource (e.g., project, folder, file) to be tested.
    • -publish: Publishes test results to DTP.
    • -publishteamserver: Publishes test results to Team Server.
    • -report: Generates a report.
    • -localsettings: Passes advanced settings for Team Server/Parasoft DTP/mail reporting. Options are described in Local Settings (Options) Files.
Info
titleTesting Headers

C++test does not directly test headers unless they are included by a source file under test. See How do I analyze header files/what files are analyzed? for details.

Info
titleTesting Template Functions

C++test does perform static analysis and unit testing of instantiated function templates and instantiated members of class templates. See Support for Template Functions for details.

Note
titleNotes for Command Line Testing on Windows
  • C++test does not support file paths specified using Cygwin's "/cygdrive/DISK/PATH" format; instead, use the standard Windows path format.
  • Depending on the shell/console, backslashes in file paths should be escaped/doubled; e.g.,"C:\\MyLocation\\MyFile"
  • All backslashes in file paths must be escaped/doubled when used in options files (with the -localsettings option). Alternatively, you can use forward slashes; e.g., "C:/MyLocation/MyFile".

cli Invocation

The general form of invocation for cpptestcli is:

  • cpptestcli [OPTIONS]

Typically, invocations follow this pattern:

Info
titleExcluding Specific Project Resources from Analysis/Testing

If you want to exclude some files from analysis/testing (for instance, to prevent static analysis of automatically-generated files), you can indicate which project resources should not be tested as described in Excluding Project Resources from Testing. Perform this configuration in the GUI, then the settings will be applied for all tests on this project—from the GUI or from the command line.

cli Options

Anchor
cli_options
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"
  • -helpDisplays help information. Does not run testing.
    Anchor
    localsettings %LOCALSETTINGS_FILE%
    localsettings %LOCALSETTINGS_FILE%
  • -localsettings %LOCALSETTINGS_FILE% - Reads the options file %LOCALSETTINGS_FILE% for global preferences. These settings specify details such as Parasoft DTP settings, email settings, and Team Server 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.) Team Server settings, Parasoft DTP settings, email settings, and more. For details on creating options files; see Local Settings (Options) Files.
  • -nobuildPrevents C++test from rebuilding the project before testing it. Use this option if the project is already built before the test run.
  • -failFails the build by returning a non-zero exit code if any violations are reported.
  • -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.
  • -publishteamserverPublishes the report to the Team Server. The Team Server location can be specified in the GUI or in the options file (described in the -localsettings %LOCALSETTINGS_FILE% entry).
  • -report %REPORT_FILE% - Generates an XML report to the given file %REPORT_FILE% and adds an HTML (or PDF or custom format—if specified using the report.format option) report 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 %[email protected]_NAME:port% - Pulls settings stored on the DTP server (recommended for ease of maintenance — especially if you do not already have a locallocally stored settings file). 
    For example:
    -dtp.autoconfig [email protected]:8080

  • -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 1) login to Team Server and b) send emails, you can use this option to encrypt the required passwords.

  • -showdetailsPrints detailed test progress information.

  • -solutionConfig %SOLUTION_CONFIG_NAME% - Specifies the solution configuration to use for building the solution and for analysis. Debug and Release are common names. If the switch is omitted, then the active configuration is used. Specifying the solution configuration is strongly recommended because the active configuration may change unexpectedly.
  • -targetPlatform %TARGET_PLATFORM_NAME% - Specifies the solution target platform to use for building the solution and for analysis. Any CPU and x86 are common names. If omitted, the active configuration is used. Specifying the target platform is strongly recommended because the active configuration may change unexpectedly.

  • -appconsole stdout|% OUTPUT_FILE%Redirects 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-compilersPrints a list of valid compiler family values. Must be used along with -solution.

  • -list-configs - Prints a list of valid Test Configuration values. Must be used along with -solution.

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


  • -useenv - Causes the IDE to use PATH, INCLUDE, and LIB environment variables for Visual C++ compilation rather than the settings specified in the VC++ Directories section of the Projects options (in the Options dialog box).
  • -clearcmc - Cleans Visual Studio's Component Model Cache

Options for Testing Projects Available in the Visual Studio IDE

OptionPurposeNotes

-solution %SOLUTION_FILE%-solution %SOLUTION_FILE%Specifies the location of the solution file to use.

Specifies the location of the solution file to use.Specifies the location of the solution file to use.

N/AN/ASpecifies the location of the solution file to use.

-resource %RESOURCE%

Specifies the path to the workspace resource %RESOURCE% to test.

Use multiple times to specify multiple resources.

Use quotes when the resource path contains spaces or other non-alphanumeric characters.

If %RESOURCE% is a .properties file, the value corresponding to com.parasoft.xtest.checkers.resources will be interpreted as a colon(:)-separated list of resources. Only one properties file can be specified in this way. If %RESOURCE% is a .lst file, each line will be treated as a resource. If no resources are specified on the command line, the complete workspace will be tested.

For example, to test the ATM.cxx file in the C++test ATM example, you could use -resource "ATM/Source Files/ATM.cxx" (without the solution name)

or

-resource "Examples/Source Files/ATM.cxx" (with the solution name)

Other Examples:

-resource "MySolution/MyProject"

-resource "MySolution/MyProject/Source Files"

-resource "MySolution/MyProject/SourceFiles/MyClass.cpp"

-resource "c:\testedprojects.properties"

Note
titleNotes
  • To see a list of valid command line options, enter for cpptestcli -help.
  • cpptestcli automatically emails designated group managers and architects a report that lists all team/project errors and identifies which developer is responsible for each error. If no errors are reported, reports will be sent unless the options file contains the report.mail.on.error.only=true option.
  • If the appropriate prerequisites are met, cpptestcli automatically emails each developer a report that contains only the errors/results related to his or her work. If no errors are reported for a particular developer, a report will not be emailed to that developer.

Local Settings (Options) Files

Anchor
local_settings
local_settings

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

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

Options files can control report settings, Parasoft DTP settings, error authorship settings, Team Server settings, and more. You can create different options files for different projects, then use the DTP settings, error authorship settings, Team Server settings, and more. You can create different options files for different projects, then use the
-localsettings option to indicate which file should be used for the current command line test.

Each options file must be a simple text file. There are no name or location requirements. Each setting should be entered in a single line.

If a parameter is specified in this file and there is an equivalent parameter in the GUI’s Preferences panel (available from Parasoft> Preferences), the parameter set in this file will override the related parameter specified from the GUI. If a parameter is not specified in this file, C++test will use the equivalent parameter specified in the GUI.

Any options for creating or importing projects are valid only when creating or importing the project. They are ignored during subsequent runs.

Info
titleCreating a Local Settings (Options) File by Exporting Your GUI Preferences

The fastest and easiest way to create options files is to export your Preferences from the GUI.

  1. Choose Parasoft> Preferences.
  2. Select Parasoft (the root element in the left tree).
  3. Click the share link in the right side of the panel.
  4. In the dialog that opens, specify which preferences you want to export to a file.
  5. Click the Browse button, then specify the file where you want the settings saved.
  6. Click OK.
    • If you select an existing file, the settings will be appended to that file. Otherwise, a new file will be created.
    • Exported passwords will be encrypted.


Options files can determine the following settings:

  • Reporting Settings
  • Parasoft DTP Settings
  • Project Center Settings
  • Team Server Settings
  • Licensing Settings
  • Technical Support Settings
  • Authorship/Scope Settings
  • Source Control Settings

  • File Encoding Settings

  • Miscellaneous Settings
Note
titleNotes
  • Each setting should be entered on a single line.
  • If your options file contains any invalid settings, details will be reported in the command line output.
  • If your are running cli mode from a developer/tester desktop (as opposed to from a Server machine), use the tasks.clear=false option to ensure that your results from previous runs are preserved.

Reporting Settings

Anchor
Reporting Settings
Reporting Settings

SettingPurpose
report.associations

Specifies whether the report shows requirements, defects, tasks, and feature requests that are associated with a test.

report.authors_details

Determines whether the report includes an overview of the number and type of tasks assigned to each developer. The default is true.

report.contexts_details

Determines whether the report includes an overview of the files that were checked or executed during testing.The default is false.

report.custom.extension
report.custom.xsl.file

Specifies the location and extension of the XSL file for a custom format. Used with report.format=custom

For details and examples, see Configuring Reporting Settings.

report.developer_errors=true|false

Determines whether manager reports include details about developer errors.

report.developer_reports=true|false

Determines whether the system generates detailed reports for all developers (in addition to a summary report for managers).

report.format=html|pdf|customSpecifies the report format.
report.generate_htmls=true|false

Determines whether HTML reports are generated and saved on the local file system. XML reports are generated and saved regardless of this setting’s value.

The default setting is true.

report.graph.cs_start_date=[MM/dd/yy]

Determines the start date for trend graphs that track static analysis tasks over a period of time. See Understanding Reports for more details on these reports.

report.graph.ue_coverage_start_date=[MM/dd/yy]
report.location_details=true|false

Specifies whether absolute file paths are added to XML data. This needs to be enabled on the Server installation if you want to relocate tasks upon import to desktop installations.

report.mail.attachments=true|false

Determines whether reports are sent as attachments. All components are included as attachments; before you can view an HTML report with images, all attachments must be saved to the disk.

The default setting is false.

report.mail.cc=[email_addresses]

Specifies where to mail comprehensive manager reports. This setting must be followed by a semicolon-separated list of email addresses. This setting is typically used to send reports to managers or architects. It can also be used to send comprehensive reports to developers if developer reports are not sent automatically (for example, because the team is not using a supported source control system).

report.mail.compact=trends|links

Specifies that you want to email a compact report or link rather than a complete report.

If trends is used, the email contains a trend graphs, summary tables, and other compact data; detailed data is not included.

If links is used, the email contains only a link to a report (which is available on Team Server)

report.mail.domain=[domain]

Specifies the mail domain used to send reports.

report.mail.enabled=true|false

Determines whether reports are emailed to developers and to the additional recipients specified with the cc setting.

Remember that each developer that worked on project code will automatically be sent a report that contains only the errors/results related to his or her work.

report.mail.exclude=[email_addresses]

Specifies any email addresses you do not want to receive reports. This setting is used to prevent C++test from automatically sending reports to someone that worked on the code, but should not be receiving reports.

report.mail.exclude.developers=true|false

Specifies whether reports should be mailed to any developer whose email is not explicitly listed in the report.mail.cc property. This setting is used to prevent reports from being mailed to individual developers.

report.mail.format=html|asciiSpecifies the email format.

report.mail.from=[email_address OR
user_name_of_the_same_domain]

Specifies the "from" line of the emails sent.

report.mail.include=[email_addresses]

Specifies the email addresses of developers that you want to receive developer reports. This setting must be followed by a semicolon-separated list of email addresses. This setting is typically used to send developer reports to developers if developer reports are not sent automatically (for example, because the team is not using a supported source control system). It overrides developers specified in the 'exclude' list.

report.mail.on.error.only=true|false

Determines whether reports are sent to the manager only if an error is found or a fatal exception occurs. Developer emails are not affected by this setting; developer emails are sent only to developers who are responsible for reported errors.

The default setting is false.

report.mail.server=[server]

Specifies the mail server used to send reports.

report.mail.subject=My New Subject

Specifies the subject line of the emails sent. The default subject line is "C++test Report." For example, if you want to change the subject line to "C++test Report for Project A", you would use
report.mail.subject=C++test Report for Project A

report.mail.time_delay=[server]

Specifies a time delay between emailing reports (to avoid bulk email restrictions).

report.mail.unknown=[email_address OR
user_name_of_the_same_domain]

Specifies where to mail reports for errors assigned to "unknown".

report.mail.username=[username]
report.mail.password=[password]
report.mail.realm=[realm]

Specifies the settings for SMTP server authentication.

The realm value is required only for those servers that authenticate using SASL realm.

report.active_rules=true|false

Determines if C++test reports contain a list of the rules that were enabled for the test.

report.suppressed_msgs=true|false

Determines whether reports include suppressed messages.
The default setting is false.

session.tag=[name]

Specifies a session tag used to label these results. This value is used for uploading summary results to Team Server.

The tag is an identifier of the module checked during the analysis process. Reports for different modules should be marked with different tags.

report.ue_coverage_details_htmls=[coverage_type]

Determines whether a test's HTML report links to another report that includes source code annotated with line-by-line coverage details.

The following values can be used for [coverage_type]:
FC - for function coverage

LC - for line coverage

SC - for statement coverage

BCC - for block coverage

DC - for decision coverage

SCC - for simple condition coverage

MCDC - for MC/DC coverage

CC - for Call Coverage

report.metrics_details=true|false

Determines whether an XML report with metrics summary information (as well as individual class and method detail data where applicable) is produced. This report will be generated only when a metricsenabled Test Configuration is run.

Parasoft DTP/ Project Center Settings

SettingPurpose
dtp.enabled=true|false

Determines whether the current C++test installation is connected to DTP. This setting is not needed if you want to use the value specified in the GUI.

concerto.reporting=true|false

Determines whether the current C++test installation is connected to Parasoft Project Center. This setting is not needed if you want to use the value specified in the GUI.

dtp.autoconfig=true|false

Enables autoconfiguration with C++test settings stored on the DTP server

dtp.server=[server]

Specifies the host name of the DTP server. This setting is not needed if this information is specified in the GUI.

concerto.data.port=[port]

Specifies the Parasoft Project Center port. This setting is not needed if you want to use the value specified in the GUI.

dtp.port=[port]

Specifies the port number of the DTP server. This setting is not needed if you want to use the value specified in the GUI.

concerto.user_defined_attributes=[attributes]

Specifies the user-defined attributes for Parasoft Project Center.

Use the format key1:value1; key2:value2

For more details on attributes, see Connecting to Project Center.

This setting is not needed if you want to use the value specified in the GUI.

concerto.log_as_nightly=true|false

Determines whether the results sent to Parasoft Project Center are marked as being from a nightly build.

concerto.use_resource_attributes=true|false

Determines whether Parasoft Project Center attributes specified in the GUI at the project level should be used. This allows you to disable project level Parasoft Project Center attributes.

dtp.project=[project_name]

Specifies the name of the DTP project that you want these results linked to.

Team Server Settings

SettingPurpose
tcm.server.enabled=true|false

Determines whether the current C++test installation is connected to the Team Server. This setting is not needed if you want to use the value specified in the GUI.

tcm.server.name=[name]

Specifies the machine name or IP address of the machine running Team Server. This setting is not needed if you want to use the value specified in the GUI.

tcm.server.port=[port]

Specifies the Team Server port number. This setting is not needed if you want to use the value specified in the GUI.

tcm.server.accountLogin=true|false
tcm.server.username=[username]
tcm.server.password=[password]

Determines whether username and password are submitted to connect to Team Server. Usernames/passwords are not always needed; it depends on your team’s setup.

If the first setting is true, the second and third settings specify the username and password.

Note that Team Server must have the username and password setting already enabled before these settings can be used.

Licensing Settings

SettingPurpose

cpptest.license.use_network=true|false

Determines whether the current C++test installation retrieves its license from LicenseServer. This setting is not needed if you want to use the value specified in the GUI.

Example: cpptest.license.use_network=tru

cpptest.license.network.host=[host]

Specifies the machine name or IP address of the machine running LicenseServer Configuration Manager. This setting is not needed if you want to use the value specified in the GUI.

Example: cpptest.license.network.host=10.9.1.63

cpptest.license.network.port=[port]

Specifies the LicenseServer port number. This setting is not needed if you want to use the value specified in the GUI.

Example: cpptest.license.network.port=2222

cpptest.license.network.edition=[edition_name]

Specifies the type of license that you want this C++test installation to retrieve from LicenseServer. This setting is not needed if you want to use the value specified in the GUI.

[edition_name] can be server_edition. To use a custom edition, do not set anything after the "="; simply leaving the value empty.

Example: cpptest.license.network.edition=cpptest.license.network.edition=server_edition

cpptest.license.autoconf.timeout=[seconds]

Specifies the maximum number of seconds C++test will wait for the license to be automatically configured from LicenseServer. Default is 10.

cpptest.license.local.expiration=[expiration]

Specifies the local license that you want this C++test installation to use. This setting is not needed if you want to use the value specified in the GUI.

cpptest.license.local.password=[password]

Specifies the local password that you want this C++test installation to use. This setting is not needed if you want to use the value specified in the GUI.

cpptest.license.wait.for.tokens.time=[time in minutes]

Specifies the time that C++test will wait for a license if a license is not currently available.

For example to make C++test wait 3 minutes for license tokens, use cpptest.wait.for.tokens.time=3.

Technical Support Settings

SettingPurpose
techsupport.auto_creation=true|false

Determines whether archives are automatically prepared when testing problems occur.

techsupport.send_email=true|false

Determines whether prepared archives are emailed to Parasoft support. If you enable this, be sure to specify email settings from the GUI or with the options in Reporting Settings.

techsupport.archive_location=[directory]Specifies where archives are stored.
techsupport.verbose=true|false

Determines whether verbose logs are included in the archive. Note that this option cannot be enabled if the logging system has custom configurations.

  • Verbose logs are stored in the xtest.log file within the user-home temporary location (on Windows, this is <drive>:\Documents and Settings\<user>\Local Settings\Temp\parasoft\xtest).
  • Verbose logging state is cross-session persistent (restored on application startup).
  • The log file is a rolling file: it won't grow over a certain size, and each time it achieves the maximum size, a backup will be created.
techsupport.verbose.scontrol=true|false

Determines whether verbose logs include output from source control commands. Note that the output could include fragments of your source code.

techsupport.item.general=true|false

Determines whether general application logs are included.

techsupport.item.environment=true|false

Determines whether environment variables, JVM system properties, platform details, additional properties (memory, other) are included in the archive.

techsupport.advanced=true|false

Specifies if advanced options will be sent.

techsupport.advanced.options=[option]

Specifies any advanced options that the support team asked you to enter.

techsupport.dtp.engine=true|falseSpecifies if additional data generated during analysis will be sent.

Authorship/Scope Settings

SettingPurpose
authors.mappings.location=team|local|shared

Specifies where the authorship mapping file is stored. This setting defaults to team unless local or shared is specified.

If set to local (recommended), authorship mappings can be set directly in the local settings. See authors.mapping and authors.user{n} for details.

If set to shared, you can store mappings in a local file using the authors.mappings.file option.

The team and shared options are deprecated. Files specified by these options should be in the previouslyused format of:

#author to author
user1=user3
user2=user3
#author to email
[email protected]

authors.mapping{n}=[from_user, to_user]

Specifies a specific author mapping for authors.mappings.location=local, as described above.

For example:

authors.mappings.location=local
authors.mapping1=baduser,gooduser
authors.mapping2=brokenuser,fixeduser
authors.mapping3=olduser,newuser

authors.user{n}=[username, email, full_name]

Specifies a specific author name and email for
authors.mappings.location=local.

For example:

authors.user1=dan,[email protected],Dan Stowe
authors.user2=jim,[email protected],Jim White

authors.mappings.file=[path]

Specifies the location of a "shared" file as described in authors.mappings.location above.

For example:

authors.mappings.file=/home/user/dev/temp/author_mapping1.txt

authors.ignore.case=true|false

Determines whether author names are case sensitive. If true, David and david will be considered the same user. If false, David and david will be considered two separate users.

scope.sourcecontrol=true|false

Determines whether C++test computes code authorship based on a data from a supported source control system. This setting is not needed if you want to use the value specified in the GUI.

scope.local=true|false

Determines whether C++test computes code authorship based on the local user. This setting is not needed if you want to use the value specified in the GUI.

scope.recommended.computation=first|random

Determines how C++test selects the Recommended Tasks for each developer — it can choose n developer tasks at random (the default) or select the first n developer tasks reported (n is the maximum number of tasks that C++test is configured to show each developer per day)

scope.xmlmap=true|false

Specifies whether C++test computes task assignment based on XML files that define how you want tasks assigned for particular files or sets of files (these mappings can be specified in the GUI then saved in an XML file).

scope.xmlmap.file=[file]

Specifies the name of the XML file that defines how you want tasks assigned for particular files or sets of files.

Source Control Settings

Info
titleDefining multiple repositories of the same type

Indexes (numbered from 1 to n) must be added to the prefix if you want to define more than one repository of the same type. For example:

scontrol.rep1.type=ccase
scontrol.rep1.ccase.vob=/vobs/myvob1

scontrol.rep2.type=ccase
scontrol.rep2.ccase.vob=/vobs/myvob2

If you are defining only one repository, you do not need to use an index. For example:

scontrol.rep.type=ccase

scontrol.rep.ccase.vob=/vobs/myvob1

AccuRev Repository Definition Properties

PropertyDescription
scontrol.rep.type=accurevAccuRev repository type identifier.
scontrol.rep.accurev.host=AccuRev server host.
scontrol.rep.accurev.port=AccuRev server port. Default port is 1666.
scontrol.rep.accurev.login=AccuRev user name.
scontrol.rep.accurev.password=AccuRev password.

ClearCase Repository Definition Properties

PropertyDescription
scontrol.ccase.exec=

Path to external client executable (cleartool).

scontrol.rep.type=ccaseClearCase repository type name.
scontrol.rep.ccase.vob=

Path inside VOB. ccase.vob value + File.separator must be the valid path to a ClearCase controlled directory.

CVS Repository Definition Properties

PropertyDescription
scontrol.rep.type=cvsCVS repository type identifier.
scontrol.rep.cvs.root=Full CVSROOT value.
scontrol.rep.cvs.pass=

Plain or encoded password. The encoded password should be the same as in the .cvspass file.

For CVS use the value in .cvspass from within the user's home directory

For CVSNT use the value store in the registry under HKEY_CURRENT_USER\Software\Cvsnt\cvspass

When you are first logged in to the CVS repository from the command line using "cvs login", the password is saved in the registry.

To retrieve it, go to the registry (using regedit), and look for the value under HKEY_CURRENT_USER→CVSNT>cvspass.

This should display your entire login name (:pserver:[email protected]:/exampleC) encrypted password value.

scontrol.rep.cvs.useCustomSSHCredentials=

Determines whether the cvs login and password should be used for EXT/SSH connections. Allowed values are true and false. It is disabled by default.

scontrol.rep.cvs.ext.server

If connecting to a CVS server in EXT mode, this specifies which CVS application to start on the server side.

Has the same meaning as the CVS_SERVER variable .cvs is the default value.

scontrol.rep.cvs.ssh.loginname=

Specifies the login for SSH connections (if an external program can be used to provide the login).

scontrol.rep.cvs.ssh.password=Specifies the password for SSH connection.
scontrol.rep.cvs.ssh.keyfile=

Specifies the private key file to establish an SSH connection with key authentication.

scontrol.rep.cvs.ssh.passphrase=

Specifies the passphrase for SSH connections with the key authentication mechanism.

scontrol.rep.cvs.useShell=

Enable an external program (CVS_RSH) to establish a connection to the CVS repository. Allowed values are true and false. It is disabled by default.

scontrol.rep.cvs.ext.shell=

Specifies the path to the executable to be used as the CVS_RSH program. Command line parameters should be specified in the cvs.ext.params property.

scontrol.rep.cvs.ext.params=

Specifies the parameters to be passed to an external program. The following casesensitive macro definitions can be used to expand values into command line parameters:

  • {host} repository host
  • {port} port
  • {user} cvs user
  • {password} cvs password
  • {extuser} parameter cvs.ssh.loginname
  • {extpassword} parameter cvs.ssh.password
  • {keyfile} parameter cvs.ssh.keyfile
  • {passphrase} parameter cvs.ssh.passphrase

Git Repository Definition Properties

PropertyDescription
scontrol.rep.type=gitGit repository type identifier.
scontrol.git.exec=

Path to Git executable. If not set, assumes git command is on the path.

scontrol.rep.git.branch=

The name of the branch that the source control module will use. This can be left blank and the currently checked out branch will be used.

scontrol.rep.git.url=

The remote repository URL (e.g., git://hostname/repo.git).

scontrol.rep.git.workspace=

The directory containing the local git
repository.

Perforce Repository Definition Properties

PropertyDescription
scontrol.perforce.exec=Path to external client executable (p4).
scontrol.rep.type=perforcePerforce repository type identifier.
scontrol.rep.perforce.host=Perforce server host.
scontrol.rep.perforce.port=Perforce server port. Default port is 1666.
scontrol.rep.perforce.login=Perforce user name.
scontrol.rep.perforce.password=Password.
scontrol.rep.perforce.client=

The client workspace name, as specified in the P4CLIENT environment variable or its equivalents. The workspace's root dir should be configured for local path (so that files can be downloaded).

Serena Dimensions Repository Definition Properties

Note
titleLinux Configuration Note

Linux users should run in an environment prepared for using Serena programs, such as 'dmcli'

  • LD_LIBRARY_PATH should contain the path to <SERENA Install Dir>/libs.
  • DM_HOME should be specified.
PropertyDescription
scontrol.rep.type=serenaSerena Dimensions repository type identifier.
scontrol.rep.serena.host=Serena Dimensions server host name.
scontrol.rep.serena.dbname=

Name of the database for the product you are working with.

scontrol.rep.serena.dbconn=Connection string for that database.
scontrol.rep.serena.login =Login name.
scontrol.rep.serena.passwordPassword.
scontrol.rep.serena.mapping

Maps workspace resources to Serena Dimension repository paths.

  • Example 1: If you use scontrol.rep.serena.mapping_1=${project_loc\:MyProject};PRODUCT1\:WORKSET1;src\\MyProject, then Project MyProject' will be mapped to the Serena workset PRODUCT1:WORKSET1 and workset relative path: src\\MyProject
  • Example 2: If you use scontrol.rep.serena.mapping_2=${workspace_loc};PRODUCT1\:WORKSET1, then the complete workspace will be mapped to the Serena workset PRODUCT1:WORKSET1.

Subversion Repository Definition Properties

PropertyDescription
scontrol.rep.type=svnSubversion repository type identifier.
scontrol.rep.svn.url=

Subversion URL specifies protocol, server name, port and starting repository path (e.g., svn://buildmachine.foobar.com/home/svn).

scontrol.rep.svn.login=Login name.
scontrol.rep.svn.password =Password (not encoded).
scontrol.svn.exec=Path to external client executable (svn).

CM Synergy Repository Definition Properties

PropertyDescription
scontrol.rep.type=synergySynergy/CM repository type identifier
scontrol.rep.synergy.host=

Computer on which synergy/cm engine runs. Local host is used when missing. For Web mode, the host must be a valid Synergy Web URL with protocol and port (e.g., http://synergy.server:8400).

scontrol.rep.synergy.dbpath=

Absolute synergy database path e.g \\host\db\name (backslash symbols '\' in UNC/Windows paths must be doubled).

scontrol.rep.synergy.projspec=

Synergy project spec which contains project name and its version e.g name-version.

scontrol.rep.synergy.login=Synergy user name.
scontrol.rep.synergy.password=Synergy password (not encoded).
scontrol.rep.synergy.port=Synergy port.
scontrol.rep.synergy.remote_client=

(UNIX only) Specifies that you want to start ccm as a remote client. Default value is false. Optional. This is not used for Web mode.

scontrol.rep.synergy.local_dbpath=

Specifies the path name to which your database information is copied when you are running a remote client session. If null, then the default location will be used. This is not used for Web mode.

scontrol.synergy.exec=Path to external client executable (ccm)

Microsoft Team Foundation Server Repository Definition Properties

PropertyDescription
scontrol.rep.type=tfsTFS repository type identifier.
scontrol.rep.tfs.host=Name of the machine running TFS.
scontrol.rep.tfs.port=

TFS server’s port number (optional; when not specified, 8080 is used).

scontrol.rep.tfs.protocol=

The protocol used to connect to TFS server. Available values are HTTP and HTTPS.

scontrol.rep.tfs.login =TFS user name.
scontrol.rep.tfs.password=TFS password.

Microsoft Visual Source Safe Repository Definition Properties

PropertyDescription
scontrol.rep.type=vssVisual SourceSafe repository type identifier.
scontrol.rep.vss.ssdir=

Path of repository database (backslash symbols '\' in UNC/Windows paths must be doubled).

scontrol.rep.vss.projpath=VSS project path.
scontrol.rep.vss.login=VSS login.
scontrol.rep.vss.password=VSS password.
scontrol.vss.exec=Path to external client executable (ss).
scontrol.vss.lookup=

Determines whether a full VSS database search is performed to find associations between local paths and repository paths. True or false.

Important Notes

  • The repository(n).vss.ssdir property should contain a UNC value even if the repository database resides locally.
  • Be aware of VSS Naming Syntax, Conventions and Limitations. Any character can be used for names or labels, except the following:
    • Dollar sign ($)
    • At sign (@)
    • Angle brackets (< >), brackets ([ ]), braces ({ }), and parentheses (( ))
    • Colon (:) and semicolon (;)
    • Equal sign (=)
    • Caret sign (^)
    • Exclamation point (!)
    • Percent sign (%)
    • Question mark (?)
    • Comma (,)
    • Quotation mark (single or double) (' ")
  • VSS 6.0 (build 8163), which is deployed with Visual Studio 6, does not work properly with projects whose names start with a dot (.) symbol. If such a project name is used, subprojects cannot be added.
  • Do not use custom working directories for sub-projects (example: Project $/SomeProject has the working directory C:\TEMP\VSS\SomeProject and its subproject $/SomeProject/SomeSubProject has the working directory D:\SomeSubProject).

File Encoding Settings

Setting
Purpose
fileencoding.mode=default|user|auto

Defines how file encoding is calculated.

default specifies that you want to use system properties.

user indicates that you will explicitly specify the encoding name (using the setting below).

auto enables automatic detection of encoding for the Far-East language specified with fileencoding.autolanguage

fileencoding.user-encoding=<name_of_encoding>

If fileencoding.mode is set to user, this specifies the encoding name Valid names are ASCII-US, UTF-8, UTF-16, UTF-16LE, UTF-16BE or java.nio canonical name.

It should be specified in form parasoft-dotNET-[codepagenumber]

fileencoding.auto-language=<language’s numeric_code>

If fileencoding.mode is set to auto, this specifies the language’s numeric code. Valid codes are:

  • JAPANESE = 1
  • CHINESE = 2
  • SIMPLIFIED CHINESE = 3
  • TRADITIONAL CHINESE = 4
  • KOREAN = 5

Miscellaneous Settings

Setting
Purpose
report.rules=[url_path_to_rules_directory]

Specifies the directory for rules html files (generated by clicking the Printable Docs button in the Test Configuration’s Static Analysis tab).

For example:

report.rules=file:///C:/Temp/Burt/parasoft/xtest/gendoc/

report.rules=../gendoc/

The default setting is none.

tasks.clear=true|false

Clears existing tasks upon startup in cli mode. This prevents excessive time being spent "loading existing results."

The default is true.

console.verbosity.level=low|normal|high

Specifies the verbosity level for the Console view. Available settings are:

low: Configures the Console view to show errors and basic information about the current step’s name and
status (done, failed, up-to-date).

normal: Also shows command lines and issues reported during test and analysis.

high: Also shows warnings.

cpptest.custom.rules.dir=[directory]

Indicates where user-defined rules are saved.

cpptest.custom.configs.dir=[directory]

Indicates where user-defined Test Configurations are saved.

custom.compilers.dir=[directory]

Overrides the custom compiler directory settings (found in Parasoft> Configurations> Custom compilers) and uses the defined directory to search for custom compilers

parallel.mode=Manual|Auto|Disabled

Determines which of the following modes is active:

  • Auto: Allows Parasoft Test to control parallel processing settings.
  • Manual: Allows you to manually configure parallel processing settings to suit your specific needs.
  • Disabled: Configures Parasoft Test to use only one of the available CPUs.

For more details on this and other parallel processing options, see Configuring Parallel Processing.

parallel.max_threads=<number>

Specifies the maximum number of parallel threads that can be executed simultaneously. The actual number of parallel threads is determined by the number of CPUs, available memory, and license settings.

parallel.free_memory_limit=<percentage>

Specifies the amount of memory that should be kept free in low memory conditions (expressed as a percentage of the total memory available for the application). This is used to ensure that free memory is available for other processes.

parallel.no_memory_limit=true|false

Indicates that you do not want to place any restrictions (beyond existing system limitations) on the memory available to C++test

Here is one sample options file named local.properties:

Code Block
# Team Server settings: (these may be redundant with settings already specified in Team Preferences of the installed version, so may not be needed).
tcm.server.enabled=true
tcm.server.name=<team_server.company.com>

# Report settings
report.developer_errors=true
report.developer_reports=true
report.format=html
session.tag=<project name>

# Mail settings:
report.mail.enabled=true
report.mail.cc=<[email protected];[email protected]>
report.mail.server=mail.company.com
report.mail.domain=company.com
report.mail.subject=<Static Analysis results on Project X>
report.mail.attachments=true

Here is another sample:

Code Block
# Team Server settings
tcm.server.enabled=true
tcm.server.name=teamserver.mycompany.com
tcm.server.port=18888
tcm.server.accountLogin=true
tcm.server.username=tcm_user
tcm.server.password=tcm_pass

# Parasoft DTP settings
dtp.server=dtp.mycompany.com
dtp.port=32323

# Mail settings
report.mail.enabled=true
report.mail.server=mail.mycompany.com
report.mail.domain=mycompany.com
report.mail.cc=project_manager
report.mail.subject=Coding Standards
concerto.log_as_nightly=true

Using Variables in Local Settings (Options) Files

The following variables can be used in reports, e-mail, Parasoft DTP, Team Server, and license settings. Note that session tag value can't contain any ':' characters.

env_var

example: ${env_var:HOME}

Outputs the value of the environmental variable specified after the colon.

project_name

example: ${project_name}

Outputs the name of the tested project. If more than one project is provided as an input, it first outputs the tested project name, then "..."

workspace_name

example: ${workspace_name}

Outputs the Solution name.

config_name

$ example: ${config_name}

Outputs the name of executed Test Configuration; applies only to Reports and Email settings.

analysis_type

$ example: ${analysis_type}

Outputs a comma separated list of enabled analysis types (for example: Static, Generation, Execution); applies only to Reports and Email settings.

tool_name

$ example: ${tool_name}

Outputs the tool name (for example: C++test).

Example localsettings file

Code Block
# REPORTS
#Determines whether reports are emailed to developers and to the additional recipients specified with the cc setting.
#Remember that if the team is using CVS for source control and each developer's email address matches his or her CVS username + the mail domain, each developer that worked on project code will automatically be sent a report that contains only the errors/results related to his or her work.
report.mail.enabled=true
#Exclude developers emails (true/false)
report.mail.exclude.developers=false
# Append developers errors to manager emails (true/false) report.developer_errors=true
# Send reports to developers (true|false) report.developer_reports=true
# Append suppressed messages (true|false) report.suppressed_msgs=false#Determines where to mail complete test reports.
#This setting is typically used to send reports to managers or architects.
#It can also be used to send reports to developers if developer reports
#are not sent automatically (for example, because the team is not using CVS).
[email protected]; ${env_var:USERNAME} @domain.com
# mail target for unknown developer errors [email protected]
#Specifies the mail server used to send reports.
report.mail.server=mail_server.domain.com
#Specifies the mail domain used to send reports.
report.mail.domain=domain.com
#Specify mali from report.mail.from=nightly
#Specifies any email addresses you do not want to receive reports.
#This setting is used to prevent from automatically sending reports to someone that worked on the code, but should not be receiving reports. This setting is only applicable if the team is using CVS for source control and developer reports are being sent automatically.
report.mail.exclude=developer1;developer2
# Specifies the subject line of the emails sent.
report.mail.subject= ${tool_name} Report - ${config_name}
# Report test params include (true|false)
report.test_params=true
# Team Server
#Determines whether the current installation is connected to the Team Server.
tcm.server.enabled=true
#Specifies the machine name or IP address of the machine running Team Server.
tcm.server.name=team_server.domain.com
#Specifies the Team Server port number.
tcm.server.port=18888
tcm.server.accountLogin=true
tcm.server.username=user
tcm.server.password=password
session.tag= ${config_name}
# Parasoft Project Center
#Determines if the current installation is connected to Parasoft Project Center.
concerto.reporting=true
#Specifies the host name of the Parasoft DTP server.
dtp.server=grs_server.domain.com
# Specifies the port number of the Parasoft Project Center report collector.
concerto.data.port=32323
# Specifies user-defined attributes for Parasoft Project Center.
#Use the format key1:value1; key2:value2
#Attributes help you mark results in ways that are meaningful to your organization.
#They also determine how results are grouped in Parasoft Project Center and how you can filter results in Parasoft Project Center.
#For example, you might want to label results by project name and/or by project component name.
#Each attribute contains two components: a general attribute category name
#and a specific identification value. For example, assume your organization wants to classify results by project.
#You might then use the attribute project:projname1. For the next project, you could use a different
#local settings file that specified an attribute such as project:projname2.
concerto.user_defined_attributes=Type:Nightly;Project:Project1
# Determines whether the results sent to Parasoft Project Center are marked as being from a nightly build.
concerto.log_as_nightly=true
# SCOPE
#code authorship based on CVS
scope.sourcecontrol=true
#code authorship based on author tag
scope.author=false
#code authorship based on local user
scope.local=false
# LICENSE
#override license settings
#cpptest.license.autoconf.timeout=40
cpptest.license.use_network=true
cpptest.license.network.host=license_server.domain.com
cpptest.license.network.port=2222
cpptest.license.network.edition=server_edition
# SOURCE CONTROL
scontrol.rep1.type=cvs
scontrol.rep1.cvs.root=:pserver:[email protected]_server.domain.com:/home/cvs/
scontrol.rep1.cvs.pass=mypassword