Chapter 4: Replaying GUI Events

Writing the Data Function

As before, a test function's associated data function carries the same name, appended by _data.

    void TestGui::testGui_data()
    {
        QTest::addColumn<QTestEventList>("events");
        QTest::addColumn<QString>("expected");

        QTestEventList list1;
        list1.addKeyClick('a');
        QTest::newRow("char") << list1 << "a";

        QTestEventList list2;
        list2.addKeyClick('a');
        list2.addKeyClick(Qt::Key_Backspace);
        QTest::newRow("there and back again") << list2 << "";
    }

First, we define the elements of the table using the QTest::addColumn() function: A list of GUI events, and the expected result of applying the list of events on a QWidget. Note that the type of the first element is QTestEventList.

A QTestEventList can be populated with GUI events that can be stored as test data for later usage, or be replayed on any QWidget.

In our current data function, we create two QTestEventLists. The first list consists of a single click to the 'a' key. We add the event to the list using the QTestEventList::addKeyClick() function. Then we use the QTest::newRow() function to give the data set a name, and stream the event list and the expected result into the table.

The second list consists of two key clicks: an 'a' with a following 'backspace'. Again we use the QTestEventList::addKeyClick() to add the events to the list, and QTest::newRow() to put the event list and the expected result into the table with an associated name.

    void TestGui::testGui()
    {
        QFETCH(QTestEventList, events);
        QFETCH(QString, expected);

        QLineEdit lineEdit;

        events.simulate(&lineEdit);

        QCOMPARE(lineEdit.text(), expected);
    }

    QTEST_MAIN(TestGui)
    #include "testgui.moc"