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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#pragma once
#include <utils/fileutils.h>
#include <utils/treemodel.h>
#include <QList>
#include <QMetaType>
#include <QSet>
#include <QString>
namespace {
enum ItemRole {
LinkRole = Qt::UserRole + 2, // can be removed if AnnotationRole comes back
ItalicRole, // used only inside the delegate
TypeRole,
EnabledRole,
FailedRole // marker for having failed in last run
};
}
namespace Autotest {
class ITestBase;
class ITestFramework;
class ITestConfiguration;
class TestParseResult;
enum class TestRunMode;
class ITestTreeItem : public Utils::TypedTreeItem<ITestTreeItem>
{
public:
enum Type
{
Root,
GroupNode,
TestSuite,
TestCase,
TestFunction,
TestDataTag,
TestDataFunction,
TestSpecialFunction
};
enum SortMode {
Alphabetically,
Naturally
};
explicit ITestTreeItem(ITestBase *testBase,
const QString &name = QString(),
const Utils::FilePath &filePath = Utils::FilePath(),
Type type = Root);
virtual QVariant data(int column, int role) const override;
virtual bool setData(int column, const QVariant &data, int role) override;
virtual Qt::ItemFlags flags(int column) const override;
virtual Qt::CheckState checked() const;
virtual bool canProvideTestConfiguration() const { return false; }
virtual ITestConfiguration *testConfiguration() const { return nullptr; }
virtual ITestConfiguration *asConfiguration(TestRunMode mode) const;
virtual QList<ITestConfiguration *> getAllTestConfigurations() const { return {}; }
virtual QList<ITestConfiguration *> getSelectedTestConfigurations() const { return {}; };
virtual QList<ITestConfiguration *> getFailedTestConfigurations() const { return {}; }
const QString name() const { return m_name; }
void setName(const QString &name) { m_name = name; }
const Utils::FilePath filePath() const { return m_filePath; }
void setFilePath(const Utils::FilePath &filePath) { m_filePath = filePath; }
Type type() const { return m_type; }
int line() const { return m_line; }
void setLine(int line) { m_line = line;}
ITestBase *testBase() const { return m_testBase; }
virtual bool lessThan(const ITestTreeItem *other, SortMode mode) const;
QString cacheName() const { return m_filePath.toString() + ':' + m_name; }
protected:
void setType(Type type) { m_type = type; }
Qt::CheckState m_checked = Qt::Checked;
private:
ITestBase *m_testBase = nullptr; // not owned
QString m_name;
Utils::FilePath m_filePath;
Type m_type;
int m_line = 0;
bool m_failed = false;
};
class TestTreeItem : public ITestTreeItem
{
public:
explicit TestTreeItem(ITestFramework *testFramework,
const QString &name = QString(),
const Utils::FilePath &filePath = Utils::FilePath(),
Type type = Root);
virtual TestTreeItem *copyWithoutChildren() = 0;
virtual QVariant data(int column, int role) const override;
bool modifyTestCaseOrSuiteContent(const TestParseResult *result);
bool modifyTestFunctionContent(const TestParseResult *result);
bool modifyDataTagContent(const TestParseResult *result);
bool modifyLineAndColumn(const TestParseResult *result);
ITestFramework *framework() const;
void setColumn(int column) { m_column = column; }
int column() const { return m_column; }
Utils::FilePath proFile() const { return m_proFile; }
void setProFile(const Utils::FilePath &proFile) { m_proFile = proFile; }
void markForRemoval(bool mark);
void markForRemovalRecursively(bool mark);
virtual void markForRemovalRecursively(const Utils::FilePath &filepath);
virtual bool removeOnSweepIfEmpty() const { return type() == GroupNode; }
bool markedForRemoval() const { return m_status == MarkedForRemoval; }
bool newlyAdded() const { return m_status == NewlyAdded; }
TestTreeItem *childItem(int at) const;
TestTreeItem *parentItem() const;
TestTreeItem *findChildByName(const QString &name);
TestTreeItem *findChildByFile(const Utils::FilePath &filePath);
TestTreeItem *findChildByFileAndType(const Utils::FilePath &filePath, Type type);
TestTreeItem *findChildByNameAndFile(const QString &name, const Utils::FilePath &filePath);
virtual ITestConfiguration *debugConfiguration() const { return nullptr; }
virtual bool canProvideDebugConfiguration() const { return false; }
ITestConfiguration *asConfiguration(TestRunMode mode) const final;
virtual QList<ITestConfiguration *> getTestConfigurationsForFile(const Utils::FilePath &fileName) const;
virtual TestTreeItem *find(const TestParseResult *result) = 0;
virtual TestTreeItem *findChild(const TestTreeItem *other) = 0;
virtual bool modify(const TestParseResult *result) = 0;
virtual bool isGroupNodeFor(const TestTreeItem *other) const;
virtual bool isGroupable() const;
virtual TestTreeItem *createParentGroupNode() const = 0;
// based on (internal) filters this will be used to filter out sub items (and remove them)
// returns a copy of the item that contains the filtered out children or nullptr
virtual TestTreeItem *applyFilters() { return nullptr; }
// decide whether an item should still be added to the treemodel
virtual bool shouldBeAddedAfterFiltering() const { return true; }
void forAllChildItems(const std::function<void(TestTreeItem *)> &pred) const;
void forFirstLevelChildItems(const std::function<void(TestTreeItem *)> &pred) const;
TestTreeItem *findFirstLevelChildItem(const std::function<bool(TestTreeItem *)> &pred) const;
protected:
void copyBasicDataFrom(const TestTreeItem *other);
typedef std::function<bool(const TestTreeItem *)> CompareFunction;
private:
bool modifyFilePath(const Utils::FilePath &filepath);
bool modifyName(const QString &name);
enum Status
{
NewlyAdded,
MarkedForRemoval,
Cleared
};
int m_column = 0;
Utils::FilePath m_proFile;
Status m_status = NewlyAdded;
friend class TestTreeModel; // grant access to (protected) findChildBy()
};
class TestCodeLocationAndType
{
public:
QString m_name;
Utils::FilePath m_filePath;
int m_line = 0;
int m_column = 0;
TestTreeItem::Type m_type = TestTreeItem::Root;
};
typedef QVector<TestCodeLocationAndType> TestCodeLocationList;
} // namespace Autotest
Q_DECLARE_METATYPE(Autotest::TestTreeItem *)
Q_DECLARE_METATYPE(Autotest::TestCodeLocationAndType)
|
