Qt Autotest Environment: Difference between revisions
No edit summary |
Deleted-686 (talk | contribs) m (Removed space in front of configure commmand, which caused some formatting issues) |
||
| (8 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Developing_Qt::Guidelines]] | |||
== Introduction == | == Introduction == | ||
| Line 7: | Line 7: | ||
Many Qt autotests require some environment setup to work correctly. This page is an attempt to document precisely what this environment is. | Many Qt autotests require some environment setup to work correctly. This page is an attempt to document precisely what this environment is. | ||
Note that this is | Note that this is "best-effort" documentation. It should not be interpreted as coding standards for autotests, in fact quite the opposite - many of the requirements here are due to a ''lack'' of coding standards. Some of these environmental requirements can be considered problems with the autotests which should be fixed. | ||
The information may become outdated as autotests change. The current version of this page was written for Qt 4.5 and 4.6. | The information may become outdated as autotests change. The current version of this page was written for Qt 4.5 and 4.6. | ||
| Line 13: | Line 13: | ||
=== Qt build === | === Qt build === | ||
Qt autotests require that Qt be built for testing itself. This will make some additional symbols be exported and some additional code be built to support it. To enable such a build, when you configure Qt, remember to pass the option | Qt autotests require that Qt be built for testing itself. This will make some additional symbols be exported and some additional code be built to support it. To enable such a build, when you configure Qt, remember to pass the option '''-developer-build''': | ||
<code> | <code> | ||
./configure -developer-build -prefix $PWD | |||
</code> | |||
The main changes to the Qt build are: | The main changes to the Qt build are: | ||
* | * '''QT_INTERNAL_BUILD''' is set, so code can #ifdef to determine whether to enable the additional code | ||
* | * '''Q_AUTOTEST_EXPORT''' is defined to exporting the symbols | ||
Note also that Qt tests have only been tested with a non-installing Qt (the '''-prefix $PWD''' option above). The test project files override the '''make install''' target, so they are not installable. And Qt doesn't work at all if it's not at its installation path. | |||
=== Shadow builds === | |||
Don't use shadow builds. | |||
Some tests assume that their source and build directory are the same directory in order to find testdata. | |||
Reference: [http://code.qt.io/cgit/qt/qt.git/tree/tests/auto/qsslkey/tst_qsslkey.cpp#line107 qsslkey uses QCoreApplication::applicationDirPath() to look for testdata which lives in the source tree] | |||
=== Working directory === | |||
When the test is invoked, the working directory must be the directory containing the test's source (and binary, due to "no shadow builds" rule). | |||
For tests with multiple subdirectories, use the top level directory for that test (e.g. for the qprocess test, run from '''tests/auto/qprocess''', even though the .pro file for the test is at '''tests/auto/qprocess/test'''). | |||
Some tests read testdata from files found relative to the current working directory. | |||
Reference: [http://code.qt.io/cgit/qt/qt.git/tree/tests/auto/qscriptv8testsuite/tst_qscriptv8testsuite.cpp qscriptv8testsuite finds testdata relative to QDir] | |||
The network test server can be set up by following the | === Environment variables === | ||
QTDIR: path to Qt build directory. [http://code.qt.io/cgit/qt/qt.git/tree/tests/auto/bic/tst_bic.cpp bic reads headers from $QTDIR/include] | |||
QTSRCDIR: path to Qt source directory (same as QTDIR due to no shadow builds rule). Strictly speaking, does not seem required, as all tests which use this fall back on QTDIR, which is correct anyway due to "no shadow builds" rule. [http://code.qt.io/cgit/qt/qt.git/tree/tests/auto/xmlpatternsxqts/tst_xmlpatternsxqts.cpp xmlpatternsxqts adds $QTSRCDIR/include to INCLUDEPATH] | |||
PATH: must include bin directory for the tested Qt, '''in front of any bin directory from other Qt versions'''. [http://code.qt.io/cgit/qt/qt.git/tree/tests/auto/rcc/tst_rcc.cpp rcc assumes <nowiki><code></nowiki> rcc' is in PATH] | |||
=== Network tests === | |||
In /etc/hosts (Unix) or windir32\drivers\etc\hosts (Windows), set up some hostnames to point to a server running particular test services. | |||
The hostnames to be set up are: | |||
'''qt-test-server''' and '''qt-test-server.qt-test-net'''- [http://code.qt.io/cgit/qt/qt.git/tree/tests/auto/network-settings.h network-settings.h] | |||
The network test server can be set up by following the '''qtqa/sysadmin.git''' repository; see [http://code.qt.io/cgit/qtqa/sysadmin.git/tree/README.network_test_server.txt instructions here] | |||
=== DBus tests === | === DBus tests === | ||
The DBus tests require a dbus session bus to be running. | The DBus tests require a dbus session bus to be running. | ||
=== Common problems with test machine setup === | |||
Please see [https://wiki.qt.io/Writing_Unit_Tests#Common_problems_with_test_machine_setup here] for problems that can appear when running the auto tests. | |||
Latest revision as of 12:45, 1 December 2022
Introduction
Many Qt autotests require some environment setup to work correctly. This page is an attempt to document precisely what this environment is.
Note that this is "best-effort" documentation. It should not be interpreted as coding standards for autotests, in fact quite the opposite - many of the requirements here are due to a lack of coding standards. Some of these environmental requirements can be considered problems with the autotests which should be fixed.
The information may become outdated as autotests change. The current version of this page was written for Qt 4.5 and 4.6.
Qt build
Qt autotests require that Qt be built for testing itself. This will make some additional symbols be exported and some additional code be built to support it. To enable such a build, when you configure Qt, remember to pass the option -developer-build:
./configure -developer-build -prefix $PWD
The main changes to the Qt build are:
- QT_INTERNAL_BUILD is set, so code can #ifdef to determine whether to enable the additional code
- Q_AUTOTEST_EXPORT is defined to exporting the symbols
Note also that Qt tests have only been tested with a non-installing Qt (the -prefix $PWD option above). The test project files override the make install target, so they are not installable. And Qt doesn't work at all if it's not at its installation path.
Shadow builds
Don't use shadow builds.
Some tests assume that their source and build directory are the same directory in order to find testdata.
Working directory
When the test is invoked, the working directory must be the directory containing the test's source (and binary, due to "no shadow builds" rule).
For tests with multiple subdirectories, use the top level directory for that test (e.g. for the qprocess test, run from tests/auto/qprocess, even though the .pro file for the test is at tests/auto/qprocess/test).
Some tests read testdata from files found relative to the current working directory.
Reference: qscriptv8testsuite finds testdata relative to QDir
Environment variables
QTDIR: path to Qt build directory. bic reads headers from $QTDIR/include
QTSRCDIR: path to Qt source directory (same as QTDIR due to no shadow builds rule). Strictly speaking, does not seem required, as all tests which use this fall back on QTDIR, which is correct anyway due to "no shadow builds" rule. xmlpatternsxqts adds $QTSRCDIR/include to INCLUDEPATH
PATH: must include bin directory for the tested Qt, in front of any bin directory from other Qt versions. rcc assumes <code> rcc' is in PATH
Network tests
In /etc/hosts (Unix) or windir32\drivers\etc\hosts (Windows), set up some hostnames to point to a server running particular test services.
The hostnames to be set up are:
qt-test-server and qt-test-server.qt-test-net- network-settings.h
The network test server can be set up by following the qtqa/sysadmin.git repository; see instructions here
DBus tests
The DBus tests require a dbus session bus to be running.
Common problems with test machine setup
Please see here for problems that can appear when running the auto tests.