matlab.unittest.plugins.XMLPlugin class

Package: matlab.unittest.plugins

Plugin that writes test results in XML format

expand all in page

Description

The XMLPlugin class creates a plugin that writes test results to a file in XML format.

Construction

Instantiate an XMLPlugin using one of its static methods.

matlab.unittest.plugins.XMLPlugin.producingJUnitFormat(xmlFile) returns a plugin that produces JUnit-style XML output to the file, xmlFile. Using this plugin, you can integrate MATLAB® Unit Test results into third-party systems that recognize the JUnit-style XML. For example, you can integrate test results with continuous integration systems like Jenkins™, TeamCity®, or Microsoft® Team Foundation Server.

Input Arguments

expand all

Name of the test-result file, specified as a character vector or string scalar. If xmlFile exists, the test framework overwrites the file.

Example: XMLPlugin.producingJUnitFormat('myTestResults.xml')

Copy Semantics

Handle. To learn how handle classes affect copy operations, see Copying Objects.

Examples

collapse all

Create ExampleTest.m containing the following test class.

classdef ExampleTest < matlab.unittest.TestCase
    methods(Test)
        function testOne(testCase)  % Test fails
            testCase.verifyEqual(5,4,'Testing 5==4')
        end
        function testTwo(testCase)  % Test passes
            testCase.verifyEqual(5,5,'Testing 5==5')
        end
        function testThree(testCase) % Test fails
            testCase.assumeTrue(false)
        end
    end
end

Create a test suite from the ExampleTest class. Create a silent test runner.

import matlab.unittest.TestRunner
import matlab.unittest.TestSuite
import matlab.unittest.plugins.XMLPlugin

suite = TestSuite.fromClass(?ExampleTest);
runner = TestRunner.withNoPlugins;

Create an XMLPlugin that writes test results to the file myTestResults.xml.

xmlFile = 'myTestResults.xml';
p = XMLPlugin.producingJUnitFormat(xmlFile);

Add the plugin to the test runner and run the suite.

runner.addPlugin(p)
results = runner.run(suite);
table(results)
ans = 

             Name              Passed    Failed    Incomplete    Duration       Details   
    _______________________    ______    ______    __________    _________    ____________

    'ExampleTest/testOne'      false     true      false          0.078297    [1x1 struct]
    'ExampleTest/testTwo'      true      false     false         0.0038761    [1x1 struct]
    'ExampleTest/testThree'    false     false     true           0.049763    [1x1 struct]

View the contents in the file created by the plugin.

disp(fileread(xmlFile))
<?xml version="1.0" encoding="utf-8"?>
<testsuites>
   <testsuite errors="0" failures="1" name="" skipped="1" tests="3" time="0.0493">
      <testcase classname="ExampleTest" name="testOne" time="0.030643">
         <failure type="VerificationFailure">================================================================================
Verification failed in ExampleTest/testOne.

    ----------------
    Test Diagnostic:
    ----------------
    Testing 5==4

    ---------------------
    Framework Diagnostic:
    ---------------------
    verifyEqual failed.
    --&gt; The values are not equal using "isequaln".
    --&gt; Failure table:
                Actual    Expected    Error    RelativeError
                ______    ________    _____    _____________
            
                5         4           1        0.25         
    
    Actual double:
             5
    Expected double:
             4

    ------------------
    Stack Information:
    ------------------
    In C:\work\ExampleTest.m (ExampleTest.testOne) at 4
================================================================================
</failure>
      </testcase>
      <testcase classname="ExampleTest" name="testTwo" time="0.004332"/>
      <testcase classname="ExampleTest" name="testThree" time="0.014325">
         <skipped>================================================================================
ExampleTest/testThree was filtered.
================================================================================
</skipped>
      </testcase>
   </testsuite>
</testsuites>

Tips

  • If your test file is a script-based or function-based test, the value of the classname attribute of the <testcase> element is the test file name.

See Also

External Websites

Introduced in R2015b

Was this topic helpful?
MATLAB Documentation
Support