Documentation

This is machine translation

Translated by Microsoft
Mouseover text to see original. Click the button below to return to the English verison of the page.

Note: This page has been translated by MathWorks. Please click here
To view all translated materals including this page, select Japan from the country navigator on the bottom of this page.

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)
suite = matlab.unittest.TestSuite.fromFolder(folder,s)
suite = matlab.unittest.TestSuite.fromFolder(___,Name,Value)

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

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 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 from the matlab.unittest.selector package.

Name-Value Pair Arguments

'BaseFolder'

Character vector or string scalar indicating the name of the folder that contains the file defining the tests. This argument filters TestSuite array elements. 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.

'IncludingSubfolders'

Indicator for whether to include tests from any folder subfolders, excluding package, class, and private folders, specified as false or true (logical 0 or 1). This property is false by default. You can specify it as true during construction.

'Name'

Character vector or string scalar indicating the name of the suite element. This argument filters TestSuite array elements. 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.

'ParameterName'

Character vector or string scalar indicating the name of a parameter used by the test suite element. This argument filters TestSuite array elements. Use the wildcard character, *, to match any number of characters. Use the question mark character, ?, to match to exactly one character.

'ParameterProperty'

Character vector or string scalar indicating the name of a property that defines a parameter used by the test suite element. This argument filters TestSuite array elements. Use the wildcard character, *, to match any number of characters. Use the question mark character, ?, to match to exactly one character.

'ProcedureName'

Name of test procedure, specified as a character vector or string scalar. This argument filters TestSuite array elements. Use the wildcard character, *, to match any number of characters. Use the question mark character, ?, to match to exactly one 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.

'Tag'

Character vector or string scalar indicating the name of the tag applied to the test suite element. This argument filters TestSuite array elements. This argument filters TestSuite array elements. Use the wildcard character, *, to match any number of characters. Use the question mark character, ?, to match exactly one character.

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

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

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

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

Introduced in R2013a

Was this topic helpful?