Main Content

本页翻译不是最新的。点击此处可查看最新英文版本。

verifyReturnsTrue

类: matlab.unittest.qualifications.Verifiable
包: matlab.unittest.qualifications

验证函数返回 true

说明

示例

verifyReturnsTrue(testCase,actual) 验证 actual 是返回逻辑标量 1 (true) 的函数句柄。

示例

verifyReturnsTrue(testCase,actual,diagnostic) 还将 diagnostic 中的诊断信息与验证相关联。

输入参数

全部展开

测试用例对象,指定为 matlab.unittest.qualifications.Verifiable 类的实例。由于 matlab.unittest.TestCase 类会子类化 matlab.unittest.qualifications.Verifiable 并继承其方法,因此 testCase 通常是 matlab.unittest.TestCase 实例。

要测试的值,指定为任何数据类型的值。虽然您可以提供任何数据类型的值,但如果 actual 不是函数句柄,测试将失败。

示例: @() myFunction(1,2)

示例: @() ~strcmp('a','b')

当验证通过或失败时显示的诊断信息,指定为字符串数组、字符数组、函数句柄或 matlab.unittest.diagnostics.Diagnostic 对象数组。

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

示例: "My Custom Diagnostic"

示例: @dir

属性

Sealedtrue

要了解方法的属性,请参阅方法属性

示例

全部展开

测试 actual 值是否为返回 true 的函数句柄。

创建一个供交互测试的测试用例。

testCase = matlab.unittest.TestCase.forInteractiveUse;

测试 true 函数。

verifyReturnsTrue(testCase,@true)
Verification passed.

测试 false 函数。测试失败,因为 false 未返回 true。

verifyReturnsTrue(testCase,@false)
Verification failed.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifyReturnsTrue failed.
    --> The function handle did not evaluate to "true".
    --> Returned value:
              logical
            
               0
    
    Evaluated Function:
      function_handle with value:
    
        @false
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestIfFunctionReturnsTrueExample.m (TestIfFunctionReturnsTrueExample) at 19

测试在给定两个相等数值的情况下,对 isequal 的调用是否返回 true。

verifyReturnsTrue(testCase,@() isequal(1,single(1)))
Verification passed.

验证两个不同字母不相同。

verifyReturnsTrue(testCase,@() ~strcmp('a','b'))
Verification passed.

测试一个返回 true 值向量的函数。测试失败,因为返回值是非标量。

verifyReturnsTrue(testCase,@() strcmp('a',{'a','a'}))
Verification failed.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifyReturnsTrue failed.
    --> The function handle did not return a scalar. The return value had a size of [1  2].
    --> Returned value:
              1×2 logical array
            
               1   1
    
    Evaluated Function:
      function_handle with value:
    
        @()strcmp('a',{'a','a'})
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestIfFunctionReturnsTrueExample.m (TestIfFunctionReturnsTrueExample) at 33

测试一个返回数值的函数。测试失败。

verifyReturnsTrue(testCase,@ones, ...
    "Returned value must be a logical scalar.")
Verification failed.
    ----------------
    Test Diagnostic:
    ----------------
    Returned value must be a logical scalar.
    ---------------------
    Framework Diagnostic:
    ---------------------
    verifyReturnsTrue failed.
    --> The function handle did not return a logical value. The return value was of type "double".
    --> Returned value:
                 1
    
    Evaluated Function:
      function_handle with value:
    
        @ones
    ------------------
    Stack Information:
    ------------------
    In C:\work\TestIfFunctionReturnsTrueExample.m (TestIfFunctionReturnsTrueExample) at 37

提示

  • verifyReturnsTrue 方法非常方便。例如,verifyReturnsTrue(testCase,actual) 在功能上等效于以下代码。

    import matlab.unittest.constraints.ReturnsTrue
    testCase.verifyThat(actual,ReturnsTrue)
    
  • verifyReturnsTrue 的替代方法是 verifyTrue 方法。verifyTrue 运行速度更快,更易于使用,但 verifyReturnsTrue 提供的诊断信息稍好。在此示例中,两个测试都失败,但第二个测试将函数句柄显示为诊断的一部分。

    actual = 1;
    expected = 2;
    testCase = matlab.unittest.TestCase.forInteractiveUse;
    verifyTrue(testCase,isequal(actual,expected))
    verifyReturnsTrue(testCase,@()isequal(actual,expected))
  • 使用此确认在不引发异常的条件下生成和记录失败。由于确认不会引发异常,因此即使出现确认失败的情形,依然会完成所有的测试内容。通常,确认指的是对单元测试的主要验证,因为这些确认一般不要求提前从测试中退出。使用其他验证类型来测试是否违反先决条件或测试安装是否正确:

    • 使用断言验证确保测试环境满足无论如何都不会导致测试失败的先决条件。假设失败会生成已筛选的测试,且测试框架会将测试设为 Incomplete。有关详细信息,请参阅 matlab.unittest.qualifications.Assumable

    • 当失败条件导致当前测试内容的剩余部分都失效,但不会阻止后续测试正确执行时,使用断言验证。断言点处的失败会将当前测试展现为 FailedIncomplete。有关详细信息,请参阅 matlab.unittest.qualifications.Assertable

    • 使用致命断言验证在失败时中止测试会话。当失败涉及根本以致继续测试已经没有意义时,这些验证非常有用。当脚手架拆解不能正确还原环境状态,适合中止测试并启动一个新会话时,致命断言也很有用。有关详细信息,请参阅 matlab.unittest.qualifications.FatalAssertable

版本历史记录

在 R2013a 中推出