polyspace-test -run

(System Command) Run tests in a Polyspace Platform project

Since R2023b

Syntax

polyspace-test -run -project <projectFile> [options]

polyspace-test -run -project <projectFile> -test <testList> [options]

polyspace-test -run -options-file <optionsFile>

Description

The system command polyspace-test -run runs tests in a Polyspace^® Platform project.

polyspace-test -run -project <projectFile> [options] runs all tests in a Polyspace Platform project file projectFile. If the test executable(s) cannot be found, the command builds the executable and then runs it.

polyspace-test -run -project <projectFile> -test <testList> [options] runs a list of tests specified by <testList>.

polyspace-test -run -options-file <optionsFile> runs tests using the options specified in <optionsFile>.

Examples

Build and Run Tests in Project File

Automate the building and running of the tests in a project file projectName.psprjx by using the polyspace-test command.

For an example of creating a project and adding sources and tests, see Write C/C++ Unit Tests in Polyspace Platform User Interface.

1. Build a test executable to run all the tests included in a project file projectName.psprjx.

   polyspace-test -build -project projectName.psprjx

   The command generates the test executable and other artifacts and stores them in folder polyspace_artifacts.

2. Run the tests and generate a results file.

   polyspace-test -run -project projectName.psprjx -results-dir resultsFolder

   The command runs all the tests and generates a .pstestr results file which is stored in the folder resultsFolder. When you use the -run command, if a test executable does not already exist, the software builds the tests and then runs them.

3. Generate an XML report to capture a snapshot of the testing status.

   polyspace-test -report -report-dir reportFolder -xml resultsFolder

   The generated report is stored in a subfolder of the reportFolder folder.

Input Arguments

-project <projectFile> — Path to project file

string

Path to the Polyspace Platform project file (.psprjx file) that contains the tests that you want to build. polyspace-test uses the build and test configurations specified in the project unless you override the configurations. You can specify the file path as an absolute path or as a path relative to your working directory.

Example: -project "../project/myTestProject.psprjx"

Example: -project "C:\Users\jsmith\project\myTestProject.psprjx"

-test <testList> — List of tests

string

List of Polyspace Test™ tests specified using the following rules:

• To specify a test suite <suiteName>, use the option -test <suiteName>.

• To specify a test <testName>:

  • In the default test suite (pst_default_suite), use the option -test <testName>.

  • In the suite <suiteName>, use the option -test <suiteName>/<testName>.

• To specify an iteration of a parameterized test <testName> in a suite <suiteName>, use the option -test <suiteName>/<testName>(<paramList>) where <paramList> is a list of parameter indices. For instance, if a parameterized test has two parameters and you want to execute the iteration where both parameters take their first values, use the option -test <suiteName>/<testName>(1,1).

You can also run tests authored using an external test framework. If you import tests into your project from an external framework such as GoogleTest, specify -test external: to run all the external tests, or -test external:suiteName.testName to run only the test testName from the test suite suiteName. For more on the GoogleTest syntax, see Running a Subset of Tests.

To execute all Polyspace Test tests in addition to an external test MyExternalSuite.MyExternalTest, use this option:

-test pstunit: -test external:MyExternalSuite.MyExternalTest

-options-file <optionsFile> — Path to options file

string

Path to text file containing options to use with the polyspace-test -run command. The file must contain one option per line.

options — Options to modify test build and execution

strings

Build Options

Option	Description
-build-dir <buildFolderPath>	Specify a path <buildFolderPath> where Polyspace Test stores the build artifacts. You can specify an absolute path or a path relative to your working directory. By default, Polyspace stores the build artifacts in the project artifacts folder, specified using the configuration option Artifacts directory.
-profiling-mode <codeProfilingMode>	Specify the code profiling mode as one of these values: coverage: The source code in the project is instrumented for code coverage calculation before project build. execution-profile: The source code in the project is instrumented for execution profiling before project build. stack-profile: The source code in the project is instrumented for stack profiling before project build.
-cov-metric-level <coverageLevel>	Specify the code coverage level <coverageLevel> as one of these values: statement: The project is built only for statement coverage results. For more information, see Statement Coverage. decision — The project is built for statement and decision coverage results. For more information on decision coverage, see Decision Coverage. condition/decision — The project is built for statement, decision and condition coverage results. For more information on condition coverage, see Condition Coverage. mcdc — The project is built for statement, decision, condition and MC/DC coverage results. For more information on MC/DC coverage, see Modified Condition/Decision Coverage (MCDC) Coverage.
-enable-debugger	Build your project in debug mode. In this mode, breakpoints are associated with specific places in the test code before the test code is built. Later, when you run tests in the project, instead of normal execution, the tests open in a debugger at those breakpoints. For more information on supported debuggers, see Debug Test Failures from Polyspace Platform User Interface. Note that you cannot debug tests in a project with profiling enabled.
-enable-portable-word-sizes	Use this option to compile your code on a host computer while retaining the word sizes of the target processor on which the code is intended to run. For example, if your code runs on a 16-bit processor, the size of an integer is 16 bits. You can emulate this processor on a 64-bit host machine (where the size of an integer is 64 bits) by enabling this option.
-refresh-sources	Use this option to update the content of a folder that is already added to the project before project build (in case source or test files were added to or removed from that folder).
-force-rebuild	Use this option to force full build of all sources in the project. If you do not use this option, the project build takes previous build information into account and builds only those sources that changed since the previous build. If you use this option, any existing build artifacts are removed before the project is built.

Execution Options

Option	Description
-results-dir <resultsFolderpath>	Specify the path to the folder where test results are stored. You can specify an absolute path or a path relative to your working directory. If you omit this option, the command stores test results in a folder results in the current folder.

Project Override Options

Option	Description
-build-config <configName>	Specify the name of a build configuration variant to use instead of the current active build configuration of the project. For more information on configuration variants, see Create Configuration Variants.
-test-config <configName>	Specify the name of a test configuration variant to use instead of the current active test configuration of the project. For more information on configuration variants, see Create Configuration Variants.
-var <var=value>	Assign a value to variable var instead of the value specified in the project.
-board <targetName>	Specify the board to use instead of the board used in the active build configuration of the project.
-toolchain <toolchainName>	Specify the toolchain to use instead of the toolchain specified in the active build configuration of the project.

Version History

Introduced in R2023b