Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space FUNCTDEV and version SVC2020.2

...

You can configure how SOAtest connects to other Parasoft systems, reports errors, determines code authorship, and performs other functions by configuring your preferences in a localsettings file. If a parameter is specified in this file and there is an equivalent parameter in the GUI’s Preferences panel (see Configuring SOAtest Across TeamsPreferences Overview), the localsettings parameter will override the parameter specified from the GUI. Localsettings can be used to:

...

You can also export your GUI preferences as described in Exporting GUI Preferences to a localsettings File to quickly create the file and adjust or extend them as needed.

...

env_var

This variable specifies the value of an environmental variable. Use a colon followed by the name of a system environment variable before the closing curly brace to output the value of the environment variable.

Example:

session.id=${env_var:HOME}

project_name

Outputs the name of the tested project. If more than one project is provided as an input, the name of the project tested is printed followed by an ellipsis (...).

Example:

build.id=${dtpproject_projectname}-${time}

general_project

It outputs the name of the general DTP project that results are linked to. Only applies when connected to DTP. 

Example:

build.id=${general_project}

workspace_name

Outputs the workspace name or Visual Studio solution name.

Example:

report.mail.subject=Code Review Scanner Results for ${workspace_name}

config_name

Outputs the name of executed test configuration. Only applies to reports and email settings.

Example:

report.mail.subject=Findings from running ${config_name} on the ${project_name}

analysis_type

Outputs a comma separated list of enabled analysis types (for example: Static, Execution). Only applies to reports and email settings.

Example:

report.mail.subject=${analysis_type} findings

tool_name

Outputs the name of the tool.

Example:

Outputs the current time. The default is yyyy-MM-dd. You can customize the format, for example:

report.mail.subject=Tests executed by ${tool_name}

time

${time:yyyy-MM-dd-HH.mm}


Specifying Which Localsettings to Use

...

For details on how to store and apply localsettings, see Configuring SOAtest Across TeamsPreferences Overview

Additional Notes

  • Each setting should be entered on a single line.
  • If a parameter is specified in localsettings, it will override the related parameter specified from the GUI. If a parameter is not specified in localsettings, the parameter specified in the GUI will be used.
  • If you are importing preferences from localsettings specified in DTP and you want to override these settings from the GUI, you can disable the Use DTP settings option on the appropriate page, then manually configure the settings.
  • If any localsettings problems are detected during a test run, details will be reported in the command line output.
  • If you 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.

...

SettingPurpose
build.id

Specifies a build identifier used to label results. It may be unique for each build but may also label more than one test sessions that were executed during a specified build. The maximum length for a build ID is 128 characters.

Default:  ${dtp_project}-${time:build-yyyy-MM-dd}

report.active_rules=true|false

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

Default: false

report.archive=true|false

Enables the generation of an additional compressed archive (.zip) file in the specified report location. The ZIP file contains all the files generated to build the report. 

This option can generate an archive for any report format (e.g., HTML, CSV, PDF, etc.). 

By generating an archive, you can also perform custom transformations of the report because all of the elements are generated to the specified destination folder.

Default: false

report.associations

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

Default: false

report.authors_details

Determines whether the report includes an overview of the number and type of tasks assigned to each team member. 

Default: true

report.contexts_details

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

Default: false

report

.coverage

.

version 

Specifies the version of the XML coverage report.

Specify 1 to enable the basic (legacy) coverage report.

Specify 2 to enable the enhanced coverage report (JaCoCo). 

Default is 2

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, seeConfiguring Report Reporting Settings.

report.developer_errors=true|false

Determines whether manager reports include details about team member tasks.

Default: false

report.developer_reports=true|false

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

Default: true

report.format=html|pdf|sate|xunit|custom

Specifies the report format.

Default: html

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.

Default: 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. 
report.graph.ue_coverage_start_date=[MM/dd/yy]Determines the start date for trend graphs that track coverage over a period of time. 
report.graph.ue_start_date=[MM/dd/yy]Determines the start date for trend graphs that track test execution results over a period of time. 
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. 

Default: false

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.

Default: 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 team members if such reports are not sent automatically.
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 team members  and to the additional recipients specified with the cc setting. 

Remember that each team member with assigned tasks will automatically be sent a report that contains only the assigned tasks.  

Default: false

report.mail.exclude=[email_addresses]Specifies any email addresses you do not want to receive reports. This set-ting is used to prevent automated sending of 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 team member whose email is not explicitly listed in the report.mail.cc property. This setting is used to prevent reports from being mailed to individual team members.

Default: false

report.mail.format=html|ascii

Specifies the email format.

Default: html

report.mail.from=[email_address OR user_name_of_the_same_domain]

Specifies the "from" line of the emails sent.

Default: <global_user_name>

report.mail.include=[email_addresses]Specifies the email addresses of team members that you want to receive individual reports. This setting must be followed by a semicolon-separated list of email addresses. This setting is typically used to send individual reports to team members if such reports are not sent automatically (for example, because the team is not using a supported source control system). It overrides team members specified in the 'exclude' list. 
report.mail.on.error.only=true|false

Determines whether reports are sent to the manager only if a task is generated or a fatal exception occurs. Team member emails are not affected by this setting; individual emails are sent only to team members who are responsible for reported tasks.

Default: false

report.mail.port=[port]

Specifies the mail server host’s port number.

Default: 25

report.mail.security=[SL| STARTTLS| NONE]Specifies the desired security. Available settings are  SSL, STARTTLS, NONE. SSL is not available in Visual Studio.
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 ${tool_name} Report - ${config_name}. For example, if you want to change the subject line to "SOAtest Report for Project A", you would use

report.mail.subject=SOAtest Report for Project A

Default: ${tool_name} Report - ${config_name}

report.mail.time_delay=[server]

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

Default: 0

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.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 metrics-enabled Test Configuration is run. Metrics details will be shown in HTML and PDF reports.

Default: true

report.setup.problems=top|bottom|hidden

Determines whether reports include a section about setup problems. 

top - Adds a "Setup Problems" section to the top of the report. This is the default. 

hidden - Prevents a "Setup Problems" section from being added.

bottom - Adds a "Setup Problems" section to the bottom of the report. 

Default: bottom

report.suppressed_msgs=true|false

Determines whether reports include suppressed messages.

Default: false

report.test_params=true|false

Determines whether reports include test parameter details.

Default: false

report.test_suites_only=true|false

Determines whether the Test Suite Summary report section only lists the .tst files (with this option enabled) or displays a tree-like view of the individual tests in each .tst file (with this option disabled). SOAtest only

Default: true

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]:

LC - for line coverage

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.

Default: ${config_name}

tasks.source.control.details=true|false
This setting specifies if additional information from source control, such as revisions and comments, is included in the report.

...

SettingPurpose
report.rules=[url_path_to_rules_directory]

Specifies the directory for HTML rule files generated by clicking Printable Docs in the Test Configuration’s Static Analysis tab. 

Default: none

tasks.clear=true|false

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

Default: 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.

Default: low

soatest.custom.rules.dir=[directory]

Indicates where user-defined rules are saved.

soatest.custom.configs.dir=[directory]

Indicates where user-defined Test Configurations are saved.

exec.env=[env1; env2; ...]Specifies a list of tags that describe the environment where a test session was executed. Tags could describe an   operating system (e.g. Windows, Linux), an architecture (e.g. x86, x86_64), a compiler, a browser, etc. These tags describe a complete test session; more environment details could be also added at the test suite, test, or test case levels via the services API.
issue.tracking.tags=[value]

Specifies custom issue tracking tags. Multiple tags can be separated by a comma. For example:

issue.tracking.tags=@custom,@pr ,@fr

For more details, see Associating Tests with Development Artifacts Indicating Code and Test Correlations.

parallel.mode=Manual|Auto|Disabled

Determines which of the following modes is active: 

  • Auto: SOAtest controls parallel processing settings.
  • Manual: Allows you to manually configure parallel processing settings to suit your specific needs.
  • Disabled: Use only one of the available CPUs.

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

Default: Auto

parallel.max_threads=<number>

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

Default: [available_processors]

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.

Default: 25

parallel.no_memory_limit=true|false

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

Default: false

usage.reporting.enabled=true|false

Enables or disables collecting anonymous usage information and sending it to Parasoft. Read our privacy statement to learn more at https://www.parasoft.com/privacy-policy.

Default: false

Additional Options for SOAtest and Virtualize

...