matlab.unittest.qualifications.FatalAssertable 类

命名空间: matlab.unittest.qualifications

用于中止测试执行的验证

描述

FatalAssertable 类提供用于中止测试执行的验证。除了对失败执行的操作外，FatalAssertable 类与 matlab.unittest.qualifications 包中的其他验证类的工作方式相同。

致命断言失败时，FatalAssertable 类会引发 FatalAssertionFailedException 对象以告知测试框架发生失败。然后，该框架会显示与失败有关的诊断信息并中止测试会话。当失败涉及根本以致继续测试已经没有意义时，此行为非常有用。此外，您还可以在脚手架拆解中使用致命断言，确保环境状态得以正确恢复。如果您可以保证脚手架拆解满足异常安全条件或在失败后恢复环境状态，请改用断言。

致命断言可避免由于基本测试失败引起的 false 测试失败。当先前的测试无法恢复状态时，它们还可以防止 false 测试失败。如果框架无法正确拆解脚手架，您必须手动重置状态。例如，您可能需要重新启动 MATLAB^®。

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

方法

全部展开

公共方法

FatalAssertable 类为测试值和如何响应失败提供了几种验证方法。例如，fatalAssertEmpty 测试某个值为空，而 fatalAssertTrue 测试 actual 值为 true。

注意

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

一般用途

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

错误和警告

fatalAssertError

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

致命断言 actual 是引发 identifier 指定的异常的函数句柄。类似于 verifyError。

输入参数

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

输出参数

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

fatalAssertWarning

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

致命断言 actual 是发出由 identifier 指定的警告的函数句柄。类似于 verifyWarning。

输入参数

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

输出参数

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

fatalAssertWarningFree

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

致命断言 actual 是未发出警告的函数句柄。类似于 verifyWarningFree。

输入参数

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

输出参数

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

不相等性

`fatalAssertGreaterThan`	`fatalAssertGreaterThan(testCase,actual,floor,diagnostic)` 致命断言 `actual` 的所有元素都大于 `floor` 的所有元素。类似于 `verifyGreaterThan`。输入参数 `testCase` - 测试用例。 `actual` - 要测试的值。 `floor` - 最小值。 `diagnostic` - 验证通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`fatalAssertGreaterThanOrEqual`	`fatalAssertGreaterThanOrEqual(testCase,actual,floor,diagnostic)` 致命断言 `actual` 的所有元素都大于或等于 `floor` 的所有元素。类似于 `verifyGreaterThanOrEqual`。输入参数 `testCase` - 测试用例。 `actual` - 要测试的值。 `floor` - 最小值。 `diagnostic` - 验证通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`fatalAssertLessThan`	`fatalAssertLessThan(testCase,actual,ceiling,diagnostic)` 致命断言 `actual` 的所有元素都小于 `ceiling` 的所有元素。类似于 `verifyLessThan`。输入参数 `testCase` - 测试用例。 `actual` - 要测试的值。 `ceiling` - 最大值。 `diagnostic` - 验证通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`fatalAssertLessThanOrEqual`	`fatalAssertLessThanOrEqual(testCase,actual,ceiling,diagnostic)` 致命断言 `actual` 的所有元素都小于或等于 `ceiling` 的所有元素。类似于 `verifyLessThanOrEqual`。输入参数 `testCase` - 测试用例。 `actual` - 要测试的值。 `ceiling` - 最大值。 `diagnostic` - 验证通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。

数组大小

`fatalAssertEmpty`	`fatalAssertEmpty(testCase,actual,diagnostic)` 致命断言 `actual` 是一个空 MATLAB 数组。类似于 `verifyEmpty`。输入参数 `testCase` - 测试用例。 `actual` - 要测试的值。 `diagnostic` - 验证通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`fatalAssertLength`	`fatalAssertLength(testCase,actual,expectedLength,diagnostic)` 致命断言 `actual` 是具有预期长度的 MATLAB 数组。类似于 `verifyLength`。输入参数 `testCase` - 测试用例。 `actual` - 要测试的值。 `expectedLength` - 预期的数组长度。 `diagnostic` - 验证通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`fatalAssertNotEmpty`	`fatalAssertNotEmpty(testCase,actual,diagnostic)` 致命断言 `actual` 是非空 MATLAB 数组。类似于 `verifyNotEmpty`。输入参数 `testCase` - 测试用例。 `actual` - 要测试的值。 `diagnostic` - 验证通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`fatalAssertNumElements`	`fatalAssertNumElements(testCase,actual,expectedNumElements,diagnostic)` 致命断言 `actual` 是包含预期元素数的 MATLAB 数组。类似于 `verifyNumElements`。输入参数 `testCase` - 测试用例。 `actual` - 要测试的值。 `expectedNumElements` - 预期的元素数。 `diagnostic` - 验证通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`fatalAssertSize`	`fatalAssertSize(testCase,actual,expectedSize,diagnostic)` 致命断言 `actual` 是具有预期大小的 MATLAB 数组。类似于 `verifySize`。输入参数 `testCase` - 测试用例。 `actual` - 要测试的值。 `expectedSize` - 预期的数组大小。 `diagnostic` - 验证通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。

类型

fatalAssertClass

fatalAssertClass(testCase,actual,class,diagnostic)

致命断言 actual 的类是指定的类。类似于 verifyClass。

输入参数

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

fatalAssertInstanceOf

fatalAssertInstanceOf(testCase,actual,class,diagnostic)

致命断言 actual 是指定类的实例。类似于 verifyInstanceOf。

输入参数

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

字符串

fatalAssertMatches

fatalAssertMatches(testCase,actual,expression,diagnostic)

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

输入参数

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

fatalAssertSubstring

fatalAssertSubstring(testCase,actual,substring,diagnostic)

致命断言 actual 是一个包含 substring 的字符串标量或字符向量。类似于 verifySubstring。

输入参数

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

事件

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

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

FatalAssertionFailed

致命断言失败时触发。QualificationEventData 对象传递给侦听程序回调函数。

matlab.unittest.qualifications.QualificationEventData

NotifyAccess: private

ListenAccess: public

FatalAssertionPassed

通过致命断言时触发。QualificationEventData 对象传递给侦听程序回调函数。

matlab.unittest.qualifications.QualificationEventData

NotifyAccess: private

ListenAccess: public

示例

全部折叠

如果状态被破坏，则中止测试会话

打开实时脚本

测试一个设置操作系统环境变量值的函数。如果在测试后环境变量无法重置为其原始值，请使用致命断言失败中止测试会话。

在当前文件夹的一个文件中创建 setUserName 函数。该函数通过调用 setenv 来设置 'UserName' 环境变量。

function setUserName(name)
setenv('UserName',name)
end

要测试 setUserName 函数，请在当前文件夹中创建一个名为 SetUserNameTest 的测试类。为您的测试定义必要的类成员：

OriginalUserName 属性 - 在测试后使用此属性重置环境变量。
testUpdate Test 方法 - 存储环境变量的原始值，调用受测函数，并验证该函数是否将环境变量设置为预期值。由于在测试期间状态会发生变化，因此一旦测试运行完成，请调用 addTeardown 来恢复状态。
resetUserName 辅助方法 - 调用 setUserName 函数来重置环境变量。如果操作不成功，则使用致命断言失败中止测试会话。

classdef SetUserNameTest < matlab.unittest.TestCase
    properties (SetAccess = private)
        OriginalUserName
    end
    
    methods (Test)
        function testUpdate(testCase)
            testCase.OriginalUserName = getenv('UserName');
            setUserName('David')
            testCase.addTeardown(@() testCase.resetUserName)
            testCase.verifyEqual(getenv('UserName'),'David')
        end
    end

    methods (Access = private)
        function resetUserName(testCase)
            setUserName(testCase.OriginalUserName)
            testCase.fatalAssertEqual(getenv('UserName'),testCase.OriginalUserName)
        end
    end
end

运行 SetUserNameTest 类。测试通过。

runtests("SetUserNameTest")

Running SetUserNameTest
.
Done SetUserNameTest
__________

ans = 
  TestResult with properties:

          Name: 'SetUserNameTest/testUpdate'
        Passed: 1
        Failed: 0
    Incomplete: 0
      Duration: 0.0226
       Details: [1×1 struct]

Totals:
   1 Passed, 0 Failed, 0 Incomplete.
   0.022649 seconds testing time.

详细信息

全部展开

诊断

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

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

异常安全

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

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

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

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

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

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

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

版本历史记录

在 R2013a 中推出

另请参阅

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

主题

验证、断言及其他鉴定一览表

matlab.unittest.qualifications.FatalAssertable 类

描述

方法

公共方法

事件

示例

如果状态被破坏，则中止测试会话

详细信息

诊断

异常安全

版本历史记录

另请参阅

主题

WeChat