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
|
'''GNOME settings daemon test base class'''
__author__ = 'Martin Pitt <martin.pitt@ubuntu.com>'
__copyright__ = '(C) 2013 Canonical Ltd.'
__license__ = 'GPL v2 or later'
import subprocess
import time
import os
import os.path
import tempfile
import fcntl
import shutil
import sys
from glob import glob
from gi.repository import GLib
try:
import dbusmock
except ImportError:
sys.stderr.write('You need python-dbusmock (http://pypi.python.org/pypi/python-dbusmock) for this test suite.\n')
sys.exit(1)
try:
from gi.repository import Gio
except ImportError:
sys.stderr.write('You need pygobject and the Gio GIR for this test suite.\n')
sys.exit(0)
if subprocess.call(['which', 'gnome-session'], stdout=subprocess.PIPE) != 0:
sys.stderr.write('You need gnome-session for this test suite.\n')
sys.exit(0)
top_builddir = os.environ.get('TOP_BUILDDIR',
os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
def set_nonblock(fd):
'''Set a file object to non-blocking'''
flags = fcntl.fcntl(fd, fcntl.F_GETFL)
fcntl.fcntl(fd, fcntl.F_SETFL, flags | os.O_NONBLOCK)
class GSDTestCase(dbusmock.DBusTestCase):
'''Base class for settings daemon tests
This redirects the XDG directories to temporary directories, and runs local
session and system D-BUSes with a minimal GNOME session and a mock
notification daemon. It also provides common functionality for plugin
tests.
'''
@classmethod
def setUpClass(klass):
os.environ['GIO_USE_VFS'] = 'local'
os.environ['GVFS_DISABLE_FUSE'] = '1'
# we do some string checks, disable translations
os.environ['LC_MESSAGES'] = 'C'
klass.workdir = tempfile.mkdtemp(prefix='gsd-plugin-test')
klass.start_xorg()
# tell dconf and friends to use our config/runtime directories
os.environ['XDG_CONFIG_HOME'] = os.path.join(klass.workdir, 'config')
os.environ['XDG_DATA_HOME'] = os.path.join(klass.workdir, 'data')
os.environ['XDG_RUNTIME_DIR'] = os.path.join(klass.workdir, 'runtime')
# work around https://bugzilla.gnome.org/show_bug.cgi?id=689136
os.makedirs(os.path.join(os.environ['XDG_CONFIG_HOME'], 'dconf'))
os.makedirs(os.environ['XDG_RUNTIME_DIR'], mode=0o700)
klass.start_system_bus()
klass.start_session_bus()
klass.system_bus_con = klass.get_dbus(True)
klass.session_bus_con = klass.get_dbus(False)
# we never want to cause notifications on the actual GUI
klass.p_notify = klass.spawn_server_template(
'notification_daemon', {}, stdout=subprocess.PIPE)[0]
set_nonblock(klass.p_notify.stdout)
klass.start_session()
klass.start_monitor()
klass.settings_session = Gio.Settings('org.gnome.desktop.session')
@classmethod
def tearDownClass(klass):
klass.p_notify.terminate()
klass.p_notify.wait()
klass.stop_monitor()
dbusmock.DBusTestCase.tearDownClass()
klass.stop_xorg()
shutil.rmtree(klass.workdir)
def run(self, result=None):
'''Show log files on failed tests
If the environment variable $SHELL_ON_FAIL is set, this runs bash in
the work directory; exit the shell to continue the tests. Otherwise it
shows all log files.
'''
if result:
orig_err_fail = len(result.errors) + len(result.failures)
super(GSDTestCase, self).run(result)
if result and len(result.errors) + len(result.failures) > orig_err_fail:
if 'SHELL_ON_FAIL' in os.environ:
subprocess.call(['bash', '-i'], cwd=self.workdir)
else:
for log_file in glob(os.path.join(self.workdir, '*.log')):
with open(log_file) as f:
print('\n----- %s -----\n%s\n------\n'
% (log_file, f.read()))
@classmethod
def start_session(klass):
'''Start minimal GNOME session'''
# create dummy session type and component
d = os.path.join(klass.workdir, 'config', 'gnome-session', 'sessions')
if not os.path.isdir(d):
os.makedirs(d)
shutil.copy(os.path.join(os.path.dirname(__file__), 'dummy.session'), d)
d = os.path.join(klass.workdir, 'data', 'applications')
if not os.path.isdir(d):
os.makedirs(d)
shutil.copy(os.path.join(os.path.dirname(__file__), 'dummyapp.desktop'), d)
@classmethod
def start_monitor(klass):
'''Start dbus-monitor'''
# You can rename the log file to *.log if you want to see it on test
# case failures
klass.monitor_log = open(os.path.join(klass.workdir, 'dbus-monitor.out'), 'wb')
klass.monitor = subprocess.Popen(['dbus-monitor', '--monitor'],
stdout=klass.monitor_log,
stderr=subprocess.STDOUT)
@classmethod
def stop_monitor(klass):
'''Stop dbus-monitor'''
assert klass.monitor
klass.monitor.terminate()
klass.monitor.wait()
klass.monitor_log.flush()
klass.monitor_log.close()
def start_logind(self, parameters=None):
'''start mock logind'''
self.logind, self.logind_obj = self.spawn_server_template('logind',
parameters or {},
stdout=subprocess.PIPE)
# set log to nonblocking
set_nonblock(self.logind.stdout)
def stop_logind(self):
'''stop mock logind'''
self.logind.terminate()
self.logind.wait()
def start_mutter(klass):
''' start mutter '''
klass.mutter_log = open(os.path.join(klass.workdir, 'mutter.log'), 'wb')
# See https://gitlab.gnome.org/GNOME/mutter/merge_requests/15
os.environ['XDG_SESSION_TYPE'] = 'x11'
klass.mutter = subprocess.Popen(['mutter', '--x11'],
stdout=klass.mutter_log,
stderr=subprocess.STDOUT)
def stop_mutter(klass):
'''stop mutter'''
assert klass.monitor
klass.mutter.terminate()
klass.mutter.wait()
klass.mutter_log.flush()
klass.mutter_log.close()
# Return the display num, -1 on hard failure, 0 on failure but to try again
@staticmethod
def launch_xorg_with_display_num(klass, xorg, display_num):
xorg_log_write = open(os.path.join(klass.workdir, 'xorg.log'), 'wb')
# Composite extension won't load unless at least 24bpp is set
klass.xorg = subprocess.Popen([xorg, ':%d' % display_num, "-screen", "0", "1280x1024x24", "+extension", "GLX"],
stdout=xorg_log_write, stderr=subprocess.STDOUT)
os.environ['DISPLAY'] = ':%d' % display_num
# wait until the server is ready
timeout = 50
while timeout > 0:
time.sleep(0.1)
timeout -= 1
if klass.xorg.poll():
# ended prematurely
try:
log = xorg_log_write.read()
except IOError:
return -1
if log and (b'Server is already active for display'):
return 0
return -1
if subprocess.call(['xprop', '-root'], stdout=subprocess.PIPE,
stderr=subprocess.PIPE) == 0:
break
if timeout <= 0:
sys.stderr.write('Cannot start Xvfb.\n--------')
return -1
return display_num
@staticmethod
def launch_xorg(klass, xorg):
display_num = 99
while os.path.isfile('/tmp/.X%d-lock' % display_num) and display_num >= 0:
display_num = display_num - 1
if display_num == 0:
return 0
ret = klass.launch_xorg_with_display_num(klass, xorg, display_num)
while ret == 0:
display_num = display_num - 1
ret = klass.launch_xorg_with_display_num(klass, xorg, display_num)
if ret == -1:
sys.stderr.write('Cannot start Xvfb.\n--------')
return 0
return display_num
@classmethod
def start_xorg(klass):
'''start Xvfb server'''
xorg = GLib.find_program_in_path ('Xvfb')
if not xorg:
sys.stderr.write('Cannot start X.org, Xvfb binary not found\n')
sys.exit(1)
display_num = klass.launch_xorg(klass, xorg)
if display_num == 0:
sys.stderr.write('Cannot start X.org, /tmp/.X*-lock all used\n')
sys.exit(1)
@classmethod
def stop_xorg(klass):
'''stop X.org server with dummy driver'''
klass.xorg.terminate()
klass.xorg.wait()
@classmethod
def reset_idle_timer(klass):
'''trigger activity to reset idle timer'''
subprocess.check_call([os.path.join(top_builddir, 'tests', 'shiftkey')])
|
