polyspace.project.TestConfigurationRef Class

R2026b

Namespace: polyspace.project

(Python) Manage references from project to external testing and profiling configurations

Since R2026a

expand all in page

Description

This Python® class contains information about an external testing and profiling configuration that is saved in a separate file, referenced by a Polyspace® Platform project. Polyspace supports two file formats for external configurations: the native JSON-based format (.pscfg) and the human-readable TOML format (.toml.pscfg). Saving your testing and profiling configurations in external files and referencing those files from one or more projects enables you to create a modular project structure that improves sharing and version control workflows. For more information about project structure, see Modularize Project by Using External Configurations, Test References, and External Stub Files.

To work with external testing and profiling configurations, use this class, which contains the name of the configuration and the path to the external configuration file, together with the polyspace.project.TestConfiguration class, which contains the testing and profiling configuration.

To work with testing and profiling configurations that are attached to a specific project, see polyspace.project.OwnedTestConfiguration.

Creation

Syntax

testConfigRef = proj.TestConfigurationRefs.add(testConfig, testConfigRefName)
testConfigRef = proj.TestConfigurationRefs.add(testConfigRefObj)
testConfigRef = proj.TestConfigurationRefs.add(testConfigRefObj, testConfigRefName)
testConfigRef = proj.TestConfigurationRefs.moveAsRef(ownedTestConfigObj,testConfigFile)
testConfigRef = proj.TestConfigurationRefs.moveAsRef(ownedTestConfigObj,testConfigFile, testConfigRefName)
testConfigRef = proj.TestConfigurationRefs.moveAsRef(ownedTestConfigObj,testConfigFile, configFileFormat)

Description

Import Configuration by Reference

testConfigRef = proj.TestConfigurationRefs.add(testConfig, testConfigRefName) adds a reference from the project to the testing and profiling configuration testConfig, which is an existing external configuration file (.pscfg or .toml.pscfg) or a polyspace.project.TestConfiguration object. The Name property of the resulting polyspace.project.TestConfigurationRef object is set to testConfigRefName.

testConfigRef = proj.TestConfigurationRefs.add(testConfigRefObj) adds a reference from the project to an existing polyspace.project.TestConfigurationRef object testConfigRefObj and inherits the configuration name.

testConfigRef = proj.TestConfigurationRefs.add(testConfigRefObj, testConfigRefName) adds a reference from the project to an existing polyspace.project.TestConfigurationRef object testConfigRefObj. Use the testConfigRefName argument to set the Name property of the resulting testConfigRef object.

Convert Configuration

testConfigRef = proj.TestConfigurationRefs.moveAsRef(ownedTestConfigObj,testConfigFile) converts the existing ownedTestConfigObj to a polyspace.project.TestConfigurationRef object in the same project. After conversion, the project references the external configuration saved in testConfigFile. You can specify testConfigFile as an absolute or relative path, where relative paths are considered relative to the location of the .psprjx project file. The resulting polyspace.project.TestConfigurationRef object has its Path property set to testConfigFile and its Name property is inherited from the owned testing and profiling configuration.

example

testConfigRef = proj.TestConfigurationRefs.moveAsRef(ownedTestConfigObj,testConfigFile, testConfigRefName) converts the existing ownedTestConfigObj to a polyspace.project.TestConfigurationRef object in the same project. After conversion, the project references the external configuration saved in testConfigFile. You can specify testConfigFile as an absolute or relative path, where relative paths are considered relative to the location of the .psprjx project file. The resulting polyspace.project.TestConfigurationRef object has its Path property set to testConfigFile and its Name property is set by the testConfigRefName argument you provide.

testConfigRef = proj.TestConfigurationRefs.moveAsRef(ownedTestConfigObj,testConfigFile, configFileFormat) converts the existing ownedTestConfigObj to a polyspace.project.TestConfigurationRef object in the same project and saves the external configuration in the format specified by configFileFormat.

Input Arguments

expand all

Testing and profiling configuration that you want to add a reference to from the project, specified as a polyspace.project.TestConfiguration object or a path to an existing external configuration file (.pscfg or .toml.pscfg).

Name to assign the referenced testing and profiling configuration, specified as a string. This argument sets the Name property of the polyspace.project.TestConfigurationRef object.

Existing testConfigRefObj to reference from the project, specified as a polyspace.project.TestConfigurationRef object.

Existing owned testing and profiling configuration to convert to an external configuration and reference from the project, specified as a polyspace.project.OwnedTestConfiguration object.

Relative or absolute path of the external configuration file to create when converting an existing owned testing and profiling configuration to an external configuration, referenced by the project. You can include a file extension as part of the testConfigFile argument to specify the file format to create: use .pscfg to create the file in native format, or .toml.pscfg to create the file in the full TOML format. Alternatively, do not include an extension in the testConfigFile argument, and use the configFileFormat argument to specify the file format. Relative paths are considered relative to the location of the .psprjx project file.

Format of the configuration file to create, specified as one of:

  • FileFormat.NATIVE — original, JSON-based file.

  • FileFormat.TOML_FULL — TOML file containing all configuration values, including defaults.

  • FileFormat.TOML_CONCISE — TOML file containing only non-default values.

To use FileFormat as an argument, you must first import it from polyspace.project:

from polyspace.project import FileFormat
If you do not import it, use the full syntax when specifying the argument. For example, 
polyspace.project.FileFormat.TOML_FULL

Properties

expand all

Name of the referenced external testing and profiling configuration, specified as a string. If you do not specify a Name argument, the name defaults to that of the existing testing and profiling configuration you are adding or converting.

Path to the .pscfg or .toml.pscfg file where the referenced external testing and profiling configuration is saved, specified as a string. All relative paths are considered relative to the location of the .psprjx project file.

Methods

expand all

Examples

collapse all

Modularize your project by converting an owned testing and profiling configuration to an external configuration, referenced by the project. An external configuration is a build, static analysis, or testing and profiling configuration that is saved in a .pscfg or .toml.pscfg file that is referenced by the project.

Create the project, add your source files, and parse the code.

## Import modules
import polyspace.project
import polyspace.test
import os

## Create project
examples_path = os.path.join(polyspace.__install_path__, "polyspace", 
                            "examples", "doc_pstest", "python_api_test_authoring")
proj = polyspace.project.Project("testRefProject.psprjx")

## Add source files and include headers
proj.Code.Files.add(os.path.join(examples_path, "src", "algo.c"))
proj.Code.Files.add(os.path.join(examples_path, "src", "saturate.c"))
proj.IncludePaths.add(os.path.join(examples_path, "src"))

## Save project and parse code
proj.save()
codeInfo = polyspace.project.parseCode(proj)

Convert the existing testing and profiling configuration to an external configuration, referenced by the project using the moveAsRef method.

# Convert the configuration
testConfig = proj.TestConfigurations[0]
proj.TestConfigurationRefs.moveAsRef(testConfig, "externalTestConfig.pscfg")

# Alternatively, convert to full TOML using:
# proj.TestConfigurationRefs.moveAsRef(testConfig, "externalTestConfig.toml.pscfg")

When you convert a configuration that is active in a project, Polyspace updates the active configuration accordingly. Check the active testing and profiling configuration for the project, then save and build the project.

proj.ActiveTestConfiguration
proj.save()
status = polyspace.test.build(proj)

Version History

Introduced in R2026a

expand all

See Also

| | | | |

Topics