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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
/*
* SPDX-FileCopyrightText: 2011 Frank Reininghaus <[email protected]>
*
* SPDX-License-Identifier: GPL-2.0-or-later
*/
#include "kitemviews/private/kitemlistkeyboardsearchmanager.h"
#include <QSignalSpy>
#include <QStandardPaths>
#include <QTest>
#include <source_location>
class KItemListKeyboardSearchManagerTest : public QObject
{
Q_OBJECT
private Q_SLOTS:
void initTestCase();
void init();
void testBasicKeyboardSearch();
void testAbortedKeyboardSearch();
void testRepeatedKeyPress();
void testPressShift();
private:
KItemListKeyboardSearchManager m_keyboardSearchManager;
// Helper function to verify signal parameters
void verifySignal(QSignalSpy &spy,
const QString &expectedString,
bool expectedSearchFromNextItem,
const std::source_location &location = std::source_location::current())
{
if (spy.count() != 1) {
QTest::qFail(QString("Compared values are not the same\n"
" Actual (spy.count()): %1\n"
" Expected (1) : 1")
.arg(spy.count())
.toUtf8()
.constData(),
location.file_name(),
location.line());
return;
}
QList<QVariant> arguments = spy.takeFirst();
if (arguments.size() != 3) {
QTest::qFail(QString("Compared values are not the same\n"
" Actual (arguments.size()): %1\n"
" Expected (3) : 3")
.arg(arguments.size())
.toUtf8()
.constData(),
location.file_name(),
location.line());
return;
}
QString actualText = arguments.at(0).toString();
if (actualText != expectedString) {
QTest::qFail(QString("Compared values are not the same\n"
" Actual (arguments.at(0).toString()): \"%1\"\n"
" Expected (QString(\"%2\")) : \"%2\"")
.arg(actualText)
.arg(expectedString)
.toUtf8()
.constData(),
location.file_name(),
location.line());
return;
}
bool actualBool = arguments.at(1).toBool();
if (actualBool != expectedSearchFromNextItem) {
QTest::qFail(QString("Compared values are not the same\n"
" Actual (arguments.at(1).toBool()): %1\n"
" Expected (%2) : %2")
.arg(actualBool ? "true" : "false")
.arg(expectedSearchFromNextItem ? "true" : "false")
.toUtf8()
.constData(),
location.file_name(),
location.line());
return;
}
// Ignore the third parameter (bool* found)
}
};
void KItemListKeyboardSearchManagerTest::initTestCase()
{
QStandardPaths::setTestModeEnabled(true);
}
void KItemListKeyboardSearchManagerTest::init()
{
// Make sure that the previous search string is cleared
m_keyboardSearchManager.cancelSearch();
}
void KItemListKeyboardSearchManagerTest::testBasicKeyboardSearch()
{
QSignalSpy spy(&m_keyboardSearchManager, &KItemListKeyboardSearchManager::changeCurrentItem);
QVERIFY(spy.isValid());
m_keyboardSearchManager.addKeys("f");
verifySignal(spy, "f", true);
m_keyboardSearchManager.addKeys("i");
verifySignal(spy, "fi", false);
m_keyboardSearchManager.addKeys("l");
verifySignal(spy, "fil", false);
m_keyboardSearchManager.addKeys("e");
verifySignal(spy, "file", false);
}
void KItemListKeyboardSearchManagerTest::testAbortedKeyboardSearch()
{
// Set the timeout to a small value (the default is 5000 milliseconds)
// to save time when running this test.
m_keyboardSearchManager.setTimeout(100);
QSignalSpy spy(&m_keyboardSearchManager, &KItemListKeyboardSearchManager::changeCurrentItem);
QVERIFY(spy.isValid());
m_keyboardSearchManager.addKeys("f");
verifySignal(spy, "f", true);
m_keyboardSearchManager.addKeys("i");
verifySignal(spy, "fi", false);
// If the delay between two key presses is larger than the chosen timeout,
// a new search is started. We add a small safety margin to avoid race conditions.
QTest::qWait(m_keyboardSearchManager.timeout() + 10);
m_keyboardSearchManager.addKeys("l");
verifySignal(spy, "l", true);
m_keyboardSearchManager.addKeys("e");
verifySignal(spy, "le", false);
// the selection was deselected, for instance with Esc or a click outside the selection
m_keyboardSearchManager.slotSelectionChanged(KItemSet(), KItemSet() << 1);
m_keyboardSearchManager.addKeys("a");
verifySignal(spy, "a", true);
}
void KItemListKeyboardSearchManagerTest::testRepeatedKeyPress()
{
// With the new implementation, pressing the same key repeatedly will:
// 1. First attempt a full match with the complete string
// 2. If full match fails, fall back to rapid navigation with the first character
QSignalSpy spy(&m_keyboardSearchManager, &KItemListKeyboardSearchManager::changeCurrentItem);
QVERIFY(spy.isValid());
// First key press - new search, only one signal
m_keyboardSearchManager.addKeys("p");
QCOMPARE(spy.count(), 1);
verifySignal(spy, "p", true);
// Second key press - repeating character, two signals
m_keyboardSearchManager.addKeys("p");
QCOMPARE(spy.count(), 2);
// First signal: full string match attempt
QList<QVariant> arguments = spy.takeFirst();
QCOMPARE(arguments.size(), 3);
QCOMPARE(arguments.at(0).toString(), QString("pp"));
QCOMPARE(arguments.at(1).toBool(), false);
// Second signal: rapid navigation fallback
arguments = spy.takeFirst();
QCOMPARE(arguments.size(), 3);
QCOMPARE(arguments.at(0).toString(), QString("p"));
QCOMPARE(arguments.at(1).toBool(), true);
// Third key press - repeating character, two signals
m_keyboardSearchManager.addKeys("p");
QCOMPARE(spy.count(), 2);
// First signal: full string match attempt
arguments = spy.takeFirst();
QCOMPARE(arguments.size(), 3);
QCOMPARE(arguments.at(0).toString(), QString("ppp"));
QCOMPARE(arguments.at(1).toBool(), false);
// Second signal: rapid navigation fallback
arguments = spy.takeFirst();
QCOMPARE(arguments.size(), 3);
QCOMPARE(arguments.at(0).toString(), QString("p"));
QCOMPARE(arguments.at(1).toBool(), true);
// Now press another key -> only one signal for non-repeating character
m_keyboardSearchManager.addKeys("q");
QCOMPARE(spy.count(), 1);
verifySignal(spy, "pppq", false);
}
void KItemListKeyboardSearchManagerTest::testPressShift()
{
// If the user presses Shift, i.e., to get a character like '_',
// KItemListController calls the addKeys(QString) method with an empty
// string. Make sure that this does not reset the current search. See
// https://bugs.kde.org/show_bug.cgi?id=321286
QSignalSpy spy(&m_keyboardSearchManager, &KItemListKeyboardSearchManager::changeCurrentItem);
QVERIFY(spy.isValid());
// Simulate that the user enters "a_b".
m_keyboardSearchManager.addKeys("a");
verifySignal(spy, "a", true);
m_keyboardSearchManager.addKeys("");
QCOMPARE(spy.count(), 0);
m_keyboardSearchManager.addKeys("_");
verifySignal(spy, "a_", false);
m_keyboardSearchManager.addKeys("b");
verifySignal(spy, "a_b", false);
}
QTEST_GUILESS_MAIN(KItemListKeyboardSearchManagerTest)
#include "kitemlistkeyboardsearchmanagertest.moc"
|
