主要内容

matlab.unittest.plugins.DiagnosticsOutputPlugin类

包:matlab.unittest.plugins

插件直接诊断到输出流

描述

DiagnosticsOutputPlugin类创建一个插件,将诊断引导到输出流。要配置测试框架输出的诊断类型和详细级别,请将此插件添加到TestRunner实例。

建设

matlab.unittest.plugins.DiagnosticsOutputPlugin创建一个插件,该插件指导对失败事件和日志事件的诊断冗长。简洁水平到ToStandardOutput流。

matlab.unittest.plugins.DiagnosticsOutputPlugin (将诊断重定向到指定的输出流。例如,可以将输出重定向到使用创建的流去整理

matlab.unittest.plugins.DiagnosticsOutputPlugin (___名称,值创建带有一个或多个指定的附加选项的插件名称,值对参数。例如,DiagnosticsOutputPlugin(“LoggingLevel”4“IncludingPassingDiagnostics”,真的)创建一个插件,该插件显示在任何级别记录的诊断信息,并显示传递的诊断信息。

输入参数

全部展开

的实例指定的输出位置OutputStream类。插件将诊断信息定向到指定位置。默认情况下,插件使用matlab.unittest.plugins.ToStandardOutput流。

例子:matlab.unittest.plugins.ToFile(“myFile.txt”)

名称-值参数

指定可选的参数对为Name1 = Value1,…,以=家,在那里名字是参数名和吗价值是对应的值。名称-值参数必须出现在其他参数之后,但对的顺序无关紧要。

在R2021a之前,使用逗号分隔每个名称和值,并将其括起来名字在报价。

例子:DiagnosticsOutputPlugin(“IncludingPassingDiagnostics”,没错,‘OutputDetail’,4)创建一个插件,该插件包含传递诊断信息,并在详细信息级别显示诊断信息。

是否从失败事件中排除诊断,指定为真正的。默认情况下,插件包含失败事件的诊断。

数据类型:逻辑

是否包括传递事件诊断,指定为真正的。默认情况下,插件不包括传入事件的诊断。

数据类型:逻辑

插件实例包含日志诊断的最大级别,指定为从0到4的整数值,amatlab.unittest.Verbosity枚举对象,或对应于预定义枚举成员名之一的字符串标量或字符向量。该插件包括在此级别及以下级别记录的诊断。类的成员对应整数值matlab.unittest.Verbosity枚举。

数字表示法 枚举成员名 冗长的描述
0 没有一个

任何信息

1 简洁

最小的信息

2 简洁的

适度的信息量

3. 详细的

一些补充信息

4 详细的

有很多补充信息

默认情况下,插件包含记录在matlab.unittest.Verbosity.Terselevel(级别1)。要排除记录的诊断,请指定LoggingLevel作为冗长。没有一个(0级)。

方法调用时提供给测试框架的已记录的诊断日志(TestCase)日志(夹具)方法。

报告事件的详细级别,指定为从0到4的整数值,amatlab.unittest.Verbosity枚举对象,或对应于预定义枚举成员名之一的字符串标量或字符向量。类的成员对应整数值matlab.unittest.Verbosity枚举。

插件报告通过、失败和记录的事件,详细信息由OutputDetail。默认情况下,插件记录事件matlab.unittest.Verbosity.Detailed等级(3级)。

数字表示法 枚举成员名 冗长的描述
0 没有一个

任何信息

1 简洁

最小的信息

2 简洁的

适度的信息量

3. 详细的

一些补充信息

4 详细的

有很多补充信息

属性

全部展开

该属性是只读的。

如果排除故障事件的诊断,则指示符指定为真正的逻辑0或1)。默认情况下,ExcludeFailureDiagnostics失败事件的诊断结果也包含在输出中。若要从输出中排除故障事件中的诊断,请指定ExcludeFailureDiagnostics作为真正的在插件构建期间。

该属性是只读的。

如果包含传递事件的诊断,则指示符,指定为真正的逻辑0或1)。默认情况下,IncludePassingDiagnostics并且从传递事件中获得的诊断信息将从输出中排除。若要在输出中包含传入事件的诊断,请指定IncludePassingDiagnostics作为真正的在插件构建期间。

该属性是只读的。

插件包含的日志诊断的最大冗长级别,作为matlab.unittest.Verbosity枚举对象。该插件包括在此级别及以下级别记录的诊断。默认情况下,此属性值为matlab.unittest.Verbosity.Terse。您可以在插件构建期间指定不同的日志级别。

方法调用时提供给测试框架的已记录的诊断日志(TestCase)日志(夹具)方法。

该属性是只读的。

报告事件的详细级别,返回为matlab.unittest.Verbosity枚举对象。默认情况下,此属性值为matlab.unittest.Verbosity.Detailed。您可以在插件构建期间指定不同的输出细节级别。

复制语义

句柄。要了解句柄类如何影响复制操作,请参见复制对象

例子

全部折叠

创建文件ExampleDiagOutputTest.m包含以下测试类。

classdefExampleDiagOutputTest < matlab.unittest.TestCase方法(测试)函数testOne (testCase)导入matlab.unittest.VerbositytestCase.log (Verbosity.Detailed“测试失败事件”) testCase.verifyEqual(42岁,13岁'42 == 13'结束函数testTwo (testCase) testCase.log (3“测试通过事件”) testCase.verifyTrue(真的,“真就是真”结束结束结束

创建一个测试套件ExampleDiagOutputTest类。创建一个不带插件的测试运行器。

进口matlab.unittest.TestRunner进口matlab.unittest.TestSuite进口matlab.unittest.Verbosity进口matlab.unittest.plugins.DiagnosticsOutputPluginsuite = TestSuite.fromClass(?ExampleDiagOutputTest);run = testrrun . withnoplugins ();

创建默认值DiagnosticsOutputPlugin,将其添加到运行器中,然后运行测试。

plugin = DiagnosticsOutputPlugin;runner.addPlugin(插件);Result = runner.run(suite);
================================================================================ 验证失败ExampleDiagOutputTest / testOne。---------------- 测试诊断 : ---------------- 42 = = 13  --------------------- 框架的诊断 : --------------------- verifyEqual失败了。——>使用“isequaln”,值是不相等的。——>失败表:实际RelativeError预期错误  ______ ________ _____ ________________ 42 13 29 2.23076923076923实际价值:42期望值:13  ------------------ 堆栈信息 : ------------------ 在C: \ \ ExampleDiagOutputTest工作。在5米(ExampleDiagOutputTest.testOne)  ================================================================================ 失败失败总结:名字不完整的原因(s ) ============================================================================ ExampleDiagOutputTest / testOne X验证失败。

创建另一个测试运行器和DiagnosticsOutputPlugin显示诊断,包括传递诊断简洁级别,并显示记录在详细的水平或更低。将其添加到运行器并重新运行测试。

run = testrrun . withnoplugins ();plugin = DiagnosticsOutputPlugin“OutputDetail”,冗长。简洁,“LoggingLevel”3,“IncludingPassingDiagnostics”,真正的);runner.addPlugin(插件);Result = runner.run(suite);
[详细]诊断日志(2018-04-13 13:47:34):Testing failing event FAIL: ExampleDiagOutputTest/testOne in ExampleDiagOutputTest. logteststone at 6:: verifequal失败。[详细]诊断日志(2018-04-13 13:47:34):Testing passing event PASS: ExampleDiagOutputTest/testTwo in ExampleDiagOutputTest. logtestTwo at 10:: verifyTrue通过。

版本历史

在R2018b中引入