matlab.unittest.TestSuite.fromMethod

类： matlab.unittest.TestSuite
包： matlab.unittest

根据单个测试方法创建 TestSuite 数组

全页展开

语法

suite = matlab.unittest.TestSuite.fromMethod(testClass,testMethod)

suite = matlab.unittest.TestSuite.fromMethod(testClass,testMethod,s)

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

说明

示例

suite = matlab.unittest.TestSuite.fromMethod(testClass,testMethod) 根据 testClass 描述的测试类以及 testMethod 描述的测试方法创建 TestSuite 数组，并在 suite 中返回该数组。

示例

suite = matlab.unittest.TestSuite.fromMethod(testClass,testMethod,s) 根据 testMethod 中包含的所有 Test 方法创建 TestSuite 数组，这些方法满足选择器 s 指定的条件。

示例

suite = matlab.unittest.TestSuite.fromMethod(___,Name,Value) 使用由一个或多个 Name,Value 对组参数指定的其他选项创建 TestSuite 数组。您可将此语法与上述语法中的任何输入参数一起使用。

输入参数

`testClass`	描述测试方法的类，指定为必须派生自 `matlab.unittest.TestCase` 的 `meta.class` 实例。
`testMethod`	测试方法，通过 `meta.method` 实例或名称指定为字符向量或字符串标量。该方法必须用 `Test` 方法属性进行定义。
`s`	选择器，指定为 `matlab.unittest.selectors` 包中类的实例。如果您安装了 MATLAB^® Test™，则还可以将 `s` 指定为 `matlabtest.selectors.DependsOn` 对象。

名称-值参数

`ExternalParameters`	外部参数，指定为由 `matlab.unittest.parameters.Parameter` 对象组成的数组。框架使用这些外部参数代替在参数化测试中定义的对应参数。有关详细信息，请参阅在参数化测试中使用外部参数。
`BaseFolder`	包含用于定义测试类或函数的文件的顶层包文件夹父级的名称，指定为字符串数组、字符向量或字符向量元胞数组。此参数过滤 `TestSuite` 数组元素。要使测试框架包含套件中的一个测试，`Test` 元素必须包含在 `BaseFolder` 指定的基本文件夹之一中。如果没有 `Test` 元素与基本文件夹匹配，将返回空测试套件。使用通配符 `*` 以匹配任何数量的字符。使用问号字符 `?` 只匹配一个字符。
`DependsOn`	包含源代码的文件和文件夹的名称，指定为字符串向量、字符向量或字符向量元胞向量。此参数过滤测试套件。为了使测试框架在过滤后的套件中包括测试，定义测试的文件必须依赖指定的源代码。如果没有测试文件依赖源代码，则返回空测试套件。指定的值必须表示至少一个具有 `.m`、`.p`、`.mlx`、`.mlapp`、`.mat` 或 `.slx` 扩展名的现有文件。无法用不支持的扩展名显式指定文件名。如果指定文件夹名称，框架将提取该文件夹中受支持文件的路径。您必须安装 MATLAB Test 才能使用 `DependsOn`。有关通过源代码依存关系选择测试的详细信息，请参阅 `matlabtest.selectors.DependsOn` (MATLAB Test)。示例： `["myFile.m" "myFolder"]` 示例： `["folderA" "C:\work\folderB"]`
`Name`	套件元素的名称，指定为字符串数组、字符向量或字符向量元胞数组。此参数过滤 `TestSuite` 数组元素。要使测试框架包含套件中的一个测试，`Test` 元素的 `Name` 属性必须匹配 `Name` 指定的名称之一。如果 `Test` 元素都没有匹配的名称，将返回空测试套件。使用通配符 `*` 以匹配任何数量的字符。使用问号字符 `?` 只匹配一个字符。
`ParameterProperty`	定义测试套件元素使用的参数的测试类属性的名称，指定为字符串数组、字符向量或字符向量元胞数组。此参数过滤 `TestSuite` 数组元素。要使测试框架包含套件中的一个测试，`Test` 元素的 `Parameterization` 属性必须包含 `ParameterProperty` 指定的至少一个属性名称。如果 `Test` 元素都没有匹配的属性名称，将返回空测试套件。使用通配符 `*` 以匹配任何数量的字符。使用问号字符 `?` 只匹配一个字符。
`ParameterName`	测试套件元素使用的参数的名称，指定为字符串数组、字符向量或字符向量元胞数组。MATLAB 根据定义参数的测试类属性生成参数名称：如果属性值是元胞数组，则 MATLAB 根据元胞数组元素的值、类型和维度，基于元胞数组的元素生成参数名称。如果属性值是结构体，则 MATLAB 将根据结构体字段生成参数名称。 `ParameterName` 参数过滤 `TestSuite` 数组元素。要使测试框架包含套件中的一个测试，`Test` 元素的 `Parameterization` 属性必须包含 `ParameterName` 指定的至少一个参数名称。如果 `Test` 元素都没有匹配的参数名称，将返回空测试套件。使用通配符 `*` 以匹配任何数量的字符。使用问号字符 `?` 只匹配一个字符。
`ProcedureName`	测试过程的名称，指定为字符串数组、字符向量或字符向量元胞数组。此参数过滤 `TestSuite` 数组元素。要使测试框架包含套件中的一个测试，`Test` 元素的 `ProcedureName` 属性必须匹配 `ProcedureName` 指定的过程名称之一。如果 `Test` 元素都没有匹配的过程名称，将返回空测试套件。使用通配符 `*` 以匹配任何数量的字符。使用问号字符 `?` 只匹配一个字符。在基于类的测试中，`ProcedureName` 是测试方法的名称。在基于函数的测试中，它是包含测试的局部函数的名称。在基于脚本的测试中，它是从测试部分标题生成的名称。与 `Name` 不同的是，测试过程的名称不包括任何类或包名称或有关参数化的信息。
`Superclass`	派生测试类的父类的名称，指定为字符串数组、字符向量或字符向量元胞数组。此参数过滤 `TestSuite` 数组元素。要使测试框架包含套件中的一个测试，`Test` 元素的 `TestClass` 属性必须指向从 `Superclass` 指定的类之一派生的一个测试类。如果没有 `Test` 元素与类匹配，将返回空测试套件。
`Tag`	测试套件元素使用的测试标记的名称，指定为字符串数组、字符向量或字符向量元胞数组。此参数过滤 `TestSuite` 数组元素。要使测试框架包含套件中的一个测试，`Test` 元素的 `Tags` 属性必须包含 `Tag` 指定的至少一个标记名称。如果 `Test` 元素都没有匹配的标记名称，将返回空测试套件。使用通配符 `*` 以匹配任何数量的字符。使用问号字符 `?` 只匹配一个字符。

输出参数

suite

测试集，指定为 matlab.unittest.Test 数组。

属性

Static true

要了解方法的属性，请参阅方法属性。

示例

全部展开

运行单个测试方法

将 matlab.unittest.TestSuite 类添加到当前导入列表。

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)

使用选择器创建测试元素的套件

在您的工作文件夹中，创建以下 testZeros.m 测试文件。该类包含四种测试方法。

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

测试类包含两种参数化测试方法：testClass 和 testSize。

在命令提示符下，基于使用参数名称 'single' 的 testClass 方法中的所有参数化测试创建测试套件。

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

使用名称-值参数创建测试元素的套件

基于以前的示例创建 testZeros.m 类。

在命令提示符下，基于使用参数名称 'single' 的 testClass 方法中的所有参数化测试创建测试套件。

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

提示

使用此方法创建 suite 以及运行 suite 时，testClass 必须位于 MATLAB 路径上。

版本历史记录

在 R2013a 中推出

全部展开

R2023a: 按源代码依存关系过滤测试套件

如果您安装了 MATLAB Test，则可以按测试文件对指定源代码的依存关系来过滤测试套件。使用 DependsOn 名称-值参数或 matlabtest.selectors.DependsOn 类来指定源文件和文件夹。

R2022b: 从元胞数组生成的参数名称更具描述性

当您将非空元胞数组分配给参数化属性时，测试框架会根据元胞数组中元素的值、类型和维度生成参数名称。在以前的版本中，如果属性值是字符向量元胞数组，该框架将根据元胞数组中的值生成参数名称。否则，该框架将参数名称指定为 value1、value2、…、valueN。

如果您的代码使用参数名称来创建或过滤测试套件，请用描述性参数名称替换旧的参数名称。例如，通过用描述性参数名称替换 value1 来更新 suite = testsuite(pwd,"ParameterName","value1")。

另请参阅

TestRunner | fromClass | fromPackage | matlab.unittest.selectors