Qt Test is a framework for unit testing Qt based applications and libraries. Qt Test provides all the functionality commonly found in unit testing frameworks as well as extensions for testing graphical user interfaces.
Test methods, private slots defined. The name is any good, you have a good descriptive name. 15 from the line, plus we are testing the method. QTest:: addColumn.
Qt Test is designed to ease the writing of unit tests for Qt based applications and libraries:
Feature | Details |
---|---|
Lightweight | Qt Test consists of about 6000 lines of code and 60 exported symbols. |
Self-contained | Qt Test requires only a few symbols from the Qt Core module for non-gui testing. |
Rapid testing | Qt Test needs no special test-runners; no special registration for tests. |
Data-driven testing | A test can be executed multiple times with different test data. |
Basic GUI testing | Qt Test offers functionality for mouse and keyboard simulation. |
Benchmarking | Qt Test supports benchmarking and provides several measurement back-ends. |
IDE friendly | Qt Test outputs messages that can be interpreted by Qt Creator, Visual Studio, and KDevelop. |
Thread-safety | The error reporting is thread safe and atomic. |
Type-safety | Extensive use of templates prevent errors introduced by implicit type casting. |
Easily extendable | Custom types can easily be added to the test data and test output. |
You can use a Qt Creator wizard to create a project that contains Qt tests and build and run them directly from Qt Creator. For more information, see Running Autotests.
I am using the QTest unit testing framework to unit test a class. I am using the data driven method like this: private slots: void test; void testdata; That makes sure that my test method is called as many times as I have created cases in my testdata. Each private slot is a test function in your test. QTest::qExec can be used to execute all test functions in the test object. In addition, you can define the following private slots that are not treated as test functions. In addition, there are four private slots that are nottreated as test functions. They will be executed by the testing framework and can be used to initialize and clean up either the entire test or the current test function. InitTestCasewill be called before the first test function is executed.
To create a test, subclass QObject and add one or more private slots to it. Each private slot is a test function in your test. QTest::qExec() can be used to execute all test functions in the test object.
In addition, you can define the following private slots that are not treated as test functions. When present, they will be executed by the testing framework and can be used to initialize and clean up either the entire test or the current test function.
initTestCase()
will be called before the first test function is executed.initTestCase_data()
will be called to create a global test data table.cleanupTestCase()
will be called after the last test function was executed.init()
will be called before each test function is executed.cleanup()
will be called after every test function.Use initTestCase()
for preparing the test. Every test should leave the system in a usable state, so it can be run repeatedly. Cleanup operations should be handled in cleanupTestCase()
, so they get run even if the test fails.
Use init()
for preparing a test function. Every test function should leave the system in a usable state, so it can be run repeatedly. Cleanup operations should be handled in cleanup()
, so they get run even if the test function fails and exits early.
Alternatively, you can use RAII (resource acquisition is initialization), with cleanup operations called in destructors, to ensure they happen when the test function returns and the object moves out of scope.
If initTestCase()
fails, no test function will be executed. If init()
fails, the following test function will not be executed, the test will proceed to the next test function.
Example:
Finally, if the test class has a static public void initMain()
method, it is called by the QTEST_MAIN macros before the QApplication object is instantiated. For example, this allows for setting application attributes like Qt::AA_DisableHighDpiScaling. This was added in 5.14.
For more examples, refer to the Qt Test Tutorial.
You can build an executable that contains one test class that typically tests one class of production code. However, usually you would want to test several classes in a project by running one command.
See Writing a Unit Test for a step by step explanation.
You can use Building with CMake and CTest to create a test. CTest enables you to include or exclude tests based on a regular expression that is matched against the test name. You can further apply the LABELS
property to a test and CTest can then include or exclude tests based on those labels. All labeled targets will be run when test
target is called on the command line.
There are several other advantages with CMake. For example, the result of a test run can be published on a web server using CDash with virtually no effort.
CTest scales to very different unit test frameworks, and works out of the box with QTest.
The following is an example of a CMakeLists.txt file that specifies the project name and the language used (here, mytest and C++), the Qt modules required for building the test (Qt5Test), and the files that are included in the test (tst_mytest.cpp).
For more information about the options you have, see Build with CMake.
If you are using qmake
as your build tool, just add the following to your project file:
If you would like to run the test via make check
, add the additional line:
To prevent the test from being installed to your target, add the additional line:
See the qmake manual for more information about make check
.
If you are using other build tools, make sure that you add the location of the Qt Test header files to your include path (usually include/QtTest
under your Qt installation directory). If you are using a release build of Qt, link your test to the QtTest
library. For debug builds, use QtTest_debug
.
The syntax to execute an autotest takes the following simple form:
Substitute testname
with the name of your executable. testfunctions
can contain names of test functions to be executed. If no testfunctions
are passed, all tests are run. If you append the name of an entry in testdata
, the test function will be run only with that test data.
For example:
Runs the test function called toUpper
with all available test data.
Runs the toUpper
test function with all available test data, and the toInt
test function with the test data called zero
(if the specified test data doesn't exist, the associated test will fail).
Runs the testMyWidget
function test, outputs every signal emission and waits 500 milliseconds after each simulated mouse/keyboard event.
The following command line options determine how test results are reported:
-o
filename,formattxt
, xml
, lightxml
, junitxml
or tap
). The special filename -
may be used to log to standard output.-o
filename-txt
-xml
-lightxml
-junitxml
-csv
-teamcity
-tap
The first version of the -o
option may be repeated in order to log test results in multiple formats, but no more than one instance of this option can log test results to standard output.
If the first version of the -o
option is used, neither the second version of the -o
option nor the -txt
, -xml
, -lightxml
, -teamcity
, -junitxml
or -tap
options should be used.
If neither version of the -o
option is used, test results will be logged to standard output. If no format option is used, test results will be logged in plain text.
The following command line options control how much detail is reported in test logs:
-silent
-v1
-v2
-v1
for plain text output.)-vs
The following command-line options influence how tests are run:
-functions
-datatags
-eventdelay
ms-keydelay
ms-mousedelay
ms-maxwarnings
number-nocrashhandler
-platform
nameThe following command line options control benchmark testing:
-callgrind
-tickcounter
-eventcounter
-minimumvalue
n-minimumtotal
n-iterations
n-median
n-vb
-help
To create a benchmark, follow the instructions for creating a test and then add a QBENCHMARK macro or QTest::setBenchmarkResult() to the test function that you want to benchmark. In the following code snippet, the macro is used:
A test function that measures performance should contain either a single QBENCHMARK
macro or a single call to setBenchmarkResult()
. Multiple occurrences make no sense, because only one performance result can be reported per test function, or per data tag in a>Walltime(default)All platformsCPU tick counter-tickcounterWindows, macOS, Linux, many UNIX-like systems.Event Counter-eventcounterAll platformsValgrind Callgrind-callgrindLinux (if installed)Linux Perf-perfLinux
In short, walltime is always available but requires many repetitions to get a useful result. Tick counters are usually available and can provide results with fewer repetitions, but can be susceptible to CPU frequency scaling issues. Valgrind provides exact results, but does not take I/O waits into account, and is only available on a limited number of platforms. Event counting is available on all platforms and it provides the number of events that were received by the event loop before they are sent to their corresponding targets (this might include non-Qt events).
The Linux Performance Monitoring solution is available only on Linux and provides many different counters, which can be selected by passing an additional option -perfcounter countername
, such as -perfcounter cache-misses
, -perfcounter branch-misses
, or -perfcounter l1d-load-misses
. The default counter is cpu-cycles
. The full list of counters can be obtained by running any benchmark executable with the option -perfcounterlist
.
See Writing a Benchmark in the Qt Test Tutorial for more benchmarking examples.
You can define initTestCase_data()
to set up a global test data table. Each test is run once for each row in the global test data table. When the test function itself is data-driven, it is run for each local data row, for each global data row. So, if there are g
rows in the global data table and d
rows in the test's own data-table, the number of runs of this test is g
times d
.
Global data is fetched from the table using the QFETCH_GLOBAL() macro.
The following are typical use cases for global test data:
For example, to test each number provided by roundTripInt_data()
with each locale provided by initTestCase_data()
:
© 2020 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.