Commit 3f3dbf48 authored by Mitch Curtis's avatar Mitch Curtis
Browse files

Remove Qt Quick Test documentation


It is being moved to qtdeclarative.

Task-number: QTBUG-50064
Change-Id: Ief9d89967c28001c3fd587d4db459abf0c948c8b
Reviewed-by: default avatarVenugopal Shivashankar <Venugopal.Shivashankar@qt.io>
Reviewed-by: default avatarTopi Reiniö <topi.reinio@qt.io>
Showing with 0 additions and 133 deletions
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/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: https://www.gnu.org/licenses/fdl-1.3.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.
If IMPORTPATH is specified in your .pro file, each import path added to IMPORTPATH
will be passed as a command-line argument when the test is run using "make check":
\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
*/
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment