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 | ||
---|---|---|
|
Prerequisites
The command line mode requires a command line interface license (available with C++test Automation Edition).
Info | ||
---|---|---|
| ||
There are two command line interface licenses available for C++test:
|
- To access the full functionality available with the Automation 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 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 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 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++test CLI can be invokedon the specified project resourcesAs 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 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++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 C/C++test, 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 -data "c:\MyWorkspace" -resource "ProjectToTest" -config builtin://ShouldHaveRules -publishteamserver -localsettings 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.
- -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 | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
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 | ||
---|---|---|
| ||
|
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
Info | ||
---|---|---|
| ||
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. |
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++test Example project by applying the "My Configuration" Test Configuration, generates a report of results, and saves that report in the c:\reports\Report1
directorycpptestcli -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
Anchor | ||||
---|---|---|---|---|
|
Available cpptestcli
options are listed in the following tables.
General Options
-config
Specifies that you want to run the Test Configuration available at%CONFIG_URL% -
This parameter is required except when importing projects.%CONFIG_URL%
.
%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"
- By filename:
-help
- Displays 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.-nobuild
- Prevents 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 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.-publishteamserver
- Publishes 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 reportfilename.html
and an XML reportfilename.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@SERVER
_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.-showdetails
- Prints detailed test progress information.-buildscript %SCRIPT_FILE%
- Executes the specified build script prior to any testing. See Using the cli with an Eclipse-Based Builder.
-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-compilers
- Prints a list of valid compiler family values.-list-configs - Prints a list of valid Test Configuration values.
-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
Option | Purpose | Notes |
---|---|---|
| Imports the specified Eclipse project(s) into the Eclipse workspace. | If If it is a directory, all Eclipse projects found in the selected directory and subdirectories will be imported. Examples:
The |
| Creates C++test projects from build data files (.bdf). To prepare a build data file, perform a build of the project with the | Example: - See Creating a Project Using an Existing Build System for details. Options can be specified in the options file. See Local Settings (Options) Files for details. The |
-ccs %CCS_PROJECT% | Imports TI Code Composer Studio projects, If pjt project file - the selected project will be imported | Examples: -ccs "MyProject.pjt" -ccs "c:\DevelRootDir" The |
| Creates C++test projects from Microsoft Visual Studio projects. Specify a 6.0 project file (.dsp), Microsoft Visual Studio 6.0 workspace file (.dsw), or root directory. | Visual Studio 6.0 project import options can be specified in the options file. See Local Settings (Options) Files for details. The |
-ewp %EWP_PROJECT% | Imports IAR Embedded Workbench projects. If .eww workspace file - all projects from the workspace will be imported directory - all .ewp projects found in selected directory and subdirectories will be imported | Examples: -ewp "MyProject.ewp" -ewp "MyWorkspace.eww" -ewp "c:\DevelRootDir" The |
| Creates C++test projects from Green Hills .gpj projects. | Green Hills .gpj project import options can be specified in the options file. See Local Settings (Options) Files for details. |
-hew %HEW_PROJECT% | Imports Highperformance Embedded Workshop projects. The following can be specified as | The Examples: -hew "MyProject.hwp" -hew "MyWorkspace.hws" -hew "c:\DevelRootDir" |
| Imports Keil uVision3 projects. If .uv2 project file - the selected project will be imported directory - all .uv2 projects found in selected directory and subdirectories | The Examples: -uv "MyProject.uv2" -uv "c:\DevelRootDir" |
-vcp %VCP_PROJECT% | Imports Microsoft eMbedded Visual C++ 4.0 projects. If .vcp project file - the selected project will be imported .vcw workspace file - all projects from the workspace will be imported directory - all .vcp projects found in selected directory and subdirectories will be imported | The Examples: -vcp "MyProject.vcp" -vcp "MyWorkspace.vcw" -vcp "c:\DevelRootDir" |
-wpj %WPJ_PROJECT% | Imports Wind River Tornado project. If the .wpj project file - selected project will be imported .wsp workspace file - all projects from the workspace will be imported directory - all .wpj projects found in selected directory and subdirectories will be imported | The Examples: -wpj "MyProject.wpj" -wpj "MyWorkspace.wsp" -wpj "c:\DevelRootDir" |
Options for Testing Projects Available in the C++test/Eclipse Workbench
Option | Purpose | Notes |
---|---|---|
| Specifies the location of the Eclipse workspace directory to use. | Defaults to the current user’s dependent directory. |
| Specifies the path to the workspace resource | Use multiple times to specify multiple resources. Use quotes when the resource path contains spaces or other non-alphanumeric characters. If Team Project Set File (PSF) files are supported for CVS, SVN, Star Team, and other source control systems (depending on the Eclipse plugin capabilities installed). Paths (even absolute ones) are relative to the workspace specified by the -data parameter. Examples:
|
Note | ||
---|---|---|
| ||
|
Local Settings (Options) Files
Anchor | ||||
---|---|---|---|---|
|
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 | ||
---|---|---|
| ||
The fastest and easiest way to create options files is to export your Preferences from the GUI.
|
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
- Settings for Creating BDF-Based Projects
- Settings for Importing Green Hills .gpj Projects
- Settings for Importing Microsoft Visual Studio 6.0 .dsp Projects
- Miscellaneous Settings
Note | ||
---|---|---|
| ||
|
Reporting Settings
Anchor | ||||
---|---|---|---|---|
|
Setting | Purpose |
---|---|
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 |
report.contexts_details | Determines whether the report includes an overview of the files that were checked or executed during testing.The default is |
| Specifies the location and extension of the XSL file for a custom format. Used with 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|custom | Specifies 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 |
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] | Determines the start date for trend graphs that track coverage over a period of time. See Understanding Reports for more details on these reports. |
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 |
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 If |
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 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.format=html|ascii | Specifies the email format. |
| 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 |
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.time_delay=[server] | Specifies a time delay between emailing reports (to avoid bulk email restrictions). |
| Specifies where to mail reports for errors assigned to "unknown". |
| Specifies the settings for SMTP server authentication. The |
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. |
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 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
Setting | Purpose |
---|---|
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 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
Setting | Purpose |
---|---|
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. |
| 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 Note that Team Server must have the username and password setting already enabled before these settings can be used. |
Licensing Settings
Setting | Purpose | |
---|---|---|
1 |
| 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: |
2 |
| 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: |
3 |
| Specifies the LicenseServer port number. This setting is not needed if you want to use the value specified in the GUI. Example: |
4 |
| 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.
Example: |
5 |
| Specifies the maximum number of seconds C++test will wait for the license to be automatically configured from LicenseServer. Default is |
6 |
| 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. |
7 |
| 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. |
8 |
| 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 |
Technical Support Settings
Setting | Purpose |
---|---|
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.
|
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|false | Specifies if additional data generated during analysis will be sent. |
Authorship/Scope Settings
Setting | Purpose |
---|---|
authors.mappings.location=team|local|shared | Specifies where the authorship mapping file is stored. This setting defaults to If set to If set to The
|
authors.mapping{n}=[from_user, to_user] | Specifies a specific author mapping for For example:
|
authors.user{n}=[username, email, full_name] | Specifies a specific author name and email for For example:
|
authors.mappings.file=[path] | Specifies the location of a "shared" file as described in For example:
|
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 | ||
---|---|---|
| ||
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:
If you are defining only one repository, you do not need to use an index. For example:
|
AccuRev Repository Definition Properties
Property | Description |
---|---|
scontrol.rep.type=accurev | AccuRev 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
Property | Description |
---|---|
scontrol.ccase.exec= | Path to external client executable ( |
scontrol.rep.type=ccase | ClearCase 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
Property | Description |
---|---|
scontrol.rep.type=cvs | CVS 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 For When you are first logged in to the To retrieve it, go to the registry (using regedit), and look for the value under This should display your entire login name ( |
| Determines whether the cvs login and password should be used for |
scontrol.rep.cvs.ext.server | If connecting to a Has the same meaning as the |
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 ( |
scontrol.rep.cvs.ext.shell= | Specifies the path to the executable to be used as the |
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:
|
Git Repository Definition Properties
Property | Description |
---|---|
scontrol.rep.type=git | Git 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., |
scontrol.rep.git.workspace= | The directory containing the local git |
Perforce Repository Definition Properties
Property | Description |
---|---|
scontrol.perforce.exec= | Path to external client executable (p4 ). |
scontrol.rep.type=perforce | Perforce 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 | ||
---|---|---|
| ||
To use Serena Dimensions with C++test,Linux users should run in an environment prepared for using Serena programs, such as 'dmcli'
|
Property | Description |
---|---|
scontrol.rep.type=serena | Serena 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.password | Password. |
scontrol.rep.serena.mapping | Maps workspace resources to Serena Dimension repository paths.
|
StarTeam Repository Definition Properties
Property | Description |
---|---|
scontrol.rep.type=starteam | StarTeam repository type identifier. |
scontrol.rep.starteam.host= | StarTeam server host. |
sscontrol.rep.starteam.port= | StarTeam server port. Default port is 49201. |
scontrol.rep.starteam.login= | Login name. |
scontrol.rep.starteam.password= | Password (not encoded). |
scontrol.rep.starteam.path= | When working with large multi-project repositories, you can improve performance by specifying the project, view, or folder that you are currently working with. You can indicate either a simple Project name (all views will be scanned when searching for the repository path), a Project/View (only the given view will scanned) or Project/View/Folder (only the specified Star Team folder will be scanned). Examples:
|
scontrol.rep.starteam.workdir= | If the Examples:
|
Subversion Repository Definition Properties
Property | Description |
---|---|
scontrol.rep.type=svn | Subversion repository type identifier. |
scontrol.rep.svn.url= | Subversion URL specifies protocol, server name, port and starting repository path (e.g., |
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
Property | Description |
---|---|
scontrol.rep.type=synergy | Synergy/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., |
scontrol.rep.synergy.dbpath= | Absolute synergy database path e.g |
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 Visual Source Safe Repository Definition Properties
Property | Description |
---|---|
scontrol.rep.type=vss | Visual SourceSafe repository type identifier. |
scontrol.rep.vss.ssdir= | Path of repository database (backslash symbols '\' in |
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. |
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 directoryC:\TEMP\VSS\SomeProject
and its subproject$/SomeProject/SomeSubProject
has the working directoryD:\SomeSubProject
).
Settings for Creating BDF-Based Projects
Option | Description |
---|---|
| You can specify an external location, or use the keyword If If an external path is specified, then the project will be created in the specified location.
For details on the available project creation options and their impacts, see Working with C++test Projects. |
| Specifies if Path Variables should be used in linked folders that will be created in the new projects. The default is false. |
| Specifies the name of the Path Variable (if Path Variables are used, per the bdf.import.pathvar.enabled property). The default Path Variable name is |
| Specifies the value of the Path Variable (if Path Variables are used, per the bdf.import.pathvar.enabled property). The default value is the most common root directory for all linked folders. |
| Specifies what compiler family will be used (for example, |
| Specifies the executable of the C compiler that will be used in the created project. |
| Specifies the executable of the C++ compiler that will be used in the created project. |
| Specifies the executable of the linker that will be used in the created project. |
| Specifies the set of folders to link for the project |
Settings for Importing Green Hills .gpj Projects
Setting | Purpose |
---|---|
gpj.import.location=WORKSPACE|ORIG|<path> | Specifies the location of the imported projects. If If If an external path is specified, then the project will be created in the specified location. The default value is |
gpj.import.linked=true|false | Specifies whether the The default value is |
gpj.import.subdirs=true|false | Applicable when Specifies whether the project(s) are imported into subdirectories or directly into the specified location. If you want the project(s) imported into subdirectories created in the specified external location, use true. If you are importing only one project and you want it imported directly into the specified external location, use false. The default value is true (subfolders are created for each project imported into in external location). |
gpj.import.pathvar.enabled=true|false | Specifies if path variables should be used when creating linked directories (if the above option is set to true). The default value is |
gpj.import.pathvar.name=<name> | Specifies the path variable name. The default value will be used unless you specify a path variable name that points to a different location (for instance, If a project with the specified name is already defined in the Eclipse workspace and it points to a different location than the value passed in the The default value is |
gpj.import.pathvar.value=<path> | Specifies the path variable value. By default, C++test calculates the common root for all linked folders. |
gpj.import.compiler.family=name | Specifies the compiler family (compiler ID) |
gpj.import.c.compiler.exec=name | Specifies the C compiler executable |
gpj.import.cpp.compiler.exec=name | Specifies the C++ compiler executable |
gpj.import.linker.exec=name | Specifies the linker executable |
Settings for Importing IAR Embedded Workbench .ewp Projects
Setting | Purpose |
---|---|
ewp.import.location=WORKSPACE|EWP_LOC|<path> | Specifies the location of the imported projects. If If If an external path is specified, then the project will be created in the specified location. The default value is |
ewp.import.config=<name> | Specifies which .ewp project configuration should be used. If the specified configuration cannot be found in the imported project, then the default configuration will be used. The configuration name can be passed in two ways: <project_name> - <configuration_name> or only <configuration_name>. If more then one project is imported, then only <configuration_name> should be entered. This prompts the wizard to search for that configuration in all projects. The default value is the default from .ewp. |
ewp.import.linked=true|false | Specifies whether the .project source folders are linked to the created Eclipse project. Default: |
ewp.import.subdirs=true|false | Specifies whether the project(s) are imported into subdirectories or directly into the specified location. Applicable when Set to Set to |
ewp.import.pathvar.enabled=true|false | Set to The default value is |
ewp.import.pathvar.name=name | Specifies the path variable name. The default name is |
ewp.import.pathvar.value=<path> | Specifies the path variable value. By default, C++test calculates the common root for all linked folders. |
Settings for Importing Microsoft Visual Studio 6.0 .dsp Projects
Setting | Purpose |
---|---|
dsp.import.location=WORKSPACE|DSP_LOC|<path> | Specifies the location of the imported projects. If If If an external path is specified, then the project will be created in the specified location. The default value is |
dsp.import.linked=true|false | Specifies whether the .dsp project source folders are linked into the created Eclipse project. The default value is |
dsp.import.subdirs=true|false | Applicable when Specifies whether the project(s) are imported into subdirectories or directly into the specified location. If you want the project(s) imported into subdirectories created in the specified external location, use true. If you are importing only one project and you want it imported directly into the specified external location, use false. The default value is true (subfolders are created for each project imported into in external location). |
dsp.import.pathvar.enabled=true|false | Specifies if path variables should be used when creating linked directories (if the above option is set to true). The default value is |
dsp.import.pathvar.name=<name> | Specifies the path variable name. The default value will be used unless you specify a path variable name that points to a different location (for instance, If a project with the specified name is already defined in the Eclipse workspace and it points to a different location than the value passed in the The default value is |
dsp.import.pathvar.location=<loc> | Specifies what location the path variable points to. By default, the automatically-generated location will be used. This location is the common root location for all linked directories. If it is not possible to find a common location (for example because .dsp projects are on multiple drives) or the specified location cannot be used, then the path variable will not be used. Full paths will be used instead. For example, assume you have the following paths:
The common root location would be The default value is automaticallygenerated. |
dsp.import.config=<name> | Specifies which .dsp project configuration should be used. If the specified configuration cannot be found in the imported project, then the default configuration will be used. The configuration name can be passed in two ways: The default value is the default from |
For example, if the folder C:\temp\sources should be linked in an imported project and we have defined the path variable DEVEL_ROOT_DIR
with the value C:\temp, then that folder will be linked as DEVEL_ROOT_DIR/sources and the DEVEL_ROOT_DIR
path variable will be created in the workspace. If such a variable cannot be used (for example, because its value points to another folder not containing C:\temp\sources folder, it is already defined and has different value, or it has an invalid value), then C:\temp\sources folder will be linked using the full path C:\temp\sources.
Settings for Importing Keil uVision Projects
Setting | Purpose |
---|---|
uv.import.location=WORKSPACE|ORIG|<path> | Specifies the location of the imported projects. If If If an external path is specified, then the project will be created in the specified location. The default value is |
uv.import.linked=true|false | Specifies whether the The default value is |
uv.import.subdirs=true|false | Applicable when Specifies whether the project(s) are imported into subdirectories or directly into the specified location. If you want the project(s) imported into subdirectories created in the specified external location, use If you are importing only one project and you want it imported directly into the specified external location, use The default value is |
uv.import.pathvar.enabled=true|false | Specifies if path variables should be used when creating linked directories (if the above option is set to The default value is |
uv.import.pathvar.name=<name> | Specifies the path variable name. The default value will be used unless you specify a path variable name that points to a different location (for instance, If a project with the specified name is already defined in the Eclipse workspace and it points to a different location than the value passed in the The default value is |
uv.import.pathvar.value=<path> | Specifies the path variable value. By default, C++test calculates the common root for all linked folders. |
uv.import.config=<name> | Specifies the name of the build configuration to use. |
Settings for Importing Renesas High-performance Embedded Projects
Setting | Purpose |
---|---|
hew.import.location=WORKSPACE|ORIG|<path> | Specifies the location of the imported projects. If If If an external path is specified, then the project will be created in the specified location. The default value is |
hew.import.linked=true|false | Specifies whether the The default value is |
hew.import.subdirs=true|false | Applicable when Specifies whether the project(s) are imported into subdirectories or directly into the specified location. If you want the project(s) imported into subdirectories created in the specified external location, use If you are importing only one project and you want it imported directly into the specified external location, use The default value is |
hew.import.pathvar.enabled=true|false | Specifies if path variables should be used when creating linked directories (if the above option is set to true). The default value is |
hew.import.pathvar.name=<name> | Specifies the path variable name. The default value will be used unless you specify a path variable name that points to a different location (for instance, If a project with the specified name is already defined in the Eclipse workspace and it points to a different location than the value passed in the The default value is |
hew.import.pathvar.value=<path> | Specifies the path variable value. By default, C++test calculates the common root for all linked folders. |
hew.import.config=<name> | Specifies the name of the build configuration to use. |
Miscellaneous Settings
Setting | Purpose |
---|---|
report.rules=[url_path_to_rules_directory] | Specifies the directory for rules html files (generated by clicking the For example:
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 |
console.verbosity.level=low|normal|high | Specifies the verbosity level for the Console view. Available settings are:
|
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:
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 an empty string.
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=automation_edition # SOURCE CONTROL scontrol.rep1.type=cvs scontrol.rep1.cvs.root=:pserver:developer@cvs_server.domain.com:/home/cvs/ scontrol.rep1.cvs.pass=mypassword |
Anchor | ||||
---|---|---|---|---|
|
The -buildscript %SCRIPT_FILE%
option executes the specified Eclipse build script prior to testing.
In some cases, this may bring up the Eclipse UI. It depends on the Eclipse component capabilities and 3rd party Eclipse source control plugins. Note that if the UI is not opened and the source control is not fully configured, then the 3rd party Eclipse source control plugins may fail in headless mode. They may fail silently or throw various exceptions while trying to access a UI that is not available. To prevent this, have source control fully configured and ensure that it does not need to ask the user for any additional information (username, passwords, etc.)
The following scripting language can be used to define the script...
Syntax
Commands are entered one per line. Whitespace at the beginning or end of the line is trimmed. Any blank line is ignored. Everything following a # comment symbol in a line is ignored. Commands consist of a command name and one or more arguments.
Substrings of the form $(key)
are recursively expanded as macros in arguments.
Commands
Command | Description |
---|---|
| Defines a variable that will be used in macro expansion. |
| Checks out projects specified in an Eclipse team project set exported file. Relative paths are resolved relative to the current file (important for included files). |
| Exactly like co, but if a project is already in the workspace, it will update it rather than checking it out from scratch. Tries to do this "headlessly" but may open a dialog, suspending the checkout until user interaction is given via the UI to resolve the conflict, if local changes are detected. NOTE: Updating is only supported with CVS and SVN repositories. If the team project set refers to another kind of repository, only checkout is supported at this time. |
| Exactly like co, but if a project is already in the workspace, it will update it rather than checking it out from scratch. Same advantages and limitations as "up". Builds all projects in the PSF file after checkout and/or update is complete. |
| Exactly like up, but if a project already in the workspace is being updated, it uses a replace operation rather than an update operation. This should overwrite local changes silently. NOTE: Updating/replacing is only supported with CVS and SVN repositories. If the team project set refers to another kind of repository, only checkout is supported at this time. |
| Exactly like upb, but if a project already in the workspace is being updated, it uses a replace operation rather than an update operation. This should overwrite local changes silently. Builds all projects in the PSF file after checkout and/or update is complete. |
| Builds the projects whose names are given in the arguments. If no argument is given, builds all projects in the workspace. If the first argument is the string "-", builds all projects in the workspace except the ones listed. |
| The specified script file will be run. Relative paths are resolved relative to the current file (important for recursive include commands). |
| The specified targets (or the default target, if no targets are specified) in the specified ant build file will be run. Relative paths are resolved relative to the current file. Refresh of entire workspace is done after the ant build file is run. |
refresh | Performs an Eclipse "refresh" of the entire workspace. |
Macros
Strings of the form $(key)
in command arguments are expanded. The values used can be from previous var commands or from System properties. System properties can be predefined by Java (e.g. user.home
) or passed into the build by running Eclipse with the -vmargs -Dkey=value
parameter.