1// Copyright (C) 2022 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
4 \page qttest-index.html
6 \brief Provides classes for unit testing Qt applications and libraries.
8 The Qt Test module provides classes for unit testing Qt applications and
9 libraries. All public methods are in the \l QTest namespace. In addition,
10 the \l QSignalSpy class provides easy introspection for Qt's signals and
11 slots, and the \l QAbstractItemModelTester allows for non-destructive
12 testing of item models.
14 \note There is no binary compatibility guarantee for the Qt Test module.
15 This means that an application that uses Qt Test is only guaranteed
16 to work with the Qt version it was developed against. However, source
17 compatibility is guaranteed.
19 \section1 Using the Module
21 \include {module-use.qdocinc} {using the c++ api}
23 \section2 Building with CMake
25 \include {module-use.qdocinc} {building with cmake} {Test}
27 \section2 Building with qmake
29 \include {module-use.qdocinc} {building_with_qmake} {testlib}
31 \section1 Articles and Guides
34 \li \l{Qt Test Overview}
35 \li \l{Qt Test Best Practices}
36 \li \l{Qt Test Tutorial}
42 \li \l{Qt Test C++ Classes}
45 The \l {Qt Quick Test} module enables unit testing of Qt Quick applications.
48 \li \l{Qt Quick Test QML Types}
49 \li \l{Qt Quick Test C++ API}
52 \section1 Module Evolution
53 \l{Changes to Qt Test} lists important changes in the module API
54 and functionality that were done for the Qt 6 series of Qt.
56 \section1 Licenses and Attributions
58 Qt Test is available under commercial licenses from \l{The Qt Company}.
59 In addition, it is available under free software licenses:
60 The \l{GNU Lesser General Public License, version 3}, or
61 the \l{GNU General Public License, version 2}.
62 See \l{Qt Licensing} for further details.
64 Furthermore, Qt Test in Qt \QtVersion may contain third party
65 modules under the following permissive licenses:
67 \generatelist{groupsbymodule attributions-qttestlib}