matlab.unittest.plugins.TestReportPlugin.producingDOCX
Class: matlab.unittest.plugins.TestReportPlugin
Namespace: matlab.unittest.plugins
Create plugin that generates DOCX test report
Syntax
Description
plugin = matlab.unittest.plugins.TestReportPlugin.producingDOCX
creates a plugin that generates a DOCX report of test results in a temporary folder.
This syntax is equivalent to plugin =
matlab.unittest.plugins.TestReportPlugin.producingDOCX([tempname
'.docx'])
.
plugin = matlab.unittest.plugins.TestReportPlugin.producingDOCX(
saves the report using the specified filename.filename
)
plugin = matlab.unittest.plugins.TestReportPlugin.producingDOCX(___,
specifies options using one or more name-value arguments in addition to any of the
input argument combinations in previous syntaxes. For example, Name,Value
)plugin =
matlab.unittest.plugins.TestReportPlugin.producingDOCX("LoggingLevel","detailed")
creates a plugin that generates a test report that includes diagnostics logged at
and below the "detailed"
level.
Input Arguments
filename
— Name of test report file
string scalar | character vector
Name of the test report file, specified as a string scalar or character
vector ending in .docx
. The value can be a path relative
to the current folder or an absolute path.
Example: "myTestReport.docx"
Example: "C:\work\myTestReport.docx"
Name-Value Arguments
Specify optional pairs of arguments as
Name1=Value1,...,NameN=ValueN
, where Name
is
the argument name and Value
is the corresponding value.
Name-value arguments must appear after other arguments, but the order of the
pairs does not matter.
Example: plugin =
matlab.unittest.plugins.TestReportPlugin.producingDOCX(LoggingLevel="detailed")
Before R2021a, use commas to separate each name and value, and enclose
Name
in quotes.
Example: plugin =
matlab.unittest.plugins.TestReportPlugin.producingDOCX("LoggingLevel","detailed")
PageOrientation
— Report orientation
"portrait"
(default) | "landscape"
Report orientation, specified as "portrait"
or "landscape"
. By default, the plugin generates a report in portrait orientation.
Title
— Title of test report
string scalar | character vector
Title of the test report, specified as a string scalar or character vector. By default, the
plugin uses "MATLAB® Test Report"
as the title.
Example: Title="My Test Report"
IncludingCommandWindowText
— Whether to include text output from Command Window
false
or 0
(default) | true
or 1
Whether to include the text output from the Command Window, specified as a numeric or
logical 0
(false
) or 1
(true
). By default, the plugin does not include the text output
from the Command Window in the test report.
IncludingPassingDiagnostics
— Whether to include diagnostics for passing events
false
or 0
(default) | true
or 1
Whether to include the diagnostics for passing events, specified as a numeric or
logical 0
(false
) or 1
(true
). By default, the plugin does not include the diagnostics
for passing events in the test report.
LoggingLevel
— Maximum verbosity level of logged diagnostics
1
(default) | 0
| 2
| 3
| 4
| matlab.automation.Verbosity
enumeration object | text representation of enumeration
Maximum verbosity level of logged diagnostics to include in the test report, specified
as an integer scalar from 0
through 4
, a matlab.automation.Verbosity
enumeration object, or a text representation of
the enumeration. The plugin includes diagnostics logged at the specified level and
below.
Numeric Representation | Enumeration Member Name | Verbosity Description |
---|---|---|
0 | None | No information |
1 | Terse | Minimal information |
2 | Concise | Moderate amount of information |
3 | Detailed | Some supplemental information |
4 | Verbose | Lots of supplemental information |
By default, the plugin includes diagnostics logged at the
matlab.automation.Verbosity.Terse
level (level 1). To exclude
logged diagnostics, specify LoggingLevel
as
matlab.automation.Verbosity.None
(level 0).
Logged diagnostics are diagnostics that you supply to
the testing framework with the log (TestCase)
and log (Fixture)
methods.
Example: "LoggingLevel","detailed"
Examples
Generate Test Report in DOCX Format
Create a test suite from two test files, run
the suite, and generate a .docx
report of the results.
Create a new file in your working folder named ScriptBasedTest.m
containing
the following test script. The script includes two failing and incomplete
tests.
%% Test double class expSolution = 'double'; actSolution = ones; assert(isa(actSolution,expSolution)) %% Test single class expSolution = 'single'; actSolution = ones('single'); assert(isa(actSolution,expSolution)) %% Test uint16 class expSolution = 'uint16'; actSolution = ones('uint16'); assert(isa(actSolution,expSolution)) %% Test that fails assert(false==true); %% Another test that fails assert(strcmp('correlation','causation'))
Create a file named ClassBasedTest.m
containing the
following test class.
classdef ClassBasedTest < matlab.unittest.TestCase properties (ClassSetupParameter) generator = {'twister','combRecursive','multFibonacci'}; end properties (MethodSetupParameter) seed = {0,123,4294967295}; end properties (TestParameter) dim1 = struct('small',1,'medium',2,'large',3); dim2 = struct('small',2,'medium',3,'large',4); dim3 = struct('small',3,'medium',4,'large',5); type = {'single','double'}; end methods (TestClassSetup) function ClassSetup(testCase,generator) orig = rng; testCase.addTeardown(@rng,orig) rng(0, generator) end end methods (TestMethodSetup) function MethodSetup(testCase,seed) orig = rng; testCase.addTeardown(@rng,orig) rng(seed) end end methods (Test, ParameterCombination='sequential') function testSize(testCase,dim1,dim2,dim3) testCase.verifySize(rand(dim1,dim2,dim3),[dim1 dim2 dim3]) end end methods (Test, ParameterCombination='pairwise') function testRepeatable(testCase,dim1,dim2,dim3) state = rng; firstRun = rand(dim1,dim2,dim3); rng(state) secondRun = rand(dim1,dim2,dim3); testCase.verifyEqual(firstRun,secondRun); end end methods (Test) function testClass(testCase,dim1,dim2,type) testCase.verifyClass(rand(dim1,dim2,type),type) end end end
At the command prompt, create a test suite from both test files.
import matlab.unittest.TestRunner; import matlab.unittest.TestSuite; import matlab.unittest.plugins.TestReportPlugin; suite = testsuite({'ScriptBasedTest','ClassBasedTest'})
suite = 1×284 Test array with properties: Name ProcedureName TestClass BaseFolder Parameterization SharedTestFixtures Tags Tests Include: 17 Unique Parameterizations, 0 Shared Test Fixture Classes, 0 Tags.
Create a silent test runner, so that there is no information
output to the command window. Create a TestReportPlugin
that
sends output to the file MyTestReport.docx
.
runner = TestRunner.withNoPlugins;
docxFile = 'MyTestReport.docx';
plugin = TestReportPlugin.producingDOCX(docxFile);
Add the plugin to the TestRunner
and
run the suite.
runner.addPlugin(plugin); result = runner.run(suite)
Generating report. Please wait. Preparing content for the report. Adding content to the report. Writing report to file. Report has been saved to: C:\work\MyTestReport.docx result = 1×284 TestResult array with properties: Name Passed Failed Incomplete Duration Details Totals: 282 Passed, 2 Failed, 2 Incomplete. 0.73477 seconds testing time.
Open the test report.
open(docxFile)
Generate DOCX Report That Includes Passing Diagnostics
Create a test suite from a function-based test, run the suite, and generate a report of the results. Include passing diagnostics and the text output to the Command Window.
Create a new file in your working folder named
FunctionBasedTest.m
containing the following
function-based test. The test file includes two failing tests.
%% Main function to generate tests function tests = FunctionBasedTest tests = functiontests(localfunctions); end %% Test Functions function passingTest(testCase) actSolution = 13*3+7*5; expSolution = 74; verifyEqual(testCase,actSolution,expSolution) end function failingTest(testCase) actSolution = single(1); verifyTrue(testCase,actSolution) end function anotherPassingTest(testCase) verifyClass(testCase,string('some text'),'string') end function anotherFailingTest(testCase) verifyTrue(testCase,strcmp('42','everything')) end
At the command prompt, create a test suite from
FunctionBasedTest.m
. Create a test runner that
displays output to the command window using the default plugin.
import matlab.unittest.TestRunner; import matlab.unittest.TestSuite; import matlab.unittest.plugins.TestReportPlugin; suite = testsuite('FunctionBasedTest'); runner = TestRunner.withTextOutput;
Create a TestReportPlugin
that sends output to the file
MyTestReport2.docx
. Include passing diagnostics and
text output from the Command Window in the report.
docxFile = 'MyTestReport2.docx'; plugin = TestReportPlugin.producingDOCX(docxFile,... 'IncludingPassingDiagnostics',true,'IncludingCommandWindowText',true);
Add the plugin to the TestRunner
and run the
suite.
runner.addPlugin(plugin); result = runner.run(suite);
Running FunctionBasedTest . ================================================================================ Verification failed in FunctionBasedTest/failingTest. --------------------- Framework Diagnostic: --------------------- verifyTrue failed. --> The value must be logical. It is of type "single". Actual single: 1 ------------------ Stack Information: ------------------ In C:\Work\FunctionBasedTest.m (failingTest) at 15 ================================================================================ .. ================================================================================ Verification failed in FunctionBasedTest/anotherFailingTest. --------------------- Framework Diagnostic: --------------------- verifyTrue failed. --> The value must evaluate to "true". Actual logical: 0 ------------------ Stack Information: ------------------ In C:\Work\FunctionBasedTest.m (anotherFailingTest) at 23 ================================================================================ . Done FunctionBasedTest __________ Failure Summary: Name Failed Incomplete Reason(s) =================================================================================== FunctionBasedTest/failingTest X Failed by verification. ----------------------------------------------------------------------------------- FunctionBasedTest/anotherFailingTest X Failed by verification. Generating report. Please wait. Preparing content for the report. Adding content to the report. Writing report to file. Report has been saved to: C:\Work\MyTestReport2.docx
Open the test report.
open(docxFile)
Version History
Introduced in R2016bR2023b: Modify test report title
To modify the title of your test report, specify the Title
name-value
argument.
Comando de MATLAB
Ha hecho clic en un enlace que corresponde a este comando de MATLAB:
Ejecute el comando introduciéndolo en la ventana de comandos de MATLAB. Los navegadores web no admiten comandos de MATLAB.
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)