Integrating Results from a Custom-Authored MATLAB Script as a Test

In this example, you link a requirement to a MATLAB script. The verification status in the Simulink Requirements Editor reflects the test results. This example performs the steps described in Linking to a Test Script. To run this example, click Open Example and run it. This example uses:

  • A requirements set file named counter_req.slreqx.

  • A MATLAB script called runmytests.m that runs a test for the Counter class in Counter.m. The test script contains custom methods that write results a TAP format to a file named results.tap.

Section 1 : Register the Link Type

Before creating the links, you need to register the link type from the requirements set file. Open the requirements file counter_req.slreqx in the Requirements Editor:

reqSet = slreq.open('counter_req.slreqx');

Register the link type that is specific to the external test file. The domain registration needed for this example is linktype_mymscripttap.m. To register the custom link type link type linktype_mymscripttap.m, type:

rmi register linktype_mymscripttap;

The custom logic in the GetResultFcn function locates the test file that corresponds to the test case and fetches the results from that test file. For more information about GetResultFcn, see Links and Link Types.

Note: If the register command returns any warning, then you must unregister the file and run the command again. To unregister the file, enter rmi unregister linktype_mymscripttap.

Section 2: Create the Link

Make the struct containing properties of the external test. To create the link, at the command prompt, enter:

externalSource.id = 'counterStartsAtZero';
externalSource.artifact = 'runmytests.m';
externalSource.domain = 'linktype_mymscripttap';

The requirement related to the link has its SID set to 2. To find the requirement related to the link, enter:

requirement = reqSet.find('Type', 'Requirement', 'SID', 2);

To create the link, enter:

link = slreq.createLink(requirement, externalSource);

This command creates the link between the test case counterStartsAtZero and the requirement with the SID of 2. In Requirements Editor, the link appears in the Links > Confirmed By section.

Section 3: View the Verification Status

To view the verification status, you need to first update the verification status for the requirement set. At the MATLAB command prompt, type:

reqSet.updateVerificationStatus;

To see the verification status column in the Requirements Editor, ensure that Display > Verification Status is selected. After the update, fetch the verification status for the requirement:

status = reqSet.getVerificationStatus;

The Requirements Editor shows the verification status for entire requirements set that are passed or failed.

The verification status for the requirements for the counterStartsAtZero is fully verified. Open the Requirements Editor to see the verification status:

reqSet = slreq.open('counter_req.slreqx');

The verification status shows that out of three tests, one test passed. Click Refresh to see the verification status for the requirements in the Requirements Editor.

Cleanup

Clear open requirement sets and link sets, and close any open models without saving changes. Unregister the link type.

slreq.clear;
bdclose('all');
rmi unregister linktype_mymscripttap;

Related Topics

Include Results from External Sources in Verification Status

Linking to a Test Script