QTest Namespace

The QTouchEventSequence class is used to simulate a sequence of touch events.

This enum describes possible actions for key handling.

This enum describes possible actions for mouse handling.

This enum lists all the things that can be benchmarked.

Note that WalltimeNanoseconds and BytesAllocated are only provided for use via setBenchmarkResult(), and results in those metrics are not able to be provided automatically by the QTest framework.

See Also▲

This enum describes the modes for handling a check, such as by QVERIFY() or QCOMPARE() macros, that is known to fail. The mode applies regardless of whether the check fails or succeeds.

See Also▲

Adds a column with type T to the current test data. name is the name of the column. dummy is a workaround for buggy compilers and can be ignored.

To populate the column with values, newRow() can be used. Use QFETCH() to fetch the data in the actual test.

Example:

    QTest::addColumn<int>("intval");
    QTest::addColumn<QString>("str");
    QTest::addColumn<double>("dbl");
    QTest::newRow("row1") << 1 << "hello" << 1.5;

To add custom types to the testdata, the type must be registered with QMetaType via Q_DECLARE_METATYPE().

See Data Driven Testing for a more extensive example.

See Also▲

Appends a new row to the current test data. The function's arguments are passed to qsnprintf() for formatting according to format. See the qvsnprintf() documentation for caveats and limitations.

The formatted string will appear as the name of this test data in the test output.

Returns a QTestData reference that can be used to stream in data.

Example:

    QTest::addColumn<int>("input");
    QTest::addColumn<QString>("output");
    QTest::addRow("%d", 0) << 0 << QString("0");
    QTest::addRow("%d", 1) << 1 << QString("1");

See Data Driven Testing for a more extensive example.

This function was introduced in Qt 5.9.

See Also▲

Returns the enum value metric as a character string.

Returns the units of measure for the specified metric.

Creates a dummy touch device of type devType with capabilities caps for simulation of touch events.

The touch device will be registered with the QPA window system interface, and deleted automatically when the QCoreApplication is deleted. So you should typically use createTouchDevice() to initialize a QPointingDevice member variable in your test case class, and use the same instance for all tests.

This function was introduced in Qt 5.8.

See Also▲

Returns the name of the binary that is currently executed.

Returns the name of the current test data. If the test doesn't have any assigned testdata, the function returns 0.

Returns true if the current test function failed, otherwise false.

Returns the name of the test function that is currently executed.

Example:

void MyTestClass::cleanup()
{
    if (qstrcmp(QTest::currentTestFunction(), "myDatabaseTest") == 0) {
        // clean up all database connections
        closeAllDatabases();
    }
}

Appends a test failure to the test log for each warning that matches messagePattern.

The test function will continue execution when a failure is added. To abort the test instead, you can check currentTestFailed() and return early if it's true.

For each warning, the first pattern that matches will cause a failure, and the remaining patterns will be ignored.

All patterns are cleared at the end of each test function.

void FileTest::loadFiles()
{
    QTest::failOnWarning(QRegularExpression("^Failed to load"));

    // Each of these will cause a test failure:
    qWarning() << "Failed to load image";
    qWarning() << "Failed to load video";
}

To fail every test that triggers a given warning, pass a suitable regular expression to this function in init():

void FileTest::init()
{
    QTest::failOnWarning(QRegularExpression(".?"));
}

This function was introduced in Qt 6.3.

See Also▲

This function overloads failOnWarning().

Appends a test failure to the test log if the message is output.

This function was introduced in Qt 6.3.

See Also▲

Ignores messages created by qDebug(), qInfo() or qWarning(). If the message with the corresponding type is outputted, it will be removed from the test log. If the test finished and the message was not outputted, a test failure is appended to the test log.

Example:

QDir dir;
QTest::ignoreMessage(QtWarningMsg, "QDir::mkdir: Empty or null file name(s)");
dir.mkdir("");

The example above tests that QDir::mkdir() outputs the right warning when invoked with an invalid file name.

This is an overloaded function.

Ignores messages created by qDebug(), qInfo() or qWarning(). If the message matching messagePattern with the corresponding type is outputted, it will be removed from the test log. If the test finished and the message was not outputted, a test failure is appended to the test log.

This function was introduced in Qt 5.3.

Simulates clicking of key with an optional modifier on a widget. If delay is larger than 0, the test will wait for delay milliseconds before clicking the key.

Examples:

QTest::keyClick(myWidget, Qt::Key_Escape);

QTest::keyClick(myWidget, Qt::Key_Escape, Qt::ShiftModifier, 200);

The first example above simulates clicking the escape key on myWidget without any keyboard modifiers and without delay. The second example simulates clicking shift-escape on myWidget following a 200 ms delay of the test.

See Also▲

This is an overloaded function.

Simulates clicking of key with an optional modifier on a window. If delay is larger than 0, the test will wait for delay milliseconds before clicking the key.

Examples:

QTest::keyClick(&myWindow, Qt::Key_Escape);
QTest::keyClick(&myWindow, Qt::Key_Escape, Qt::ShiftModifier, 200);

The first example above simulates clicking the escape key on myWindow without any keyboard modifiers and without delay. The second example simulates clicking shift-escape on myWindow following a 200 ms delay of the test.

This function was introduced in Qt 5.0.

See Also▲

This is an overloaded function.

Simulates clicking of key with an optional modifier on a window. If delay is larger than 0, the test will wait for delay milliseconds before clicking the key.

Example:

QWidget myWindow;
QTest::keyClick(&myWindow, Qt::Key_Tab);

The example above simulates clicking a on myWindow without any keyboard modifiers and without delay of the test.

This function was introduced in Qt 5.0.

See Also▲

This is an overloaded function.

Simulates clicking of key with an optional modifier on a widget. If delay is larger than 0, the test will wait for delay milliseconds before clicking the key.

Example:

QTest::keyClick(myWidget, 'a');

The example above simulates clicking a on myWidget without any keyboard modifiers and without delay of the test.

See Also▲

Simulates clicking a sequence of keys on a widget. Optionally, a keyboard modifier can be specified as well as a delay (in milliseconds) of the test before each key click.

Example:

QTest::keyClicks(myWidget, "hello world");

The example above simulates clicking the sequence of keys representing "hello world" on myWidget without any keyboard modifiers and without delay of the test.

See Also▲

Sends a Qt key event to widget with the given key and an associated action. Optionally, a keyboard modifier can be specified, as well as a delay (in milliseconds) of the test before sending the event.

This is an overloaded function.

Sends a Qt key event to window with the given key ascii and an associated action. Optionally, a keyboard modifier can be specified, as well as a delay (in milliseconds) of the test before sending the event.

This function was introduced in Qt 5.0.

This is an overloaded function.

Sends a Qt key event to window with the given key and an associated action. Optionally, a keyboard modifier can be specified, as well as a delay (in milliseconds) of the test before sending the event.

This function was introduced in Qt 5.0.

This is an overloaded function.

Sends a Qt key event to widget with the given key ascii and an associated action. Optionally, a keyboard modifier can be specified, as well as a delay (in milliseconds) of the test before sending the event.

Simulates pressing a key with an optional modifier on a widget. If delay is larger than 0, the test will wait for delay milliseconds before pressing the key.

See Also▲

This is an overloaded function.

Simulates pressing a key with an optional modifier on a window. If delay is larger than 0, the test will wait for delay milliseconds before pressing the key.

This function was introduced in Qt 5.0.

See Also▲

This is an overloaded function.

Simulates pressing a key with an optional modifier on a window. If delay is larger than 0, the test will wait for delay milliseconds before pressing the key.

This function was introduced in Qt 5.0.

See Also▲

This is an overloaded function.

Simulates pressing a key with an optional modifier on a widget. If delay is larger than 0, the test will wait for delay milliseconds before pressing the key.

See Also▲

Simulates releasing a key with an optional modifier on a widget. If delay is larger than 0, the test will wait for delay milliseconds before releasing the key.

See Also▲

This is an overloaded function.

Simulates releasing a key with an optional modifier on a window. If delay is larger than 0, the test will wait for delay milliseconds before releasing the key.

This function was introduced in Qt 5.0.

See Also▲

This is an overloaded function.

Simulates releasing a key with an optional modifier on a window. If delay is larger than 0, the test will wait for delay milliseconds before releasing the key.

This function was introduced in Qt 5.0.

See Also▲

This is an overloaded function.

Simulates releasing a key with an optional modifier on a widget. If delay is larger than 0, the test will wait for delay milliseconds before releasing the key.

See Also▲

This is an overloaded function.

Simulates typing of keySequence into a window.

This function was introduced in Qt 5.10.

See Also▲

This is an overloaded function.

Simulates typing of keySequence into a widget.

This function was introduced in Qt 5.10.

See Also▲

Simulates clicking a mouse button with an optional modifier on a widget. The position of the click is defined by pos; the default position is the center of the widget. If delay is specified, the test will wait for the specified amount of milliseconds before pressing and before releasing the button.

See Also▲

This is an overloaded function.

Simulates clicking a mouse button with an optional stateKey modifier on a window. The position of the click is defined by pos; the default position is the center of the window. If delay is specified, the test will wait for the specified amount of milliseconds before pressing and before releasing the button.

This function was introduced in Qt 5.0.

See Also▲

Simulates double clicking a mouse button with an optional modifier on a widget. The position of the click is defined by pos; the default position is the center of the widget. If delay is specified, the test will wait for the specified amount of milliseconds before each press and release.

See Also▲

This is an overloaded function.

Simulates double clicking a mouse button with an optional stateKey modifier on a window. The position of the click is defined by pos; the default position is the center of the window. If delay is specified, the test will wait for the specified amount of milliseconds before each press and release.

This function was introduced in Qt 5.0.

See Also▲

Moves the mouse pointer to a widget. If pos is not specified, the mouse pointer moves to the center of the widget. If a delay (in milliseconds) is given, the test will wait before moving the mouse pointer.

This is an overloaded function.

Moves the mouse pointer to a window. If pos is not specified, the mouse pointer moves to the center of the window. If a delay (in milliseconds) is given, the test will wait before moving the mouse pointer.

This function was introduced in Qt 5.0.

Simulates pressing a mouse button with an optional modifier on a widget. The position is defined by pos; the default position is the center of the widget. If delay is specified, the test will wait for the specified amount of milliseconds before the press.

See Also▲

This is an overloaded function.

Simulates pressing a mouse button with an optional stateKey modifier on a window. The position is defined by pos; the default position is the center of the window. If delay is specified, the test will wait for the specified amount of milliseconds before the press.

This function was introduced in Qt 5.0.

See Also▲

Simulates releasing a mouse button with an optional modifier on a widget. The position of the release is defined by pos; the default position is the center of the widget. If delay is specified, the test will wait for the specified amount of milliseconds before releasing the button.

See Also▲

This is an overloaded function.

Simulates releasing a mouse button with an optional stateKey modifier on a window. The position of the release is defined by pos; the default position is the center of the window. If delay is specified, the test will wait for the specified amount of milliseconds before releasing the button.

This function was introduced in Qt 5.0.

See Also▲

Appends a new row to the current test data. dataTag is the name of the testdata that will appear in the test output. Returns a QTestData reference that can be used to stream in data.

Example:

void MyTestClass::addSingleStringRows()
{
    QTest::addColumn<QString>("aString");
    QTest::newRow("just.hello") << QString("hello");
    QTest::newRow("a.null.string") << QString();
}

See Data Driven Testing for a more extensive example.

See Also▲

Executes tests declared in testObject. In addition, the private slots initTestCase(), cleanupTestCase(), init() and cleanup() are executed if they exist. See Creating a Test for more details.

Optionally, the command line arguments argc and argv can be provided. For a list of recognized arguments, read Qt Test Command Line Arguments.

The following example will run all tests in MyTestObject:

MyTestObject test1;
QTest::qExec(&test1);

This function returns 0 if no tests failed, or a value other than 0 if one or more tests failed or in case of unhandled exceptions. (Skipped tests do not influence the return value.)

For stand-alone test applications, the convenience macro QTEST_MAIN() can be used to declare a main() function that parses the command line arguments and executes the tests, avoiding the need to call this function explicitly.

The return value from this function is also the exit code of the test application when the QTEST_MAIN() macro is used.

For stand-alone test applications, this function should not be called more than once, as command-line options for logging test output to files and executing individual test functions will not behave correctly.

If you have programmatically created the arguments, as opposed to getting them from the arguments in main(), it is likely of interest to use QTest::qExec(QObject *, const QStringList &) since it is Unicode safe.

See Also▲

This is an overloaded function.

Behaves identically to qExec(QObject *, int, char**) but takes a QStringList of arguments instead of a char** list.

Extracts a directory from resources to disk. The content is extracted recursively to a temporary folder. The extracted content is removed automatically once the last reference to the return value goes out of scope.

dirName is the name of the directory to extract from resources.

Returns the temporary directory where the data was extracted or null in case of errors.

Sleeps for ms milliseconds, blocking execution of the test. qSleep() will not do any event processing and leave your test unresponsive. Network communication might time out while sleeping. Use QTest::qWait() to do non-blocking sleeping.

ms must be greater than 0.

Note: The qSleep() function calls either nanosleep() on unix or Sleep() on windows, so the accuracy of time spent in qSleep() depends on the operating system.

Example:

QTest::qSleep(250);

See Also▲

Waits for ms milliseconds. While waiting, events will be processed and your test will stay responsive to user interface events or network communication.

Example:

    int i = 0;
    while (myNetworkServerNotResponding() && i++ < 50)
        QTest::qWait(250);

The code above will wait until the network server is responding for a maximum of about 12.5 seconds.

See Also▲

Waits for timeout milliseconds or until the predicate returns true.

Returns true if the predicate returned true at any point, otherwise returns false.

Example:

    MyObject obj;
    obj.startup();
    QTest::qWaitFor([&]() {
        return obj.isReady();
    }, 3000);

The code above will wait for the object to become ready, for a maximum of three seconds.

This function was introduced in Qt 5.10.

Returns true, if window is active within timeout milliseconds. Otherwise returns false.

The method is useful in tests that call QWindow::show() and rely on the window actually being active (i.e. being visible and having focus) before proceeding.

This function was introduced in Qt 5.0.

See Also▲

Returns true if widget is active within timeout milliseconds. Otherwise returns false.

The method is useful in tests that call QWidget::show() and rely on the widget actually being active (i.e. being visible and having focus) before proceeding.

This function was introduced in Qt 5.0.

See Also▲

Returns true, if window is exposed within timeout milliseconds. Otherwise returns false.

The method is useful in tests that call QWindow::show() and rely on the window actually being being visible before proceeding.

This function was introduced in Qt 5.0.

See Also▲

Returns true if widget is exposed within timeout milliseconds. Otherwise returns false.

The method is useful in tests that call QWidget::show() and rely on the widget actually being being visible before proceeding.

This function was introduced in Qt 5.0.

See Also▲

Sets the benchmark result for this test function to result.

Use this function if you want to report benchmark results without using the QBENCHMARK macro. Use metric to specify how Qt Test should interpret the results.

The context for the result will be the test function name and any data tag from the _data function. This function can only be called once in each test function, subsequent calls will replace the earlier reported results.

Note that the -iterations command line argument has no effect on test functions without the QBENCHMARK macro.

Returns a pointer to a string that is the string ba represented as a space-separated sequence of hex characters. If the input is considered too long, it is truncated. A trucation is indicated in the returned string as an ellipsis at the end. The caller has ownership of the returned pointer and must ensure it is later passed to operator delete[].

length is the length of the string ba.

Returns a textual representation of value. This function is used by QCOMPARE() to output verbose information in case of a test failure.

You can add specializations or overloads of this function to your test to enable verbose output.

Example for specializing (Qt ≤ 5.4):

namespace QTest {
    template<>
    char *toString(const MyPoint &point)
    {
        const QByteArray ba("MyPoint("
                            + QByteArray::number(point.x()) + ", "
                            + QByteArray::number(point.y()) + ')');
        return qstrdup(ba.data());
    }
}

The example above defines a toString() specialization for a class called MyPoint. Whenever a comparison of two instances of MyPoint fails, QCOMPARE() will call this function to output the contents of MyPoint to the test log.

Same example, but with overloading (Qt ≥ 5.5):

namespace {
    char *toString(const MyPoint &point)
    {
        return QTest::toString("MyPoint(" +
                               QByteArray::number(point.x()) + ", " +
                               QByteArray::number(point.y()) + ')');
    }
}

See Also▲

This is an overloaded function.

Returns a textual representation of the pair.

This function was introduced in Qt 5.11.

This is an overloaded function.

Returns a textual representation of the 4D vector v.

This function was introduced in Qt 5.11.

This is an overloaded function.

Returns a textual representation of policy p.

This function was introduced in Qt 5.5.

This is an overloaded function.

Returns a textual representation of control types cts.

This function was introduced in Qt 5.5.

This is an overloaded function.

Returns a textual representation of control type ct.

This function was introduced in Qt 5.5.

This is an overloaded function.

Returns a textual representation of size policy sp.

This function was introduced in Qt 5.5.

This is an overloaded function.

Returns a textual representation of the pair.

This function was introduced in Qt 5.11.

This is an overloaded function.

Returns a textual representation of the given tuple.

This function was introduced in Qt 5.12.

This is an overloaded function.

Returns a textual representation of the given string.

This function was introduced in Qt 5.11.

This is an overloaded function.

Returns a textual representation of the given string.

This is an overloaded function.

Returns a textual representation of the given string.

This is an overloaded function.

Returns a textual representation of the byte array ba.

See Also▲

This is an overloaded function.

Returns a textual representation of the given time.

This is an overloaded function.

Returns a textual representation of the given date.

This is an overloaded function.

Returns a textual representation of the date and time specified by dateTime.

This is an overloaded function.

Returns a textual representation of the given CBOR error c.

This function was introduced in Qt 5.12.

This is an overloaded function.

Returns a textual representation of the given character.

This is an overloaded function.

Returns a textual representation of the given point.

This is an overloaded function.

Returns a textual representation of the given size.

This is an overloaded function.

Returns a textual representation of the given rectangle.

This is an overloaded function.

Returns a textual representation of the given point.

This is an overloaded function.

Returns a textual representation of the given size.

This is an overloaded function.

Returns a textual representation of the given rectangle.

This is an overloaded function.

Returns a textual representation of the given url.

This is an overloaded function.

Returns a textual representation of the given uuid.

This function was introduced in Qt 5.11.

This is an overloaded function.

Returns a textual representation of the given variant.

This is an overloaded function.

Returns a string containing nullptr.

This function was introduced in Qt 5.8.

This is an overloaded function.

Returns a textual representation of the 2D vector v.

This function was introduced in Qt 5.11.

This is an overloaded function.

Returns a textual representation of the 3D vector v.

This function was introduced in Qt 5.11.

Creates and returns a QTouchEventSequence for the device to simulate events for widget.

When adding touch events to the sequence, widget will also be used to translate the position provided to screen coordinates, unless another widget is provided in the respective calls to press(), move() etc.

The touch events are committed to the event system when the destructor of the QTouchEventSequence is called (ie when the object returned runs out of scope), unless autoCommit is set to false. When autoCommit is false, commit() has to be called manually.

createTouchDevice() can be called to create a test touch device for use with this function.

Creates and returns a QTouchEventSequence for the device to simulate events for window.

When adding touch events to the sequence, window will also be used to translate the position provided to screen coordinates, unless another window is provided in the respective calls to press(), move() etc.

The touch events are committed to the event system when the destructor of the QTouchEventSequence is called (ie when the object returned runs out of scope), unless autoCommit is set to false. When autoCommit is false, commit() has to be called manually.

createTouchDevice() can be called to create a test touch device for use with this function.

This function was introduced in Qt 5.0.

This macro is used to measure the performance of code within a test. The code to be benchmarked is contained within a code block following this macro.

For example:

void TestBenchmark::simple()
{
    QString str1 = u"This is a test string"_s;
    QString str2 = u"This is a test string"_s;
    QCOMPARE(str1.localeAwareCompare(str2), 0);
    QBENCHMARK {
        str1.localeAwareCompare(str2);
    }
}

See Also▲

The QBENCHMARK_ONCE macro is for measuring performance of a code block by running it once.

This macro is used to measure the performance of code within a test. The code to be benchmarked is contained within a code block following this macro.

Unlike QBENCHMARK, the contents of the contained code block is only run once. The elapsed time will be reported as "0" if it's to short to be measured by the selected backend. (Use)

See Also▲

The QCOMPARE() macro compares an actual value to an expected value using the equality operator. If actual and expected match, execution continues. If not, a failure is recorded in the test log and the test function returns without attempting any later checks.

Always respect QCOMPARE() parameter semantics. The first parameter passed to it should always be the actual value produced by the code-under-test, while the second parameter should always be the expected value. When the values don't match, QCOMPARE() prints them with the labels Actual and Expected. If the parameter order is swapped, debugging a failing test can be confusing and tests expecting zero may fail due to rounding errors.

QCOMPARE() tries to output the contents of the values if the comparison fails, so it is visible from the test log why the comparison failed.

Example:

QCOMPARE(QString("hello").toUpper(), QString("HELLO"));

When comparing floating-point types (float, double, and qfloat16), qFuzzyCompare() is used for finite values. If qFuzzyIsNull() is true for both values, they are also considered equal. Infinities match if they have the same sign, and any NaN as actual value matches with any NaN as expected value (even though NaN != NaN, even when they're identical).

When comparing QList, arrays and initializer lists of the value type can be passed as expected value:

    const int expected[] = {8, 10, 12, 16, 20, 24};
    QCOMPARE(QFontDatabase::standardSizes(), expected);

Note that using initializer lists requires a defining a helper macro to prevent the preprocessor from interpreting the commas as macro argument delimiters:

 #define ARG(...) __VA_ARGS__
     QCOMPARE(QFontDatabase::standardSizes(), ARG({8, 10, 12, 16, 20, 24}));
 #undef ARG

For your own classes, you can overload QTest::toString() to format values for output into the test log. Example:

char *toString(const MyType &t)
{
    char *repr = new char[t.reprSize()];
    t.writeRepr(repr);
    return repr;
}

The return from toString() must be a new char []. That is, it shall be released with delete[] (rather than free() or plain delete) once the calling code is done with it.

See Also▲

The QCOMPARE_EQ() macro checks that left is equal to right using the equality operator. If that is true, execution continues. If not, a failure is recorded in the test log and the test function returns without attempting any later checks.

It is generally similar to calling QVERIFY(left == right); but prints a formatted error message reporting left and right argument expressions and values in case of failure.

For your own classes, you can overload QTest::toString() to format values for output into the test log.

This macro was introduced in Qt 6.4.

See Also▲

The QCOMPARE_GE() macro checks that left is at least right using the greater-than-or-equal-to operator. If that is true, execution continues. If not, a failure is recorded in the test log and the test function returns without attempting any later checks.

It is generally similar to calling QVERIFY(left >= right); but prints a formatted error message reporting left and right argument expressions and values in case of failure.

For your own classes, you can overload QTest::toString() to format values for output into the test log.

This macro was introduced in Qt 6.4.

See Also▲

The QCOMPARE_GT() macro checks that left is greater than right using the greater-than operator. If that is true, execution continues. If not, a failure is recorded in the test log and the test function returns without attempting any later checks.

It is generally similar to calling QVERIFY(left > right); but prints a formatted error message reporting left and right argument expressions and values in case of failure.

For your own classes, you can overload QTest::toString() to format values for output into the test log.

This macro was introduced in Qt 6.4.

See Also▲

The QCOMPARE_LE() macro checks that left is at most right using the less-than-or-equal-to operator. If that is true, execution continues. If not, a failure is recorded in the test log and the test function returns without attempting any later checks.

It is generally similar to calling QVERIFY(left <= right); but prints a formatted error message reporting left and right argument expressions and values in case of failure.

For your own classes, you can overload QTest::toString() to format values for output into the test log.

This macro was introduced in Qt 6.4.

See Also▲

The QCOMPARE_LT() macro checks that left is less than right using the less-than operator. If that is true, execution continues. If not, a failure is recorded in the test log and the test function returns without attempting any later checks.

It is generally similar to calling QVERIFY(left < right); but prints a formatted error message reporting left and right argument expressions and values in case of failure.

For your own classes, you can overload QTest::toString() to format values for output into the test log.

This macro was introduced in Qt 6.4.

See Also▲

The QCOMPARE_NE() macro checks that left is not equal to right using the inequality operator. If that is true, execution continues. If not, a failure is recorded in the test log and the test function returns without attempting any later checks.

It is generally similar to calling QVERIFY(left != right); but prints a formatted error message reporting left and right argument expressions and values in case of failure.

For your own classes, you can overload QTest::toString() to format values for output into the test log.

This macro was introduced in Qt 6.4.

See Also▲

The QEXPECT_FAIL() macro marks the next QCOMPARE() or QVERIFY() as an expected failure. Instead of adding a failure to the test log, an expected failure will be reported.

If a QVERIFY() or QCOMPARE() is marked as an expected failure, but passes instead, an unexpected pass (XPASS) is written to the test log.

The parameter dataIndex describes for which entry in the test data the failure is expected. Pass an empty string ("") if the failure is expected for all entries or if no test data exists.

comment will be appended to the test log for the expected failure.

mode is a QTest::TestFailMode and sets whether the test should continue to execute or not. The mode is applied regardless of whether the expected test failure occurs.

Example 1:

QEXPECT_FAIL("", "Will fix in the next release", Continue);
QCOMPARE(i, 42);
QCOMPARE(j, 43);

In the example above, an expected fail will be written into the test output if the variable i is not 42. If the variable i is 42, an unexpected pass is written instead. The QEXPECT_FAIL() has no influence on the second QCOMPARE() statement in the example.

Example 2:

QEXPECT_FAIL("data27", "Oh my, this is soooo broken", Abort);
QCOMPARE(i, 42);

The above testfunction will not continue executing for the test data entry data27 (regardless of the value of i).

See Also▲

This macro can be used to force a test failure. The test stops executing and the failure message is appended to the test log.

Example:

if (sizeof(int) != 4)
    QFAIL("This test has not been ported to this platform yet.");

The fetch macro creates a local variable named name with the type type on the stack. The name and type must match a column from the test's data table. This is asserted and the test will abort if the assertion fails.

Assuming a test has the following data:

void TestQString::toInt_data()
{
    QTest::addColumn<QString>("aString");
    QTest::addColumn<int>("expected");

    QTest::newRow("positive+value") << "42" << 42;
    QTest::newRow("negative-value") << "-42" << -42;
    QTest::newRow("zero") << "0" << 0;
}

The test data has two elements, a QString called aString and an integer called expected. To fetch these values in the actual test:

void TestQString::toInt()
{
     QFETCH(QString, aString);
     QFETCH(int, expected);

     QCOMPARE(aString.toInt(), expected);
}

aString and expected are variables on the stack that are initialized with the current test data.

This macro fetches a variable named name with the type type from a row in the global data table. The name and type must match a column in the global data table. This is asserted and the test will abort if the assertion fails.

Assuming a test has the following data:

void TestQLocale::initTestCase_data()
{
    QTest::addColumn<QLocale>("locale");
    QTest::newRow("C") << QLocale::c();
    QTest::newRow("UKish") << QLocale("en_GB");
    QTest::newRow("USAish") << QLocale(QLocale::English, QLocale::UnitedStates);
}

void TestQLocale::roundTripInt_data()
{
    QTest::addColumn<int>("number");
    QTest::newRow("zero") << 0;
    QTest::newRow("one") << 1;
    QTest::newRow("two") << 2;
    QTest::newRow("ten") << 10;
}

The test's own data is a single number per row. In this case, initTestCase_data() also supplies a locale per row. Therefore, this test will be run with every combination of locale from the latter and number from the former. Thus, with four rows in the global table and three in the local, the test function is run for 12 distinct test-cases (4 * 3 = 12).

void TestQLocale::roundTripInt()
{
    QFETCH_GLOBAL(QLocale, locale);
    QFETCH(int, number);
    bool ok;
    QCOMPARE(locale.toInt(locale.toString(number), &ok), number);
    QVERIFY(ok);
}

The locale is read from the global data table using QFETCH_GLOBAL(), and the number is read from the local data table using QFETCH().

Returns a QString for the testdata file referred to by filename, or an empty QString if the testdata file could not be found.

This macro allows the test to load data from an external file without hardcoding an absolute filename into the test, or using relative paths which may be error prone.

The returned path will be the first path from the following list which resolves to an existing file or directory:

• filename relative to QCoreApplication::applicationDirPath() (only if a QCoreApplication or QApplication object has been created).

• filename relative to the test's standard install directory (QLibraryInfo::TestsPath with the lowercased testcase name appended).

• filename relative to the directory containing the source file from which QFINDTESTDATA is invoked.

If the named file/directory does not exist at any of these locations, a warning is printed to the test log.

For example, in this code:

bool tst_MyXmlParser::parse()
{
    MyXmlParser parser;
    QString input = QFINDTESTDATA("testxml/simple1.xml");
    QVERIFY(parser.parse(input));
}

The testdata file will be resolved as the first existing file from:

• /home/user/build/myxmlparser/tests/tst_myxmlparser/testxml/simple1.xml

• /usr/local/Qt-5.0.0/tests/tst_myxmlparser/testxml/simple1.xml

• /home/user/sources/myxmlparser/tests/tst_myxmlparser/testxml/simple1.xml

This allows the test to find its testdata regardless of whether the test has been installed, and regardless of whether the test's build tree is equal to the test's source tree.

This macro was introduced in Qt 5.0.

If called from a test function, the QSKIP() macro stops execution of the test without adding a failure to the test log. You can use it to skip tests that wouldn't make sense in the current configuration. For example, a test of font rendering may call QSKIP() if the needed fonts are not installed on the test system.

The text description is appended to the test log and should contain an explanation of why the test couldn't be executed.

If the test is data-driven, each call to QSKIP() in the test function will skip only the current row of test data, so an unconditional call to QSKIP() will produce one skip message in the test log for each row of test data.

If called from an _data function, the QSKIP() macro will stop execution of the _data function and will prevent execution of the associated test function. This entirely omits a data-driven test. To omit individual rows, make them conditional by using a simple if (condition) newRow(...) << ... in the _data function, instead of using QSKIP() in the test function.

If called from initTestCase_data(), the QSKIP() macro will skip all test and _data functions. If called from initTestCase() when there is no initTestCase_data(), or when it only sets up one row, QSKIP() will likewise skip the whole test. However, if initTestCase_data() contains more than one row, then initTestCase() is called (followed by each test and finally the wrap-up) once per row of it. Therefore, a call to QSKIP() in initTestCase() will merely skip all test functions for the current row of global data, set up by initTestCase_data().

Example:

if (!QSqlDatabase::drivers().contains("SQLITE"))
    QSKIP("This test requires the SQLITE database driver");

Skipping Known Bugs▲

Notes▲

See Also▲

QTEST() is a convenience macro for QCOMPARE() that compares the value actual with the element testElement from the test's data. If there is no such element, the test asserts.

Apart from that, QTEST() behaves exactly as QCOMPARE().

Instead of writing:

QFETCH(QString, myString);
QCOMPARE(QString("hello").toUpper(), myString);

you can write:

QTEST(QString("hello").toUpper(), "myString");

See Also▲

Implements a main() function that executes all tests in TestClass.

Behaves like QTEST_MAIN(), but doesn't instantiate a QApplication object. Use this macro for really simple stand-alone non-GUI tests.

See Also▲

Implements a main() function that instantiates a QCoreApplication object and the TestClass, and executes all tests in the order they were defined. Use this macro to build stand-alone executables.

Behaves like QTEST_MAIN(), but instantiates a QCoreApplication instead of the QApplication object. Use this macro if your test case doesn't need functionality offered by QApplication, but the event loop is still necessary.

This macro was introduced in Qt 5.0.

See Also▲

Implements a main() function that instantiates an application object and the TestClass, and executes all tests in the order they were defined. Use this macro to build stand-alone executables.

If QT_WIDGETS_LIB is defined, the application object will be a QApplication, if QT_GUI_LIB is defined, the application object will be a QGuiApplication, otherwise it will be a QCoreApplication. If qmake is used and the configuration includes QT += widgets, then QT_WIDGETS_LIB will be defined automatically. Similarly, if qmake is used and the configuration includes QT += gui, then QT_GUI_LIB will be defined automatically.

Example:

QTEST_MAIN(TestQString)

See Also▲

Performs a comparison of the actual and expected values by invoking QTRY_COMPARE_WITH_TIMEOUT() with a timeout of five seconds.

This macro was introduced in Qt 5.0.

See Also▲

Performs comparison of left and right values by invoking QTRY_COMPARE_EQ_WITH_TIMEOUT with a timeout of five seconds.

This macro was introduced in Qt 6.4.

See Also▲

This macro is similar to QCOMPARE_EQ(), but performs the comparison of the left and right values repeatedly, until either the comparison returns true or the timeout (in milliseconds) is reached. Between each comparison, events will be processed. If the timeout is reached, a failure is recorded in the test log and the test won't be executed further.

This macro was introduced in Qt 6.4.

See Also▲

Performs comparison of left and right values by invoking QTRY_COMPARE_GE_WITH_TIMEOUT with a timeout of five seconds.

This macro was introduced in Qt 6.4.

See Also▲

This macro is similar to QCOMPARE_GE(), but performs the comparison of the left and right values repeatedly, until either the comparison returns true or the timeout (in milliseconds) is reached. Between each comparison, events will be processed. If the timeout is reached, a failure is recorded in the test log and the test won't be executed further.

This macro was introduced in Qt 6.4.

See Also▲

Performs comparison of left and right values by invoking QTRY_COMPARE_GT_WITH_TIMEOUT with a timeout of five seconds.

This macro was introduced in Qt 6.4.

See Also▲

This macro is similar to QCOMPARE_GT(), but performs the comparison of the left and right values repeatedly, until either the comparison returns true or the timeout (in milliseconds) is reached. Between each comparison, events will be processed. If the timeout is reached, a failure is recorded in the test log and the test won't be executed further.

This macro was introduced in Qt 6.4.

See Also▲

Performs comparison of left and right values by invoking QTRY_COMPARE_LE_WITH_TIMEOUT with a timeout of five seconds.

This macro was introduced in Qt 6.4.

See Also▲

This macro is similar to QCOMPARE_LE(), but performs the comparison of the left and right values repeatedly, until either the comparison returns true or the timeout (in milliseconds) is reached. Between each comparison, events will be processed. If the timeout is reached, a failure is recorded in the test log and the test won't be executed further.

This macro was introduced in Qt 6.4.

See Also▲

Performs comparison of left and right values by invoking QTRY_COMPARE_LT_WITH_TIMEOUT with a timeout of five seconds.

This macro was introduced in Qt 6.4.

See Also▲

This macro is similar to QCOMPARE_LT(), but performs the comparison of the left and right values repeatedly, until either the comparison returns true or the timeout (in milliseconds) is reached. Between each comparison, events will be processed. If the timeout is reached, a failure is recorded in the test log and the test won't be executed further.

This macro was introduced in Qt 6.4.

See Also▲