matlab.unittest.plugins.TAPPlugin.producingVersion13

Class: matlab.unittest.plugins.TAPPlugin
Package: matlab.unittest.plugins

Construct TAPPlugin for version 13 TAP format

expand all in page

Syntax

matlab.unittest.plugins.TAPPlugin.producingVersion13

matlab.unittest.plugins.TAPPlugin.producingVersion13(stream)

matlab.unittest.plugins.TAPPlugin.producingVersion13(___,Name,Value)

Description

example

matlab.unittest.plugins.TAPPlugin.producingVersion13 creates a plugin that produces output in version 13 of the Test Anything Protocol (TAP) format. The TAP version 13 output includes test diagnostics in YAML blocks. By default, the plugin uses the ToStandardOutput stream, and the output appears on the screen. In this case, other output sent to the screen can invalidate the TAP stream.

matlab.unittest.plugins.TAPPlugin.producingVersion13(stream) redirects all the text output to a specified output stream. For example, you can redirect the output to the ToFile stream.

matlab.unittest.plugins.TAPPlugin.producingVersion13(___,Name,Value) creates a plugin with additional options specified by one or more Name,Value pair arguments.

Input Arguments

expand all

`stream` — Location where the plugin directs text output
`matlab.unittest.plugins.ToStandardOutput` (default) | instance of `matlab.unittest.plugins.OutputStream` class

Location where the plugin directs text output, specified as an instance of the OutputStream class. By default, the plugin uses the ToStandardOutput stream.

Example: stream = matlab.unittest.plugins.ToStandardOutput

Example: stream = matlab.unittest.plugins.ToFile('myFile.tap')

Name-Value Pair Arguments

Specify optional comma-separated pairs of Name,Value arguments. Name is the argument name and Value is the corresponding value. Name must appear inside quotes. You can specify several name and value pair arguments in any order as Name1,Value1,...,NameN,ValueN.

Example: TAPPlugin.producingVersion13('LoggingLevel', Verbosity.Detailed) creates a plugin that includes diagnostics logged at and below the Detailed level.

`'IncludingPassingDiagnostics'` — Include passing event diagnostics
`false` (default) | `true`

Whether to include passing event diagnostics, specified as false or true. By default the plugin does not include diagnostics from passing events.

Data Types: logical

`'LoggingLevel'` — Maximum level of logged diagnostics
1 (default) | 0 | 2 | 3 | 4 | `matlab.unittest.Verbosity` enumeration | enumeration name as string or char vector

Maximum level at which logged diagnostics are included by the plugin instance, specified as an integer value from 0 through 4, a matlab.unittest.Verbosity enumeration object, or a string scalar or character vector corresponding to one of the predefined enumeration member names. The plugin includes diagnostics that are logged at this level and below. Integer values correspond to the members of the matlab.unittest.Verbosity enumeration.

Numeric Representation	Enumeration Member Name	Verbosity Description
`0`	`None`	No information
`1`	`Terse`	Minimal information
`2`	`Concise`	Moderate amount of information
`3`	`Detailed`	Some supplemental information
`4`	`Verbose`	Lots of supplemental information

By default the plugin includes diagnostics logged at the matlab.unittest.Verbosity.Terse level (level 1). To exclude logged diagnostics, specify LoggingLevel as Verbosity.None (level 0).

Logged diagnostics are diagnostics that you supply to the testing framework with a call to the log (TestCase) or log (Fixture) method.

`'OutputDetail'` — Detail level for reported events
3 (default) | 0 | 1 | 2 | 4 | `matlab.unittest.Verbosity` enumeration | enumeration name as string or char vector

Detail level for reported events, specified as an integer value from 0 through 4, a matlab.unittest.Verbosity enumeration object, or a string scalar or character vector corresponding to one of the predefined enumeration member names. Integer values correspond to the members of the matlab.unittest.Verbosity enumeration.

The plugin reports passing, failing, and logged events with the amount of detail specified by OutputDetail. By default the plugin records events at the matlab.unittest.Verbosity.Detailed level (level 3).

Numeric Representation	Enumeration Member Name	Verbosity Description
`0`	`None`	No information
`1`	`Terse`	Minimal information
`2`	`Concise`	Moderate amount of information
`3`	`Detailed`	Some supplemental information
`4`	`Verbose`	Lots of supplemental information

Examples

expand all

Create TAP Plugin

In a new file in your working folder, 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 code
        end
    end
end

At the command prompt, create a test suite from the ExampleTest class.

import matlab.unittest.TestRunner
import matlab.unittest.TestSuite
import matlab.unittest.plugins.TAPPlugin
import matlab.unittest.plugins.ToFile

suite = TestSuite.fromClass(?ExampleTest);

Create a test runner that displays output to the command window using the default plugin.

runner = TestRunner.withTextOutput;

Create a TAPPlugin that sends output to the file MyTapOutput.tap.

tapFile = 'MyTAPOutput.tap';
plugin = TAPPlugin.producingVersion13(ToFile(tapFile));

Add the plugin to the TestRunner and run the suite.

runner.addPlugin(plugin)
result = runner.run(suite);

Running ExampleTest

================================================================================
Verification failed in ExampleTest/testOne.

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

    ---------------------
    Framework Diagnostic:
    ---------------------
    verifyEqual failed.
    --> The values are not equal using "isequaln".
    --> 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
================================================================================
...
Done ExampleTest
__________

Failure Summary:

     Name                 Failed  Incomplete  Reason(s)
    ==================================================================
     ExampleTest/testOne    X                 Failed by verification.

Display the file created by the plugin.

disp(fileread(tapFile))

TAP version 13
1..3
not ok 1 - ExampleTest/testOne
    ---
    Event:
        Event Name: 'VerificationFailed'
        Event Location: 'ExampleTest/testOne'
        Test Diagnostic: |
            Testing 5==4
        Framework Diagnostic: |
            verifyEqual failed.
            --> The values are not equal using "isequaln".
            --> Failure table:
                    Actual    Expected    Error    RelativeError
                    ______    ________    _____    _____________
                
                    5         4           1        0.25         
            
            Actual Value:
                 5
            Expected Value:
                 4
        Stack: |
            In C:\work\ExampleTest.m (ExampleTest.testOne) at 4
    ...
ok 2 - ExampleTest/testTwo
ok 3 - ExampleTest/testThree

You can use the TAPPlugin directed to standard output. However, any other text displayed to standard output (such as failed test information) interrupts the stream and has the potential to invalidate it.

Documentation

matlab.unittest.plugins.TAPPlugin.producingVersion13

Syntax

Description

Input Arguments

`stream` — Location where the plugin directs text output
`matlab.unittest.plugins.ToStandardOutput` (default) | instance of `matlab.unittest.plugins.OutputStream` class

Name-Value Pair Arguments

`'IncludingPassingDiagnostics'` — Include passing event diagnostics
`false` (default) | `true`

`'LoggingLevel'` — Maximum level of logged diagnostics
1 (default) | 0 | 2 | 3 | 4 | `matlab.unittest.Verbosity` enumeration | enumeration name as string or char vector

`'OutputDetail'` — Detail level for reported events
3 (default) | 0 | 1 | 2 | 4 | `matlab.unittest.Verbosity` enumeration | enumeration name as string or char vector

Examples

Create TAP Plugin

See Also

External Websites

MATLAB Documentation

Support

Documentation

matlab.unittest.plugins.TAPPlugin.producingVersion13

Syntax

Description

Input Arguments

stream — Location where the plugin directs text output matlab.unittest.plugins.ToStandardOutput (default) | instance of matlab.unittest.plugins.OutputStream class

Name-Value Pair Arguments

'IncludingPassingDiagnostics' — Include passing event diagnostics false (default) | true

'LoggingLevel' — Maximum level of logged diagnostics 1 (default) | 0 | 2 | 3 | 4 | matlab.unittest.Verbosity enumeration | enumeration name as string or char vector

'OutputDetail' — Detail level for reported events 3 (default) | 0 | 1 | 2 | 4 | matlab.unittest.Verbosity enumeration | enumeration name as string or char vector

Examples

Create TAP Plugin

See Also

External Websites

MATLAB Documentation

Support

`stream` — Location where the plugin directs text output
`matlab.unittest.plugins.ToStandardOutput` (default) | instance of `matlab.unittest.plugins.OutputStream` class

`'IncludingPassingDiagnostics'` — Include passing event diagnostics
`false` (default) | `true`

`'LoggingLevel'` — Maximum level of logged diagnostics
1 (default) | 0 | 2 | 3 | 4 | `matlab.unittest.Verbosity` enumeration | enumeration name as string or char vector

`'OutputDetail'` — Detail level for reported events
3 (default) | 0 | 1 | 2 | 4 | `matlab.unittest.Verbosity` enumeration | enumeration name as string or char vector