summaryrefslogtreecommitdiffstats
path: root/tests/auto/corelib/global/qlogging/tst_qmessagelogger.cpp
blob: 4ff0469a49d0b19febf9d5f3cfe939d233713470 (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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the test suite of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** 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 General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#include <qlogging.h>
#include <qloggingcategory.h>
#include <QtTest/QTest>

Q_LOGGING_CATEGORY(debugTestCategory, "debug", QtDebugMsg)
Q_LOGGING_CATEGORY(infoTestCategory, "info", QtInfoMsg)
Q_LOGGING_CATEGORY(warningTestCategory, "warning", QtWarningMsg)
Q_LOGGING_CATEGORY(criticalTestCategory, "critical", QtCriticalMsg)

struct LoggerMessageInfo
{
    QtMsgType messageType { QtFatalMsg };
    QString message;
    const char *file { nullptr };
    int line { 0 };
    const char *function { nullptr };
    const char *category { nullptr };
};

LoggerMessageInfo messageInfo;

static void customMessageHandler(QtMsgType type, const QMessageLogContext &context,
                                 const QString &message)
{
    messageInfo.messageType = type;
    messageInfo.message = message;
    messageInfo.file = context.file;
    messageInfo.line = context.line;
    messageInfo.function = context.function;
    messageInfo.category = context.category;
}

class tst_QMessageLogger : public QObject
{
    Q_OBJECT
private slots:
    void initTestCase_data();

    void init();
    void cleanup();

    void logMessage();
    void logMessageWithLoggingCategory();
    void logMessageWithLoggingCategoryDisabled();
    void logMessageWithCategoryFunction();
    void logMessageWithNoDebug();

private:
    void logWithLoggingCategoryHelper(bool messageTypeEnabled);
};

void tst_QMessageLogger::initTestCase_data()
{
    QTest::addColumn<QtMsgType>("messageType");
    QTest::addColumn<QByteArray>("categoryName");
    QTest::addColumn<QByteArray>("messageText");
    QTest::addColumn<bool>("useDebugStream");

    // not testing QtFatalMsg, as it terminates the application
    QTest::newRow("debug") << QtDebugMsg << QByteArray("categoryDebug")
                           << QByteArray("debug message") << false;
    QTest::newRow("info") << QtInfoMsg << QByteArray("categoryInfo") << QByteArray("info message")
                          << false;
    QTest::newRow("warning") << QtWarningMsg << QByteArray("categoryWarning")
                             << QByteArray("warning message") << false;
    QTest::newRow("critical") << QtCriticalMsg << QByteArray("categoryCritical")
                              << QByteArray("critical message") << false;

#ifndef QT_NO_DEBUG_STREAM
    QTest::newRow("stream debug") << QtDebugMsg << QByteArray("categoryDebug")
                                  << QByteArray("debug message") << true;
    QTest::newRow("stream info") << QtInfoMsg << QByteArray("categoryInfo")
                                 << QByteArray("info message") << true;
    QTest::newRow("stream warning") << QtWarningMsg << QByteArray("categoryWarning")
                                    << QByteArray("warning message") << true;
    QTest::newRow("stream critical") << QtCriticalMsg << QByteArray("categoryCritical")
                                     << QByteArray("critical message") << true;
#endif
}

void tst_QMessageLogger::init()
{
    qInstallMessageHandler(customMessageHandler);
}

void tst_QMessageLogger::cleanup()
{
    qInstallMessageHandler((QtMessageHandler)0);
    messageInfo.messageType = QtFatalMsg;
    messageInfo.message.clear();
    messageInfo.file = nullptr;
    messageInfo.line = 0;
    messageInfo.function = nullptr;
    messageInfo.category = nullptr;
}

void tst_QMessageLogger::logMessage()
{
    const int line = QT_MESSAGELOG_LINE;
    QMessageLogger logger(QT_MESSAGELOG_FILE, line, QT_MESSAGELOG_FUNC);

    QFETCH_GLOBAL(QtMsgType, messageType);
    QFETCH_GLOBAL(QByteArray, messageText);
    QFETCH_GLOBAL(bool, useDebugStream);
    if (useDebugStream) {
#ifndef QT_NO_DEBUG_STREAM
        switch (messageType) {
        case QtDebugMsg:
            logger.debug().noquote() << messageText;
            break;
        case QtInfoMsg:
            logger.info().noquote() << messageText;
            break;
        case QtWarningMsg:
            logger.warning().noquote() << messageText;
            break;
        case QtCriticalMsg:
            logger.critical().noquote() << messageText;
            break;
        default:
            QFAIL("Invalid message type");
            break;
        }
#else
        QSKIP("Qt debug stream disabled");
#endif
    } else {
        switch (messageType) {
        case QtDebugMsg:
            logger.debug("%s", messageText.constData());
            break;
        case QtInfoMsg:
            logger.info("%s", messageText.constData());
            break;
        case QtWarningMsg:
            logger.warning("%s", messageText.constData());
            break;
        case QtCriticalMsg:
            logger.critical("%s", messageText.constData());
            break;
        default:
            QFAIL("Invalid message type");
            break;
        }
    }

    QCOMPARE(messageInfo.messageType, messageType);
    QCOMPARE(messageInfo.message, messageText);
    QCOMPARE(messageInfo.file, __FILE__);
    QCOMPARE(messageInfo.line, line);
    QCOMPARE(messageInfo.function, Q_FUNC_INFO);
}

void tst_QMessageLogger::logMessageWithLoggingCategory()
{
    logWithLoggingCategoryHelper(true);
}

void tst_QMessageLogger::logMessageWithLoggingCategoryDisabled()
{
    logWithLoggingCategoryHelper(false);
}

void tst_QMessageLogger::logMessageWithCategoryFunction()
{
    const int line = QT_MESSAGELOG_LINE;
    QMessageLogger logger(QT_MESSAGELOG_FILE, line, QT_MESSAGELOG_FUNC);

    const QLoggingCategory *category = nullptr;
    QFETCH_GLOBAL(QtMsgType, messageType);
    QFETCH_GLOBAL(QByteArray, messageText);
    QFETCH_GLOBAL(bool, useDebugStream);
    if (useDebugStream) {
#ifndef QT_NO_DEBUG_STREAM
        switch (messageType) {
        case QtDebugMsg:
            logger.debug(debugTestCategory()).noquote() << messageText;
            category = &debugTestCategory();
            break;
        case QtInfoMsg:
            logger.info(infoTestCategory()).noquote() << messageText;
            category = &infoTestCategory();
            break;
        case QtWarningMsg:
            logger.warning(warningTestCategory()).noquote() << messageText;
            category = &warningTestCategory();
            break;
        case QtCriticalMsg:
            logger.critical(criticalTestCategory()).noquote() << messageText;
            category = &criticalTestCategory();
            break;
        default:
            QFAIL("Invalid message type");
            break;
        }
#else
        QSKIP("Qt debug stream disabled");
#endif
    } else {
        switch (messageType) {
        case QtDebugMsg:
            logger.debug(debugTestCategory(), "%s", messageText.constData());
            category = &debugTestCategory();
            break;
        case QtInfoMsg:
            logger.info(infoTestCategory(), "%s", messageText.constData());
            category = &infoTestCategory();
            break;
        case QtWarningMsg:
            logger.warning(warningTestCategory(), "%s", messageText.constData());
            category = &warningTestCategory();
            break;
        case QtCriticalMsg:
            logger.critical(criticalTestCategory(), "%s", messageText.constData());
            category = &criticalTestCategory();
            break;
        default:
            QFAIL("Invalid message type");
            break;
        }
    }

    QCOMPARE(messageInfo.messageType, messageType);
    QCOMPARE(messageInfo.message, messageText);
    QCOMPARE(messageInfo.file, __FILE__);
    QCOMPARE(messageInfo.line, line);
    QCOMPARE(messageInfo.function, Q_FUNC_INFO);
    QCOMPARE(messageInfo.category, category->categoryName());
}

void tst_QMessageLogger::logMessageWithNoDebug()
{
    const int line = QT_MESSAGELOG_LINE;
    QMessageLogger logger(QT_MESSAGELOG_FILE, line, QT_MESSAGELOG_FUNC);

    QFETCH_GLOBAL(QByteArray, messageText);
    QFETCH_GLOBAL(bool, useDebugStream);
    if (useDebugStream) {
#ifndef QT_NO_DEBUG_STREAM
        logger.noDebug().noquote() << messageText;
#else
        QSKIP("Qt debug stream disabled");
#endif
    } else {
        logger.noDebug("%s", messageText.constData());
    }

    // the callback was not called
    QVERIFY(messageInfo.messageType == QtFatalMsg);
    QVERIFY(messageInfo.message.isEmpty());
    QVERIFY(messageInfo.file == nullptr);
    QVERIFY(messageInfo.line == 0);
    QVERIFY(messageInfo.function == nullptr);
    QVERIFY(messageInfo.category == nullptr);
}

void tst_QMessageLogger::logWithLoggingCategoryHelper(bool messageTypeEnabled)
{
    QFETCH_GLOBAL(QtMsgType, messageType);
    QFETCH_GLOBAL(QByteArray, categoryName);
    QLoggingCategory category(categoryName.constData(), messageType);
    if (!messageTypeEnabled)
        category.setEnabled(messageType, false);

    const int line = QT_MESSAGELOG_LINE;
    QMessageLogger logger(QT_MESSAGELOG_FILE, line, QT_MESSAGELOG_FUNC);

    QFETCH_GLOBAL(QByteArray, messageText);
    QFETCH_GLOBAL(bool, useDebugStream);
    if (useDebugStream) {
#ifndef QT_NO_DEBUG_STREAM
        switch (messageType) {
        case QtDebugMsg:
            logger.debug(category).noquote() << messageText;
            break;
        case QtInfoMsg:
            logger.info(category).noquote() << messageText;
            break;
        case QtWarningMsg:
            logger.warning(category).noquote() << messageText;
            break;
        case QtCriticalMsg:
            logger.critical(category).noquote() << messageText;
            break;
        default:
            QFAIL("Invalid message type");
            break;
        }
#else
        QSKIP("Qt debug stream disabled");
#endif
    } else {
        switch (messageType) {
        case QtDebugMsg:
            logger.debug(category, "%s", messageText.constData());
            break;
        case QtInfoMsg:
            logger.info(category, "%s", messageText.constData());
            break;
        case QtWarningMsg:
            logger.warning(category, "%s", messageText.constData());
            break;
        case QtCriticalMsg:
            logger.critical(category, "%s", messageText.constData());
            break;
        default:
            QFAIL("Invalid message type");
            break;
        }
    }

    if (messageTypeEnabled) {
        QCOMPARE(messageInfo.messageType, messageType);
        QCOMPARE(messageInfo.message, messageText);
        QCOMPARE(messageInfo.file, __FILE__);
        QCOMPARE(messageInfo.line, line);
        QCOMPARE(messageInfo.function, Q_FUNC_INFO);
        QCOMPARE(messageInfo.category, categoryName);
    } else {
        // the callback was not called
        QVERIFY(messageInfo.messageType == QtFatalMsg);
        QVERIFY(messageInfo.message.isEmpty());
        QVERIFY(messageInfo.file == nullptr);
        QVERIFY(messageInfo.line == 0);
        QVERIFY(messageInfo.function == nullptr);
        QVERIFY(messageInfo.category == nullptr);
    }
}

QTEST_MAIN(tst_QMessageLogger)
#include "tst_qmessagelogger.moc"