Main Content

padv.builtin.query.FindModelsWithTestCases Class

Namespace: padv.builtin.query
Superclasses: padv.Query

Query for finding models that have test cases

expand all in page

Description

This class requires CI/CD Automation for Simulink Check.

The padv.builtin.query.FindModelsWithTestCases class provides a query that can return the models in your project that have test cases.

You can use this query in your process model to find models that are associated with test cases. For example, If you use a built-in task like padv.builtin.task.MergeTestResults to merge the test results for each model in your project, you can use the FindModelsWithTestCases query to find only models that have test cases and therefore test results that the task can merge.

The padv.builtin.query.FindModelsWithTestCases class is a handle class.

Creation

Description

query = padv.builtin.query.FindModelsWithTestCases() creates a query for finding the models in your project that have test cases.

example

query = padv.builtin.query.FindModelsWithTestCases(Name=Value) sets certain properties using one or more name-value arguments. For example, query = padv.builtin.query.FindModelsWithTestCases(ExcludePath = "Control") creates a query that finds models that have test cases, but excludes models that have "Control" in the file address.

The padv.builtin.query.FindModelsWithTestCases class also has other properties, but you cannot set those properties during query creation.

Input Arguments

expand all

Name-Value Arguments

Specify optional pairs of arguments as Name1=Value1,...,NameN=ValueN, where Name is the argument name and Value is the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Example: query = padv.builtin.query.FindModelsWithTestCases(ExcludePath = "Control")

Exclude models with specific project label, specified as a cell array where the first entry is the project label category and the second entry is the project label name.

Example: {"Classification","Design"}

Data Types: cell

Exclude models where the path contains specific text, specified as a string or a character vector.

Example: "Control"

Data Types: char | string

Find models with specific project label, specified as a cell array where the first entry is the project label category and the second entry is the project label name.

Example: {"Classification","Design"}

Data Types: cell

Find models where the path contains specific text, specified as a string or a character vector.

Example: "Control"

Data Types: char | string

Unique identifier for query, specified as a string or a character vector.

Example: "FindModelsWithTests"

Data Types: char | string

Initial query that runs before iteration query, specified as either a padv.Query object or the Name of a padv.Query object. When you specify an iteration query for a task, the parent query is the initial query that the build system runs before running the specified iteration query.

For information on how to improve Process Advisor load times by sharing query instances across your process model, see Best Practices for Process Model Authoring.

Example: sharedFindModelsQuery

Example: "padv.builtin.query.FindModels"

Find models that have at least one test case that uses specific test case tags, specified as a string or an array of strings.

Example: "FeatureA"

Example: ["FeatureA","FeatureB"]

Data Types: string

Properties

expand all

Find models with specific project label, specified as a cell array where the first entry is the project label category and the second entry is the project label name.

Example: {"Classification","Design"}

Data Types: cell

Exclude models with specific project label, specified as a cell array where the first entry is the project label category and the second entry is the project label name.

Example: {"Classification","Design"}

Data Types: cell

Find models where the path contains specific text, specified as a string or a character vector.

Example: "Control"

Data Types: char | string

Exclude models where the path contains specific text, specified as a string or a character vector.

Example: "Control"

Data Types: char | string

Only include models with test cases that use specific test case tags, specified as a string or an array of strings.

Example: "FeatureA"

Example: ["FeatureA","FeatureB"]

Data Types: string

Query title, specified as a string or a character vector.

Example: "Find models that have test cases"

Data Types: char | string

Default artifact type returned by the query, specified as one or more of the values in this table. To specify multiple values, use an array.

CategoryArtifact TypeDescription

MATLAB®

"m_class"MATLAB class
"m_file"MATLAB file
"m_func"MATLAB function
"m_method"MATLAB class method
"m_property"MATLAB class property

Model Advisor

"ma_config_file"Model Advisor configuration file
"ma_justification_file"Model Advisor justification file

Other

"coder_code_files"Code files
"other_file"Other file

Process Advisor

"padv_dep_artifacts"

Related artifacts that current artifact depends on

"padv_output_file"

Process Advisor output file

Project

"project"Current project file

Requirements

"mwreq_item"Requirement (since R2024b)

"sl_req"

Requirement (for R2024a and earlier)
"sl_req_file"Requirement file
"sl_req_table"Requirements Table

Stateflow®

"sf_chart"Stateflow chart
"sf_graphical_fcn"Stateflow graphical function
"sf_group"Stateflow group
"sf_state"Stateflow state
"sf_state_transition_chart"Stateflow state transition chart
"sf_truth_table"Stateflow truth table

Simulink®

"sl_block_diagram"Block diagram
"sl_data_dictionary_file"Data dictionary file
"sl_embedded_matlab_fcn"MATLAB function
"sl_block_diagram"Block diagram
"sl_library_file"Library file
"sl_model_file"Simulink model file
"sl_protected_model_file"Protected Simulink model file
"sl_subsystem"Subsystem
"sl_subsystem_file"Subsystem file
"sl_subsystem"Subsystem

System Composer™

"zc_block_diagram"System Composer architecture
"zc_component"System Composer architecture component
"zc_file"System Composer architecture file
Tests"harness_info_file"Harness info file
"sl_harness_block_diagram"Harness block diagram
"sl_harness_file"Test harness file
"sl_test_case"Simulink Test™ case
"sl_test_case_result"Simulink Test case result
"sl_test_file"Simulink Test file
"sl_test_iteration"Simulink Test iteration
"sl_test_iteration_result"Simulink Test iteration result
"sl_test_report_file"Simulink Test result report
"sl_test_result_file"Simulink Test result file
"sl_test_resultset"Simulink Test result set
"sl_test_seq"Test Sequence
"sl_test_suite"Simulink Test suite
"sl_test_suite_result"Simulink Test suite result

Example: "zc_file"

Initial query that runs before iteration query, specified as either a padv.Query object or the Name of a padv.Query object. When you specify an iteration query for a task, the parent query is the initial query that the build system runs before running the specified iteration query.

For information on how to improve Process Advisor load times by sharing query instances across your process model, see Best Practices for Process Model Authoring.

Example: sharedFindModelsQuery

Example: "padv.builtin.query.FindModels"

Unique identifier for query, specified as a string or a character vector.

Example: "FindModelsWithTests"

Data Types: char | string

Show file extensions in the Alias property of returned artifacts, specified as a numeric or logical 1 (true) or 0 (false). The Alias property controls the display name for the artifact in the Tasks column in Process Advisor.

By default, queries strip file extensions from the Alias property of each task iteration artifact. To show file extensions for all artifacts in the Tasks column, select the project setting Show file extensions. To keep file extensions in the results for a specific query, specify the query property ShowFileExtension as true.

Example: true

Data Types: logical

Setting for automatically sorting artifacts by address, specified as a numeric or logical 1 (true) or 0 (false). When a query returns artifacts, the artifacts should be in a consistent order. By default, the build system sorts artifacts by the artifact address.

Alternatively, you can sort artifacts in a different order by overriding the internal sortArtifacts method in a subclass that defines a custom sort behavior. For an example, see Sort Artifacts in Specific Order.

The build system automatically calls the sortArtifacts method when using the process model. The sortArtifacts method expects two input arguments: a padv.Query object and a list of padv.Artifact objects returned by the run method. The sortArtifacts method should return a list of sorted padv.Artifact objects.

Example: SortArtifacts = false

Data Types: logical

Handle to the function that a function-based query runs, specified as a function_handle.

If you define your query functionality inside a function and you or the build system call run on the query, the query runs the function specified by the function_handle.

The built-in queries are defined inside classes and do not use the FunctionHandle.

Example: FunctionHandle = @FunctionForQuery

Data Types: function_handle

Methods

expand all

Examples

collapse all

You can use the FindModelsWithTestCases query in your process model to find units and components that your tasks can iterate over (IterationQuery). Suppose you have a custom task that you want to run for each model in your project that has test cases. You can find those models by using the built-in query FindModelsWithTestCases.

Open a project. For this example, open the Process Advisor example project.

processAdvisorExampleStart

To have the custom task run for each of those models, specify the query as the iteration query for the task. For example, in your process model:

pm.addTask("MyCustomTask",...
    IterationQuery = padv.builtin.query.FindModelsWithTestCases);

In Process Advisor, view the updated Tasks by clicking Refresh Tasks and switching to the Project view. For the task MyCustomTask, there is one task iteration for each model that has test cases. The Process Advisor example project has two models that have test cases: AHRS_Voter and OuterLoop_Control.

Capabilities and Limitations

This table identifies functionality that is supported by the query.

FunctionalitySupported?

Input query for task

No.

Iteration query for task

Yes. See IterationQuery.

See Also

| | |