git.iko.soy/unity8
on 9bc9ff2 help sign in
unity8/tests/utils/modules/Unity/Test/UnityTestCase.qml
455 lines 16 kB history raw
1/*
2 * Copyright 2013 Canonical Ltd.
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; version 3.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program. If not, see <http://www.gnu.org/licenses/>.
15 */
17import QtQuick 2.0
18import QtTest 1.0
19import Ubuntu.Components 0.1
20import Unity.Test 0.1 as UT
22TestCase {
23 id: testCase
24 TestUtil {id:util}
26 ActivityIndicator {
27 visible: testCase.running
28 anchors.centerIn: parent
29 Component.onCompleted: parent = testCase.parent
30 z: 100
31 running: visible
32 }
34 // Fake implementation to be provided to items under test
35 property var fakeDateTime: new function() {
36 this.currentTimeMs = 0
37 this.getCurrentTimeMs = function() {return this.currentTimeMs}
38 }
40 function mouseClick(item, x, y, button, modifiers, delay) {
41 if (button === undefined)
42 button = Qt.LeftButton;
43 if (modifiers === undefined)
44 modifiers = Qt.NoModifier;
45 if (delay === undefined)
46 delay = -1;
47 if (x === undefined)
48 x = item.width / 2;
49 if (y === undefined)
50 y = item.height / 2;
51 if (!qtest_events.mouseClick(item, x, y, button, modifiers, delay))
52 qtest_fail("window not shown", 2);
53 }
55 function mouseDoubleClick(item, x, y, button, modifiers, delay) {
56 if (button === undefined)
57 button = Qt.LeftButton;
58 if (modifiers === undefined)
59 modifiers = Qt.NoModifier;
60 if (delay === undefined)
61 delay = -1;
62 if (x === undefined)
63 x = item.width / 2;
64 if (y === undefined)
65 y = item.height / 2;
66 if (!qtest_events.mouseDoubleClick(item, x, y, button, modifiers, delay))
67 qtest_fail("window not shown", 2)
68 }
70 function mousePress(item, x, y, button, modifiers, delay) {
71 if (button === undefined)
72 button = Qt.LeftButton;
73 if (modifiers === undefined)
74 modifiers = Qt.NoModifier;
75 if (delay === undefined)
76 delay = -1;
77 if (x === undefined)
78 x = item.width / 2;
79 if (y === undefined)
80 y = item.height / 2;
81 if (!qtest_events.mousePress(item, x, y, button, modifiers, delay))
82 qtest_fail("window not shown", 2)
83 }
85 function mouseRelease(item, x, y, button, modifiers, delay) {
86 if (button === undefined)
87 button = Qt.LeftButton;
88 if (modifiers === undefined)
89 modifiers = Qt.NoModifier;
90 if (delay === undefined)
91 delay = -1;
92 if (x === undefined)
93 x = item.width / 2;
94 if (y === undefined)
95 y = item.height / 2;
96 if (!qtest_events.mouseRelease(item, x, y, button, modifiers, delay))
97 qtest_fail("window not shown", 2)
98 }
101 // Flickable won't recognise a single mouse move as dragging the flickable.
102 // Use 5 steps because it's what
103 // Qt uses in QQuickViewTestUtil::flick
104 // speed is in pixels/second
105 function mouseFlick(item, x, y, toX, toY, pressMouse, releaseMouse,
106 speed, iterations) {
107 pressMouse = ((pressMouse != null) ? pressMouse : true); // Default to true for pressMouse if not present
108 releaseMouse = ((releaseMouse != null) ? releaseMouse : true); // Default to true for releaseMouse if not present
110 // set a default speed if not specified
111 speed = (speed != null) ? speed : units.gu(10);
113 // set a default iterations if not specified
114 iterations = (iterations !== undefined) ? iterations : 5
116 var distance = Math.sqrt(Math.pow(toX - x, 2) + Math.pow(toY - y, 2))
117 var totalTime = (distance / speed) * 1000 /* converting speed to pixels/ms */
119 var timeStep = totalTime / iterations
120 var diffX = (toX - x) / iterations
121 var diffY = (toY - y) / iterations
122 if (pressMouse) {
123 fakeDateTime.currentTimeMs += timeStep
124 mousePress(item, x, y)
125 }
126 for (var i = 0; i < iterations; ++i) {
127 fakeDateTime.currentTimeMs += timeStep
128 if (i === iterations - 1) {
129 // Avoid any rounding errors by making the last move be at precisely
130 // the point specified
131 mouseMove(item, toX, toY, iterations / speed)
132 } else {
133 mouseMove(item, x + (i + 1) * diffX, y + (i + 1) * diffY, iterations / speed)
134 }
135 }
136 if (releaseMouse) {
137 fakeDateTime.currentTimeMs += timeStep
138 mouseRelease(item, toX, toY)
139 }
140 }
143 // Find an object with the given name in the children tree of "obj"
144 function findChild(obj, objectName) {
145 return findChildIn(obj, "children", objectName);
146 }
148 // Find an object with the given name in the children tree of "obj"
149 // Including invisible children like animations, timers etc.
150 // Note: you should use findChild if you're not sure you need this
151 // as this tree is much bigger and might contain stuff that goes
152 // away randomly.
153 function findInvisibleChild(obj, objectName) {
154 return findChildIn(obj, "data", objectName);
155 }
157 // Find a child in the named property
158 function findChildIn(obj, prop, objectName) {
159 var childs = new Array(0);
160 childs.push(obj)
161 while (childs.length > 0) {
162 if (childs[0].objectName == objectName) {
163 return childs[0]
164 }
165 for (var i in childs[0][prop]) {
166 childs.push(childs[0][prop][i])
167 }
168 childs.splice(0, 1);
169 }
170 return null;
171 }
173 // Type a full string instead of keyClick letter by letter
174 // TODO: this is not ugly, this is uber-ugly and does not support
175 // any special character. Remove the keyMap once keyClick(obj, char)
176 // has landed in upstream Qt.
177 function typeString(str) {
178 var keyMap = {
179 "a": Qt.Key_A,
180 "b": Qt.Key_B,
181 "c": Qt.Key_C,
182 "d": Qt.Key_D,
183 "e": Qt.Key_E,
184 "f": Qt.Key_F,
185 "g": Qt.Key_G,
186 "h": Qt.Key_H,
187 "i": Qt.Key_I,
188 "j": Qt.Key_J,
189 "k": Qt.Key_K,
190 "l": Qt.Key_L,
191 "m": Qt.Key_M,
192 "n": Qt.Key_N,
193 "o": Qt.Key_O,
194 "p": Qt.Key_P,
195 "q": Qt.Key_Q,
196 "r": Qt.Key_R,
197 "s": Qt.Key_S,
198 "t": Qt.Key_T,
199 "u": Qt.Key_U,
200 "v": Qt.Key_V,
201 "w": Qt.Key_W,
202 "x": Qt.Key_X,
203 "y": Qt.Key_Y,
204 "z": Qt.Key_Z,
205 "A": Qt.Key_A,
206 "B": Qt.Key_B,
207 "C": Qt.Key_C,
208 "D": Qt.Key_D,
209 "E": Qt.Key_E,
210 "F": Qt.Key_F,
211 "G": Qt.Key_G,
212 "H": Qt.Key_H,
213 "I": Qt.Key_I,
214 "J": Qt.Key_J,
215 "K": Qt.Key_K,
216 "L": Qt.Key_L,
217 "M": Qt.Key_M,
218 "N": Qt.Key_N,
219 "O": Qt.Key_O,
220 "P": Qt.Key_P,
221 "Q": Qt.Key_Q,
222 "R": Qt.Key_R,
223 "S": Qt.Key_S,
224 "T": Qt.Key_T,
225 "U": Qt.Key_U,
226 "V": Qt.Key_V,
227 "W": Qt.Key_W,
228 "X": Qt.Key_X,
229 "Y": Qt.Key_Y,
230 "Z": Qt.Key_Z,
231 "0": Qt.Key_0,
232 "1": Qt.Key_1,
233 "2": Qt.Key_2,
234 "3": Qt.Key_3,
235 "4": Qt.Key_4,
236 "5": Qt.Key_5,
237 "6": Qt.Key_6,
238 "7": Qt.Key_7,
239 "8": Qt.Key_8,
240 "9": Qt.Key_9,
241 " ": Qt.Key_Space,
242 }
243 for (var i = 0; i < str.length; i++) {
244 keyClick(keyMap[str[i]])
245 }
246 }
248 // Keeps executing a given parameter-less function until it returns the given
249 // expected result or the timemout is reached (in which case a test failure
250 // is generated)
251 function tryCompareFunction(func, expectedResult, timeout) {
252 var timeSpent = 0
253 if (timeout === undefined)
254 timeout = 5000;
255 var success = false
256 var actualResult
257 while (timeSpent < timeout && !success) {
258 actualResult = func()
259 success = qtest_compareInternal(actualResult, expectedResult)
260 if (success === false) {
261 wait(50)
262 timeSpent += 50
263 }
264 }
266 var act = qtest_results.stringify(actualResult)
267 var exp = qtest_results.stringify(expectedResult)
268 if (!qtest_results.compare(success,
269 "function returned unexpected result",
270 act, exp,
271 util.callerFile(), util.callerLine())) {
272 throw new Error("QtQuickTest::fail")
273 }
274 }
276 function touchEvent() {
277 return UT.Util.touchEvent()
278 }
280 // speed is in pixels/second
281 function touchFlick(item, x, y, toX, toY, beginTouch, endTouch, speed, iterations) {
282 // Make sure the item is rendered
283 waitForRendering(item);
285 var root = fetchRootItem(item);
286 var rootFrom = item.mapToItem(root, x, y);
287 var rootTo = item.mapToItem(root, toX, toY);
289 // Default to true for beginTouch if not present
290 beginTouch = (beginTouch !== undefined) ? beginTouch : true
292 // Default to true for endTouch if not present
293 endTouch = (endTouch !== undefined) ? endTouch : true
295 // Set a default speed if not specified
296 speed = (speed !== undefined) ? speed : units.gu(10)
298 // Set a default iterations if not specified
299 var iterations = (iterations !== undefined) ? iterations : 5
301 var distance = Math.sqrt(Math.pow(rootTo.x - rootFrom.x, 2) + Math.pow(rootTo.Y - rootFrom.y, 2))
302 var totalTime = (distance / speed) * 1000 /* converting speed to pixels/ms */
304 var timeStep = totalTime / iterations
305 var diffX = (rootTo.x - rootFrom.x) / iterations
306 var diffY = (rootTo.y - rootFrom.y) / iterations
307 if (beginTouch) {
308 fakeDateTime.currentTimeMs += timeStep
310 var event = touchEvent()
311 event.press(0 /* touchId */, rootFrom.x, rootFrom.y)
312 event.commit()
313 }
314 for (var i = 0; i < iterations; ++i) {
315 fakeDateTime.currentTimeMs += timeStep
316 if (i === iterations - 1) {
317 // Avoid any rounding errors by making the last move be at precisely
318 // the point specified
319 wait(iterations / speed)
320 var event = touchEvent()
321 event.move(0 /* touchId */, rootTo.x, rootTo.y)
322 event.commit()
323 } else {
324 wait(iterations / speed)
325 var event = touchEvent()
326 event.move(0 /* touchId */, rootFrom.x + (i + 1) * diffX, rootFrom.y + (i + 1) * diffY)
327 event.commit()
328 }
329 }
330 if (endTouch) {
331 fakeDateTime.currentTimeMs += timeStep
332 var event = touchEvent()
333 event.release(0 /* touchId */, rootTo.x, rootTo.y)
334 event.commit()
335 }
336 }
338 function touchPinch(item, x1Start, y1Start, x1End, y1End, x2Start, y2Start, x2End, y2End) {
339 // Make sure the item is rendered
340 waitForRendering(item);
342 var event1 = touchEvent();
343 // first finger
344 event1.press(0, x1Start, y1Start);
345 event1.commit();
346 // second finger
347 event1.stationary(0);
348 event1.press(1, x2Start, y2Start);
349 event1.commit();
351 // pinch
352 for (var i = 0.0; i < 1.0; i += 0.02) {
353 event1.move(0, x1Start + (x1End - x1Start) * i, y1Start + (y1End - y1Start) * i);
354 event1.move(1, x2Start + (x2End - x2Start) * i, y2Start + (y2End - y2Start) * i);
355 event1.commit();
356 }
358 // release
359 event1.release(0, x1End, y1End);
360 event1.release(1, x2End, y2End);
361 event1.commit();
362 }
364 function fetchRootItem(item) {
365 if (item.parent)
366 return fetchRootItem(item.parent)
367 else
368 return item
369 }
371 function touchPress(item, x, y) {
372 var root = fetchRootItem(item)
373 var rootPoint = item.mapToItem(root, x, y)
375 var event = touchEvent()
376 event.press(0 /* touchId */, rootPoint.x, rootPoint.y)
377 event.commit()
378 }
380 function touchRelease(item, x, y) {
381 var root = fetchRootItem(item)
382 var rootPoint = item.mapToItem(root, x, y)
384 var event = touchEvent()
385 event.release(0 /* touchId */, rootPoint.x, rootPoint.y)
386 event.commit()
387 }
389 /*! \brief Tap the item with a touch event.
391 \param item The item to be tapped
392 \param x The x coordinate of the tap, defaults to horizontal center
393 \param y The y coordinate of the tap, defaults to vertical center
394 */
395 function tap(item, x, y) {
396 if (typeof x !== "number") x = item.width / 2;
397 if (typeof y !== "number") y = item.height / 2;
399 var root = fetchRootItem(item)
400 var rootPoint = item.mapToItem(root, x, y)
402 var event = touchEvent()
403 event.press(0 /* touchId */, rootPoint.x, rootPoint.y)
404 event.commit()
406 event = touchEvent()
407 event.release(0 /* touchId */, rootPoint.x, rootPoint.y)
408 event.commit()
409 }
411 Component.onCompleted: {
412 UT.Util.ensureTouchRegistryInstalled();
414 var rootItem = parent;
415 while (rootItem.parent != undefined) {
416 rootItem = rootItem.parent;
417 }
418 removeTimeConstraintsFromDirectionalDragAreas(rootItem);
419 }
421 /*
422 In qmltests, sequences of touch events are sent all at once, unlike in "real life".
423 Also qmltests might run really slowly, e.g. when run from inside virtual machines.
424 Thus to remove a variable that qmltests cannot really control, namely time, this
425 function removes all constraints from DirectionalDragAreas that are sensible to
426 elapsed time.
428 This effectively makes DirectionalDragAreas easier to fool.
429 */
430 function removeTimeConstraintsFromDirectionalDragAreas(item) {
432 // use duck-typing to identify a DirectionalDragArea
433 if (item.minSpeed != undefined
434 && item.maxSilenceTime != undefined
435 && item.compositionTime != undefined) {
436 item.minSpeed = 0;
437 item.maxSilenceTime = 60 * 60 * 1000;
438 item.compositionTime = 0;
439 } else {
440 for (var i in item.children) {
441 removeTimeConstraintsFromDirectionalDragAreas(item.children[i]);
442 }
443 }
444 }
446 // TODO This function can be removed altogether once we use Qt 5.5 which has the same feature
447 function waitForRendering(item, timeout) {
448 if (timeout === undefined)
449 timeout = 5000;
450 if (!item)
451 qtest_fail("No item given to waitForRendering", 1);
452 return qtest_results.waitForRendering(item, timeout);
453 }