summaryrefslogtreecommitdiffstats
path: root/tests/auto/core/qwebengineurlrequestjob/tst_qwebengineurlrequestjob.cpp
blob: d48da2c44d9d355a0ec3a1525bc8155279173f3e (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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

#include <QtTest/QtTest>
#include <QtWebEngineCore/qwebengineurlschemehandler.h>
#include <QtWebEngineCore/qwebengineurlscheme.h>
#include <QtWebEngineCore/qwebengineurlrequestjob.h>
#include <QtWebEngineCore/qwebengineprofile.h>
#include <QtWebEngineCore/qwebenginepage.h>

class CustomPage : public QWebEnginePage
{
    Q_OBJECT

public:
    CustomPage(QWebEngineProfile *profile, QString compareStringPrefix, QString compareStringSuffix,
               QObject *parent = nullptr)
        : QWebEnginePage(profile, parent)
        , m_compareStringPrefix(compareStringPrefix)
        , m_compareStringSuffix(compareStringSuffix)
        , m_comparedMessageCount(0)
    {
    }

    int comparedMessageCount() const { return m_comparedMessageCount; }

signals:
    void receivedMessage();

protected:
    void javaScriptConsoleMessage(QWebEnginePage::JavaScriptConsoleMessageLevel level,
                                  const QString &message, int lineNumber,
                                  const QString &sourceID) override
    {
        Q_UNUSED(level);
        Q_UNUSED(lineNumber);
        Q_UNUSED(sourceID);

        auto splitMessage = message.split(";");
        if (splitMessage[0] == m_compareStringPrefix) {
            QCOMPARE(splitMessage[1], m_compareStringSuffix);
            m_comparedMessageCount++;
            emit receivedMessage();
        }
    }

private:
    QString m_compareStringPrefix;
    QString m_compareStringSuffix;
    int m_comparedMessageCount;
};

class AdditionalResponseHeadersHandler : public QWebEngineUrlSchemeHandler
{
    Q_OBJECT
public:
    AdditionalResponseHeadersHandler(bool addAdditionalResponseHeaders, QObject *parent = nullptr)
        : QWebEngineUrlSchemeHandler(parent)
        , m_addAdditionalResponseHeaders(addAdditionalResponseHeaders)
    {
    }

    void requestStarted(QWebEngineUrlRequestJob *job) override
    {
        QCOMPARE(job->requestUrl(), QUrl(schemeName + ":about"));

        QMultiMap<QByteArray, QByteArray> additionalResponseHeaders;
        if (m_addAdditionalResponseHeaders) {
            additionalResponseHeaders.insert(QByteArray::fromStdString("test1"),
                                             QByteArray::fromStdString("test1VALUE"));
            additionalResponseHeaders.insert(QByteArray::fromStdString("test2"),
                                             QByteArray::fromStdString("test2VALUE"));
        }
        job->setAdditionalResponseHeaders(additionalResponseHeaders);

        QFile *file = new QFile(QStringLiteral(":additionalResponseHeadersScript.html"), job);
        file->open(QIODevice::ReadOnly);

        job->reply(QByteArrayLiteral("text/html"), file);
    }

    static void registerUrlScheme()
    {
        QWebEngineUrlScheme webUiScheme(schemeName);
        webUiScheme.setFlags(QWebEngineUrlScheme::CorsEnabled);
        QWebEngineUrlScheme::registerScheme(webUiScheme);
    }

    const static inline QByteArray schemeName =
            QByteArrayLiteral("additionalresponseheadershandler");

private:
    bool m_addAdditionalResponseHeaders;
};

class RequestBodyHandler : public QWebEngineUrlSchemeHandler
{
    Q_OBJECT
public:
    void requestStarted(QWebEngineUrlRequestJob *job) override
    {
        QCOMPARE(job->requestUrl(), QUrl(schemeName + ":about"));
        QCOMPARE(job->requestMethod(), QByteArrayLiteral("POST"));

        QIODevice *requestBodyDevice = job->requestBody();
        requestBodyDevice->open(QIODevice::ReadOnly);
        QByteArray requestBody = requestBodyDevice->readAll();
        requestBodyDevice->close();

        QBuffer *buf = new QBuffer(job);
        buf->open(QBuffer::ReadWrite);
        buf->write(requestBody);
        job->reply(QByteArrayLiteral("text/plain"), buf);
        buf->close();
    }

    static void registerUrlScheme()
    {
        QWebEngineUrlScheme webUiScheme(schemeName);
        webUiScheme.setFlags(QWebEngineUrlScheme::CorsEnabled
                             | QWebEngineUrlScheme::FetchApiAllowed);
        QWebEngineUrlScheme::registerScheme(webUiScheme);
    }

    const static inline QByteArray schemeName = QByteArrayLiteral("requestbodyhandler");
};

class tst_QWebEngineUrlRequestJob : public QObject
{
    Q_OBJECT

public:
    tst_QWebEngineUrlRequestJob() { }

private Q_SLOTS:
    void initTestCase()
    {
        AdditionalResponseHeadersHandler::registerUrlScheme();
        RequestBodyHandler::registerUrlScheme();
    }

    void withAdditionalResponseHeaders_data()
    {
        QTest::addColumn<bool>("withHeaders");
        QTest::addColumn<QString>("expectedHeaders");
        QTest::newRow("headers enabled")
                << true << "content-type: text/html\r\ntest1: test1value\r\ntest2: test2value\r\n";
        QTest::newRow("headers disabled") << false << "content-type: text/html\r\n";
    }

    void withAdditionalResponseHeaders()
    {
        QFETCH(bool, withHeaders);
        QFETCH(QString, expectedHeaders);

        QWebEngineProfile profile;

        AdditionalResponseHeadersHandler handler(withHeaders);
        profile.installUrlSchemeHandler(AdditionalResponseHeadersHandler::schemeName, &handler);

        CustomPage page(&profile, "TST_ADDITIONALRESPONSEHEADERS", expectedHeaders);
        QSignalSpy spy(&page, SIGNAL(loadFinished(bool)));

        page.load(QUrl("qrc:///additionalResponseHeadersScript.html"));
        QVERIFY(spy.wait());
        QCOMPARE(page.comparedMessageCount(), 1);
    }

    void requestBody()
    {
        QWebEngineProfile profile;

        RequestBodyHandler handler;
        profile.installUrlSchemeHandler(RequestBodyHandler::schemeName, &handler);

        const QString expected = "reading request body successful";
        CustomPage page(&profile, "TST_REQUESTBODY", expected);
        QSignalSpy spy(&page, SIGNAL(receivedMessage()));

        page.load(QUrl("qrc:///requestBodyScript.html"));
        QVERIFY(spy.wait());
        QCOMPARE(page.comparedMessageCount(), 1);
    }
};

QTEST_MAIN(tst_QWebEngineUrlRequestJob)
#include "tst_qwebengineurlrequestjob.moc"