matlab.unittest.TestCase - Superclass of all test classes - MATLAB (original) (raw)

Namespace: matlab.unittest
Superclasses: matlab.unittest.qualifications.Assertable, matlab.unittest.qualifications.Assumable, matlab.unittest.qualifications.FatalAssertable, matlab.unittest.qualifications.Verifiable

Superclass of all test classes

Description

The matlab.unittest.TestCase class is the superclass of all test classes in MATLAB®. It provides an interface to write and identify test content, including test fixture setup and teardown routines.

Creating class-based tests requires subclassing the TestCase class. To specify tests and test fixtures, subclasses can leverage framework-specific attributes. For more information, see TestCase Class Attributes, TestCase Method Attributes, and TestCase Property Attributes.

The matlab.unittest.TestCase class is a handle class.

Creation

In most cases, you are not required to create an instance of the TestCase class directly. The test runner automatically creates TestCase instances when running the tests.

To create a TestCase instance for interactive, command-line testing, use the forInteractiveUse static method.

Methods

Examples

collapse all

Test the properties of a figure by creating and running a test class.

In a file named FigurePropertiesTest.m in your current folder, create the FigurePropertiesTest test class by:

• Subclassing the matlab.unittest.TestCase class
• Adding a property to represent the figure to test
• Adding setup and teardown code for each test in a TestMethodSetup methods block
• Adding tests in a Test methods block

classdef FigurePropertiesTest < matlab.unittest.TestCase properties TestFigure end

methods (TestMethodSetup)
    function createFigure(testCase)
        testCase.TestFigure = figure;
        testCase.addTeardown(@close,testCase.TestFigure)
    end
end

methods (Test)
    function defaultCurrentPoint(testCase)
        cp = testCase.TestFigure.CurrentPoint;
        testCase.verifyEqual(cp,[0 0], ...
            "Default current point must be [0 0].")
    end

    function defaultCurrentObject(testCase)
        import matlab.unittest.constraints.IsEmpty
        co = testCase.TestFigure.CurrentObject;
        testCase.verifyThat(co,IsEmpty, ...
            "Default current object must be empty.")
    end
end

end

Run the tests in the test class. In this example, both of the tests pass.

results = runtests("FigurePropertiesTest")

Running FigurePropertiesTest

. Done FigurePropertiesTest

results = 1×2 TestResult array with properties:

Name
Passed
Failed
Incomplete
Duration
Details

Totals: 2 Passed, 0 Failed, 0 Incomplete. 1.1899 seconds testing time.

More About

expand all

These class attributes are specific to TestCase subclasses.

Standard attributes also apply to TestCase subclasses. For details, seeClass Attributes.

These method attributes are specific to TestCase subclasses.

Standard attributes also apply to methods of TestCase subclasses. For details, see Method Attributes.

These property attributes are specific to TestCase subclasses.

Standard attributes also apply to properties of TestCase subclasses. For details, see Property Attributes.

Tips

• Defining constructor or destructor methods in a TestCase subclass is not recommended. TestCase constructor and destructor methods are not considered test content and should not be used to perform qualifications. For example, theSampleTest class specifies qualifications using a constructor method and a Test method. However, the qualification in the constructor method does not produce a test failure. The testing framework reports only one test failure as a result of the qualification performed within the testSize method.
  classdef SampleTest < matlab.unittest.TestCase
  methods
  function testCase = SampleTest % Constructor method not recommended
  testCase.verifyEqual(1,2) % Does not produce a test failure
  end
  end
  methods (Test)
  function testSize(testCase)
  testCase.verifySize([1 2 3; 4 5 6],[2 4]) % Produces a test failure
  end
  end
  end

Version History

Introduced in R2013a

expand all

You can specify the value of the ParameterCombination method attribute as "_`n`_-wise", where_`n`_ is an integer between 2 and 10. For more information, see Use Parameters in Class-Based Tests.

The matlab.unittest.TestCase class has a new methodcreateTemporaryFolder that creates a temporary folder for your tests. The lifecycle of the folder is tied to the test case. Once the test case goes out of scope, the testing framework removes the folder.

You can initialize a parameterization property at test suite creation time using a static method with the new TestParameterDefinition attribute. This feature is useful when parameters cannot be determined at the time MATLAB loads the test class definition. For more information, see Define Parameters at Suite Creation Time.