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;
67
68class Q_TESTLIB_EXPORT QTestLog
69{
70 Q_GADGET
71public:
72 QTestLog() = delete;
73 ~QTestLog() = delete;
74 Q_DISABLE_COPY_MOVE(QTestLog)
75
76 enum LogMode {
77 Plain = 0, XML, LightXML, JUnitXML, CSV, TeamCity, TAP
78#if defined(QT_USE_APPLE_UNIFIED_LOGGING)
79 , Apple
80#endif
81#if defined(HAVE_XCTEST)
82 , XCTest
83#endif
84 };
85 Q_ENUM(LogMode);
86
87 static void enterTestFunction(const char* function);
88 static void leaveTestFunction();
89
90 static void enterTestData(QTestData *data);
91
92 static void addPass(const char *msg);
93 static void addFail(const char *msg, const char *file, int line);
94 static void addXFail(const char *msg, const char *file, int line);
95 static void addXPass(const char *msg, const char *file, int line);
96 static void addBPass(const char *msg);
97 static void addBFail(const char *msg, const char *file, int line);
98 static void addBXPass(const char *msg, const char *file, int line);
99 static void addBXFail(const char *msg, const char *file, int line);
100 static void addSkip(const char *msg, const char *file, int line);
101 static void addBenchmarkResult(const QBenchmarkResult &result);
102
103 static void ignoreMessage(QtMsgType type, const char *msg);
104#ifndef QT_NO_REGULAREXPRESSION
105 static void ignoreMessage(QtMsgType type, const QRegularExpression &expression);
106#endif
107 static int unhandledIgnoreMessages();
108 static void printUnhandledIgnoreMessages();
109 static void clearIgnoreMessages();
110
111 static void warn(const char *msg, const char *file, int line);
112 static void info(const char *msg, const char *file, int line);
113
114 static void startLogging();
115 static void stopLogging();
116
117 static void addLogger(LogMode mode, const char *filename);
118
119 static int loggerCount();
120 static bool loggerUsingStdout();
121
122 static void setVerboseLevel(int level);
123 static int verboseLevel();
124
125 static void setMaxWarnings(int max);
126
127 static void setPrintAvailableTagsMode();
128
129 static int passCount();
130 static int failCount();
131 static int skipCount();
132 static int blacklistCount();
133 static int totalCount();
134
135 static void resetCounters();
136
137 static void setInstalledTestCoverage(bool installed);
138 static bool installedTestCoverage();
139
140 static qint64 nsecsTotalTime();
141 static qreal msecsTotalTime() { return QTestLog::nsecsTotalTime() / 1000000.; }
142 static qint64 nsecsFunctionTime();
143 static qreal msecsFunctionTime() { return QTestLog::nsecsFunctionTime() / 1000000.; }
144
145private:
146 static bool printAvailableTags;
147};
148
149QT_END_NAMESPACE
150
151#endif
152