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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
|
/*
* Copyright (C) 2013-2014 Canonical, Ltd.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; version 3.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* Authors:
* Pete Woods <pete.woods@canonical.com>
* Pawel Stolowski <pawel.stolowski@canonical.com>
*/
#include <QTest>
#include <scope-harness/scope-harness.h>
#include <scope-harness/matcher/settings-matcher.h>
#include <scope-harness/matcher/settings-option-matcher.h>
#include <scope-harness/matcher/category-matcher.h>
#include <scope-harness/matcher/category-list-matcher.h>
#include <scope-harness/matcher/result-matcher.h>
#include <scope-harness/view/settings-view.h>
#include <scope-harness/test-utils.h>
#define QVERIFY_MATCHRESULT_FAILS(statement, errormsg) \
do {\
auto result = (statement);\
QVERIFY(!result.success());\
const QRegExp r(QString::fromStdString(errormsg));\
QVERIFY2(r.exactMatch(QString::fromStdString(result.concat_failures().c_str())),\
std::string("Failed to match: '\n" + result.concat_failures() + "\nagainst regexp '\n" + errormsg + "\n'").c_str());\
} while (0)
namespace sh = unity::scopeharness;
namespace shm = unity::scopeharness::matcher;
namespace shr = unity::scopeharness::registry;
namespace shv = unity::scopeharness::view;
namespace sc = unity::scopes;
namespace ss = unity::shell::scopes;
class SettingsEndToEndTest : public QObject
{
Q_OBJECT
private:
sh::ScopeHarness::UPtr m_harness;
private Q_SLOTS:
void cleanupTestCase()
{
}
void init()
{
qputenv("UNITY_SCOPES_NO_WAIT_LOCATION", "1");
m_harness = sh::ScopeHarness::newFromScopeList(
shr::CustomRegistry::Parameters({
TEST_DATA_DIR "mock-scope-departments/mock-scope-departments.ini",
TEST_DATA_DIR "mock-scope-double-nav/mock-scope-double-nav.ini",
TEST_DATA_DIR "mock-scope/mock-scope.ini",
})
);
}
void testBasic()
{
auto resultsView = m_harness->resultsView();
resultsView->setActiveScope("mock-scope");
auto settings = resultsView->settings();
QVERIFY(settings.get());
QCOMPARE(static_cast<long>(settings->count()), 5l);
QVERIFY_MATCHRESULT(
shm::SettingsMatcher().mode(shm::SettingsMatcher::Mode::by_id)
.hasAtLeast(1)
.option(
shm::SettingsOptionMatcher("distanceUnit")
.displayName("Distance Unit")
.optionType(shv::SettingsView::OptionType::List)
.displayValues(sc::VariantArray {sc::Variant("Kilometers"), sc::Variant("Miles")})
.value(sc::Variant("Miles"))
.defaultValue(sc::Variant("Miles"))
)
.match(settings)
);
QVERIFY_MATCHRESULT(
shm::SettingsMatcher().mode(shm::SettingsMatcher::Mode::starts_with)
.hasAtLeast(1)
.option(
shm::SettingsOptionMatcher("location")
.displayName("Location")
.optionType(shv::SettingsView::OptionType::String)
.value(sc::Variant("London"))
.defaultValue(sc::Variant("London"))
)
.match(settings)
);
QVERIFY_MATCHRESULT(
shm::SettingsMatcher().mode(shm::SettingsMatcher::Mode::all)
.hasExactly(5)
.option(
shm::SettingsOptionMatcher("location")
.displayName("Location")
.optionType(shv::SettingsView::OptionType::String)
.value(sc::Variant("London"))
.defaultValue(sc::Variant("London"))
)
.option(
shm::SettingsOptionMatcher("distanceUnit")
.displayName("Distance Unit")
.optionType(shv::SettingsView::OptionType::List)
.displayValues(sc::VariantArray {sc::Variant("Kilometers"), sc::Variant("Miles")})
.value(sc::Variant("Miles"))
.defaultValue(sc::Variant("Miles"))
)
.option(
shm::SettingsOptionMatcher("age")
.displayName("Age")
.optionType(shv::SettingsView::OptionType::Number)
.value(sc::Variant(23))
.defaultValue(sc::Variant(23))
)
.option(
shm::SettingsOptionMatcher("enabled")
.displayName("Enabled")
.optionType(shv::SettingsView::OptionType::Boolean)
.value(sc::Variant(true))
.defaultValue(sc::Variant(true))
)
.option(
shm::SettingsOptionMatcher("color")
.displayName("Color")
.optionType(shv::SettingsView::OptionType::String)
.value(sc::Variant())
.defaultValue(sc::Variant())
)
.match(settings)
);
}
void testBasicFailures()
{
auto resultsView = m_harness->resultsView();
resultsView->setActiveScope("mock-scope");
auto settings = resultsView->settings();
QVERIFY(settings.get());
QVERIFY_MATCHRESULT_FAILS(
shm::SettingsMatcher()
.hasAtLeast(6)
.match(settings),
"Failed expectations:\nExpected at least 6 options\n");
QVERIFY_MATCHRESULT_FAILS(
shm::SettingsMatcher()
.hasExactly(2)
.match(settings),
"Failed expectations:\nExpected exactly 2 options\n");
}
void testOptionLookupFailures()
{
auto resultsView = m_harness->resultsView();
resultsView->setActiveScope("mock-scope");
auto settings = resultsView->settings();
QVERIFY(settings.get());
QVERIFY_MATCHRESULT_FAILS(
shm::SettingsMatcher().mode(shm::SettingsMatcher::Mode::by_id)
.option(
shm::SettingsOptionMatcher("xyz")
)
.match(settings),
"Failed expectations:\nSettings option with ID xyz could not be found\n"
);
}
void testTypeCheckFailures()
{
auto resultsView = m_harness->resultsView();
resultsView->setActiveScope("mock-scope");
auto settings = resultsView->settings();
QVERIFY(settings.get());
QVERIFY_MATCHRESULT_FAILS(
shm::SettingsMatcher().mode(shm::SettingsMatcher::Mode::by_id)
.option(
shm::SettingsOptionMatcher("age")
.optionType(shv::SettingsView::OptionType::String)
)
.option(
shm::SettingsOptionMatcher("distanceUnit")
.optionType(shv::SettingsView::OptionType::Boolean)
)
.option(
shm::SettingsOptionMatcher("location")
.optionType(shv::SettingsView::OptionType::Number)
)
.option(
shm::SettingsOptionMatcher("color")
.optionType(shv::SettingsView::OptionType::List)
)
.match(settings),
"Failed expectations:\nOption ID age is of type number, expected string\nOption ID distanceUnit is of type list, expected boolean\nOption ID"
" location is of type string, expected number\nOption ID color is of type string, expected list\n"
);
}
void testValueCheckFailures()
{
auto resultsView = m_harness->resultsView();
resultsView->setActiveScope("mock-scope");
auto settings = resultsView->settings();
QVERIFY(settings.get());
QVERIFY_MATCHRESULT_FAILS(
shm::SettingsMatcher().mode(shm::SettingsMatcher::Mode::by_id)
.option(
shm::SettingsOptionMatcher("age")
.value(sc::Variant("xyz"))
)
.option(
shm::SettingsOptionMatcher("distanceUnit")
.displayValues(sc::VariantArray {sc::Variant("Kilometers"), sc::Variant("Parsecs")})
)
.match(settings),
"Failed expectations:\nOption with ID 'age' has 'value' == '23(.0)?' but expected "
"'\"xyz\"'\nOption with ID 'distanceUnit' has 'displayValues' == '\\[\"Kilometers\",\"Miles\"\\]' but expected '\\[\"Kilometers\",\"Parsecs\"\\]'\n"
);
}
void testValueSetFailure()
{
auto resultsView = m_harness->resultsView();
resultsView->setActiveScope("mock-scope");
auto settings = resultsView->settings();
QVERIFY(settings.get());
{
bool exception_thrown = false;
try
{
settings->set("distanceUnit", sc::Variant("foo"));
}
catch (const std::domain_error &e)
{
exception_thrown = true;
QCOMPARE(e.what(), "Failed to update settings option with ID 'distanceUnit': no such value 'foo'");
}
QVERIFY(exception_thrown);
}
{
bool exception_thrown = false;
try
{
settings->set("distanceUnit", sc::Variant(111));
}
catch (const std::domain_error &e)
{
exception_thrown = true;
QCOMPARE(e.what(), "Settings updated failed for option with ID 'distanceUnit': only string values are allowed");
}
QVERIFY(exception_thrown);
}
{
bool exception_thrown = false;
try
{
settings->set("xyz", sc::Variant("abc"));
}
catch (const std::domain_error &e)
{
exception_thrown = true;
QCOMPARE(e.what(), "Setting update failed. No such option: 'xyz'");
}
QVERIFY(exception_thrown);
}
}
void verifySettingsChange()
{
auto resultsView = m_harness->resultsView();
resultsView->setActiveScope("mock-scope");
auto settings = resultsView->settings();
QVERIFY(settings.get());
settings->set("location", sc::Variant("Barcelona"));
QVERIFY_MATCHRESULT(
shm::SettingsMatcher().mode(shm::SettingsMatcher::Mode::by_id)
.option(
shm::SettingsOptionMatcher("location")
.value(sc::Variant("Barcelona"))
.defaultValue(sc::Variant("London"))
)
.match(settings)
);
settings->set("distanceUnit", sc::Variant("Miles"));
resultsView->setQuery("settings-change");
QVERIFY_MATCHRESULT(
shm::CategoryListMatcher()
.hasAtLeast(1)
.mode(shm::CategoryListMatcher::Mode::by_id)
.category(shm::CategoryMatcher("cat1")
.hasAtLeast(1)
.mode(shm::CategoryMatcher::Mode::by_uri)
.result(shm::ResultMatcher("test:uri")
.title("result for: \"settings-change\"")
.property("setting-distanceUnit", sc::Variant(1))
)
)
.match(resultsView->categories())
);
settings->set("distanceUnit", sc::Variant("Kilometers"));
QVERIFY_MATCHRESULT(
shm::SettingsMatcher().mode(shm::SettingsMatcher::Mode::by_id)
.option(
shm::SettingsOptionMatcher("distanceUnit")
.value(sc::Variant("Kilometers"))
.defaultValue(sc::Variant("Miles"))
)
.match(settings)
);
QVERIFY_MATCHRESULT(
shm::CategoryListMatcher()
.hasAtLeast(1)
.mode(shm::CategoryListMatcher::Mode::by_id)
.category(shm::CategoryMatcher("cat1")
.hasAtLeast(1)
.mode(shm::CategoryMatcher::Mode::by_uri)
.result(shm::ResultMatcher("test:uri")
.title("result for: \"settings-change\"")
.property("setting-distanceUnit", sc::Variant(0))
)
)
.match(resultsView->categories())
);
}
void testChildScopes()
{
auto resultsView = m_harness->resultsView();
// make aggregator scope active
resultsView->setActiveScope("mock-scope-departments");
auto settings = resultsView->settings();
QVERIFY(settings.get());
QCOMPARE(static_cast<long>(settings->count()), 4l);
QVERIFY_MATCHRESULT(
shm::SettingsMatcher().mode(shm::SettingsMatcher::Mode::all)
.option(
shm::SettingsOptionMatcher("string-setting")
.displayName("String Setting")
.optionType(shv::SettingsView::OptionType::String)
.value(sc::Variant("Hello"))
.defaultValue(sc::Variant("Hello"))
)
.option(
shm::SettingsOptionMatcher("number-setting")
.displayName("Number Setting")
.optionType(shv::SettingsView::OptionType::Number)
.value(sc::Variant(13))
.defaultValue(sc::Variant(13))
)
.option(
shm::SettingsOptionMatcher("mock-scope-double-nav")
.displayName("Display results from mock-double-nav.DisplayName")
.optionType(shv::SettingsView::OptionType::Boolean)
.value(sc::Variant(true))
.defaultValue(sc::Variant())
)
.option(
shm::SettingsOptionMatcher("mock-scope")
.displayName("Display results from mock.DisplayName")
.optionType(shv::SettingsView::OptionType::Boolean)
.value(sc::Variant(true))
.defaultValue(sc::Variant())
)
.match(settings)
);
}
};
QTEST_GUILESS_MAIN(SettingsEndToEndTest)
#include <settingsendtoendtest.moc>
|