matlab.uitest.TestCase Class
Namespace: matlab.uitest
Superclasses: matlab.unittest.TestCase
Class for writing tests with app testing framework
Description
The matlab.uitest.TestCase class lets you write tests that use the app
testing framework. Because the matlab.uitest.TestCase class derives from the
matlab.unittest.TestCase class, your tests have access to the features of the
unit testing framework, such as qualifications, fixtures, and plugins. For more information
about app testing, see Overview of App Testing Framework.
The matlab.uitest.TestCase class is a handle class.
Creation
In most cases, you are not required to create an instance of the
matlab.uitest.TestCase class directly. The app testing framework
automatically creates matlab.uitest.TestCase instances when running the
tests.
To create a matlab.uitest.TestCase instance for interactive, command-line
testing, use the forInteractiveUse
static method.
Methods
Examples
Create a discrete knob.
knob = uiknob('discrete');
Create an interactive test case and choose the 'High' knob value. An animated blue dot performs the programmatic choose gesture.
tc = matlab.uitest.TestCase.forInteractiveUse;
tc.choose(knob,'High')
View the value of the Items property on the knob.
knob.Items
ans =
1×4 cell array
{'Off'} {'Low'} {'Medium'} {'High'}Choose the 'Low' knob value by index. The knob moves from 'High' to 'Low'.
tc.choose(knob,2)
Create a state button.
b = uibutton('state');Create an interactive test case and verify that the value of the state button is false.
tc = matlab.uitest.TestCase.forInteractiveUse; tc.verifyFalse(b.Value)
Verification passed.
Press the button and verify the state changes to true. A blue dot representing the programmatic push gesture appears and then disappears on the button.
tc.press(b) tc.verifyTrue(b.Value)
Verification passed.
Programmatically drag on a slider UI component and verify the final value of the slider.
Create a slider with a minimum value of –10, a maximum value of 10, a step size of
0.1, and an initial value of 5. The
Step name-value argument restricts the valid values to
increments of the specified step size from the slider minimum. (since R2025a)
slider = uislider(Limits=[-10 10],Step=0.1,Value=5);
Create an interactive test case and use it to verify the initial value of the slider.
testCase = matlab.uitest.TestCase.forInteractiveUse; testCase.verifyEqual(slider.Value,5)
Verification passed.
Test a drag gesture on the slider and verify the final value. Because the framework mimics a user dragging the slider thumb to an arbitrarily precisioned value, it is a best practice to use a tolerance when comparing the actual and expected slider values.
x = 7.5; testCase.drag(slider,-x,x) testCase.verifyEqual(slider.Value,x,AbsTol=0.1)
Verification passed.
Since R2023b
Perform a gesture on a component that is not in the viewable area of a figure by automatically scrolling to the component.
Create a scrollable figure with a state button that is outside the viewable area of the figure.
fig = uifigure("Scrollable","on"); b = uibutton(fig,"state","Position",[fig.Position(3)+100 100 100 22]);
Create a test case for interactive testing, and verify the initial state of the button.
tc = matlab.uitest.TestCase.forInteractiveUse; tc.verifyFalse(b.Value)
Verification passed.
Press the button and verify that its state changes. Because the figure is scrollable, the app testing framework automatically scrolls to the button before performing the gesture.
tc.press(b) tc.verifyTrue(b.Value)
Verification passed.
