Documentation Center

  • Trial Software
  • Product Updates

matlab.unittest.TestSuite.fromFolder

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

Create TestSuite array from all tests in folder

Syntax

  • suite = matlab.unittest.TestSuite.fromFolder(folder) example
  • suite = matlab.unittest.TestSuite.fromFolder(folder,s) example
  • suite = matlab.unittest.TestSuite.fromFolder(___,Name,Value) example

Description

example

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, 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.

example

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.

example

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 test methods, specified as a string. folder can be either an absolute or relative path to the desired folder.

s

Selector, specified as an instance of a class from the matlab.unittest.selector package.

Name-Value Pair Arguments

'IncludingSubfolders'

Include test methods from any folder subfolders, excluding package, class, and private folders. This property is false by default. You can specify it as true during construction.

'Name'

String indicating the name of the suite element. To include a test element in the suite, the Name property of the test element must match the specified name. Use the wildcard character, *, to match any number of characters. Use the question mark character, ?, to match to exactly one character.

'ParameterProperty'

String indicating the name of a property that defines a parameter used by the test suite element. Use the wildcard character, *, to match any number of characters. Use the question mark character, ?, to match to exactly one character.

'ParameterName'

String indicating the name of a parameter used by the test suite element. Use the wildcard character, *, to match any number of characters. Use the question mark character, ?, to match to exactly one character.

'BaseFolder'

String indicating the name of the folder that contains the file defining the test class or function. For a test element to be included in the suite, the test element must be contained in the specified base folder. Use the wildcard character, *, to match any number of characters. Use the question mark character, ?, to match to exactly one character. For test classes defined in packages, the base folder is the parent of the top-level package folder.

Output Arguments

suite

Set of tests, specified as a matlab.unittest.Test array.

Attributes

Statictrue

To learn about attributes of methods, see Method Attributes in the MATLAB Object-Oriented Programming documentation.

Examples

expand all

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)'

See Also

| |

Was this topic helpful?