Main Content

sltest.testmanager.report

Generate report of test results

所有的页面崩溃

Syntax

sltest.testmanager.report(resultObj,filePath,Name,Value)

Description

example

sltest.testmanager.report(resultObj,filePath,Name,Value)generates a report of the specified results inresultObjand saves the report to thefilePathlocation.

Examples

collapse all

Generate a report that includes the test author, test title, and the MATLAB®version used to run the test case. The report includes only failed results.

filePath ='test.pdf'; sltest.testmanager.report(resultObj,filePath,...'Author','TestAuthor',...'Title','Test',...'IncludeMLVersion',true,...'IncludeTestResults',2);

If you create a custom class to customize how the report is generated using thesltest.testmanager.TestResultReportclass, then generate the report using:

% Import existing results or use sltest.testmanager.run to run tests% and collect resultsresult = sltest.testmanager.importResults('testResults.mldatx'); filePath ='testreport.zip'; sltest.testmanager.report(result,filePath,...'Author','User',...'Title','Test',...'IncludeMLVersion',true,...'IncludeTestResults',int32(0),...'IncludeSimulationSignalPlots',true,...'NumPlotColumnsPerPage',2,...'CustomReportClass','CustomReport',...'LaunchReport',true);

Input Arguments

collapse all

文件名和路径的基因rated report, specified as a character vector. File path must have file extension of pdf, docx, or zip, which are the only supported file types.

Name-Value Arguments

Specify optional pairs of arguments asName1=Value1,...,NameN=ValueN, whereNameis the argument name andValueis the corresponding value. Name-value arguments must appear after other arguments, but the order of the pairs does not matter.

Before R2021a, use commas to separate each name and value, and encloseNamein quotes.

Example:'IncludeTestRequirement',true

Name of the report author, specified as a character vector.

Example:'Test Engineer'

Title of the report, specified as a character vector.

Example:'Test_Report_1'

Choose to include the version of MATLAB used to run the test cases, specified as a Boolean value,trueorfalse.

Choose to include the test requirement link defined underRequirementsin the test case, specified as a Boolean value,trueorfalse.

Choose to include the simulation output plots of each signal, specified as a Boolean value,trueorfalse.

Number of rows of plots to include on report pages, specified as an integer from 1 to 4. This property is used only if theIncludeSimulationSignalPlotsproperty istrue.

Number of columns of plots to include on report pages, specified as an integer from 1 to 4. This property is used only if theIncludeSimulationSignalPlotsproperty istrue.

Choose to include the signal comparison plots defined under baseline criteria, equivalence criteria, or assessments using theverifyoperator in the test case, specified as a Boolean value,trueorfalse.

Option to include the figures opened from a callback script, custom criteria, or by the model in the report, specified astrueorfalse.

Choose to include error messages from the test case simulations, specified as a Boolean value,trueorfalse.

Option to include all or a subset of test results in the report. You can select passed and failed results, specified as the integer value0, select only passed results, specified as the value1, or select only failed results, specified as the value2.

Open the report when it is finished generating, specified as a Boolean value,trueor to not open the report,false.

Name and path for aMicrosoft®Wordtemplate file to use for report generation, specified as a character vector. This is an optional argument that is only available if you have aMATLAB Report Generator™license.

Name of the class used for report customization, specified as a character vector. This is an optional argument that is only available if you have aMATLAB Report Generatorlicense.

Choose to include coverage metrics that are collected at test execution, specified as a Boolean value,trueorfalse. For more information about collecting coverage, seeCollect Coverage in Tests.

Choose to include simulation metadata for each test case or iteration, specified as a Boolean value,trueorfalse. The metadata includes: Simulink®version, model version, model author, date, model user ID, model path, machine name, solver name, solver type, fixed step size, simulation start time, simulation stop time, and platform.

Version History

Introduced in R2015a

See Also

|

Topics