matlab.unittest.fixtures.Fixture 类

测试脚手架的基础接口

描述

matlab.unittest.fixtures.Fixture 类为测试脚手架提供接口。脚手架指定设置和拆解代码，这些代码设置测试环境并在运行测试后将其还原到初始状态。

Fixture 子类必须实现 setup 方法，该方法可在测试框架设置脚手架时对环境进行更改。要在框架拆解脚手架时还原环境，请在 setup 方法中调用 addTeardown 方法，或实现 teardown 方法。

除了在 Fixture 子类中指定设置和拆解操作之外，如果脚手架是可配置的（例如，如果其类构造函数接受输入参量），您还必须实现 isCompatible 方法。测试框架调用 isCompatible 来确定相同 Fixture 子类的实例是否对应于相同的共享测试脚手架状态。

matlab.unittest.fixtures.Fixture 类是一个 handle 类。

类属性

Abstract true

有关类属性的信息，请参阅类属性。

属性

全部展开

`SetupDescription` — 设置操作的描述
字符向量

设置操作的描述，以字符向量形式返回。在您的 Fixture 实现中设置此属性，以描述在测试框架调用 setup 方法时脚手架执行的操作。如果您将脚手架用作共享测试脚手架，则框架会在设置脚手架时显示属性值。

属性：

`GetAccess`	`public`
`SetAccess`	`protected`

`TeardownDescription` — 拆解操作的描述
字符向量

拆解操作的描述，以字符向量形式返回。在您的 Fixture 实现中设置此属性，以描述当测试框架调用 teardown 方法或传递给 addTeardown 方法的函数句柄时脚手架执行的操作。如果您将脚手架用作共享测试脚手架，则框架会在拆解脚手架时显示属性值。

属性：

`GetAccess`	`public`
`SetAccess`	`protected`

方法

全部展开

公共方法

`addTeardown`	向脚手架动态添加拆解代码
`applyAndRun`	Run function in environment provided by fixture
`setup`	设置脚手架
`teardown`	拆解脚手架

受保护方法

`applyFixture`	设置脚手架以将工作委派给另一个脚手架
`isCompatible`	确定两个脚手架是否兼容
`log`	记录在脚手架设置和拆解过程中的诊断信息
`needsReset`	确定共享测试脚手架是否需要重置
`onFailure`	动态添加在脚手架设置和拆解过程中出现故障时执行的诊断

基于鉴定的受保护方法

与 Assumable、Assertable 和 FatalAssertable 类类似，Fixture 类为测试值和响应失败提供了几种鉴定方法。例如，您可以使用这些受保护方法在 Fixture 子类中实现 setup 和 teardown 方法。

Fixture 类支持假设、断言和致命断言。对于相同类型的测试，这些鉴定类型具有相似的方法。这些方法使用一种共同的命名约定。例如，测试相等性的方法使用形式 <qualify>Equal，其中 <qualify> 可以是 assume、assert 或 fatalAssert。即：

assumeEqual - 假设两个值相等。
assertEqual - 断言两个值相等。
fatalAssertEqual - 致命断言两个值相等。

一般用途

`assumeEqual` `assertEqual` `fatalAssertEqual`	`<qualify>Equal(fixture,actual,expected,diagnostic,Name,Value)` 测试 `actual` 是否严格等于 `expected`。将 `<qualify>` 替换为 `assume`、`assert` 或 `fatalAssert`。输入参量 `fixture` - 脚手架。 `actual` - 要测试的值。 `expected` - 预期值。 `diagnostic` -（可选）鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。名称-值参量 `AbsTol` - 绝对误差，指定为一个数值数组。 `RelTol` - 相对误差，指定为数值数组。
`assumeFail` `assertFail` `fatalAssertFail`	`<qualify>Fail(fixture,diagnostic)` 产生无条件鉴定失败。将 `<qualify>` 替换为 `assume`、`assert` 或 `fatalAssert`。输入参量 `fixture` - 脚手架。 `diagnostic` -（可选）鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeFalse` `assertFalse` `fatalAssertFalse`	`<qualify>False(fixture,actual,diagnostic)` 测试 `actual` 的值是否为逻辑值 `0` (`false`)。将 `<qualify>` 替换为 `assume`、`assert` 或 `fatalAssert`。输入参量 `fixture` - 脚手架。 `actual` - 要测试的值。 `diagnostic` -（可选）鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeNotEqual` `assertNotEqual` `fatalAssertNotEqual`	`<qualify>NotEqual(fixture,actual,prohibited,diagnostic)` 测试 `actual` 是否不等于 `prohibited`。将 `<qualify>` 替换为 `assume`、`assert` 或 `fatalAssert`。输入参量 `fixture` - 脚手架。 `actual` - 要测试的值。 `prohibited` - 要用于比较的值。 `diagnostic` -（可选）鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeNotSameHandle` `assertNotSameHandle` `fatalAssertNotSameHandle`	`<qualify>NotSameHandle(fixture,actual,prohibited,diagnostic)` 测试 `actual` 是否与禁止的句柄数组不同。将 `<qualify>` 替换为 `assume`、`assert` 或 `fatalAssert`。输入参量 `fixture` - 脚手架。 `actual` - 要测试的值。 `prohibited` - 要用于比较的值，指定为句柄数组。 `diagnostic` -（可选）鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeReturnsTrue` `assertReturnsTrue` `fatalAssertReturnsTrue`	`<qualify>ReturnsTrue(fixture,actual,diagnostic)` 测试 `actual` 是否为返回逻辑标量 `1` (`true`) 的函数句柄。将 `<qualify>` 替换为 `assume`、`assert` 或 `fatalAssert`。输入参量 `fixture` - 脚手架。 `actual` - 要测试的值。 `diagnostic` -（可选）鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeSameHandle` `assertSameHandle` `fatalAssertSameHandle`	`<qualify>SameHandle(fixture,actual,expected,diagnostic)` 测试 `actual` 是否与预期的句柄数组相同。将 `<qualify>` 替换为 `assume`、`assert` 或 `fatalAssert`。输入参量 `fixture` - 脚手架。 `actual` - 要测试的值。 `expected` - 预期值，指定为句柄数组。 `diagnostic` -（可选）鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeThat` `assertThat` `fatalAssertThat`	`<qualify>That(fixture,actual,constraint,diagnostic)` 测试 `actual` 是否为满足指定约束的值。将 `<qualify>` 替换为 `assume`、`assert` 或 `fatalAssert`。输入参量 `fixture` - 脚手架。 `actual` - 要测试的值。 `constraint` - actual 值必须满足的约束，指定为 `matlab.unittest.constraints.Constraint` 类的实例。 `diagnostic` -（可选）鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeTrue` `assertTrue` `fatalAssertTrue`	`<qualify>True(fixture,actual,diagnostic)` 测试 `actual` 的值是否为逻辑值 `1` (`true`)。将 `<qualify>` 替换为 `assume`、`assert` 或 `fatalAssert`。输入参量 `fixture` - 脚手架。 `actual` - 要测试的值。 `diagnostic` -（可选）鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。

错误和警告

assumeError
assertError
fatalAssertError

[output1,...,outputN] = <qualify>Error(fixture,actual,identifier,diagnostic)

测试 actual 是否为抛出由 identifier 指定的异常的函数句柄。将 <qualify> 替换为 assume、assert 或 fatalAssert。

输入参量

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

输出参量（可选）

output1,...,outputN - 从 actual 请求的输出参量 1 到 N（如果有）。

assumeWarning
assertWarning
fatalAssertWarning

[output1,...,outputN] = <qualify>Warning(fixture,actual,identifier,diagnostic)

测试 actual 是否为发出由 identifier 指定的警告的函数句柄。将 <qualify> 替换为 assume、assert 或 fatalAssert。

输入参量

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

输出参量（可选）

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

assumeWarningFree
assertWarningFree
fatalAssertWarningFree

[output1,...,outputN] = <qualify>WarningFree(fixture,actual,diagnostic)

测试 actual 是否为不发出警告的函数句柄。将 <qualify> 替换为 assume、assert 或 fatalAssert。

输入参量

fixture - 脚手架。
actual - 要测试的值。
diagnostic -（可选）鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。

输出参量（可选）

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

不相等性

`assumeGreaterThan` `assertGreaterThan` `fatalAssertGreaterThan`	`<qualify>GreaterThan(fixture,actual,floor,diagnostic)` 测试 `actual` 的所有元素是否都大于 `floor` 的所有元素。将 `<qualify>` 替换为 `assume`、`assert` 或 `fatalAssert`。输入参量 `fixture` - 脚手架。 `actual` - 要测试的值。 `floor` - 最小值。 `diagnostic` -（可选）鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeGreaterThanOrEqual` `assertGreaterThanOrEqual` `fatalAssertGreaterThanOrEqual`	`<qualify>GreaterThanOrEqual(fixture,actual,floor,diagnostic)` 测试 `actual` 的所有元素是否都大于或等于 `floor` 的所有元素。将 `<qualify>` 替换为 `assume`、`assert` 或 `fatalAssert`。输入参量 `fixture` - 脚手架。 `actual` - 要测试的值。 `floor` - 最小值。 `diagnostic` -（可选）鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeLessThan` `assertLessThan` `fatalAssertLessThan`	`<qualify>LessThan(fixture,actual,ceiling,diagnostic)` 测试 `actual` 的所有元素是否都小于 `ceiling` 的所有元素。将 `<qualify>` 替换为 `assume`、`assert` 或 `fatalAssert`。输入参量 `fixture` - 脚手架。 `actual` - 要测试的值。 `ceiling` - 最大值。 `diagnostic` -（可选）鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeLessThanOrEqual` `assertLessThanOrEqual` `fatalAssertLessThanOrEqual`	`<qualify>LessThanOrEqual(fixture,actual,ceiling,diagnostic)` 测试 `actual` 的所有元素是否都小于或等于 `ceiling` 的所有元素。将 `<qualify>` 替换为 `assume`、`assert` 或 `fatalAssert`。输入参量 `fixture` - 脚手架。 `actual` - 要测试的值。 `ceiling` - 最大值。 `diagnostic` -（可选）鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。

数组大小

`assumeEmpty` `assertEmpty` `fatalAssertEmpty`	`<qualify>Empty(fixture,actual,diagnostic)` 测试 `actual` 是否为空 MATLAB^® 数组。将 `<qualify>` 替换为 `assume`、`assert` 或 `fatalAssert`。输入参量 `fixture` - 脚手架。 `actual` - 要测试的值。 `diagnostic` -（可选）鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeLength` `assertLength` `fatalAssertLength`	`<qualify>Length(fixture,actual,expectedLength,diagnostic)` 测试 `actual` 是否为具有预期长度的 MATLAB 数组。将 `<qualify>` 替换为 `assume`、`assert` 或 `fatalAssert`。输入参量 `fixture` - 脚手架。 `actual` - 要测试的值。 `expectedLength` - 预期的数组长度。 `diagnostic` -（可选）鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeNotEmpty` `assertNotEmpty` `fatalAssertNotEmpty`	`<qualify>NotEmpty(fixture,actual,diagnostic)` 测试 `actual` 是否为非空 MATLAB 数组。将 `<qualify>` 替换为 `assume`、`assert` 或 `fatalAssert`。输入参量 `fixture` - 脚手架。 `actual` - 要测试的值。 `diagnostic` -（可选）鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeNumElements` `assertNumElements` `fatalAssertNumElements`	`<qualify>NumElements(fixture,actual,expectedNumElements,diagnostic)` 测试 `actual` 是否为包含预期元素数的 MATLAB 数组。将 `<qualify>` 替换为 `assume`、`assert` 或 `fatalAssert`。输入参量 `fixture` - 脚手架。 `actual` - 要测试的值。 `expectedNumElements` - 预期的元素数。 `diagnostic` -（可选）鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。
`assumeSize` `assertSize` `fatalAssertSize`	`<qualify>Size(fixture,actual,expectedSize,diagnostic)` 测试 `actual` 是否为具有预期大小的 MATLAB 数组。将 `<qualify>` 替换为 `assume`、`assert` 或 `fatalAssert`。输入参量 `fixture` - 脚手架。 `actual` - 要测试的值。 `expectedSize` - 预期的数组大小。 `diagnostic` -（可选）鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。

类型

assumeClass
assertClass
fatalAssertClass

<qualify>Class(fixture,actual,class,diagnostic)

测试 actual 的类是否为指定的类。将 <qualify> 替换为 assume、assert 或 fatalAssert。

输入参量

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

assumeInstanceOf
assertInstanceOf
fatalAssertInstanceOf

<qualify>InstanceOf(fixture,actual,class,diagnostic)

测试 actual 是否为指定类的实例。将 <qualify> 替换为 assume、assert 或 fatalAssert。

输入参量

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

字符串

assumeMatches
assertMatches
fatalAssertMatches

<qualify>Matches(fixture,actual,expression,diagnostic)

测试 actual 是否为一个与指定的正则表达式匹配的字符串标量或字符向量。将 <qualify> 替换为 assume、assert 或 fatalAssert。

输入参量

fixture - 脚手架。
actual - 要测试的值。
expression - 要匹配的正则表达式。
diagnostic -（可选）鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。

assumeSubstring
assertSubstring
fatalAssertSubstring

<qualify>Substring(fixture,actual,substring,diagnostic)

测试 actual 是否为包含 substring 的字符串标量或字符向量。将 <qualify> 替换为 assume、assert 或 fatalAssert。

输入参量

fixture - 脚手架。
actual - 要测试的值。
substring - actual 值中包含的文本。
diagnostic -（可选）鉴定通过或失败时显示的诊断信息。有关详细信息，请参阅诊断。

事件

事件名称	触发器	事件数据	事件属性
`AssumptionFailed`	假设失败时触发。`QualificationEventData` 对象传递给侦听程序回调函数。	`matlab.unittest.qualifications.QualificationEventData`	`NotifyAccess: private` `ListenAccess: public`
`AssumptionPassed`	通过假设时触发。`QualificationEventData` 对象传递给侦听程序回调函数。	`matlab.unittest.qualifications.QualificationEventData`	`NotifyAccess: private` `ListenAccess: public`
`AssertionFailed`	断言失败时触发。`QualificationEventData` 对象传递给侦听程序回调函数。	`matlab.unittest.qualifications.QualificationEventData`	`NotifyAccess: private` `ListenAccess: public`
`AssertionPassed`	通过断言时触发。`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`
`ExceptionThrown`	当测试运行器在测试内容中捕获到异常时由测试运行器触发。系统会将一个 `ExceptionEventData` 对象传递给侦听程序回调函数。	`matlab.unittest.qualifications.ExceptionEventData`	`NotifyAccess: private` `ListenAccess: public`
`DiagnosticLogged`	在调用 `log` 方法时触发。`LoggedDiagnosticEventData` 对象传递给侦听程序回调函数。	`matlab.unittest.diagnostics.LoggedDiagnosticEventData`	`NotifyAccess: private` `ListenAccess: public`

示例

全部折叠

创建和使用测试脚手架

创建并使用自定义脚手架，它将数值的输出显示格式更改为小数点后两位数的货币格式。

在当前文件夹的名为 CurrencyFormatFixture.m 的文件中，通过子类化 matlab.unittest.fixtures.Fixture 接口来创建 CurrencyFormatFixture 类。在类中实现 setup 方法，以便脚手架将数值的显示格式更改为货币格式。要在测试后将显示格式还原到其原始状态，请在 setup 方法中调用 addTeardown 方法。

classdef CurrencyFormatFixture < matlab.unittest.fixtures.Fixture
    methods
        function setup(fixture)
            originalFormat = format;
            fixture.addTeardown(@format,originalFormat)
            format bank
        end
    end
end

在当前文件夹内名为 ExampleTest.m 的文件中，创建 ExampleTest 类，以应用自定义脚手架，并验证数值是否以预期格式显示。为了简化此示例，实际值是通过调用 formattedDisplayText 函数生成的。在实际操作中，您要测试用户定义的代码。

classdef ExampleTest < matlab.unittest.TestCase
    methods (Test)
        function formatTest(testCase)
            testCase.applyFixture(CurrencyFormatFixture)
            actual = strtrim(formattedDisplayText(pi));
            expected = "3.14";
            testCase.verifyEqual(actual,expected)
        end
    end
end

运行 ExampleTest 类。测试框架可设置脚手架，以将显示格式更改为货币格式。一旦测试运行完毕，框架就会拆解脚手架，这会还原原始显示格式。在此示例中，测试通过。

runtests("ExampleTest");

Running ExampleTest
.
Done ExampleTest
__________

详细信息

全部展开

诊断

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

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

版本历史记录

在 R2014a 中推出

全部展开

R2024b: 在脚手架提供的环境中运行函数

matlab.unittest.fixtures.Fixture 类有新方法 applyAndRun，它允许您在由一个或多个脚手架提供的环境中运行函数。

R2020b: 报告共享测试脚手架的有效性

matlab.unittest.fixtures.Fixture 类包含新方法 needsReset，让您可以向测试框架报告共享测试脚手架的有效性。如果由脚手架配置的测试环境状态在整个测试会话期间保持不变，则共享测试脚手架有效。

另请参阅

getSharedTestFixtures | addTeardown

matlab.unittest.fixtures.Fixture 类

描述

类属性

属性

SetupDescription — 设置操作的描述 字符向量

属性：

TeardownDescription — 拆解操作的描述 字符向量

属性：

方法

公共方法

受保护方法

基于鉴定的受保护方法

事件

示例

创建和使用测试脚手架

详细信息

诊断

版本历史记录

R2024b: 在脚手架提供的环境中运行函数

R2020b: 报告共享测试脚手架的有效性

另请参阅

主题

`SetupDescription` — 设置操作的描述
字符向量

`TeardownDescription` — 拆解操作的描述
字符向量