Main Content

testsuite

Create suite of tests

Description

example

suite = testsuite creates a suite of tests from your current folder, and returns the suite as a Test array.

To run a test suite created with testsuite, use the run method of matlab.unittest.TestSuite, matlab.unittest.TestRunner, or matlab.perftest.TimeExperiment.

suite = testsuite(tests) creates a suite from a set of specified tests.

example

suite = testsuite(tests,Name,Value) creates a suite of tests with additional options specified by one or more Name,Value pair arguments.

Examples

collapse all

Create a folder myExample in your current working folder, make it your current working folder, and create a couple of tests.

In the myExample folder, create a script-based test, onesTest.m.

%% Test double class
expClass = 'double';
act = ones;
assert(isa(act,expClass))

%% Test single class
expClass = 'single';
act = ones('single');
assert(isa(act,expClass))

%% Test uint16 class
expClass = 'uint16';
act = ones('uint16');
assert(isa(act,expClass))

%% Test size
expSize = [7 13];
act = ones([7 13]);
assert(isequal(size(act),expSize))

%% Test values
act = ones(42);
assert(unique(act) == 1)

In the myExample folder, create a function-based test, eyeTest.m.

function tests = eyeTest
tests = functiontests(localfunctions);

function doubleClassTest(testCase)
actValue = eye;
verifyClass(testCase,actValue,'double')

function singleClassTest(testCase)
actValue = eye('single');
verifyClass(testCase,actValue,'single')

function uint16ClassTest(testCase)
actValue = eye('uint16');
verifyClass(testCase,actValue,'uint16')

function sizeTest(testCase)
expSize = [7 13];
actValue = eye(expSize);
verifySize(testCase,actValue,expSize);

function valueTest(testCase)
actValue = eye(42);
verifyEqual(testCase,unique(diag(actValue)),1)    % diagonal are 1s
verifyEqual(testCase,unique(triu(actValue,1)),0)  % upper tri vals are 0
verifyEqual(testCase,unique(tril(actValue,-1)),0) % lower tri vals are 0

Create a test suite from all tests in the current folder.

suite = testsuite
suite = 

  1×10 Test array with properties:

    Name
    BaseFolder
    ProcedureName
    SharedTestFixtures
    Parameterization
    Tags

Tests Include:
   0 Parameterizations, 0 Shared Test Fixture Classes, 0 Tags.

If onesTest and eyesTest are the only tests in your folder, MATLAB® creates a suite of 10 tests.

View the names of the tests in suite.

{suite.Name}'
ans = 

    'eyeTest/doubleClassTest'
    'eyeTest/singleClassTest'
    'eyeTest/uint16ClassTest'
    'eyeTest/sizeTest'
    'eyeTest/valueTest'
    'onesTest/TestDoubleClass'
    'onesTest/TestSingleClass'
    'onesTest/TestUint16Class'
    'onesTest/TestSize'
    'onesTest/TestValues'

Create a test suite from all tests in eyeTest.

suite2 = testsuite('eyeTest')
suite2 = 

  1×5 Test array with properties:

    Name
    BaseFolder
    ProcedureName
    SharedTestFixtures
    Parameterization
    Tags

Tests Include:
   0 Parameterizations, 0 Shared Test Fixture Classes, 0 Tags.

In your working folder, create a class-based test, testZeros.m. This class contains five 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 full test suite has 11 test elements: 6 from the testClass method, 2 from the testSize method, and 1 each from the testDefaultClass, testDefaultSize, and testDefaultValue methods.

Create a test suite from the test elements with test names that contain 'Default'.

suite = testsuite('testZeros','Name','*Default*')
suite = 

  1x3 Test array with properties:

    Name
    ProcedureName
    TestClass
    BaseFolder
    Parameterization
    SharedTestFixtures
    Tags

Tests Include:
   0 Parameterizations, 0 Shared Test Fixture Classes, 0 Tags.

Create a test suite from the test elements that use the outSize parameter property.

suite = testsuite('testZeros','ParameterProperty','outSize')
suite = 

  1x8 Test array with properties:

    Name
    ProcedureName
    TestClass
    BaseFolder
    Parameterization
    SharedTestFixtures
    Tags

Tests Include:
   5 Unique Parameterizations, 0 Shared Test Fixture Classes, 0 Tags.

The test suite contains eight tests that use the outSize parameter property: six from the testClass method and two from the testSize method.

Input Arguments

collapse all

Suite of tests specified as a string array, character vector, or cell array of character vectors. Each character vector in the cell array can contain the name of a test file, a test class, a test suite element name, a package containing your test classes, a folder containing your test files, or a project folder containing test files.

Example: testsuite('myTestFile.m')

Example: testsuite('myTestFile/aTest')

Example: testsuite('mypackage.MyTestClass')

Example: testsuite(pwd)

Example: testsuite({'mypackage.MyTestClass','myTestFile.m',pwd,'mypackage.subpackage'})

Example: testsuite('C:/projects/project1/')

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: suite = testsuite(tests,'Name','productA_*') creates a test suite from tests that have names starting with 'productA_'.

Name of the base folder that contains the file defining the test class, function, or script, 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 matches 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 packages, the base folder is the parent of the top-level package folder.

Indicator to include tests in subfolders in the suite, specified as false or true (0 or 1). By default the framework creates a suite from tests in the specified folders and not in their subfolders.

Data Types: logical

Indicator to include tests in subpackages in the suite, specified as false or true (0 or 1). By default the framework creates a suite from tests in the specified package and not in their subpackages.

Data Types: logical

Indicator to include tests from referenced projects, specified as false or true. For more information on referenced projects, see Componentize Large Projects.

Data Types: logical

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

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

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 of character vectors, MATLAB generates parameter names from the values in the cell array. Otherwise, MATLAB specifies parameter names as value1, value2, …, valueN.

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

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

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 matches a class, an empty test suite is returned.

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

More About

collapse all

Create Test Suite from MLDATX Files

You can use the testsuite function to create a test suite from an MLDATX file (requires Simulink® Test™). For example, suite = testsuite('myTestFile.mldatx') creates a suite from the tests specified in the file myTestFile.mldatx.

When you specify an MLDATX file, testsuite creates a suite including all of the tests in the file. You cannot instruct testsuite to create a suite from specific tests in an MLDATX file.

Tips

  • If you do not need to create a test suite explicitly, use runtests or runperf to create the suite implicitly before running the tests.

  • An alternative way to create an explicit test suite is to use the matlab.unittest.TestSuite methods.

  • When you specify the input to the testsuite function as a string array or cell array of character vectors (for example, suite = testsuite(["Test1","Test2"])), the testing framework sorts the array to reduce shared test fixture setup and teardown operations. As a result, the tests might run in an order that is different from the order of elements in the input array.

    To enforce the order of the test run, create the suite by using several calls to testsuite. For example, to ensure that the tests specified by Test1 run before the tests specified by Test2, use this syntax:

    suite = [testsuite("Test1") testsuite("Test2")]
    

Introduced in R2016a