matlab.unittest.TestSuite.fromProject

Class: matlab.unittest.TestSuite
Namespace: matlab.unittest

Create test suite from tests in project

Syntax

suite = matlab.unittest.TestSuite.fromProject(project)

suite = matlab.unittest.TestSuite.fromProject(project,selector)

suite = matlab.unittest.TestSuite.fromProject(___,Name=Value)

Description

suite = matlab.unittest.TestSuite.fromProject(project) creates a test suite from the tests in the specified MATLAB^® project. The method includes tests defined in project files with the Test classification label. For more information about projects and classification labels, see Create Projects.

suite = matlab.unittest.TestSuite.fromProject(project,selector) includes only the tests that satisfy the conditions of the specified selector.

suite = matlab.unittest.TestSuite.fromProject(___,Name=Value) specifies options using one or more name-value arguments in addition to any of the input argument combinations in previous syntaxes. For example, suite = matlab.unittest.TestSuite.fromProject(project,IncludingReferencedProjects=true) creates a test suite from the tests in the specified project and its referenced projects.

Input Arguments

project — Project containing tests

string scalar | character vector | matlab.project.Project object

Project containing the tests, specified as one of these values:

• String scalar or character vector — Specify the path to the project root folder.

• matlab.project.Project object — Specify the object representing the project. When you specify an object, the project must be open.

The method includes tests defined in project files that have the Test classification label.

Example: "C:\work\myProject"

Example: currentProject

selector — Selector

matlab.unittest.selectors.Selector object

Selector, specified as a matlab.unittest.selectors.Selector object.

Example: matlab.unittest.selectors.HasTag

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: suite = matlab.unittest.TestSuite.fromProject(project,IncludingReferencedProjects=true)

IncludingReferencedProjects — Option to include tests from referenced projects

false or 0 (default) | true or 1

Option to include tests from referenced projects in the test suite, specified as a numeric or logical 0 (false) or 1 (true). By default, the method does not include tests from referenced projects. For more information about referenced projects, see Componentize Large Projects.

ExternalParameters — External parameters to use in tests

array of matlab.unittest.parameters.Parameter objects

External parameters to use in the tests, specified as an array of matlab.unittest.parameters.Parameter objects. Use this argument to specify external parameters instead of the existing parameters in a parameterized test. For more information, see Use External Parameters in Parameterized Test.

BaseFolder — Name of base folder

string array | character vector | cell array of character vectors

Name of the base folder that contains the test file, specified as a string array, character vector, or cell array of character vectors. This argument filters the test suite. For the testing framework to include a test in the filtered suite, the Test element must be contained in one of the base folders specified by BaseFolder. If none of the Test elements match a base folder, an empty test suite is returned. Use the wildcard character (*) to match any number of characters. Use the question mark character (?) to match a single character.

For test files defined in namespaces, the base folder is the parent of the top-level namespace folder.

DependsOn — Names of files and folders that contain source code

string vector | character vector | cell vector of character vectors

Names of the files and folders that contain source code, specified as a string vector, character vector, or cell vector of character vectors. This argument filters the test suite by including only the tests that depend on the specified source code. If none of the tests depend on the source code, an empty test suite is returned.

The specified value must represent at least one existing file. If you specify a folder, the framework extracts the paths to the files within the folder.

You must have a MATLAB Test™ license to use DependsOn. For more information about selecting tests by source code dependency, see matlabtest.selectors.DependsOn (MATLAB Test).

Example: DependsOn=["myFile.m" "myFolder"]

Example: DependsOn=["folderA" "C:\work\folderB"]

Name — Name of test

string array | character vector | cell array of character vectors

Name of the test, specified as a string array, character vector, or cell array of character vectors. This argument filters the test suite. For the testing framework to include a test in the filtered suite, the Name property of the Test element must match one of the names specified by Name. If none of the Test elements have a matching name, an empty test suite is returned. Use the wildcard character (*) to match any number of characters. Use the question mark character (?) to match a single character.

For a given test file, the name of a test uniquely identifies the smallest runnable portion of the test content. The test name includes the namespace name, filename (excluding the extension), procedure name, and information about parameterization.

ParameterProperty — Name of parameterization property

string array | character vector | cell array of character vectors

Name of a test class property that defines a parameter used by the test, specified as a string array, character vector, or cell array of character vectors. This argument filters the test suite. For the testing framework to include a test in the filtered suite, the Parameterization property of the Test element must contain at least one of the property names specified by ParameterProperty. If none of the Test elements have a matching property name, an empty test suite is returned. Use the wildcard character (*) to match any number of characters. Use the question mark character (?) to match a single character.

ParameterName — Name of parameter

string array | character vector | cell array of character vectors

Name of a parameter used by the test, specified as a string array, character vector, or cell array of character vectors. MATLAB generates parameter names based on the test class property that defines the parameters. For example:

• If the property value is a cell array, MATLAB generates parameter names from the elements of the cell array by taking into account their values, types, and dimensions.

• If the property value is a structure, MATLAB generates parameter names from the structure fields.

The ParameterName argument filters the test suite. For the testing framework to include a test in the filtered suite, the Parameterization property of the Test element must contain at least one of the parameter names specified by ParameterName. If none of the Test elements have a matching parameter name, an empty test suite is returned. Use the wildcard character (*) to match any number of characters. Use the question mark character (?) to match a single character.

ProcedureName — Name of test procedure

string array | character vector | cell array of character vectors

Name of the test procedure, specified as a string array, character vector, or cell array of character vectors. This argument filters the test suite. For the testing framework to include a test in the filtered suite, the ProcedureName property of the Test element must match one of the procedure names specified by ProcedureName. If none of the Test elements have a matching procedure name, an empty test suite is returned. Use the wildcard character (*) to match any number of characters. Use the question mark character (?) to match a single character.

In a class-based test, the name of a test procedure is the name of a Test method that contains the test. In a function-based test, it is the name of a local function that contains the test. In a script-based test, it is a name generated from the test section title. Unlike the name of a test suite element, the name of a test procedure does not include any namespace name, filename, or information about parameterization.

Superclass — Name of class that test class derives from

string array | character vector | cell array of character vectors

Name of the class that the test class derives from, specified as a string array, character vector, or cell array of character vectors. This argument filters the test suite. For the testing framework to include a test in the filtered suite, the TestClass property of the Test element must point to a test class that derives from one of the classes specified by Superclass. If none of the Test elements match a class, an empty test suite is returned.

Tag — Name of tag

string array | character vector | cell array of character vectors

Name of a tag used by the test, specified as a string array, character vector, or cell array of character vectors. This argument filters the test suite. For the testing framework to include a test in the filtered suite, the Tags property of the Test element must contain at least one of the tag names specified by Tag. If none of the Test elements have a matching tag name, an empty test suite is returned. Use the wildcard character (*) to match any number of characters. Use the question mark character (?) to match a single character.

Output Arguments

suite — Test suite

matlab.unittest.TestSuite array

Test suite, returned as a matlab.unittest.TestSuite array.

Attributes

Static

true

To learn about attributes of methods, see Method Attributes.

Examples

Create Test Suite from Project

Create a test suite from files with the Test classification label in your project.

Suppose that the folder C:\work\myProject is your project root folder. Open the project, and then create a test suite from tests defined in project files with the Test label. Run the resulting test suite and capture the test results.

import matlab.unittest.TestSuite

project = openProject("C:\work\myProject");
suite = TestSuite.fromProject(project);
results = run(suite);

Include Tests from Referenced Projects

Create a test suite from files with the Test classification label in your project and its referenced projects.

Suppose that the folder C:\work\myProject is your project root folder. Using the IncludingReferencedProjects name-value argument, create a test suite from files with the Test classification label in your project and its referenced projects. Run the resulting test suite and capture the test results.

import matlab.unittest.TestSuite

suite = TestSuite.fromProject("C:\work\myProject", ...
    IncludingReferencedProjects=true);
results = run(suite);

Limitations

• You cannot use the matlab.unittest.TestSuite.fromProject method in compiled applications created with MATLAB Compiler™. For more information, see Functions Not Supported for Compilation by MATLAB Compiler and MATLAB Compiler SDK (MATLAB Compiler).

Version History

Introduced in R2019a

R2025a: Improved accuracy of test selection by source code dependency

When you select function-based or class-based tests using the DependsOn name-value argument or the matlabtest.selectors.DependsOn class (requires MATLAB Test), the method more accurately selects tests that depend on the specified source code. If the method can determine which individual tests in the test file depend on the source code, then it selects only the dependent tests and excludes the rest. Otherwise, the method includes all the tests in the test file.

In previous releases, the method includes all the tests in a test file if the file depends on the specified source code, without attempting to exclude tests that are not dependent on the source code.

R2024a: Specify any type of source file when filtering test suite by source code dependency

If you have a MATLAB Test license, you can specify any type of source file using the DependsOn name-value argument or the matlabtest.selectors.DependsOn class. In previous releases, you can specify files only with a .m, .p, .mlx, .mlapp, .mat, or .slx extension.

R2023a: Filter test suite by source code dependency

If you have a MATLAB Test license, you can filter a test suite by test file dependency on specified source code. Use the DependsOn name-value argument or the matlabtest.selectors.DependsOn class to specify the source files and folders.

R2022b: Parameter names generated from cell arrays are more descriptive

When you assign a nonempty cell array to a parameterization property, the testing framework generates parameter names from the elements of the cell array by taking into account their values, types, and dimensions. In previous releases, if the property value is a cell array of character vectors, the framework generates parameter names from the values in the cell array. Otherwise, the framework specifies parameter names as value1, value2, …, valueN.

If your code uses parameter names to create or filter test suites, replace the old parameter names with the descriptive parameter names. For example, update suite = testsuite(pwd,"ParameterName","value1") by replacing value1 with a descriptive parameter name.

R2021b: matlab.unittest.TestSuite.fromProject ignores the files that do not define test procedures when creating a test suite

If your project includes files with the Test classification, matlab.unittest.TestSuite.fromProject ignores the files that do not define test procedures when creating a test suite. For example, if an abstract TestCase class definition file is labeled with the Test classification, fromProject ignores it. In previous releases, MATLAB produces an error if fromProject is called on a project that uses the Test classification for any files other than concrete test files. With this change, fromProject becomes consistent with the matlab.unittest.TestSuite.fromFolder method: both methods create a test suite from all the concrete test files and ignore any other files in the folder.

This behavior change also applies to the testsuite, runtests, and runperf functions when they operate on code organized into files and folders within a project.