matlab.unittest.TestSuite.fromFolder

Class: matlab.unittest.TestSuite
Package: matlab.unittest

Create TestSuite array from tests in folder

Syntax

suite = matlab.unittest.TestSuite.fromFolder(folder)

suite = matlab.unittest.TestSuite.fromFolder(folder,s)

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

Description

suite = matlab.unittest.TestSuite.fromFolder(folder) creates a TestSuite array from all of the Test methods of all concrete TestCase classes contained in folder and returns that array in suite. If tests are function-based or script-based, a Test file is included in the TestSuite array if it follows the naming convention of starting or ending in the word ‘test’, which is case-insensitive. Class-based tests do not need to follow this naming convention. The method is not recursive, returning only those tests directly in the specified folder.

When the test suite is run, MATLAB^® changes the current folder to the folder that defines the test content, and adds it to the path for the duration of the test run.

suite = matlab.unittest.TestSuite.fromFolder(folder,s) creates a TestSuite array from all of the Test methods contained in folder that satisfy the conditions specified by the selector, s.

suite = matlab.unittest.TestSuite.fromFolder(___,Name,Value) creates a TestSuite array with additional options specified by one or more Name,Value pair arguments. You can use this syntax with any of the input arguments of the previous syntaxes.

Input Arguments

folder	Folder containing tests, specified as a character vector or string scalar. folder can be either an absolute or relative path to the desired folder.
s	Selector, specified as an instance of a class in the matlab.unittest.selectors package. If you have MATLAB Test™ installed, you also can specify s as a matlabtest.selectors.DependsOn object.

Name-Value Arguments

IncludingSubfolders	Whether to include tests from any of the subfolders, excluding class and private folders, specified as false or true (logical 0 or 1). The value is false by default.
InvalidFileFoundAction	Action to take against an invalid test file in the folder, specified as "warn" or "error". By default, the value is "warn". When the value is "warn", the method issues a warning for each invalid test file in the folder and creates a test suite from the valid files. When the value is "error", the method throws an error if it finds an invalid test file in the folder. An invalid test file is a test file from which the framework cannot generate a test suite. Examples include a test file that contains syntax errors, a function-based test file that is missing local functions, and a file with a Test method that is passed an undefined parameterization property.
ExternalParameters	External parameters, specified as an array of matlab.unittest.parameters.Parameter objects. The framework uses these external parameters in place of the corresponding parameters that are defined within a parameterized test. For more information, see Use External Parameters in Parameterized Test.
BaseFolder	Name of the folder that contains the file defining the tests, specified as a string array, character vector, or cell array of character vectors. This argument filters TestSuite array elements. For the testing framework to include a test in the 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.
DependsOn	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 with a .m, .p, .mlx, .mlapp, .mat, or .slx extension. You cannot explicitly specify a filename with an unsupported extension. If you specify a folder name, the framework extracts the paths to the supported files within the folder. You must have MATLAB Test installed to use DependsOn. For more information about selecting tests by source code dependency, see matlabtest.selectors.DependsOn (MATLAB Test). Example: ["myFile.m" "myFolder"] Example: ["folderA" "C:\work\folderB"]
Name	Name of the suite element, specified as a string array, character vector, or cell array of character vectors. This argument filters TestSuite array elements. For the testing framework to include a test in the 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.
ParameterProperty	Name of a test class property that defines a parameter used by the test suite element, specified as a string array, character vector, or cell array of character vectors. This argument filters TestSuite array elements. For the testing framework to include a test in the 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 to a single character.
ParameterName	Name of a parameter used by the test suite element, 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: 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 TestSuite array elements. For the testing framework to include a test in the 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 the test procedure, specified as a string array, character vector, or cell array of character vectors. This argument filters TestSuite array elements. For the testing framework to include a test in the 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 ProcedureName is the name of the test method. In a function-based test, it is the name of the local function that contains the test. In a script-based test, it is a name generated from the test section title. Unlike Name, the name of the test procedure does not include any class or package name or information about parameterization.
Superclass	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 TestSuite array elements. For the testing framework to include a test in the 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 a test tag used by the test suite element, specified as a string array, character vector, or cell array of character vectors. This argument filters TestSuite array elements. For the testing framework to include a test in the 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, specified as a matlab.unittest.Test array.

Attributes

Static

true

To learn about attributes of methods, see Method Attributes.

Examples

Run Tests in Current Folder

Add the matlab.unittest.TestSuite class to the current import list.

import matlab.unittest.TestSuite;

suite = TestSuite.fromFolder(pwd);
result = run(suite);

Run Tests in Subfolders

suite = TestSuite.fromFolder(pwd, 'IncludingSubfolders', true);
result = run(suite);

Create Suite of Test Elements Using Selector

In your working folder, create a new folder, myTests. In that folder, create the following testZeros.m test file. This class contains four test methods.

classdef testZeros < matlab.unittest.TestCase
    properties (TestParameter)
        type = {'single','double','uint16'};
        outSize = struct('s2d',[3 3], 's3d',[2 5 4]);
    end
    
    methods (Test)
        function testClass(testCase, type, outSize)
            testCase.verifyClass(zeros(outSize,type), type);
        end
        
        function testSize(testCase, outSize)
            testCase.verifySize(zeros(outSize), outSize);
        end
        
        function testDefaultClass(testCase)
            testCase.verifyClass(zeros, 'double');
        end
        function testDefaultSize(testCase)
            testCase.verifySize(zeros, [1 1]);
        end
        
        function testDefaultValue(testCase)
            testCase.verifyEqual(zeros,0);
        end
    end
end

The test class contains two parameterized test methods, testClass and testSize.

At the command prompt, create a test suite from all parameterized tests that use the parameter name 'double'.

import matlab.unittest.TestSuite;
import matlab.unittest.selectors.HasParameter;

suite = TestSuite.fromFolder('myTests', HasParameter('Name','double'));
{suite.Name}'

ans = 

    'testZeros/testClass(type=double,outSize=s2d)'
    'testZeros/testClass(type=double,outSize=s3d)'

Create Suite of Test Elements Using Name-Value Arguments

Create the myTests folder and testZeros.m class from the previous example.

Create a test suite of all tests that use the parameter name 'double'.

import matlab.unittest.TestSuite;

suite = TestSuite.fromFolder('myTests', 'ParameterName', 'double');
{suite.Name}'

ans = 

    'testZeros/testClass(type=double,outSize=s2d)'
    'testZeros/testClass(type=double,outSize=s3d)'

Version History

Introduced in R2013a

R2023a: Filter test suite by source code dependency

If you have MATLAB Test installed, 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: Specify action to take against invalid test files

To specify whether the testing framework issues a warning or throws an error when it encounters an invalid test file in a folder, use the InvalidFileFoundAction name-value argument.

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.

R2022a: matlab.unittest.TestSuite.fromFolder includes tests from package folders when creating a test suite

The matlab.unittest.TestSuite.fromFolder method treats folders and packages the same way, and includes tests defined within package folders when creating a test suite. For example, suite = matlab.unittest.TestSuite.fromFolder(pwd,IncludingSubfolders=true) creates a suite from all the test files in the current folder and any of its subfolders, including package folders. In previous releases, the method ignores any tests defined in a package folder and its subfolders.

This behavior change also applies to the testsuite, runtests, and runperf functions when they operate on a folder containing tests. With the consistent treatment of folders and packages, creating a suite from all test files within a folder and its subfolders becomes more convenient and independent of the folder structure.

To exclude tests defined within packages, filter the suite being constructed or returned by fromFolder. For example, create a filtered test suite comprising tests whose names do not include any dots (that is, do not refer to any packages).

import matlab.unittest.TestSuite
import matlab.unittest.selectors.HasName
import matlab.unittest.constraints.ContainsSubstring
suite = TestSuite.fromFolder(pwd,HasName(~ContainsSubstring(".")), ...
    IncludingSubfolders=true);