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
|
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of Qt Creator.
**
** 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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#include "testwizard.h"
#include "testwizarddialog.h"
#include <cpptools/abstracteditorsupport.h>
#include <projectexplorer/projectexplorerconstants.h>
#include <qtsupport/qtsupportconstants.h>
#include <utils/qtcassert.h>
#include <QTextStream>
#include <QFileInfo>
#include <QIcon>
namespace Qt4ProjectManager {
namespace Internal {
TestWizard::TestWizard() :
QtWizard(QLatin1String("L.Qt4Test"),
QLatin1String(ProjectExplorer::Constants::QT_PROJECT_WIZARD_CATEGORY),
QLatin1String(ProjectExplorer::Constants::QT_PROJECT_WIZARD_CATEGORY_DISPLAY),
tr("Qt Unit Test"),
tr("Creates a QTestLib-based unit test for a feature or a class. "
"Unit tests allow you to verify that the code is fit for use "
"and that there are no regressions."),
QIcon(QLatin1String(":/wizards/images/console.png")))
{
}
QWizard *TestWizard::createWizardDialog(QWidget *parent,
const Core::WizardDialogParameters &wizardDialogParameters) const
{
TestWizardDialog *dialog = new TestWizardDialog(displayName(), icon(), parent, wizardDialogParameters);
dialog->setProjectName(TestWizardDialog::uniqueProjectName(wizardDialogParameters.defaultPath()));
return dialog;
}
// ---------------- code generation helpers
static const char initTestCaseC[] = "initTestCase";
static const char cleanupTestCaseC[] = "cleanupTestCase";
static const char closeFunctionC[] = "}\n\n";
static const char testDataTypeC[] = "QString";
static inline void writeVoidMemberDeclaration(QTextStream &str,
const QString &indent,
const QString &methodName)
{
str << indent << "void " << methodName << "();\n";
}
static inline void writeVoidMemberBody(QTextStream &str,
const QString &className,
const QString &methodName,
bool close = true)
{
str << "void " << className << "::" << methodName << "()\n{\n";
if (close)
str << closeFunctionC;
}
static QString generateTestCode(const TestWizardParameters &testParams,
const QString &sourceBaseName)
{
QString rc;
const QString indent = QString(4, QLatin1Char(' '));
QTextStream str(&rc);
// Includes
str << CppTools::AbstractEditorSupport::licenseTemplate(testParams.fileName, testParams.className)
<< "#include <QString>\n#include <QtTest>\n";
if (testParams.requiresQApplication)
str << "#include <QCoreApplication>\n";
// Class declaration
str << "\nclass " << testParams.className << " : public QObject\n"
"{\n" << indent << "Q_OBJECT\n\npublic:\n"
<< indent << testParams.className << "();\n\nprivate Q_SLOTS:\n";
if (testParams.initializationCode) {
writeVoidMemberDeclaration(str, indent, QLatin1String(initTestCaseC));
writeVoidMemberDeclaration(str, indent, QLatin1String(cleanupTestCaseC));
}
const QString dataSlot = testParams.testSlot + QLatin1String("_data");
writeVoidMemberDeclaration(str, indent, testParams.testSlot);
if (testParams.useDataSet)
writeVoidMemberDeclaration(str, indent, dataSlot);
str << "};\n\n";
// Code: Constructor
str << testParams.className << "::" << testParams.className << "()\n{\n}\n\n";
// Code: Initialization slots
if (testParams.initializationCode) {
writeVoidMemberBody(str, testParams.className, QLatin1String(initTestCaseC));
writeVoidMemberBody(str, testParams.className, QLatin1String(cleanupTestCaseC));
}
// Test slot with data or dummy
writeVoidMemberBody(str, testParams.className, testParams.testSlot, false);
if (testParams.useDataSet) {
str << indent << "QFETCH(" << testDataTypeC << ", data);\n";
}
switch (testParams.type) {
case TestWizardParameters::Test:
str << indent << "QVERIFY2(true, \"Failure\");\n";
break;
case TestWizardParameters::Benchmark:
str << indent << "QBENCHMARK {\n" << indent << "}\n";
break;
}
str << closeFunctionC;
// test data generation slot
if (testParams.useDataSet) {
writeVoidMemberBody(str, testParams.className, dataSlot, false);
str << indent << "QTest::addColumn<" << testDataTypeC << ">(\"data\");\n"
<< indent << "QTest::newRow(\"0\") << " << testDataTypeC << "();\n"
<< closeFunctionC;
}
// Main & moc include
str << (testParams.requiresQApplication ? "QTEST_MAIN" : "QTEST_APPLESS_MAIN")
<< '(' << testParams.className << ")\n\n"
<< "#include \"" << sourceBaseName << ".moc\"\n";
return rc;
}
Core::GeneratedFiles TestWizard::generateFiles(const QWizard *w, QString *errorMessage) const
{
Q_UNUSED(errorMessage)
const TestWizardDialog *wizardDialog = qobject_cast<const TestWizardDialog *>(w);
QTC_ASSERT(wizardDialog, return Core::GeneratedFiles());
const QtProjectParameters projectParams = wizardDialog->projectParameters();
const TestWizardParameters testParams = wizardDialog->testParameters();
const QString projectPath = projectParams.projectPath();
// Create files: Source
const QString sourceFilePath = Core::BaseFileWizard::buildFileName(projectPath, testParams.fileName, sourceSuffix());
const QFileInfo sourceFileInfo(sourceFilePath);
Core::GeneratedFile source(sourceFilePath);
source.setAttributes(Core::GeneratedFile::OpenEditorAttribute);
source.setContents(generateTestCode(testParams, sourceFileInfo.baseName()));
// Create profile with define for base dir to find test data
const QString profileName = Core::BaseFileWizard::buildFileName(projectPath, projectParams.fileName, profileSuffix());
Core::GeneratedFile profile(profileName);
profile.setAttributes(Core::GeneratedFile::OpenProjectAttribute);
QString contents;
{
QTextStream proStr(&contents);
QtProjectParameters::writeProFileHeader(proStr);
projectParams.writeProFile(proStr);
proStr << "\n\nSOURCES += " << QFileInfo(sourceFilePath).fileName() << '\n'
<< "DEFINES += SRCDIR=\\\\\\\"$$PWD/\\\\\\\"\n";
}
profile.setContents(contents);
return Core::GeneratedFiles() << source << profile;
}
Core::FeatureSet TestWizard::requiredFeatures() const
{
return Core::Feature(QtSupport::Constants::FEATURE_QT_CONSOLE) |
Core::Feature(QtSupport::Constants::FEATURE_QT);
}
} // namespace Internal
} // namespace Qt4ProjectManager
|
