1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtTest module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QTESTLOG_P_H
41#define QTESTLOG_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QtTest/qttestglobal.h>
55
56#if defined(Q_OS_DARWIN)
57#include <QtCore/private/qcore_mac_p.h>
58#endif
59
60#include <QtCore/qobjectdefs.h>
61
62QT_BEGIN_NAMESPACE
63
64class QBenchmarkResult;
65class QRegularExpression;
66class QTestData;
67class QAbstractTestLogger;
68
69class Q_TESTLIB_EXPORT QTestLog
70{
71 Q_GADGET
72public:
73 QTestLog() = delete;
74 ~QTestLog() = delete;
75 Q_DISABLE_COPY_MOVE(QTestLog)
76
77 enum LogMode {
78 Plain = 0, XML, LightXML, JUnitXML, CSV, TeamCity, TAP
79#if defined(QT_USE_APPLE_UNIFIED_LOGGING)
80 , Apple
81#endif
82#if defined(HAVE_XCTEST)
83 , XCTest
84#endif
85 };
86 Q_ENUM(LogMode);
87
88 static void enterTestFunction(const char* function);
89 static void leaveTestFunction();
90
91 static void enterTestData(QTestData *data);
92
93 static void addPass(const char *msg);
94 static void addFail(const char *msg, const char *file, int line);
95 static void addXFail(const char *msg, const char *file, int line);
96 static void addXPass(const char *msg, const char *file, int line);
97 static void addBPass(const char *msg);
98 static void addBFail(const char *msg, const char *file, int line);
99 static void addBXPass(const char *msg, const char *file, int line);
100 static void addBXFail(const char *msg, const char *file, int line);
101 static void addSkip(const char *msg, const char *file, int line);
102 static void addBenchmarkResult(const QBenchmarkResult &result);
103
104 static void ignoreMessage(QtMsgType type, const char *msg);
105#ifndef QT_NO_REGULAREXPRESSION
106 static void ignoreMessage(QtMsgType type, const QRegularExpression &expression);
107#endif
108 static int unhandledIgnoreMessages();
109 static void printUnhandledIgnoreMessages();
110 static void clearIgnoreMessages();
111
112 static void warn(const char *msg, const char *file, int line);
113 static void info(const char *msg, const char *file, int line);
114
115 static void startLogging();
116 static void stopLogging();
117
118 static void addLogger(LogMode mode, const char *filename);
119 static void addLogger(QAbstractTestLogger *logger);
120
121 static int loggerCount();
122 static bool loggerUsingStdout();
123
124 static void setVerboseLevel(int level);
125 static int verboseLevel();
126
127 static void setMaxWarnings(int max);
128
129 static void setPrintAvailableTagsMode();
130
131 static int passCount();
132 static int failCount();
133 static int skipCount();
134 static int blacklistCount();
135 static int totalCount();
136
137 static void resetCounters();
138
139 static void setInstalledTestCoverage(bool installed);
140 static bool installedTestCoverage();
141
142 static qint64 nsecsTotalTime();
143 static qreal msecsTotalTime() { return QTestLog::nsecsTotalTime() / 1000000.; }
144 static qint64 nsecsFunctionTime();
145 static qreal msecsFunctionTime() { return QTestLog::nsecsFunctionTime() / 1000000.; }
146
147private:
148 static bool printAvailableTags;
149};
150
151QT_END_NAMESPACE
152
153#endif
154