matlab.unittest.TestSuite.fromProject
Class: matlab.unittest.TestSuite
Namespace: matlab.unittest
Create test suite from tests in project
Syntax
Description
creates a suite
= matlab.unittest.TestSuite.fromProject(project
)TestSuite
array from all test files contained in the specified
project that are labeled with the Test
classification. The
project
input is either a loaded matlab.project.Project
object or the root folder of a project. This method is
not recursive. It includes only those tests in the project specified. To include tests from
referenced projects, specify the IncludingReferencedProjects
name-value
argument as true
. For more information on projects, see Projects.
creates a suite
= matlab.unittest.TestSuite.fromProject(project
,selector
)TestSuite
array from all test files contained in the specified
project that are labeled with the Test
classification and that satisfy
the selector
. For more information on selectors, see matlab.unittest.selectors
.
creates a suite
= matlab.unittest.TestSuite.fromProject(___,Name,Value
)TestSuite
array from all test files contained in the specified
project that are labeled with the Test
classification and that satisfy
the conditions specified by one or more name-value arguments. Specify the name-value
arguments after all of the arguments in any of the previous syntaxes.
Input Arguments
project
— Project containing test files
path to project root folder | open Project
object
Project containing test files, specified as the path to the project root folder or
an open Project
object. A test file is a file that is classified as test
by adding the Test
label in the project.
Example: 'C:\MyProjects\ThisProject'
Data Types: char
| string
selector
— Filter for TestSuite
array elements
instance of selector class
Filter for TestSuite
array elements, specified as an instance of
a class in the matlab.unittest.selectors
namespace. If
you have a MATLAB®
Test™ license, you also can specify selector
as a
matlabtest.selectors.DependsOn
or
matlabtest.selectors.HasBaseline
object.
Example: matlab.unittest.selectors.HasBaseFolder(fullfile(pwd,'MyTests','Feature1'))
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.
Before R2021a, use commas to separate each name and value, and enclose
Name
in quotes.
IncludingReferencedProjects
— Option to include tests from referenced projects
false (default) | true | 0
| 1
Option to include tests from referenced projects in the
TestSuite
, specified as logical true
or
false
. By default, fromProject
includes test
files only from the project specified in the input. Passing a value of
true
for IncludingReferencedProjects
results
in a TestSuite
array that includes the tests from the project specified
in the input and tests from projects referenced from the parent project. For more
information on referenced projects, see Componentize Large Projects.
Example: suite =
matlab.unittest.TestSuite.fromProject(project,'IncludingReferencedProjects',true);
Data Types: logical
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. For the testing framework to include a test in the filtered suite, the file that defines the test must depend on the specified source code. If none of the test files 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
— Set of tests
test suite
Set of tests, returned as a matlab.unittest.Test
array.
Examples
Build Test Suite from Project Files
Build a test suite from project files that are labeled as
Test
files. This example assumes that a project folder at
C:/projects/project1
contains test files that are labeled with the
Test
classification. Use the
matlab.unittest.TestSuite.fromProject
static method to create a test
suite using those tests.
Open project1
and pass the matlab.project.Project
object to fromProject
. Run the test suite and capture the
results.
import matlab.unittest.TestSuite project = openProject('C:/projects/project1/'); suite = TestSuite.fromProject(project); result = run(suite)
Include Tests from Referenced Projects
Build a test suite from project files that are labeled as
Test
files in the project and all referenced projects.
import matlab.unittest.TestSuite project = openProject('C:/projects/project1/'); suite = TestSuite.fromProject(project,'IncludingReferencedProjects',true); result = run(suite)
Version History
Introduced in R2019aR2024a: 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.
MATLAB Command
You clicked a link that corresponds to this MATLAB command:
Run the command by entering it in the MATLAB Command Window. Web browsers do not support MATLAB commands.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)