/****************************************************************************

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtTest module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#include "QtTest/qtestcase.h"

#include "QtTest/qtestassert.h"

#include <QtCore/qbytearray.h>

#include <QtCore/qmetaobject.h>

#include <QtCore/qobject.h>

#include <QtCore/qstringlist.h>

#include <QtCore/qvector.h>

#include <QtCore/qvarlengtharray.h>

#include <QtCore/qcoreapplication.h>

#include <QtCore/qfile.h>

#include <QtCore/qfileinfo.h>

#include <QtCore/qdir.h>

#include <QtCore/qprocess.h>

#include <QtCore/qdebug.h>

#include <QtCore/qlibraryinfo.h>

#include "QtTest/private/qtestlog_p.h"

#include "QtTest/private/qtesttable_p.h"

#include "QtTest/qtestdata.h"

#include "QtTest/private/qtestresult_p.h"

#include "QtTest/private/qsignaldumper_p.h"

#include "QtTest/private/qbenchmark_p.h"

#include "3rdparty/cycle_p.h"

#include <stdarg.h>

#include <stdio.h>

#include <stdlib.h>

#ifdef Q_OS_WIN

#include <windows.h> // for Sleep

#endif

#ifdef Q_OS_UNIX

#include <errno.h>

#include <signal.h>

#include <time.h>

#endif

#ifdef Q_WS_MAC

#include <Carbon/Carbon.h> // for SetFrontProcess

#ifdef QT_MAC_USE_COCOA

#include <IOKit/pwr_mgt/IOPMLib.h>

#else

#include <Security/AuthSession.h>

#endif

#undef verify

#endif

QT_BEGIN_NAMESPACE

/*!

   \namespace QTest

   \inmodule QtTest

   \brief The QTest namespace contains all the functions and

   declarations that are related to the QTestLib tool.

   Please refer to the \l{QTestLib Manual} documentation for information on

   how to write unit tests.

*/

/*! \macro QVERIFY(condition)

   \relates QTest

   The QVERIFY() macro checks whether the \a condition is true or not. If it is

   true, execution continues. If not, a failure is recorded in the test log

   and the test won't be executed further.

   \bold {Note:} This macro can only be used in a test function that is invoked

   by the test framework.

   Example:

   \snippet doc/src/snippets/code/src_qtestlib_qtestcase.cpp 0

   \sa QCOMPARE()

*/

/*! \macro QVERIFY2(condition, message)

    \relates QTest

    The QVERIFY2() macro behaves exactly like QVERIFY(), except that it outputs

    a verbose \a message when \a condition is false. The \a message is a plain

    C string.

    Example:

    \snippet doc/src/snippets/code/src_qtestlib_qtestcase.cpp 1

    \sa QVERIFY(), QCOMPARE()

*/

/*! \macro QCOMPARE(actual, expected)

   \relates QTest

   The QCOMPARE macro compares an \a actual value to an \a expected value using

   the equals operator. If \a actual and \a expected are identical, execution

   continues. If not, a failure is recorded in the test log and the test

   won't be executed further.

   In the case of comparing floats and doubles, qFuzzyCompare() is used for

   comparing. This means that comparing to 0 will likely fail. One solution

   to this is to compare to 1, and add 1 to the produced output.

   QCOMPARE tries to output the contents of the values if the comparison fails,

   so it is visible from the test log why the comparison failed.

   QCOMPARE is very strict on the data types. Both \a actual and \a expected

   have to be of the same type, otherwise the test won't compile. This prohibits

   unspecified behavior from being introduced; that is behavior that usually

   occurs when the compiler implicitly casts the argument.

   If you use QCOMPARE() to compare two QStringList objects, it will start

   comparing the objects from the end of the lists.

   For your own classes, you can use \l QTest::toString() to format values for

   outputting into the test log.

   \note This macro can only be used in a test function that is invoked

   by the test framework.

   Example:

   \snippet doc/src/snippets/code/src_qtestlib_qtestcase.cpp 2

   \sa QVERIFY(), QTest::toString()

*/

/*! \macro QFETCH(type, name)

   \relates QTest

   The fetch macro creates a local variable named \a name with the type \a type

   on the stack. \a name has to match the element name from the test's data.

   If no such element exists, the test will assert.

   Assuming a test has the following data:

   \snippet doc/src/snippets/code/src_qtestlib_qtestcase.cpp 3

   The test data has two elements, a QString called \c aString and an integer

   called \c expected. To fetch these values in the actual test:

   \snippet doc/src/snippets/code/src_qtestlib_qtestcase.cpp 4

   \c aString and \c expected are variables on the stack that are initialized with

   the current test data.

   \bold {Note:} This macro can only be used in a test function that is invoked

   by the test framework. The test function must have a _data function.

*/

/*! \macro QWARN(message)

   \relates QTest

   \threadsafe

   Appends \a message as a warning to the test log. This macro can be used anywhere

   in your tests.

*/

/*! \macro QFAIL(message)

   \relates QTest

   This macro can be used to force a test failure. The test stops

   executing and the failure \a message is appended to the test log.

   \bold {Note:} This macro can only be used in a test function that is invoked

   by the test framework.

   Example:

   \snippet doc/src/snippets/code/src_qtestlib_qtestcase.cpp 5

*/

/*! \macro QTEST(actual, testElement)

   \relates QTest

   QTEST() is a convenience macro for \l QCOMPARE() that compares

   the value \a actual with the element \a testElement from the test's data.

   If there is no such element, the test asserts.

   Apart from that, QTEST() behaves exactly as \l QCOMPARE().

   Instead of writing:

   \snippet doc/src/snippets/code/src_qtestlib_qtestcase.cpp 6

   you can write:

   \snippet doc/src/snippets/code/src_qtestlib_qtestcase.cpp 7

   \sa QCOMPARE()

*/

/*! \macro QSKIP(description, mode)

   \relates QTest

   The QSKIP() macro stops execution of the test without adding a failure to the

   test log. You can use it to skip tests that wouldn't make sense in the current

   configuration. The text \a description is appended to the test log and should

   contain an explanation why the test couldn't be executed. \a mode is a QTest::SkipMode

   and describes whether to proceed with the rest of the test data or not.

   \bold {Note:} This macro can only be used in a test function that is invoked

   by the test framework.

   Example:

   \snippet doc/src/snippets/code/src_qtestlib_qtestcase.cpp 8

   \sa QTest::SkipMode

*/

/*! \macro QEXPECT_FAIL(dataIndex, comment, mode)

   \relates QTest

   The QEXPECT_FAIL() macro marks the next \l QCOMPARE() or \l QVERIFY() as an

   expected failure. Instead of adding a failure to the test log, an expected

   failure will be reported.

   If a \l QVERIFY() or \l QCOMPARE() is marked as an expected failure,

   but passes instead, an unexpected pass (XPASS) is written to the test log.

   The parameter \a dataIndex describes for which entry in the test data the

   failure is expected. Pass an empty string (\c{""}) if the failure

   is expected for all entries or if no test data exists.

   \a comment will be appended to the test log for the expected failure.

   \a mode is a \l QTest::TestFailMode and sets whether the test should

   continue to execute or not.

   \bold {Note:} This macro can only be used in a test function that is invoked

   by the test framework.

   Example 1:

   \snippet doc/src/snippets/code/src_qtestlib_qtestcase.cpp 9

   In the example above, an expected fail will be written into the test output

   if the variable \c i is not 42. If the variable \c i is 42, an unexpected pass

   is written instead. The QEXPECT_FAIL() has no influence on the second QCOMPARE()

   statement in the example.

   Example 2:

   \snippet doc/src/snippets/code/src_qtestlib_qtestcase.cpp 10

   The above testfunction will not continue executing for the test data

   entry \c{data27}.

   \sa QTest::TestFailMode, QVERIFY(), QCOMPARE()

*/

/*! \macro QTEST_MAIN(TestClass)

    \relates QTest

    Implements a main() function that instantiates a QApplication object and

    the \a TestClass, and executes all tests in the order they were defined.

    Use this macro to build stand-alone executables.

    \bold {Note:} On platforms that have keypad navigation enabled by default (eg: Symbian),

    this macro will forcfully disable it to simplify the usage of key events when writing

    autotests. If you wish to write a test case that uses keypad navigation, you should

    enable it either in the \c {initTestCase()} or \c {init()} functions of your test case.

    Example:

    \snippet doc/src/snippets/code/src_qtestlib_qtestcase.cpp 11

    \sa QTEST_APPLESS_MAIN(), QTest::qExec(), QApplication::setNavigationMode()

*/

/*! \macro QTEST_APPLESS_MAIN(TestClass)

    \relates QTest

    Implements a main() function that executes all tests in \a TestClass.

    Behaves like \l QTEST_MAIN(), but doesn't instantiate a QApplication

    object. Use this macro for really simple stand-alone non-GUI tests.

    \sa QTEST_MAIN()

*/

/*! \macro QTEST_NOOP_MAIN()

    \relates QTest

    Implements a main() function with a test class that does absolutely nothing.

    Use this macro to create a test that produces valid test output but just

    doesn't execute any test, for example in conditional compilations:

    \snippet doc/src/snippets/code/src_qtestlib_qtestcase.cpp 12

    \sa QTEST_MAIN()

*/

/*!

    \macro QBENCHMARK

    \relates QTest

    This macro is used to measure the performance of code within a test.

    The code to be benchmarked is contained within a code block following

    this macro.

    For example:

    \snippet examples/qtestlib/tutorial5/benchmarking.cpp 0

    \sa {QTestLib Manual#Creating a Benchmark}{Creating a Benchmark},

        {Chapter 5: Writing a Benchmark}{Writing a Benchmark}

*/

/*!

    \macro QBENCHMARK_ONCE

    \since 4.6

    \relates QTest

    \brief The QBENCHMARK_ONCE macro is for measuring performance of a

    code block by running it once.

    This macro is used to measure the performance of code within a test.

    The code to be benchmarked is contained within a code block following

    this macro.

    Unlike QBENCHMARK, the contents of the contained code block is only run

    once. The elapsed time will be reported as "0" if it's to short to

    be measured by the selected backend. (Use)

    \sa {QTestLib Manual#Creating a Benchmark}{Creating a Benchmark},

    {Chapter 5: Writing a Benchmark}{Writing a Benchmark}

*/

/*! \enum QTest::SkipMode

    This enum describes the modes for skipping tests during execution

    of the test data.

    \value SkipSingle Skips the current entry in the test table; continues

           execution of all the other entries in the table.

    \value SkipAll Skips all the entries in the test table; the test won't

           be executed further.

    \sa QSKIP()

*/

/*! \enum QTest::TestFailMode

    This enum describes the modes for handling an expected failure of the

    \l QVERIFY() or \l QCOMPARE() macros.

    \value Abort Aborts the execution of the test. Use this mode when it

           doesn't make sense to execute the test any further after the

           expected failure.

    \value Continue Continues execution of the test after the expected failure.

    \sa QEXPECT_FAIL()

*/

/*! \enum QTest::KeyAction

    This enum describes possible actions for key handling.

    \value Press    The key is pressed.

    \value Release  The key is released.

    \value Click    The key is clicked (pressed and released).

*/

/*! \enum QTest::MouseAction

    This enum describes possible actions for mouse handling.

    \value MousePress    A mouse button is pressed.

    \value MouseRelease  A mouse button is released.

    \value MouseClick    A mouse button is clicked (pressed and released).

    \value MouseDClick   A mouse button is double clicked (pressed and released twice).

    \value MouseMove     The mouse pointer has moved.

*/

/*! \fn void QTest::keyClick(QWidget *widget, char key, Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)

    \overload

    Simulates clicking of \a key with an optional \a modifier on a \a widget.

    If \a delay is larger than 0, the test will wait for \a delay milliseconds.

    Example:

    \snippet doc/src/snippets/code/src_qtestlib_qtestcase.cpp 13

    The example above simulates clicking \c a on \c myWidget without

    any keyboard modifiers and without delay of the test.

    \sa QTest::keyClicks()

*/

/*! \fn void QTest::keyClick(QWidget *widget, Qt::Key key, Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)

    Simulates clicking of \a key with an optional \a modifier on a \a widget.

    If \a delay is larger than 0, the test will wait for \a delay milliseconds.

    Examples:

    \snippet doc/src/snippets/code/src_qtestlib_qtestcase.cpp 14

    The first example above simulates clicking the \c escape key on \c

    myWidget without any keyboard modifiers and without delay. The

    second example simulates clicking \c shift-escape on \c myWidget

    with a following 200 ms delay of the test.

    \sa QTest::keyClicks()

*/

/*! \fn void QTest::keyEvent(KeyAction action, QWidget *widget, Qt::Key key, Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)

    Sends a Qt key event to \a widget with the given \a key and an associated \a action.

    Optionally, a keyboard \a modifier can be specified, as well as a \a delay

    (in milliseconds) of the test before sending the event.

*/

/*! \fn void QTest::keyEvent(KeyAction action, QWidget *widget, char ascii, Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)

    \overload

    Sends a Qt key event to \a widget with the given key \a ascii and an associated \a action.

    Optionally, a keyboard \a modifier can be specified, as well as a \a delay

    (in milliseconds) of the test before sending the event.

*/

/*! \fn void QTest::keyPress(QWidget *widget, Qt::Key key, Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)

    Simulates pressing a \a key with an optional \a modifier on a \a widget. If \a delay

    is larger than 0, the test will wait for \a delay milliseconds.

    \bold {Note:} At some point you should release the key using \l keyRelease().

    \sa QTest::keyRelease(), QTest::keyClick()

*/

/*! \fn void QTest::keyPress(QWidget *widget, char key, Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)

    \overload

    Simulates pressing a \a key with an optional \a modifier on a \a widget.

    If \a delay is larger than 0, the test will wait for \a delay milliseconds.

    \bold {Note:} At some point you should release the key using \l keyRelease().

    \sa QTest::keyRelease(), QTest::keyClick()

*/

/*! \fn void QTest::keyRelease(QWidget *widget, Qt::Key key, Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)

    Simulates releasing a \a key with an optional \a modifier on a \a widget.

    If \a delay is larger than 0, the test will wait for \a delay milliseconds.

    \sa QTest::keyPress(), QTest::keyClick()

*/

/*! \fn void QTest::keyRelease(QWidget *widget, char key, Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)

    \overload

    Simulates releasing a \a key with an optional \a modifier on a \a widget.

    If \a delay is larger than 0, the test will wait for \a delay milliseconds.

    \sa QTest::keyClick()

*/

/*! \fn void QTest::keyClicks(QWidget *widget, const QString &sequence, Qt::KeyboardModifiers modifier = Qt::NoModifier, int delay=-1)

    Simulates clicking a \a sequence of keys on a \a

    widget. Optionally, a keyboard \a modifier can be specified as

    well as a \a delay (in milliseconds) of the test before each key

    click.

    Example:

    \snippet doc/src/snippets/code/src_qtestlib_qtestcase.cpp 15