MATLAB: Skip an unit test

MATLABmatlab unit testunit test

Hi,

I have a list of unit tests. Some of them should be skipped.

I would assume as TestResult something like that:

TestResult with properties:
          Name: 'myTestCase'
        Passed: 0
        Failed: 0
    Incomplete: 1
      Duration: 0.42

In the documentation of "TestResult" there is one point: "Tests filtered through assumption"

How can I do this?

Thanks

Best Answer

To filter tests, you use an "assumable" qualification in your Test Method.

http://www.mathworks.com/help/releases/R2013b/matlab/ref/matlab.unittest.qualifications.assumableclass.html

This will skip the remainder of the Test method but not fail it, marking it incomplete.

http://www.mathworks.com/help/releases/R2013b/matlab/matlab_prog/write-test-using-assumptions.html

And a Quick Example:

classdef MyUnitTest < matlab.unittest.TestCase
    methods(Test)
        function Test(testCase)
            testCase.assumeTrue(ismac,'The computer is not a Mac')
            disp('This line of code will not run on my PC');
        end
    end
end

To run it:

T = MyUnitTest
run(T)

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 construct test cases derived from the matlab.unittest.TestCase class for private methods in MATLAB 8.1 (R2013a)

In MATLAB, you can specify the classes that are allowed to access a private method in the 'Access' attribute statement. Suppose MyTestCase is derived from the matlab.unittest.TestCase class in the following example:

methods( Access = ?MyTestCase )
      function obj = objMethod(obj)
          %do something
      end
end

This allows MyTestCase to access the private method objMethod.

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 construct test cases derived from the matlab.unittest.TestCase class for private methods in MATLAB 8.1 (R2013a)

Related Question