matlab.uitest.TestCase class

Package: matlab.uitest
Superclasses: matlab.unittest.TestCase

TestCase to write tests with app testing framework

Description

Use the matlab.uitest.TestCase class to write tests that use the app testing framework. The matlab.uitest.TestCase derives from the matlab.unittest.TestCase class.

To avoid user interference with the app during testing, the framework locks new figure instances. The components of locked figures only respond to programmatic gestures via TestCase methods such as press and choose.

Construction

The testing framework constructs the matlab.uitest.TestCase instances.

Methods

choose	Perform choose gesture on UI component
chooseContextMenu	Perform choose gesture on context menu item
dismissAlertDialog	Close frontmost alert dialog box in figure window
drag	Perform drag gesture on UI component
forInteractiveUse	Create a TestCase object for interactive use
hover	Perform hover gesture on UI component
press	Perform press gesture on UI component
type	Type in UI component

Inherited Methods

addTeardown	Dynamically add teardown routine to TestCase instance
applyFixture	Use fixture with TestCase
createTemporaryFolder	Create temporary folder
forInteractiveUse	Create TestCase for interactive use
getSharedTestFixtures	Provide access to shared test fixtures
log	Record diagnostic information during test execution
onFailure	Dynamically add diagnostics for test failures
run	Run TestCase test

Also, the TestCase class inherits methods from these classes:

Attributes

Abstract	true
HandleCompatibile	true

For information on class attributes, see Class Attributes.

Copy Semantics

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

Examples

Choose Value on Discrete Knob

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)

Press Button and Verify Value Change

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.

Drag Slider and Verify Stop Value

Create a slider with a minimum value of -237, a maximum value of 237, and a starting value of 7.

slider = uislider('Limits',[-237 237],'Value',7);

Create an interactive test case and verify the initial value of the slider.

tc = matlab.uitest.TestCase.forInteractiveUse;
tc.verifyEqual(slider.Value,7)

Verification passed.

Drag the slider between two values and verify the final value. Since the framework mimics a user manipulating the component to an arbitrarily precisioned value, it is a best practice to use a tolerance to compare the actual and expected slider values.

val = 26.75;
tc.drag(slider,-val,val)
tc.verifyEqual(slider.Value,val,'AbsTol',0.1)

Verification passed.

Version History

Introduced in R2018a

R2021a: Close alert dialog box in front of figure window

The matlab.uitest.TestCase class has a new method dismissAlertDialog that programmatically closes an alert dialog box in front of a figure window.

R2020b: Perform choose gestures on context menu items

The matlab.uitest.TestCase class has a new method chooseContextMenu that lets you test choose gestures on context menu items for UI components.

R2019a: Perform hover gestures on axes, UI axes, and UI figures

The matlab.uitest.TestCase class has a new method hover that lets you test hover gestures on axes, UI axes, and UI figures.