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
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
|
# This work is licensed under the GNU GPLv2 or later.
# See the COPYING file in the top-level directory.
import os
import re
import time
import signal
import subprocess
import sys
import unittest
from gi.repository import Gio
from gi.repository import Gdk
import pyatspi
import dogtail.utils
from virtinst import log
import tests
if not dogtail.utils.isA11yEnabled():
print("Enabling gsettings accessibility")
dogtail.utils.enableA11y()
# This will trigger an error if accessibility isn't enabled
import dogtail.tree # pylint: disable=wrong-import-order,ungrouped-imports
class UITestCase(unittest.TestCase):
"""
Common testcase bits shared for ui tests
"""
def setUp(self):
self.app = VMMDogtailApp(tests.utils.URIs.test_full)
def tearDown(self):
self.app.stop()
_default_vmname = "test-many-devices"
# Helpers to save testfile imports
@staticmethod
def sleep(*args, **kwargs):
return time.sleep(*args, **kwargs)
@staticmethod
def pressKey(*args, **kwargs):
return dogtail.rawinput.pressKey(*args, **kwargs)
def holdKey(self, keyName):
# From dogtail 9.9.0 which isn't widely distributed yet
code = dogtail.rawinput.keyNameToKeyCode(keyName)
pyatspi.Registry().generateKeyboardEvent(
code, None, pyatspi.KEY_PRESS)
def releaseKey(self, keyName):
# From dogtail 9.9.0 which isn't widely distributed yet
code = dogtail.rawinput.keyNameToKeyCode(keyName)
pyatspi.Registry().generateKeyboardEvent(
code, None, pyatspi.KEY_RELEASE)
def point(self, x, y):
# From dogtail 9.9.0 which isn't widely distributed yet
pyatspi.Registry().generateMouseEvent(x, y, 'abs')
#################################
# virt-manager specific helpers #
#################################
def _open_host_window(self, tab, conn_label="test testdriver.xml"):
"""
Helper to open host connection window and switch to a tab
"""
self.app.root.find_fuzzy(conn_label, "table cell").click()
self.app.root.find_fuzzy("Edit", "menu").click()
self.app.root.find_fuzzy("Connection Details", "menu item").click()
win = self.app.root.find_fuzzy(
"%s Connection Details" % conn_label, "frame")
win.find_fuzzy(tab, "page tab").click()
return win
def _open_details_window(self, vmname=None, shutdown=False,
double=False):
if vmname is None:
vmname = self._default_vmname
if double:
self.app.root.find_fuzzy(vmname, "table cell").doubleClick()
else:
self.app.root.find_fuzzy(vmname, "table cell").click(button=3)
self.app.root.find("Open", "menu item").click()
win = self.app.root.find("%s on" % vmname, "frame")
win.find("Details", "radio button").click()
if shutdown:
win.find("Shut Down", "push button").click()
run = win.find("Run", "push button")
check_in_loop(lambda: run.sensitive)
return win
def _walkUIList(self, win, lst, error_cb, reverse=False):
"""
Toggle down through a UI list like addhardware, net/storage/iface
lists, and ensure an error isn't raised.
"""
# Walk the lst UI and find all labelled table cells, these are
# the actual list entries
all_cells = lst.findChildren(lambda w: w.roleName == "table cell")
if reverse:
all_cells.reverse()
all_cells[0].click()
cells_per_selection = len([c for c in all_cells if c.focused])
idx = 0
while idx < len(all_cells):
cell = all_cells[idx]
if not cell.state_selected:
# Could be a separator table cell. Try to figure it out
if not any([c.name for c in
all_cells[idx:(idx + cells_per_selection)]]):
idx += cells_per_selection
continue
self.assertTrue(cell.state_selected)
dogtail.rawinput.pressKey(reverse and "Up" or "Down")
if not win.active:
# Should mean an error dialog popped up
self.app.root.find("Error", "alert")
raise AssertionError("Error dialog raised?")
if error_cb():
raise AssertionError("Error found on a page")
idx += cells_per_selection
if idx >= len(all_cells):
# Last cell, selection shouldn't have changed
self.assertTrue(cell.state_selected)
else:
self.assertTrue(not cell.state_selected)
def _test_xmleditor_interactions(self, win, finish):
"""
Helper to test some common XML editor interactions
"""
# Click the tab, make a bogus XML edit
win.find("XML", "page tab").click()
xmleditor = win.find("XML editor")
xmleditor.text = xmleditor.text.replace("<", "<FOO", 1)
# Trying to click away should warn that there's unapplied changes
win.find("Details", "page tab").click()
alert = self.app.root.find("vmm dialog")
alert.find_fuzzy("changes will be lost")
# Select 'No', meaning don't abandon changes
alert.find("No", "push button").click()
check_in_loop(lambda: xmleditor.showing)
# Click the finish button, but our bogus change should trigger error
finish.click()
alert = self.app.root.find("vmm dialog")
alert.find_fuzzy("(xmlParseDoc|tag.mismatch)")
alert.find("Close", "push button").click()
# Try unapplied changes again, this time abandon our changes
win.find("Details", "page tab").click()
alert = self.app.root.find("vmm dialog")
alert.find("Yes", "push button").click()
check_in_loop(lambda: not xmleditor.showing)
class _FuzzyPredicate(dogtail.predicate.Predicate):
"""
Object dogtail/pyatspi want for node searching.
"""
def __init__(self, name=None, roleName=None, labeller_text=None):
"""
:param name: Match node.name or node.labeller.text if
labeller_text not specified
:param roleName: Match node.roleName
:param labeller_text: Match node.labeller.text
"""
self._name = name
self._roleName = roleName
self._labeller_text = labeller_text
self._name_pattern = None
self._role_pattern = None
self._labeller_pattern = None
if self._name:
self._name_pattern = re.compile(self._name, re.DOTALL)
if self._roleName:
self._role_pattern = re.compile(self._roleName, re.DOTALL)
if self._labeller_text:
self._labeller_pattern = re.compile(self._labeller_text, re.DOTALL)
def makeScriptMethodCall(self, isRecursive):
ignore = isRecursive
return
def makeScriptVariableName(self):
return
def describeSearchResult(self, node=None):
if not node:
return ""
return node.node_string()
def satisfiedByNode(self, node):
"""
The actual search routine
"""
try:
if self._roleName and not self._role_pattern.match(node.roleName):
return
labeller = ""
if node.labeller:
labeller = node.labeller.text
if (self._name and
not self._name_pattern.match(node.name) and
not self._name_pattern.match(labeller)):
return
if (self._labeller_text and
not self._labeller_pattern.match(labeller)):
return
return True
except Exception as e:
log.debug(
"got predicate exception name=%s role=%s labeller=%s: %s",
self._name, self._roleName, self._labeller_text, e)
def check_in_loop(func, timeout=2):
"""
Run the passed func in a loop every .1 seconds until timeout is hit or
the func returns True.
"""
start_time = time.time()
interval = 0.1
while True:
if func() is True:
return
if (time.time() - start_time) > timeout:
raise RuntimeError("Loop condition wasn't met")
time.sleep(interval)
def drag(win, x, y):
"""
Drag a window to the x/y coordinates
"""
win.click()
clickX = win.position[0] + win.size[0] / 2
clickY = win.position[1] + 10
dogtail.rawinput.drag((clickX, clickY), (x, y))
class VMMDogtailNode(dogtail.tree.Node):
"""
Our extensions to the dogtail node wrapper class.
"""
# The class hackery means pylint can't figure this class out
# pylint: disable=no-member
@property
def active(self):
"""
If the window is the raised and active window or not
"""
return self.getState().contains(pyatspi.STATE_ACTIVE)
@property
def state_selected(self):
return self.getState().contains(pyatspi.STATE_SELECTED)
@property
def onscreen(self):
# We need to check that full widget is on screen because we use this
# function to check whether we can click a widget. We may click
# anywhere within the widget and clicks outside the screen bounds are
# silently ignored.
if self.roleName in ["menu", "menu item", "frame"]:
return True
screen = Gdk.Screen.get_default()
return (self.position[0] > 0 and
self.position[0] + self.size[0] < screen.get_width() and
self.position[1] > 0 and
self.position[1] + self.size[1] < screen.get_height())
def click_secondary_icon(self):
"""
Helper for clicking the secondary icon of a text entry
"""
button = 1
clickX = self.position[0] + self.size[0] - 10
clickY = self.position[1] + (self.size[1] / 2)
dogtail.rawinput.click(clickX, clickY, button)
def click_combo_entry(self):
"""
Helper for clicking the arrow of a combo entry, to expose the menu.
Clicks middle of Y axis, but 1/10th of the height from the right side.
Using a small, hardcoded offset may not work on some themes (e.g. when
running virt-manager on KDE)
"""
button = 1
clickX = self.position[0] + self.size[0] - self.size[1] / 4
clickY = self.position[1] + self.size[1] / 2
dogtail.rawinput.click(clickX, clickY, button)
def click_expander(self):
"""
Helper for clicking expander, hitting the text part to actually
open it. Basically clicks top left corner with some indent
"""
button = 1
clickX = self.position[0] + 10
clickY = self.position[1] + 5
dogtail.rawinput.click(clickX, clickY, button)
def click(self, *args, **kwargs):
"""
click wrapper, give up to a second for widget to appear on
screen, helps reduce some test flakiness
"""
# pylint: disable=arguments-differ,signature-differs
check_in_loop(lambda: self.onscreen)
dogtail.tree.Node.click(self, *args, **kwargs)
def bring_on_screen(self, key_name="Down", max_tries=100):
"""
Attempts to bring the item to screen by repeatedly clicking the given
key. Raises exception if max_tries attempts are exceeded.
"""
cur_try = 0
while not self.onscreen:
dogtail.rawinput.pressKey(key_name)
cur_try += 1
if cur_try > max_tries:
raise RuntimeError("Could not bring widget on screen")
return self
#########################
# Widget search helpers #
#########################
def find(self, name, roleName=None, labeller_text=None, check_active=True):
"""
Search root for any widget that contains the passed name/role regex
strings.
"""
pred = _FuzzyPredicate(name, roleName, labeller_text)
try:
ret = self.findChild(pred)
except dogtail.tree.SearchError:
raise dogtail.tree.SearchError("Didn't find widget with name='%s' "
"roleName='%s' labeller_text='%s'" %
(name, roleName, labeller_text)) from None
# Wait for independent windows to become active in the window manager
# before we return them. This ensures the window is actually onscreen
# so it sidesteps a lot of race conditions
if ret.roleName in ["frame", "dialog", "alert"] and check_active:
check_in_loop(lambda: ret.active)
return ret
def find_fuzzy(self, name, roleName=None, labeller_text=None):
"""
Search root for any widget that contains the passed name/role strings.
"""
name_pattern = None
role_pattern = None
labeller_pattern = None
if name:
name_pattern = ".*%s.*" % name
if roleName:
role_pattern = ".*%s.*" % roleName
if labeller_text:
labeller_pattern = ".*%s.*" % labeller_text
return self.find(name_pattern, role_pattern, labeller_pattern)
#####################
# Debugging helpers #
#####################
def node_string(self):
msg = "name='%s' roleName='%s'" % (self.name, self.roleName)
if self.labeller:
msg += " labeller.text='%s'" % self.labeller.text
return msg
def fmt_nodes(self):
strs = []
def _walk(node):
try:
strs.append(node.node_string())
except Exception as e:
strs.append("got exception: %s" % e)
self.findChildren(_walk, isLambda=True)
return "\n".join(strs)
def print_nodes(self):
"""
Helper to print the entire node tree for the passed root. Useful
if to figure out the roleName for the object you are looking for
"""
print(self.fmt_nodes())
# This is the same hack dogtail uses to extend the Accessible class.
_bases = list(pyatspi.Accessibility.Accessible.__bases__)
_bases.insert(_bases.index(dogtail.tree.Node), VMMDogtailNode)
_bases.remove(dogtail.tree.Node)
pyatspi.Accessibility.Accessible.__bases__ = tuple(_bases)
class VMMDogtailApp(object):
"""
Wrapper class to simplify dogtail app handling
"""
def __init__(self, uri):
self._proc = None
self._root = None
self._topwin = None
self.uri = uri
@property
def root(self):
if self._root is None:
self.open()
return self._root
@property
def topwin(self):
if self._topwin is None:
self.open()
return self._topwin
def error_if_already_running(self):
# Ensure virt-manager isn't already running
dbus = Gio.DBusProxy.new_sync(
Gio.bus_get_sync(Gio.BusType.SESSION, None), 0, None,
"org.freedesktop.DBus", "/org/freedesktop/DBus",
"org.freedesktop.DBus", None)
if "org.virt-manager.virt-manager" in dbus.ListNames():
raise RuntimeError("virt-manager is already running. "
"Close it before running this test suite.")
def is_running(self):
return bool(self._proc and self._proc.poll() is None)
def open(self, extra_opts=None, check_already_running=True, use_uri=True,
window_name=None, xmleditor_enabled=False):
extra_opts = extra_opts or []
if tests.utils.clistate.debug:
stdout = sys.stdout
stderr = sys.stderr
extra_opts.append("--debug")
else:
stdout = open(os.devnull)
stderr = open(os.devnull)
cmd = [sys.executable]
cmd += [os.path.join(os.getcwd(), "virt-manager"),
"--test-first-run",
"--no-fork"]
if use_uri:
cmd += ["--connect", self.uri]
if xmleditor_enabled:
cmd += ["--test-options=xmleditor-enabled"]
cmd += extra_opts
if check_already_running:
self.error_if_already_running()
self._proc = subprocess.Popen(cmd, stdout=stdout, stderr=stderr)
self._root = dogtail.tree.root.application("virt-manager")
self._topwin = self._root.find(window_name, "(frame|dialog|alert)")
def stop(self):
"""
Try graceful process shutdown, then kill it
"""
if not self._proc:
return
try:
self._proc.send_signal(signal.SIGINT)
except Exception:
log.debug("Error terminating process", exc_info=True)
self._proc = None
return
# Wait for shutdown for 1 second, with 20 checks
for ignore in range(20):
time.sleep(.05)
if self._proc.poll() is not None:
self._proc = None
return
log.warning("App didn't exit gracefully from SIGINT. Killing...")
try:
self._proc.kill()
finally:
time.sleep(1)
self._proc = None
|