matlab.unittest.qualifications.Assumable 类

命名空间: matlab.unittest.qualifications

用于过滤测试内容的鉴定

描述

Assumable 类提供了一种用于过滤测试内容的鉴定机制。除了对失败执行的操作外，Assumable 类与 matlab.unittest.qualifications 命名空间中的其他鉴定类的工作方式相同。

假设失败时，Assumable 类将引发 AssumptionFailedException 对象以告知测试框架发生失败。然后，框架会将当前测试内容标记为已过滤并继续测试。假设确保测试仅在满足特定先决条件时运行，但其实在不满足此先决条件的情况下执行测试也不会导致测试失败。如果未满足先决条件会导致测试失败，请使用断言来代替假设。

当在 TestCase 类的一个方法中产生假设失败时，该方法的类型确定过滤哪些测试：

Test 方法 - 框架将整个 Test 方法标记为已过滤。
TestMethodSetup 或 TestMethodTeardown 方法 - 框架将针对该方法实例运行的 Test 方法标记为已过滤。
TestClassSetup 或 TestClassTeardown 方法 - 框架将整个测试类标记为已过滤。

当您使用假设时，请确保您的测试内容满足异常安全条件。由于假设不会导致测试失败，因此部分测试代码可能会以静默方式被过滤。为了避免产生无效的测试代码，请考虑监视您的已过滤测试。

matlab.unittest.qualifications.Assumable 类是一个 handle 类。

方法

全部展开

公共方法

Assumable 类为测试值和如何响应失败提供了几种鉴定方法。例如，assumeEmpty 测试某个值为空，而 assumeTrue 测试 actual 值为 true。

注意

Assumable 类的方法对应于 Verifiable 类的方法。它们仅在鉴定类型方面有所不同。您可以像调用 Verifiable 方法一样调用 Assumable 方法。

一般用途

`assumeEqual`	`assumeEqual(testCase,actual,expected,diagnostic,Name,Value)` 假设 `actual` 严格等于 `expected`。类似于 `verifyEqual`。输入参量 `testCase` - 测试用例。 `actual` - 要测试的值。 `expected` - 预期值。 `diagnostic` - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。名称-值参量 `AbsTol` - 绝对误差，指定为一个数值数组。 `RelTol` - 相对误差，指定为数值数组。
`assumeFail`	`assumeFail(testCase,diagnostic)` 生成无条件的假设失败。类似于 `verifyFail`。输入参量 `testCase` - 测试用例。 `diagnostic` - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeFalse`	`assumeFalse(testCase,actual,diagnostic)` 假设 `actual` 的值是逻辑值 `0` (`false`)。类似于 `verifyFalse`。输入参量 `testCase` - 测试用例。 `actual` - 要测试的值。 `diagnostic` - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeNotEqual`	`assumeNotEqual(testCase,actual,prohibited,diagnostic)` 假设 `actual` 不等于 `prohibited`。类似于 `verifyNotEqual`。输入参量 `testCase` - 测试用例。 `actual` - 要测试的值。 `prohibited` - 要用于比较的值。 `diagnostic` - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeNotSameHandle`	`assumeNotSameHandle(testCase,actual,prohibited,diagnostic)` 假设 `actual` 与禁止的句柄数组不同。类似于 `verifyNotSameHandle`。输入参量 `testCase` - 测试用例。 `actual` - 要测试的值。 `prohibited` - 要用于比较的值，指定为句柄数组。 `diagnostic` - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeReturnsTrue`	`assumeReturnsTrue(testCase,actual,diagnostic)` 假设 `actual` 是返回逻辑标量 `1` (`true`) 的函数句柄。类似于 `verifyReturnsTrue`。输入参量 `testCase` - 测试用例。 `actual` - 要测试的值。 `diagnostic` - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeSameHandle`	`assumeSameHandle(testCase,actual,expected,diagnostic)` 假设 `actual` 与预期的句柄数组相同。类似于 `verifySameHandle`。输入参量 `testCase` - 测试用例。 `actual` - 要测试的值。 `expected` - 预期值，指定为句柄数组。 `diagnostic` - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeThat`	`assumeThat(testCase,actual,constraint,diagnostic)` 假设 `actual` 是一个满足指定约束的值。类似于 `verifyThat`。输入参量 `testCase` - 测试用例。 `actual` - 要测试的值。 `constraint` - actual 值必须满足的约束，指定为 `matlab.unittest.constraints.Constraint` 类的实例。 `diagnostic` - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeTrue`	`assumeTrue(testCase,actual,diagnostic)` 假设 `actual` 的值是逻辑值 `1` (`true`)。类似于 `verifyTrue`。输入参量 `testCase` - 测试用例。 `actual` - 要测试的值。 `diagnostic` - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。

错误和警告

assumeError

[output1,...,outputN] = assumeError(testCase,actual,identifier,diagnostic)

假设 actual 是引发 identifier 指定的异常的函数句柄。类似于 verifyError。

输入参量

testCase - 测试用例。
actual - 要测试的值。
identifier - 错误标识符，指定为字符串标量、字符向量或 matlab.metadata.Class 实例。
diagnostic - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。

输出参量

output1,...,outputN - 从 actual 请求的输出参量 1 到 N。

assumeWarning

[output1,...,outputN] = assumeWarning(testCase,actual,identifier,diagnostic)

假设 actual 是发出由 identifier 指定的警告的函数句柄。类似于 verifyWarning。

输入参量

testCase - 测试用例。
actual - 要测试的值。
identifier - 警告标识符，指定为字符向量、字符向量元胞数组或字符串数组。
diagnostic - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。

输出参量

output1,...,outputN - 调用 actual 时生成的输出参量 1 到 N（如果有）。

assumeWarningFree

[output1,...,outputN] = assumeWarningFree(testCase,actual,diagnostic)

假设 actual 是未发出警告的函数句柄。类似于 verifyWarningFree。

输入参量

testCase - 测试用例。
actual - 要测试的值。
diagnostic - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。

输出参量

output1,...,outputN - 调用 actual 时生成的输出参量 1 到 N（如果有）。

不相等性

`assumeGreaterThan`	`assumeGreaterThan(testCase,actual,floor,diagnostic)` 假设 `actual` 的所有元素都大于 `floor` 的所有元素。类似于 `verifyGreaterThan`。输入参量 `testCase` - 测试用例。 `actual` - 要测试的值。 `floor` - 最小值。 `diagnostic` - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeGreaterThanOrEqual`	`assumeGreaterThanOrEqual(testCase,actual,floor,diagnostic)` 假设 `actual` 的所有元素都大于或等于 `floor` 的所有元素。类似于 `verifyGreaterThanOrEqual`。输入参量 `testCase` - 测试用例。 `actual` - 要测试的值。 `floor` - 最小值。 `diagnostic` - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeLessThan`	`assumeLessThan(testCase,actual,ceiling,diagnostic)` 假设 `actual` 的所有元素都小于 `ceiling` 的所有元素。类似于 `verifyLessThan`。输入参量 `testCase` - 测试用例。 `actual` - 要测试的值。 `ceiling` - 最大值。 `diagnostic` - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeLessThanOrEqual`	`assumeLessThanOrEqual(testCase,actual,ceiling,diagnostic)` 假设 `actual` 的所有元素都小于或等于 `ceiling` 的所有元素。类似于 `verifyLessThanOrEqual`。输入参量 `testCase` - 测试用例。 `actual` - 要测试的值。 `ceiling` - 最大值。 `diagnostic` - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。

数组大小

`assumeEmpty`	`assumeEmpty(testCase,actual,diagnostic)` 假设 `actual` 是空的 MATLAB^® 数组。类似于 `verifyEmpty`。输入参量 `testCase` - 测试用例。 `actual` - 要测试的值。 `diagnostic` - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeLength`	`assumeLength(testCase,actual,expectedLength,diagnostic)` 假设 `actual` 是具有预期长度的 MATLAB 数组。类似于 `verifyLength`。输入参量 `testCase` - 测试用例。 `actual` - 要测试的值。 `expectedLength` - 预期的数组长度。 `diagnostic` - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeNotEmpty`	`assumeNotEmpty(testCase,actual,diagnostic)` 假设 `actual` 是非空 MATLAB 数组。类似于 `verifyNotEmpty`。输入参量 `testCase` - 测试用例。 `actual` - 要测试的值。 `diagnostic` - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeNumElements`	`assumeNumElements(testCase,actual,expectedNumElements,diagnostic)` 假设 `actual` 是具有预期元素数的 MATLAB 数组。类似于 `verifyNumElements`。输入参量 `testCase` - 测试用例。 `actual` - 要测试的值。 `expectedNumElements` - 预期的元素数。 `diagnostic` - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeSize`	`assumeSize(testCase,actual,expectedSize,diagnostic)` 假设 `actual` 是具有预期大小的 MATLAB 数组。类似于 `verifySize`。输入参量 `testCase` - 测试用例。 `actual` - 要测试的值。 `expectedSize` - 预期的数组大小。 `diagnostic` - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。

类型

assumeClass

assumeClass(testCase,actual,class,diagnostic)

假设 actual 的类是指定的类。类似于 verifyClass。

输入参量

testCase - 测试用例。
actual - 要测试的值。
class - 预期的类，指定为字符串标量、字符向量或 matlab.metadata.Class 实例。
diagnostic - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。

assumeInstanceOf

assumeInstanceOf(testCase,actual,class,diagnostic)

假设 actual 是指定类的实例。类似于 verifyInstanceOf。

输入参量

testCase - 测试用例。
actual - 要测试的值。
class - 预期的类，指定为字符串标量、字符向量或 matlab.metadata.Class 实例。
diagnostic - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。

字符串

assumeMatches

assumeMatches(testCase,actual,expression,diagnostic)

假设 actual 是一个与指定的正则表达式匹配的字符串标量或字符向量。类似于 verifyMatches。

输入参量

testCase - 测试用例。
actual - 要测试的值。
expression - 要匹配的正则表达式。
diagnostic - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。

assumeSubstring

assumeSubstring(testCase,actual,substring,diagnostic)

假设 actual 是一个包含 substring 的字符串标量或字符向量。类似于 verifySubstring。

输入参量

testCase - 测试用例。
actual - 要测试的值。
substring - actual 值中包含的文本。
diagnostic - 鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。

事件

事件名称触发器事件数据事件属性

事件名称	触发器	事件数据	事件属性
`AssumptionFailed`	假设失败时触发。`QualificationEventData` 对象传递给侦听程序回调函数。	`matlab.unittest.qualifications.QualificationEventData`	`NotifyAccess: private` `ListenAccess: public`
`AssumptionPassed`	通过假设时触发。`QualificationEventData` 对象传递给侦听程序回调函数。	`matlab.unittest.qualifications.QualificationEventData`	`NotifyAccess: private` `ListenAccess: public`

AssumptionFailed

假设失败时触发。QualificationEventData 对象传递给侦听程序回调函数。

matlab.unittest.qualifications.QualificationEventData

NotifyAccess: private

ListenAccess: public

AssumptionPassed

通过假设时触发。QualificationEventData 对象传递给侦听程序回调函数。

matlab.unittest.qualifications.QualificationEventData

NotifyAccess: private

ListenAccess: public

示例

全部折叠

仅在 Linux 平台上运行测试

打开实时脚本

使用假设来确保您的测试只能在 Linux® 平台上运行。如果 MATLAB 安装在 Microsoft® Windows® 或 macOS 平台上，则指示测试框架过滤测试。

在当前文件夹的一个文件中创建 LinuxTests 类。要针对平台进行测试，请在 TestClassSetup methods 代码块中定义 testPlatform 方法。该方法使用对 assumeTrue 方法的调用来测试 MATLAB 是否安装在 Linux 平台上。如果假设失败，框架会过滤整个测试类。

classdef LinuxTests < matlab.unittest.TestCase
    methods (TestClassSetup)
        function testPlatform(testCase)
            testCase.assumeTrue(isunix && ~ismac, ...
                "Tests must run on a Linux platform.")
        end
    end
end

在具有 Test 属性的 methods 代码块中定义测试。此示例中的测试仅用于说明目的。

classdef LinuxTests < matlab.unittest.TestCase
    methods (TestClassSetup)
        function testPlatform(testCase)
            testCase.assumeTrue(isunix && ~ismac, ...
                "Tests must run on a Linux platform.")
        end
    end

    methods (Test)
        function test1(testCase)
            testCase.verifyWarningFree(@rand)
        end
        function test2(testCase)
            testCase.verifyWarningFree(@() size([]))
        end
    end
end

在 Windows 计算机上运行测试。由于假设在类设置级别失败，框架会过滤由 LinuxTests 类定义的测试。

runtests("LinuxTests")

Running LinuxTests

================================================================================
All tests in LinuxTests were filtered.
    Test Diagnostic: Tests must run on a Linux platform.
Details
================================================================================

Done LinuxTests
__________

Failure Summary:

     Name              Failed  Incomplete  Reason(s)
    ===============================================================
     LinuxTests/test1              X       Filtered by assumption.
    ---------------------------------------------------------------
     LinuxTests/test2              X       Filtered by assumption.

ans = 
  1×2 TestResult array with properties:

    Name
    Passed
    Failed
    Incomplete
    Duration
    Details

Totals:
   0 Passed, 0 Failed, 2 Incomplete.
   0.27782 seconds testing time.

详细信息

全部展开

诊断

根据测试运行器的配置，测试框架可能会在鉴定通过或失败时显示诊断信息。默认情况下，框架仅在鉴定失败时显示诊断信息。您可以通过自定义测试运行器来覆盖默认行为。例如，您可以使用 DiagnosticsOutputPlugin 实例来显示失败和通过事件诊断信息。

要将诊断消息添加到测试用例中，请在任何鉴定方法中使用可选的 diagnostic 参量。您可以将 diagnostic 指定为字符串数组、字符数组、函数句柄或 matlab.automation.diagnostics.Diagnostic 对象数组。

异常安全

测试内容有时会更改其环境的状态。当环境可以还原到其原始状态时，即使存在异常，内容也满足异常安全条件。异常安全可确保引发异常的测试不会因破坏环境而影响后续测试。为了实现异常安全，请使用 addTeardown 方法执行所有拆解操作。在原始状态更改之前或之后立即调用 addTeardown，中间没有任何可能引发异常的其他代码。

例如，下面的代码不满足异常安全条件。如果测试失败，测试框架不会关闭图窗。此图窗的存在可能导致后续测试失败。

% Not exception safe
f = figure;
testCase.assumeEqual(actual,expected)
close(f)

另一方面，以下代码满足异常安全条件，因为不管测试结果如何，框架都会关闭图窗。

% Exception safe
f = figure;
testCase.addTeardown(@close,f)
testCase.assumeEqual(actual,expected)

使用 addTeardown 拆解脚手架并不能保证代码就是异常安全的。以下代码不满足异常安全条件，因为对 addTeardown 的调用是在测试后进行的。如果测试失败，框架不会关闭图窗。

% Not exception safe
f = figure;
testCase.assumeEqual(actual,expected)
testCase.addTeardown(@close,f)

版本历史记录

在 R2013a 中推出

另请参阅

matlab.unittest.qualifications.Verifiable | matlab.unittest.qualifications.Assertable | matlab.unittest.qualifications.FatalAssertable | matlab.unittest.TestCase | matlab.unittest.qualifications.QualificationEventData

matlab.unittest.qualifications.Assumable 类

描述

方法

公共方法

事件

示例

仅在 Linux 平台上运行测试

详细信息

诊断

异常安全

版本历史记录

另请参阅

主题

WeChat