assumeUsing

Class: matlab.unittest.plugins.QualifyingPlugin
Namespace: matlab.unittest.plugins

Assume that value satisfies given constraint

Syntax

assumeUsing(plugin,context,actual,constraint)
assumeUsing(plugin,context,actual,constraint,diagnostic)


Description

assumeUsing(plugin,context,actual,constraint) assumes that actual is a value that satisfies the given constraint, constraint, using the qualification context. If the actual value does not satisfy the constraint, the testing framework reports an assumption failure.

You can perform assumptions in these QualifyingPlugin methods:

• setupSharedTestFixture

• teardownSharedTestFixture

• setupTestClass

• teardownTestClass

• setupTestMethod

• teardownTestMethod

assumeUsing(plugin,context,actual,constraint,diagnostic) displays the diagnostic information, diagnostic, upon failure.

Input Arguments

plugin — Qualifying plugin instance

matlab.unittest.plugins.QualifyingPlugin

Plugin instance, specified as an instance of the matlab.unittest.plugins.QualifyingPlugin class.

context — Context for plugins

matlab.unittest.plugins.plugindata.QualificationContext

Context for plugins, specified as an instance of matlab.unittest.plugins.plugindata.QualificationContext class. This instance provides the context for the plugin to perform qualifications on test suites. The plugin obtains this context from the plugin data.

actual — Value to test

workspace variable

Value to test, specified as a workspace variable. actual can be any data type. The qualification passes when actual satisfies the specified constraint, constraint.

constraint — Condition test must satisfy

instance of class in matlab.unittest.constraints namespace

Condition the test must satisfy, specified as an instance of a class in the matlab.unittest.constraints namespace.

diagnostic — Diagnostic information to display

string | character vector | function handle | instance of class in matlab.unittest.diagnostics namespace

Diagnostic information to display upon failure, specified as a string, a character vector, a function handle, or an instance of a class in the matlab.unittest.diagnostics namespace.

Examples

Use Qualifications in Plugin

See examples for the QualifyingPlugin class and replace calls to verifyUsing with assumeUsing.

Tips

Use the QualifyingPlugin.assumeUsing method to ensure that the test environment meets preconditions that otherwise do not result in a test failure. Assumption failures result in filtered tests, and the testing framework marks the associated test content as Incomplete. Alternatively,

• Use the QualifyingPlugin.verifyUsing method to produce and record failures without throwing an exception. Because a QualifyingPlugin performs additional qualifications beyond the ones defined in the unit tests, it typically uses verifications. Verifications do not cause an early exit from the test, ensuring that the test framework executes all test content. Use other qualification types to test for violation of preconditions or incorrect test setup.

• Use the QualifyingPlugin.assertUsing method when the failure condition invalidates the remainder of the current test content, but does not prevent proper execution of subsequent test methods. A failure at the assertion point renders the associated test content as failed and incomplete.

• Use the QualifyingPlugin.fatalAssertUsing method to abort the test session upon failure. These qualifications are useful when the failure mode is so fundamental that there is no point in continuing testing. These qualifications are also useful when fixture teardown does not restore the MATLAB^® state correctly and it is preferable to abort testing and start a fresh session.

Version History

Introduced in R2015b