matlab.unittest.TestSuite.fromMethod

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

Create TestSuite array from single test method

Syntax

  • suite = matlab.unittest.TestSuite.fromMethod(testClass,testMethod) example
  • suite = matlab.unittest.TestSuite.fromMethod(testClass,testMethod,s) example
  • suite = matlab.unittest.TestSuite.fromMethod(___,Name,Value) example

Description

example

suite = matlab.unittest.TestSuite.fromMethod(testClass,testMethod) creates a TestSuite array from the test class described by testClass and the test method described by testMethod and returns it in suite.

example

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

example

suite = matlab.unittest.TestSuite.fromMethod(___,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.

Tips

  • testClass must be on the MATLAB® path when using this method to create suite, as well as when suite is run.

Input Arguments

testClass

Class describing the test methods, specified as a meta.class instance which must derive from matlab.unittest.TestCase.

testMethod

Test method, specified by either the meta.method instance or the name as a string. The method must be defined with a Test method attribute.

s

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

Name-Value Pair Arguments

'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 a Single Test Method

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

import matlab.unittest.TestSuite;
cls = ?mypackage.MyTestClass;
    
% Create the suite using the method name
suite = TestSuite.fromMethod(cls, 'testMethod');
result = run(suite)
 
% Create the suite using the meta.method instance
metaMethod = findobj(cls.MethodList, 'Name', 'testMethod');
suite = TestSuite.fromMethod(cls, metaMethod);
result = run(suite)

Create Suite of Test Elements Using Selector

In your working 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 from the testClass method that use the parameter name 'double'.

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

suite = TestSuite.fromMethod(?testZeros,'testClass', ...
    HasParameter('Name','single'));
{suite.Name}'
ans = 

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

Create Suite of Test Elements Using Name-Value Arguments

Create the testZeros.m class from the previous example.

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

import matlab.unittest.TestSuite;

suite = TestSuite.fromMethod(?testZeros,'testClass', ...
    'ParameterName','single');
{suite.Name}'
ans = 

    'testZeros/testClass(type=single,outSize=s2d)'
    'testZeros/testClass(type=single,outSize=s3d)'
Was this topic helpful?