sltest.testmanager.registerTestAdapter

Since R2022b

Syntax

sltest.testmanager.registerTestAdapter(adapterfcn,adapterdefault)

Description

sltest.testmanager.registerTestAdapter(adapterfcn,adapterdefault) registers an adapter function to convert an Excel^® or MAT file that contains test data to a format supported by the Test Manager. For information about the supported Excel format, see Microsoft Excel Import, Export, and Logging Format.

Examples

collapse all

Register an Excel Adapter

Open Live Script

This example shows how to use and register a function that converts the formatting of an Excel spreadsheet so it can be used in the Test Manager. The spreadsheet has 6 sheets, each corresponding to an iteration. Each sheet has a header with the iteration name and description. The sheets also include the built-in formats for specifying test inputs, parameters, and baselines. This examples uses the CruiseContol model.

The files used in this example are:

CruiseControlTests_CustomHeader.xlsx - Excel spreadsheet
HybridBuiltInAdapter.m - Adapter function
CruiseControlTests_HybridBuiltInAdapter.mldatx - Test file

View the adapter function.

type HybridBuiltInAdapter.m

function HybridBuiltInAdapter(testCase, inputFileName)  

    % Find iteration test specs (worksheets)
    [sheets] = sheetnames(inputFileName); 

    % Configure test case from each worksheet
    for ii=1:numel(sheets)
        % Create new iteration object and get iteration information
        testItr = sltestiteration();
        [testItr.Name, testItr.Description,specRange] = ...
            getTestInfo(inputFileName,sheets{ii});
        % Add a single input set from worksheet and map to ports
        testInput = testCase.addInput(inputFileName,Sheet=sheets(ii),...
            Ranges={specRange},SimulationIndex=1,CreateIterations=false);
        testInput.map('Mode',0,'CompileModel',true);
        setTestParam(testItr,'ExternalInput',testInput.Name);

        % Add a single baseline set from worksheet
        baseline = testCase.addBaselineCriteria(inputFileName, ...
            Sheet=sheets(ii),Ranges={specRange});
        setTestParam(testItr,'Baseline',baseline.Name);
        % Add iteration to run in this test case
        addIteration(testCase,testItr); 
    end
end

function [name,desc,specRange] = getTestInfo(inputFileName,sheetName)
% Get test name and description, input/output cell range, and 
% parameter data from worksheet
    rawT = readcell(inputFileName,'Sheet',sheetName,'UseExcel',false);

    % Assign missing data to '' for "isempty" checks
    rawT(cellfun(@(x) all(ismissing(x)), rawT)) = {''};

    % Find row with "Name" and find row with "Description"
    nameRow = find(cellfun(@(x) strcmpi(x,'Name'),rawT(:,1)),1);
    name = rawT{nameRow,2};
    descRow = find(cellfun(@(x) strcmpi(x,'Description'),rawT(:,1)),1);
    desc = rawT{descRow,2};

    % Find test vector row range
    timeRow = find(cellfun(@(x) strcmpi(x,'Time'), rawT(:,1)));
    endRow = numel(rawT(:,1));
    specRange = [num2str(timeRow) ':' num2str(endRow)];
end

sltest.testmanager.registerTestAdapter...
    ('HybridBuiltInAdapter',true);

Open the CruiseControlTests_HybridBuiltInAdapter test file in the Test Manager.

tf = sltest.testmanager.TestFile...
    ('CruiseControlTests_HybridBuiltInAdapter.mldatx'); 
sltest.testmanager.view

Selecting the Create Test Case from External File and specifying the File and Adapter in the Test Manager adds the data and information adapted from the Excel file. For example, see the Inputs and Iterations sections of the test case.

Test Manager section showing checkbox to create test case from external file and filled in file and adapter fields.

Input section showing the external inputs for each worksheet in the Excel file

Iterations showing the name and description for each iteration

Clean up and close the Test Manager.

sltest.testmanager.clear
sltest.testmanager.clearResults
sltest.testmanager.close

Register Baseline Parameters in a MAT File

Create and register a function to format a MAT file to use in the Test Manager. This example assumes that you have a MAT file that has x, y, and z parameters and xin and yin inputs.

Create a function that converts a baseline test parameter set in the MAT file.

function Adapter_InputBaselineParamSet(test,externalMATFile)
   load(externalMATFile);
   
   % Set model property for the test case
   setProperty(test,'Model',mdl_name);

   % Save external file parameters to a supported format
   % MAT file and add parameter set to test case
   save('param.mat','x','y','z');
   paramset = addParameterSet(test,'FilePath',...
       'param.mat','SimulationIndex',1) 

   % Save external file inputs to a supported format MAT
   % file and add inputs to test case
   save('input.mat','xin','yin');
   inputs = addInput(test,'input.mat');
   inputs.map(3);                         

   % Capture baseline criteria and add to test case
   captureBaselineCriteria(test,'base.mat',true);

Then register the function by using its function handle.

sltest.testmanager.registerTestAdapter(...
    @Adapter_InputBaselineParamSet,true);

Input Arguments

collapse all

`adapterfcn` — Adapter function name
function handle

Adapter function name, specified as a function handle. The adapter function specifies how to convert an Excel or MAT test data file into a format supported by the Test Manager.

`adapterdefault` — Whether to use the adapter as the default
`false` or `0` (default) | `true` or `1`

Whether to use the specified adapter as the default for the test case, specified as a numeric or logical 1 (true) or 0 (false). When you set the adapterdefault input to 1 or true, the test case uses specified adapter even if you previously registered a different adapter.