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

**

** 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 test suite 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 <QFile>

#include <QtTest/QtTest>

#ifdef QTEST_XMLPATTERNS

#include "../qxmlquery/TestFundament.h"

#include "../network-settings.h"

#if defined(Q_OS_SYMBIAN)

#define SRCDIR ""

#endif

/*!

 \class tst_XmlPatterns

 \internal

 \since 4.4

 \brief Tests the command line interface, \c xmlpatterns, for the XQuery code.

 This test is not intended for testing the engine, but all the gluing the

 command line interface do: error reporting, query output, variable bindings, exit

 codes, and so on.

 In other words, if you have an engine bug; don't add it here because it won't be

 tested properly. Instead add it to the test suite.

 */

class tst_XmlPatterns : public QObject

                      , private TestFundament

{

    Q_OBJECT

public:

    tst_XmlPatterns();

private Q_SLOTS:

    void initTestCase();

    void xquerySupport();

    void xquerySupport_data() const;

    void xsltSupport();

    void xsltSupport_data() const;

    void stdoutFailure() const;

    void cleanupTestCase() const;

private:

    static void createNonWritable(const QString &name);

    static void removeNonWritable(QFile &outFile);

    int             m_generatedTests;

    /**

     * Get rid of characters that complicates on various file systems.

     */

    const QRegExp   m_normalizeTestName;

    /**

     * @note Perforce disallows wildcards in the name.

     */

    const QRegExp   m_filenameInStderr;

    const QString   m_command;

    bool            m_dontRun;

};

tst_XmlPatterns::tst_XmlPatterns() : m_generatedTests(0)

                                   , m_normalizeTestName(QLatin1String("[\\*\\?#\\-\\/:; ()',&]"))

                                   , m_filenameInStderr(QLatin1String("file:\\/\\/.*(\\.xq|\\.gccxml|\\.xml|\\.xsl|-)(,|:)"))

                                   , m_command(QLatin1String("xmlpatterns"))

                                   , m_dontRun(false)

{

    Q_SET_DEFAULT_IAP

    Q_ASSERT(m_normalizeTestName.isValid());

    Q_ASSERT(m_filenameInStderr.isValid());

}

void tst_XmlPatterns::initTestCase()

{

    QProcess process;

    process.start(m_command);

    if(!process.waitForFinished())

    {

        m_dontRun = true;

        QEXPECT_FAIL("", "The command line tool is not in the path, most likely because Qt "

                         "has been partically built, such as only the sub-src rule. No tests will be run.", Abort);

        QVERIFY(false);

    }

}

void tst_XmlPatterns::xquerySupport()

{

    if(m_dontRun)

        QSKIP("The command line utility is not in the path.", SkipAll);

#ifdef Q_OS_WINCE

    QSKIP("WinCE: This test uses unsupported WinCE functionality", SkipAll);

#elif defined(Q_OS_SYMBIAN)

    QSKIP("Symbian: This test uses unsupported Symbian functionality (QProcess with std streams)", SkipAll);

#endif

    QFETCH(int,         expectedExitCode);

    QFETCH(QByteArray,  expectedQueryOutput);

    QFETCH(QStringList, arguments);

    QFETCH(QString,     cwd);

    QFETCH(QString,     outputFile);

    QProcess process;

    if(!cwd.isEmpty())

        process.setWorkingDirectory(inputFile(cwd));

    process.start(m_command, arguments);

    QCOMPARE(process.exitStatus(), QProcess::NormalExit);

    QVERIFY(process.waitForFinished());

    if(process.exitCode() != expectedExitCode)

        QTextStream(stderr) << "stderr:" << process.readAllStandardError();

    QCOMPARE(process.exitCode(), expectedExitCode);

    const QByteArray rawProducedStderr((process.readAllStandardError()));

    QString fixedStderr(QString::fromLocal8Bit(rawProducedStderr).remove(m_filenameInStderr));

    // convert Windows line endings to Unix ones

    fixedStderr.replace("\r\n", "\n");

    const QString errorFileName(inputFile(QLatin1String(SRCDIR "stderrBaselines/") +

                                          QString::fromUtf8(QTest::currentDataTag()).remove(m_normalizeTestName) +

                                          QLatin1String(".txt")));

    QFile writeErr(errorFileName);

    if(writeErr.exists())

    {

        QVERIFY(writeErr.open(QIODevice::ReadOnly));

        QString rawExpectedStdErr(QString::fromLocal8Bit(writeErr.readAll()));

        /* On Windows, at least MinGW, this differs. */

        if(qstrcmp(QTest::currentDataTag(), "-output with a non-writable file") == 0)

        {

            QVERIFY(fixedStderr == rawExpectedStdErr.remove(m_filenameInStderr) ||

                    fixedStderr.trimmed() == "Failed to open file notWritable.out for writing: Access is denied.");

        }

        else if(qstrcmp(QTest::currentDataTag(), "Invoke -version") == 0)

        {

            /* There's a wide range of different version strings used. For

             * instance, "4.4.0-rc1". */

            const QRegExp removeVersion(QLatin1String(" Qt \\d\\.\\d.*"));

            QVERIFY(removeVersion.isValid());

            QCOMPARE(QString(fixedStderr).remove(removeVersion) + QChar('|'), rawExpectedStdErr + QChar('|'));

        }

        else

            QCOMPARE(fixedStderr, rawExpectedStdErr.remove(m_filenameInStderr));

    }

    else

    {

        QFile writeErr(errorFileName);

        QVERIFY(writeErr.open(QIODevice::WriteOnly));

        QCOMPARE(writeErr.write(rawProducedStderr), qint64(rawProducedStderr.count()));

        QTextStream(stderr) << "creating file " << errorFileName;

        ++m_generatedTests;

    }

    const QByteArray actual(process.readAllStandardOutput());

    if(outputFile.isEmpty())

    {

        QCOMPARE(actual, expectedQueryOutput);

        return; /* We're done, this test was not creating any output file. */

    }

    else

    {

        QVERIFY(actual.isEmpty());

        QFile outFile(outputFile);

        QVERIFY(outFile.exists());

        QVERIFY(outFile.open(QIODevice::ReadOnly));

        QCOMPARE(outFile.readAll(), expectedQueryOutput);

        removeNonWritable(outFile);

    }

}

void tst_XmlPatterns::xquerySupport_data() const

{

#if defined(Q_OS_WINCE) || defined(Q_OS_SYMBIAN)

    return;

#endif

    /* Check one file for existence, to avoid possible false positives. */

    QVERIFY(QFile::exists(inputFile(QLatin1String(SRCDIR "queries/onePlusOne.xq"))));

    QTest::addColumn<int>("expectedExitCode");

    QTest::addColumn<QByteArray>("expectedQueryOutput");

    QTest::addColumn<QStringList>("arguments");

    QTest::addColumn<QString>("cwd");

    QTest::addColumn<QString>("outputFile");

    QTest::newRow("A simple math query")

        << 0

        << QByteArray("2\n")

        << QStringList((QLatin1String(SRCDIR "queries/onePlusOne.xq")))

        << QString()

        << QString();

    QTest::newRow("An unbound external variable")

        << 2

        << QByteArray()

        << QStringList(QLatin1String(SRCDIR "queries/externalVariable.xq"))

        << QString()

        << QString();

    QTest::newRow("Bind an external variable")

        << 0

        << QByteArray("1 4<e>1</e>true\n")

        << (QStringList() << QLatin1String(SRCDIR "queries/externalVariable.xq")

                          << QLatin1String("-param")

                          << QLatin1String("externalVariable=1"))

        << QString()

        << QString();

    QTest::newRow("Bind an external variable, query appearing last")

        << 0

        << QByteArray("1 4<e>1</e>true\n")

        << (QStringList() << QLatin1String("-param")

                          << QLatin1String("externalVariable=1")

                          << QLatin1String(SRCDIR "queries/externalVariable.xq"))

        << QString()

        << QString();

    QTest::newRow("Use fn:doc")

        << 0

        << QByteArray("<e xmlns=\"http://example.com\" xmlns:p=\"http://example.com/P\" attr=\"1\" p:attr=\"\">\n    <?target data?>\n    <!-- a comment -->\n    <e/>text <f/>text node</e>\n")

        << QStringList(QLatin1String(SRCDIR "queries/openDocument.xq"))

        << QString()

        << QString();

    QTest::newRow("Use fn:doc, together with -no-format, last")

        << 0

        << QByteArray("<e xmlns=\"http://example.com\" xmlns:p=\"http://example.com/P\" attr=\"1\" p:attr=\"\"><?target data?><!-- a comment --><e/>text <f/>text node</e>")

        << (QStringList() << QLatin1String(SRCDIR "queries/openDocument.xq")

                          << QLatin1String("-no-format"))

        << QString()

        << QString();

    QTest::newRow("Use fn:doc, together with -no-format, first")

        << 0

        << QByteArray("<e xmlns=\"http://example.com\" xmlns:p=\"http://example.com/P\" attr=\"1\" p:attr=\"\"><?target data?><!-- a comment --><e/>text <f/>text node</e>")

        << (QStringList() << QLatin1String("-no-format")

                          << QLatin1String(SRCDIR "queries/openDocument.xq"))

        << QString()

        << QString();

    /* This is true for the command line utility, but not QXmlQuery::setQuery(). */

    QTest::newRow("Make sure query paths are resolved against CWD, not the location of the executable.")

        << 0

        << QByteArray("2\n")

        << QStringList(QLatin1String(SRCDIR "queries/onePlusOne.xq"))

        << QString::fromLatin1("queries")

        << QString();

    QTest::newRow("Call fn:error()")

        << 2

        << QByteArray()

        << QStringList(QLatin1String(SRCDIR "queries/errorFunction.xq"))

        << QString()

        << QString();

    QTest::newRow("Evaluate a library module")

        << 2

        << QByteArray()

        << QStringList(QLatin1String(SRCDIR "queries/simpleLibraryModule.xq"))

        << QString()

        << QString();

    QTest::newRow("Trigger a static error.")

        << 2

        << QByteArray()

        << QStringList(QLatin1String(SRCDIR "queries/staticError.xq"))

        << QString()

        << QString();

    QTest::newRow("Pass -help")

        << 0

        << QByteArray()

        << QStringList(QLatin1String("-help"))

        << QString()

        << QString();

    QTest::newRow("Open an nonexistent file")

        << 2

        << QByteArray()

        << QStringList(QLatin1String(SRCDIR "queries/ThisFileDoesNotExist.xq"))

        << QString()

        << QString();

    /* The following five tests exists to test the various

     * markup classes in the message. */

    QTest::newRow("XQuery-function message markups")

        << 2

        << QByteArray()

        << QStringList(QLatin1String(SRCDIR "queries/wrongArity.xq"))

        << QString()

        << QString();

    QTest::newRow("XQuery-type message markups")

        << 2

        << QByteArray()

        << QStringList(QLatin1String(SRCDIR "queries/typeError.xq"))

        << QString()

        << QString();

    QTest::newRow("XQuery-data & XQuery-keyword message markups")

        << 2

        << QByteArray()

        << QStringList(QLatin1String(SRCDIR "queries/zeroDivision.xq"))

        << QString()

        << QString();

    QTest::newRow("XQuery-uri message markups")

        << 2

        << QByteArray()

        << QStringList(QLatin1String(SRCDIR "queries/unsupportedCollation.xq"))

        << QString()

        << QString();

    QTest::newRow("XQuery-expression message markups")

        << 2

        << QByteArray()

        << QStringList(QLatin1String(SRCDIR "queries/invalidRegexp.xq"))

        << QString()

        << QString();

    QTest::newRow("Print a list of available regexp flags(The available flags are formatted in a complex way.)")

        << 2

        << QByteArray()

        << QStringList(QLatin1String(SRCDIR "queries/invalidRegexpFlag.xq"))

        << QString()

        << QString();

    QTest::newRow("Trigger an assert in QPatternist::ColorOutput. The query naturally contains an error; XPTY0004.")

        << 2

        << QByteArray()

        << QStringList(QLatin1String(SRCDIR "queries/flwor.xq"))

        << QString()

        << QString();

    QTest::newRow("Trigger a second assert in QPatternist::ColorOutput. The query naturally contains XPST0003.")

        << 2

        << QByteArray()

        << QStringList(QLatin1String(SRCDIR "queries/syntaxError.xq"))

        << QString()

        << QString();

    QTest::newRow("-param is missing so multiple queries appear")

        << 2

        << QByteArray()

        << (QStringList() << QLatin1String(SRCDIR "queries/reportGlobals.xq")

                          << QLatin1String("fileToOpen=globals.gccxml"))

        << QString()

        << QString();

    QTest::newRow("only -no-format")

        << 1

        << QByteArray()

        << (QStringList() << QLatin1String("-no-format"))

        << QString()

        << QString();

    QTest::newRow("Basic use of -output, query first")

        << 0

        << QByteArray("2\n")

        << (QStringList() << QLatin1String(SRCDIR "queries/onePlusOne.xq")

                          << QLatin1String("-output")

                          << QLatin1String("basicOutput.out"))

        << QString()

        << QString::fromLatin1("basicOutput.out");

    QTest::newRow("Basic use of -output, query last")

        << 0

        << QByteArray("<e/>\n")

        << (QStringList() << QLatin1String("-output")

                          << QLatin1String("basicOutput2.out")

                          << QLatin1String(SRCDIR "queries/oneElement.xq"))

        << QString()

        << QString::fromLatin1("basicOutput2.out");

    QTest::newRow("A single query, that does not exist")

        << 2

        << QByteArray()

        << (QStringList() << QLatin1String(SRCDIR "doesNotExist.xq"))

        << QString()

        << QString();

    QTest::newRow("Specify two identical query names")

        << 2

        << QByteArray()

        << (QStringList() << QLatin1String(SRCDIR "query.xq")

                          << QLatin1String(SRCDIR "query.xq"))

        << QString()

        << QString();

    QTest::newRow("Specify no arguments at all.")

        << 1

        << QByteArray()

        << QStringList()

        << QString()

        << QString();

    QTest::newRow("Use -output twice")

        << 1

        << QByteArray()

        << (QStringList() << QLatin1String("-output")

                          << QLatin1String("output1")

                          << QLatin1String("-output")

                          << QLatin1String("output2"))

        << QString()

        << QString();

    {

        const QString filename(QString::fromLatin1("notWritable.out"));

        createNonWritable(filename);

        QTest::newRow("-output with a non-writable file")

            << 1

            << QByteArray()

            << (QStringList() << QLatin1String("-output")

                              << filename

                              << QLatin1String(SRCDIR "queries/onePlusOne.xq"))

            << QString()

            << filename;

    }

    {

        const QString outName(QString::fromLatin1("existingContent.out"));

        QFile outFile(outName);

        QVERIFY(outFile.open(QIODevice::WriteOnly));

        QCOMPARE(outFile.write("Existing content\n"), qint64(17));

        outFile.close();

        QTest::newRow("Use -output on a file with existing content, to ensure we truncate, not append the content we produce.")

            << 0

            << QByteArray("2\n")

            << (QStringList() << QLatin1String("-output")

                              << outName

                              << QLatin1String(SRCDIR "queries/onePlusOne.xq"))

            << QString()

            << outName;

    }

    QTest::newRow("one query, and a terminating dash at the end")

        << 0

        << QByteArray("2\n")

        << (QStringList() << QLatin1String(SRCDIR "queries/onePlusOne.xq")

                          << QLatin1String("-"))

        << QString()

        << QString();

    QTest::newRow("one query, with a preceding dash")

        << 0

        << QByteArray("2\n")

        << (QStringList() << QLatin1String("-")

                          << QLatin1String(SRCDIR "queries/onePlusOne.xq"))

        << QString()

        << QString();

    QTest::newRow("A single dash, that's invalid")

        << 1

        << QByteArray()

        << (QStringList() << QLatin1String("-"))

        << QString()

        << QString();

    QTest::newRow("Invoke -version")

        << 0

        << QByteArray()

        << (QStringList() << QLatin1String("-version"))

        << QString()

        << QString();

    QTest::newRow("Unknown switch; -unknown-switch")

        << 1

        << QByteArray()

        << (QStringList() << QLatin1String("-unknown-switch"))

        << QString()

        << QString();