MATLAB: In Matlab unittesting how to modify a property after test suite is created

ooptestparamterunit testunittest

I would like to modify a property (not a TestParameter) after the test suite is created but I am getting an error "No public field myparam exists for class matlab.unittest.Test". Here is what I am doing in terms of code: I create a class unitclass.m

classdef unitclass < matlab.unittest.TestCase
    properties ( SetAccess = public )
        myparam = 2;
    end
    properties (TestParameter)
        test_param1 = struct('Low', 0.1,'Medium', 0.5);
        test_param2 = struct('Cold', 10,'Hot', 200);
    end
    methods (Test)  
        function testError(testcase,test_param1,test_param2)
            output = test_param1 * test_param2;  
            testcase.myparam
            testcase.verifyLessThan(output,20);
        end
    end
end

Then a create a custom unittest SDLTest.m class to modify my parameter

classdef SDLTest < matlab.unittest.Test
   methods (Static = true)
       function this = set_myparam(this,myparam)
           for i = 1:length(this)
               this(i).myparam = myparam;
           end
       end
   end
end

when I try to execute the code

mySuite = matlab.unittest.TestSuite.fromClass(?unitclass)
results = SDLTest.set_myparam(mySuite,1)

I get the error "No public field myparam exists for class matlab.unittest.Test".

Help with this is greatly appreciatd.

Thanks.

Best Answer

Hello Nadjib,

The reason you can't change the property like you were trying to do is becase matlab.unittest.Test and matlab.unittest.TestCase are not in the same class hierarchy. The Test arrays are what give the TestRunner the knowledge of how to run the tests defined in the TestCase classes, but the runner constructs the TestCase classes during the test run.

It sounds to me like you may be interested in the log method of TestCase which was included in the framework in R2014b.

Using this feature, if you write a " PlotDiagnostic " similar to the one shown in this post , you could generate the plots only when you run the test above a certain verbosity threshold. This would look like:

classdef unitclass < matlab.unittest.TestCase
    properties (TestParameter)
        test_param1 = struct('Low', 0.1,'Medium', 0.5);
        test_param2 = struct('Cold', 10,'Hot', 200);
    end
    methods (Test)  
        function testError(testcase,test_param1,test_param2)
            output = test_param1 * test_param2;  
            testcase.log(3, PlotDiagnostic(output)); % can be another verbosity
            testcase.verifyLessThan(output,20);
        end
    end
end

Then when could run it as follows:

   >> % run it normally (& easily)
   >> runtests('unitclass')
   >> 
   >> % create the suite and run it at a higher verbosity level to show the plots
   >> import matlab.unittest.TestSuite
   >> import matlab.unittest.TestRunner
   >> 
   >> suite = TestSuite.fromClass(?unitclass)
   >> runner = TestRunner.withTextOutput('Verbosity', 3)
   >> runner.run(suite);

Here are a few relevant links of interest for you:

Does that help?

Related Solutions

MATLAB: How to assign the Test Diagnostic provided by the Unit Testing framework in the Command Window to a variable

Hi Malek,

You can get programmatic access to this information by creating and installing a TestRunnerPlugin for the test run. This plugin can then listen to qualification failed events (like verification failures, assertion failure, etc) and this diagnostic information is contained in the TestDiagnosticResult property of the event data as a cell array of strings.

Here is a quick example that save all of the test diagnostics for failing verifications in test methods. Note this could expand to cover other cases like assertions, assumptions, etc and other scopes like TestClassSetup, but this might help get you started.

classdef TestDiagnosticSaverPlugin < matlab.unittest.plugins.TestRunnerPlugin
      properties
          TestDiagnosticData
      end
      methods (Access = protected)
          function runTestSuite(plugin, pluginData) 
              plugin.TestDiagnosticData = []; % Reinitialize for each test run
              runTestSuite@...
                  matlab.unittest.plugins.TestRunnerPlugin(plugin, pluginData);
          end
          function testCase = createTestMethodInstance(plugin, pluginData)
              testCase = createTestMethodInstance@...
                  matlab.unittest.plugins.TestRunnerPlugin(plugin, pluginData);
              testName = pluginData.Name;
              testCase.addlistener('VerificationFailed', ...
                @(~,event)plugin.storeTestDiagnosticsData(event,pluginData.Name));
          end
      end
      methods (Access = private)
          function storeTestDiagnosticsData(plugin,eventData,name,failureType)
              s.Name = {name};
              s.TestDiagnostics = eventData.TestDiagnosticResult;
              plugin.TestDiagnosticData = [plugin.TestDiagnosticData; struct2table(s)];
          end
      end
  end

With the above plugin you could then install it on a runner:

>> import matlab.unittest.TestRunner;
>> import matlab.unittest.TestSuite;
>> suite = TestSuite.fromFile('mbd_ZaehlerUnitTest.m')
>> runner = TestRunner.withTextOutput;
>> plugin = TestDiagnosticSaverPlugin;
>> runner.addPlugin(plugin);
>> runner.run(suite)
>> plugin.TestDiagnosticData

Hope that helps! Here are a few links you might find interesting to help you do this:

Writing plugins overview

Example of creating a custom plugin

QualificationEventData

MATLAB: How to pass values from inside a TestRunner run

You can use a TestRunnerPlugin to store data from the test run. I've included some example code below to show how this might work. The basic outline is as follows:

The test logs information using a Diagnostic subclass and TestCase.log
A plugin listens to the DiagnosticLogged event and stores the logged data on itself
After running the test, you can then access the data on the plugin

Example test code:

classdef MyTest < matlab.unittest.TestCase
    properties (ClassSetupParameter)
        idx = num2cell(1:3);
    end
    properties
        MyData;
    end
    methods(TestClassSetup)
        function createData(testCase,idx)
            testCase.MyData = idx;
            testCase.log(4, DataDiagnostic(testCase.MyData));
        end
    end
    methods(Test)
        function a(testCase)
        end
    end
end

Plugin code:

classdef MyPlugin < matlab.unittest.plugins.TestRunnerPlugin
    properties(SetAccess=private)
        Data = {};
    end
    methods(Access=protected)
        function testCase = createTestClassInstance(plugin, pluginData)
            testCase = createTestClassInstance@matlab.unittest.plugins.TestRunnerPlugin(plugin, pluginData);
            testCase.addlistener('DiagnosticLogged', @plugin.logDiagnostic);
        end
    end
    methods(Access=private)
        function logDiagnostic(plugin, src, evd)
            if isa(evd.Diagnostic, 'DataDiagnostic')
                plugin.Data{end+1} = evd.Diagnostic.Data;
            end
        end
    end
end

Diagnostic class code:

classdef DataDiagnostic < matlab.unittest.diagnostics.Diagnostic
    properties(SetAccess=immutable)
        Data;
    end
    methods
        function diag = DataDiagnostic(data)
            diag.Data = data;
        end
        function diagnose(~)
        end
    end
end

Usage:

>> suite = testsuite('MyTest');
>> runner = matlab.unittest.TestRunner.withTextOutput;
>> plugin = MyPlugin;
>> runner.addPlugin(plugin);
>> runner.run(suite);
Running MyTest
...
Done MyTest
__________
>> plugin.Data
ans =
    1×3 cell array
      {[1]}    {[2]}    {[3]}

References:

Best Answer

Related Solutions

MATLAB: How to assign the Test Diagnostic provided by the Unit Testing framework in the Command Window to a variable

MATLAB: How to pass values from inside a TestRunner run

Related Question