blob: 5e8ae3b83b04b277f2b75ab39123fa9d2c75ffb7 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\page qtquick-qtquicktest.html
\title Qt Quick Test Reference Documentation
\brief unit testing framework for QML
\section1 Introduction
\l {Qt Quick Test QML Types}{Qt Quick Test} is a unit test framework for QML applications.
Test cases are written as JavaScript functions within a \l {QtTest::TestCase}{TestCase}
type:
\code
import QtQuick 2.3
import QtTest 1.0
TestCase {
name: "MathTests"
function test_math() {
compare(2 + 2, 4, "2 + 2 = 4")
}
function test_fail() {
compare(2 + 2, 5, "2 + 2 = 5")
}
}
\endcode
Functions whose names start with \c{test_} are treated as test cases
to be executed. See the documentation for the \l {QtTest::TestCase}{TestCase} and
\l {QtTest::SignalSpy}{SignalSpy} types for more information on writing test cases.
\section1 Running Tests
Test cases are launched by a C++ harness that consists of
the following code:
\code
#include <QtQuickTest/quicktest.h>
QUICK_TEST_MAIN(example)
\endcode
Where "example" is the identifier to use to uniquely identify
this set of tests. You should add \c{CONFIG += qmltestcase}.
for example:
\code
TEMPLATE = app
TARGET = tst_example
CONFIG += warn_on qmltestcase
SOURCES += tst_example.cpp
\endcode
The test harness scans the specified source directory recursively
for "tst_*.qml" files. If \c{QUICK_TEST_SOURCE_DIR} is not defined,
then the current directory will be scanned when the harness is run.
Other *.qml files may appear for auxillary QML components that are
used by the test.
The \c{-input} command-line option can be set at runtime to run
test cases from a different directory. This may be needed to run
tests on a target device where the compiled-in directory name refers
to a host. For example:
\code
tst_example -input /mnt/SDCard/qmltests
\endcode
It is also possible to run a single file using the \c{-input} option.
For example:
\code
tst_example -input data/test.qml
\endcode
\code
tst_example -input <full_path>/test.qml
\endcode
\note Specifying the full path to the qml test file is for example
needed for shadow builds.
If your test case needs QML imports, then you can add them as
\c{-import} options to the test program command-line by adding
the following line to your .pro file:
\code
IMPORTPATH += $$PWD/../imports/my_module1 $$PWD/../imports/my_module2
\endcode
The \c{-functions} command-line option will return a list of the current
tests functions. It is possible to run a single test function using the name
of the test function as an argument. For example:
\code
tst_example Test_Name::function1
\endcode
The \c{-help} command-line option will return all the options available.
\code
tst_example -help
\endcode
*/
|
