polyspace-test -create-testgen-config

R2026b

(System Command) Create a default configuration file for automatic test generation in a Polyspace Platform project

Since R2026b

Syntax

polyspace-test -create-testgen-config -config-file <configFile> -project <projectFile> -function <function>

Description

The system command polyspace-test -create-testgen-config creates a default test generation configuration file for a specified function in a Polyspace^® Platform project. You can then customize the configuration file and use it with the polyspace-test -generate-tests command.

polyspace-test -create-testgen-config -config-file <configFile> -project <projectFile> -function <function> creates a default test generation configuration file configFile for the function function in the project projectFile. The configuration file uses a TOML-like format and contains default entries for the function inputs. You can edit this file to add constraints such as fixed values, minimum and maximum bounds, and pointer target sizes, and then use it with the polyspace-test -generate-tests command.

example

Examples

collapse all

Create a Configuration File for Function-Based Test Generation

Create a default configuration file for a function, customize the input constraints, and then generate boundary-value tests using the configuration file.

Create a default configuration file for the saturate_value function.

polyspace-test -create-testgen-config -config-file saturate_config.toml -project myProject.psprjx -function "int saturate_value(int)"

The command creates a file saturate_config.toml with default entries for the function inputs.

Open the generated file and customize the input constraints. For instance, specify a minimum and maximum value for the input:

Tabular = true
CodeUnderTest = "int saturate_value(int)"

[[Inputs]]
Var = 0
MinValue = "-100"
MaxValue = "100"

Generate boundary-value tests using the customized configuration file.

polyspace-test -generate-tests -project myProject.psprjx -boundary -config-file saturate_config.toml -boundary-mode minimal

Input Arguments

collapse all

`-config-file <configFile>` — Path to configuration file to create
string

Path to the configuration file to create. You can specify the file path as an absolute path or as a path relative to your working directory.

Example: -config-file "myConfig.toml"

Example: -config-file "configs/saturate_config.toml"

`-project <projectFile>` — Path to project file
string

Absolute or relative path to the Polyspace Platform project file (.psprjx file) that contains the source files.

Example: -project "myProject.psprjx"

`-function <function>` — Name of function for which to create configuration
string

Name of the C/C++ function to generate configuration file for. If only one function with the specified name exists in the project sources, specifying just the function name is sufficient. Otherwise, specify the full function signature.

Example: -function "int saturate_value(int)"

Example: -function "saturate_value"

More About

collapse all

Configuration File Format

The configuration file uses a TOML-like format to describe the test generation template. You can use the configuration file to describe both tabular (function-based) and scripted test generation settings.

Configuration File for Tabular Tests

A configuration file for tabular tests describes the function under test and its inputs. The following example shows a configuration file for a function that takes a pointer argument, two integer arguments, a global variable, and a mock variable:

Preamble = """
#include <myinclude.h>
"""
Setup = """
"""
Teardown = """
"""

Tabular = true
ActiveMocks = ["mock_variant_1"]
CodeUnderTest = "bool update(ecoCarState*, uint32_t, uint32_t)"

[[Inputs]]
Var = 0
Size = 1

[[Inputs]]
Var = 1
Scope = "PARAMETER"
MinValue = "0"
MaxValue = "150"

[[Inputs]]
Var = 2
Scope = "PARAMETER"
Value = "5"

[[Inputs]]
Var = "my_glob"
Scope = "GLOBAL"
MinValue = "12"

[[Inputs]]
Var = "mockVar"
Scope = "MOCK"

All fields are optional because the test generator fills in the values. A minimal configuration file for a tabular test requires only the function under test:

Tabular = true
CodeUnderTest = "bool update(ecoCarState*, uint32_t, uint32_t)"

If only one function with the specified name exists, you can omit the full signature:

Tabular = true
CodeUnderTest = "update"

Configuration File for Scripted Tests

A configuration file for scripted tests describes the test script body, optional preamble, setup, and teardown code, and the script inputs. The following example shows a configuration file for a scripted test:

Tabular = false

Preamble = """
#include <myinclude.h>
"""
Setup = """
"""
Teardown = """
"""
Body = """
int res1 = my_function(input1);
if (res1 > 0) {
    my_function2(input2);
} else {
    other_function(input2);
}
"""

[[Inputs]]
Var = "input1"
Type = "int"
MinValue = "-10"
MaxValue = "10"

[[Inputs]]
Var = "input2"
Type = "float"

For scripted tests, the name of each input is mandatory because it is used within the script body.

Configuration File Fields

This table describes the fields you can use in a configuration file:

Field	Description
`Tabular`	Set to `true` for tabular (function-based) tests or `false` for scripted tests.
`CodeUnderTest`	For tabular tests, the name or signature of the function under test.
`Body`	For scripted tests, the C/C++ code that forms the body of the test script.
`Preamble`	Optional C/C++ code compiled into the generated test harness prior to executing tests.
`Setup`	Optional C/C++ code executed before each generated scripted test.
`Teardown`	Optional C/C++ code executed after each generated scripted test.
`ActiveMocks`	List of active mocks for the test, specified as a string array. The mocks must be previously created either in the Polyspace Platform user interface or using the Python^® API.
`[[Inputs]]`	Each `[[Inputs]]` section describes one input variable with the following sub-fields: `Var` — Parameter index (0-based, specified as either integer or string) or variable name (string). `Scope` — Scope of the variable: `"PARAMETER"`, `"GLOBAL"`, or `"MOCK"`. Optional, but can be used to disambiguate. `Type` — Data type of the input. Required for scripted test inputs. `Value` — Fixed value of the input in generated tests. `MinValue` — Minimum value of the input in generated tests. `MaxValue` — Maximum value of the input in generated tests. `Size` — Size of the underlying pointer target. Use this sub-field for pointer arguments.

Version History

Introduced in R2026b

polyspace-test -create-testgen-config

Syntax

Description

Examples

Create a Configuration File for Function-Based Test Generation

Input Arguments

`-config-file <configFile>` — Path to configuration file to create
string

`-project <projectFile>` — Path to project file
string

`-function <function>` — Name of function for which to create configuration
string

More About

Configuration File Format

Version History

See Also

Topics

polyspace-test -create-testgen-config

Syntax

Description

Examples

Create a Configuration File for Function-Based Test Generation

Input Arguments

-config-file <configFile> — Path to configuration file to create string

-project <projectFile> — Path to project file string

-function <function> — Name of function for which to create configuration string

More About

Configuration File Format

Version History

See Also

Topics

`-config-file <configFile>` — Path to configuration file to create
string

`-project <projectFile>` — Path to project file
string

`-function <function>` — Name of function for which to create configuration
string