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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#include "clangtoolsunittests.h"
#include "clangtool.h"
#include "clangtoolsdiagnostic.h"
#include "clangtoolssettings.h"
#include <coreplugin/icore.h>
#include <cppeditor/clangdiagnosticconfig.h>
#include <cppeditor/cppmodelmanager.h>
#include <cppeditor/cpptoolsreuse.h>
#include <cppeditor/cpptoolstestcase.h>
#include <projectexplorer/kitinformation.h>
#include <projectexplorer/kitmanager.h>
#include <projectexplorer/projectexplorer.h>
#include <projectexplorer/projectexplorerconstants.h>
#include <projectexplorer/toolchain.h>
#include <qtsupport/qtkitinformation.h>
#include <utils/environment.h>
#include <utils/fileutils.h>
#include <QSignalSpy>
#include <QTimer>
#include <QtTest>
using namespace CppEditor;
using namespace ProjectExplorer;
using namespace Utils;
Q_DECLARE_METATYPE(CppEditor::ClangDiagnosticConfig)
namespace ClangTools {
namespace Internal {
void ClangToolsUnitTests::initTestCase()
{
const QList<Kit *> allKits = KitManager::kits();
if (allKits.count() == 0)
QSKIP("This test requires at least one kit to be present");
m_kit = findOr(allKits, nullptr, [](Kit *k) {
return k->isValid() && QtSupport::QtKitAspect::qtVersion(k) != nullptr;
});
if (!m_kit)
QSKIP("This test requires at least one valid kit with a valid Qt");
const ToolChain *const toolchain = ToolChainKitAspect::cxxToolChain(m_kit);
if (!toolchain)
QSKIP("This test requires that there is a kit with a toolchain.");
if (Core::ICore::clangExecutable(CLANG_BINDIR).isEmpty())
QSKIP("No clang suitable for analyzing found");
m_tmpDir = new Tests::TemporaryCopiedDir(":/clangtools/unit-tests");
QVERIFY(m_tmpDir->isValid());
}
void ClangToolsUnitTests::cleanupTestCase()
{
delete m_tmpDir;
}
static ClangDiagnosticConfig configFor(const QString &tidyChecks, const QString &clazyChecks)
{
ClangDiagnosticConfig config;
config.setId("Test.MyTestConfig");
config.setDisplayName("Test");
config.setIsReadOnly(true);
config.setClangOptions(QStringList{QStringLiteral("-Wno-everything")});
config.setClangTidyMode(ClangDiagnosticConfig::TidyMode::UseCustomChecks);
const QString theTidyChecks = tidyChecks.isEmpty() ? tidyChecks : "-*," + tidyChecks;
config.setChecks(ClangToolType::Tidy, theTidyChecks);
config.setChecks(ClangToolType::Clazy, clazyChecks);
return config;
}
void ClangToolsUnitTests::testProject()
{
QFETCH(FilePath, projectFilePath);
QFETCH(int, expectedDiagCountClangTidy);
QFETCH(int, expectedDiagCountClazy);
QFETCH(ClangDiagnosticConfig, diagnosticConfig);
if (projectFilePath.contains("mingw")) {
const auto toolchain = ToolChainKitAspect::cxxToolChain(m_kit);
if (toolchain->typeId() != ProjectExplorer::Constants::MINGW_TOOLCHAIN_TYPEID)
QSKIP("This test is mingw specific, does not run for other toolchains");
}
// Open project
Tests::ProjectOpenerAndCloser projectManager;
QVERIFY(projectManager.open(projectFilePath, true, m_kit));
// Run tools
for (ClangTool * const tool : {ClangTidyTool::instance(), ClazyTool::instance()}) {
tool->startTool(ClangTool::FileSelectionType::AllFiles,
ClangToolsSettings::instance()->runSettings(),
diagnosticConfig);
QSignalSpy waitForFinishedTool(tool, &ClangTool::finished);
QVERIFY(waitForFinishedTool.wait(m_timeout));
// Check for errors
const QString errorText = waitForFinishedTool.takeFirst().constFirst().toString();
const bool finishedSuccessfully = errorText.isEmpty();
if (!finishedSuccessfully)
qWarning("Error: %s", qPrintable(errorText));
QVERIFY(finishedSuccessfully);
QCOMPARE(tool->diagnostics().count(), tool == ClangTidyTool::instance()
? expectedDiagCountClangTidy : expectedDiagCountClazy);
}
}
void ClangToolsUnitTests::testProject_data()
{
QTest::addColumn<FilePath>("projectFilePath");
QTest::addColumn<int>("expectedDiagCountClangTidy");
QTest::addColumn<int>("expectedDiagCountClazy");
QTest::addColumn<ClangDiagnosticConfig>("diagnosticConfig");
// Test simple C++ project.
ClangDiagnosticConfig config = configFor("modernize-use-nullptr", QString());
addTestRow("simple/simple.qbs", 1, 0, config);
addTestRow("simple/simple.pro", 1, 0, config);
// Test simple Qt project.
config = configFor("readability-static-accessed-through-instance", QString());
addTestRow("qt-widgets-app/qt-widgets-app.qbs", 1, 0, config);
addTestRow("qt-widgets-app/qt-widgets-app.pro", 1, 0, config);
// Test that libraries can be analyzed.
config = configFor(QString(), QString());
addTestRow("simple-library/simple-library.qbs", 0, 0, config);
addTestRow("simple-library/simple-library.pro", 0, 0, config);
// Test that standard headers can be parsed.
addTestRow("stdc++11-includes/stdc++11-includes.qbs", 0, 0, config);
addTestRow("stdc++11-includes/stdc++11-includes.pro", 0, 0, config);
// Test that qt essential headers can be parsed.
addTestRow("qt-essential-includes/qt-essential-includes.qbs", 0, 0, config);
addTestRow("qt-essential-includes/qt-essential-includes.pro", 0, 0, config);
// Test that mingw includes can be parsed.
addTestRow("mingw-includes/mingw-includes.qbs", 0, 0, config);
addTestRow("mingw-includes/mingw-includes.pro", 0, 0, config);
// Test that tidy and clazy diagnostics are emitted for the same project.
addTestRow("clangtidy_clazy/clangtidy_clazy.pro",
1, 1, configFor("misc-unconventional-assign-operator", "qgetenv"));
}
void ClangToolsUnitTests::addTestRow(const QByteArray &relativeFilePath,
int expectedDiagCountClangTidy,
int expectedDiagCountClazy,
const ClangDiagnosticConfig &diagnosticConfig)
{
const FilePath absoluteFilePath = m_tmpDir->absolutePath(QString::fromUtf8(relativeFilePath));
const QString fileName = absoluteFilePath.fileName();
QTest::newRow(fileName.toUtf8().constData())
<< absoluteFilePath << expectedDiagCountClangTidy << expectedDiagCountClazy
<< diagnosticConfig;
}
int ClangToolsUnitTests::getTimeout()
{
const int t = qtcEnvironmentVariableIntValue("QTC_CLANGTOOLS_TEST_TIMEOUT");
return t > 0 ? t : 480000;
}
} // namespace Internal
} // namespace ClangTools
|
