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