Documentation

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 in resultObj and saves the report to the filePath location.

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 the sltest.testmanager.TestResultReport class, then generate the report using:

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

Input Arguments

collapse all

Results set object to get results from, specified as an sltest.testmanager.ResultSet object.

File name and path of the generated 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 Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside single quotes (' '). You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: 'IncludeTestRequirement',true

collapse all

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, true or false.

Choose to include the test requirement link defined under Requirements in the test case, specified as a Boolean value, true or false.

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

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

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

Choose to include any error messages from the test case simulations, specified as a Boolean value, true or false.

Option to include all or a subset of test results in the report. You can select passed and failed results, specified as the integer value 0, select only passed results, specified as the value 1, or select only failed results, specified as the value 2.

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

Name and path for a Microsoft® Word template file to use for report generation, specified as a character vector. This is an optional argument that is only available if you have a MATLAB 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 a MATLAB Report Generator license.

Choose to include coverage metrics that are collected at test execution, specified as a Boolean value, true or false. For more information about collecting coverage, see Collect Coverage in Tests.

Choose to include simulation metadata for each test case or iteration, specified as a Boolean value, true or false. 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.

Introduced in R2015a

Was this topic helpful?