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
|
# Test apport_python_hook.py
#
# Copyright (c) 2006 - 2011 Canonical Ltd.
# Authors: Robert Collins <robert@ubuntu.com>
# Martin Pitt <martin.pitt@ubuntu.com>
#
# 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; either version 2 of the License, or (at your
# option) any later version. See http://www.gnu.org/copyleft/gpl.html for
# the full text of the license.
import unittest, tempfile, subprocess, os, stat, shutil, atexit
import dbus
temp_report_dir = tempfile.mkdtemp()
os.environ['APPORT_REPORT_DIR'] = temp_report_dir
atexit.register(shutil.rmtree, temp_report_dir)
import apport.fileutils, problem_report
class T(unittest.TestCase):
def tearDown(self):
for f in apport.fileutils.get_all_reports():
os.unlink(f)
def _test_crash(self, extracode='', scriptname=None):
'''Create a test crash.'''
# put the script into /var/tmp, since that isn't ignored in the
# hook
if scriptname:
script = scriptname
fd = os.open(scriptname, os.O_CREAT | os.O_WRONLY)
else:
(fd, script) = tempfile.mkstemp(dir='/var/tmp')
try:
os.write(fd, ('''#!/usr/bin/env %s
import apport_python_hook
apport_python_hook.install()
def func(x):
raise Exception(b'This should happen. \\xe2\\x99\\xa5'.decode('UTF-8'))
%s
func(42)
''' % (os.getenv('PYTHON', 'python3'), extracode)).encode())
os.close(fd)
os.chmod(script, 0o755)
env = os.environ.copy()
env['PYTHONPATH'] = '/my/bogus/path'
p = subprocess.Popen([script, 'testarg1', 'testarg2'],
stderr=subprocess.PIPE, env=env)
err = p.communicate()[1].decode()
self.assertEqual(p.returncode, 1,
'crashing test python program exits with failure code')
if not extracode:
self.assertTrue('This should happen.' in err, err)
self.assertFalse('OSError' in err, err)
finally:
os.unlink(script)
return script
def test_general(self):
'''general operation of the Python crash hook.'''
script = self._test_crash()
# did we get a report?
reports = apport.fileutils.get_new_reports()
pr = None
self.assertEqual(len(reports), 1, 'crashed Python program produced a report')
self.assertEqual(stat.S_IMODE(os.stat(reports[0]).st_mode),
0o640, 'report has correct permissions')
pr = problem_report.ProblemReport()
with open(reports[0], 'rb') as f:
pr.load(f)
# check report contents
expected_keys = ['InterpreterPath', 'PythonArgs', 'Traceback',
'ProblemType', 'ProcEnviron', 'ProcStatus',
'ProcCmdline', 'Date', 'ExecutablePath', 'ProcMaps',
'UserGroups']
self.assertTrue(set(expected_keys).issubset(set(pr.keys())),
'report has necessary fields')
self.assertTrue('bin/python' in pr['InterpreterPath'])
self.assertEqual(pr['ExecutablePath'], script)
self.assertEqual(pr['PythonArgs'], "['%s', 'testarg1', 'testarg2']" % script)
self.assertTrue(pr['Traceback'].startswith('Traceback'))
self.assertTrue("func\n raise Exception(b'This should happen." in
pr['Traceback'], pr['Traceback'])
def test_existing(self):
'''Python crash hook overwrites seen existing files.'''
script = self._test_crash()
# did we get a report?
reports = apport.fileutils.get_new_reports()
self.assertEqual(len(reports), 1, 'crashed Python program produced a report')
self.assertEqual(stat.S_IMODE(os.stat(reports[0]).st_mode),
0o640, 'report has correct permissions')
# touch report -> "seen" case
apport.fileutils.mark_report_seen(reports[0])
reports = apport.fileutils.get_new_reports()
self.assertEqual(len(reports), 0)
script = self._test_crash(scriptname=script)
reports = apport.fileutils.get_new_reports()
self.assertEqual(len(reports), 1)
# "unseen" case
script = self._test_crash(scriptname=script)
reports = apport.fileutils.get_new_reports()
self.assertEqual(len(reports), 1)
def test_no_argv(self):
'''with zapped sys.argv.'''
self._test_crash('import sys\nsys.argv = None')
# did we get a report?
reports = apport.fileutils.get_new_reports()
pr = None
self.assertEqual(len(reports), 1, 'crashed Python program produced a report')
self.assertEqual(stat.S_IMODE(os.stat(reports[0]).st_mode),
0o640, 'report has correct permissions')
pr = problem_report.ProblemReport()
with open(reports[0], 'rb') as f:
pr.load(f)
# check report contents
expected_keys = ['InterpreterPath', 'Traceback', 'ProblemType',
'ProcEnviron', 'ProcStatus', 'ProcCmdline', 'Date',
'ExecutablePath', 'ProcMaps', 'UserGroups']
self.assertTrue(set(expected_keys).issubset(set(pr.keys())),
'report has necessary fields')
self.assertTrue('bin/python' in pr['InterpreterPath'])
self.assertTrue(pr['Traceback'].startswith('Traceback'))
def test_python_env(self):
'''Python environmental variables appear in report'''
self._test_crash()
# did we get a report?
reports = apport.fileutils.get_new_reports()
pr = None
self.assertEqual(len(reports), 1, 'crashed Python program produced a report')
pr = problem_report.ProblemReport()
with open(reports[0], 'rb') as f:
pr.load(f)
# check report contents
self.assertTrue('PYTHONPATH' in pr['ProcEnviron'],
'report contains PYTHONPATH')
self.assertTrue('/my/bogus/path' in pr['ProcEnviron'],
pr['ProcEnviron'])
def _assert_no_reports(self):
'''Assert that there are no crash reports.'''
reports = apport.fileutils.get_new_reports()
self.assertEqual(len(reports), 0,
'no crash reports present (cwd: %s)' % os.getcwd())
def test_interactive(self):
'''interactive Python sessions never generate a report.'''
orig_cwd = os.getcwd()
try:
for d in ('/tmp', '/usr/local', '/usr'):
os.chdir(d)
p = subprocess.Popen(['python'], stdin=subprocess.PIPE,
stdout=subprocess.PIPE, stderr=subprocess.PIPE)
(out, err) = p.communicate(b'raise ValueError')
out = out.decode()
err = err.decode()
assert p.returncode != 0
assert out == ''
assert 'ValueError' in err
self._assert_no_reports()
finally:
os.chdir(orig_cwd)
def test_ignoring(self):
'''the Python crash hook respects the ignore list.'''
# put the script into /var/crash, since that isn't ignored in the
# hook
(fd, script) = tempfile.mkstemp(dir=apport.fileutils.report_dir)
ifpath = os.path.expanduser(apport.report._ignore_file)
orig_ignore_file = None
try:
os.write(fd, ('''#!/usr/bin/env %s
import apport_python_hook
apport_python_hook.install()
def func(x):
raise Exception('This should happen.')
func(42)
''' % os.getenv('PYTHON', 'python3')).encode('ascii'))
os.close(fd)
os.chmod(script, 0o755)
# move aside current ignore file
if os.path.exists(ifpath):
orig_ignore_file = ifpath + '.apporttest'
os.rename(ifpath, orig_ignore_file)
# ignore
r = apport.report.Report()
r['ExecutablePath'] = script
r.mark_ignore()
r = None
p = subprocess.Popen([script, 'testarg1', 'testarg2'],
stdout=subprocess.PIPE, stderr=subprocess.PIPE)
err = p.communicate()[1].decode()
self.assertEqual(p.returncode, 1,
'crashing test python program exits with failure code')
self.assertTrue('Exception: This should happen.' in err, err)
finally:
os.unlink(script)
# clean up our ignore file
if os.path.exists(ifpath):
os.unlink(ifpath)
if orig_ignore_file:
os.rename(orig_ignore_file, ifpath)
# did we get a report?
reports = apport.fileutils.get_new_reports()
self.assertEqual(len(reports), 0)
def test_no_flooding(self):
'''limit successive reports'''
count = 0
limit = 5
while count < limit:
self._test_crash(scriptname='/var/tmp/pytestcrash')
reports = apport.fileutils.get_new_reports()
if not reports:
break
self.assertEqual(len(reports), 1, 'crashed Python program produced one report')
apport.fileutils.mark_report_seen(reports[0])
count += 1
self.assertGreater(count, 1)
self.assertLess(count, limit)
def test_dbus_service_unknown_invalid(self):
'''DBus.Error.ServiceUnknown with an invalid name'''
self._test_crash(extracode='''import dbus
obj = dbus.SessionBus().get_object('com.example.NotExisting', '/Foo')
''')
pr = self._load_report()
self.assertTrue(pr['Traceback'].startswith('Traceback'), pr['Traceback'])
self.assertTrue('org.freedesktop.DBus.Error.ServiceUnknown' in pr['Traceback'], pr['Traceback'])
self.assertEqual(pr['DbusErrorAnalysis'], 'no service file providing com.example.NotExisting')
def test_dbus_service_unknown_wrongbus_notrunning(self):
'''DBus.Error.ServiceUnknown with a valid name on a different bus (not running)'''
subprocess.call(['killall', 'gvfsd-metadata'])
self._test_crash(extracode='''import dbus
obj = dbus.SystemBus().get_object('org.gtk.vfs.Metadata', '/org/gtk/vfs/metadata')
''')
pr = self._load_report()
self.assertTrue('org.freedesktop.DBus.Error.ServiceUnknown' in pr['Traceback'], pr['Traceback'])
self.assertTrue(pr['DbusErrorAnalysis'].startswith('provided by /usr/share/dbus-1/services/gvfs-metadata.service'),
pr['DbusErrorAnalysis'])
self.assertTrue('gvfsd-metadata is not running' in pr['DbusErrorAnalysis'], pr['DbusErrorAnalysis'])
def test_dbus_service_unknown_wrongbus_running(self):
'''DBus.Error.ServiceUnknown with a valid name on a different bus (running)'''
self._test_crash(extracode='''import dbus
# let the service be activated, to ensure it is running
obj = dbus.SessionBus().get_object('org.gtk.vfs.Metadata', '/org/gtk/vfs/metadata')
assert obj
obj = dbus.SystemBus().get_object('org.gtk.vfs.Metadata', '/org/gtk/vfs/metadata')
''')
pr = self._load_report()
self.assertTrue('org.freedesktop.DBus.Error.ServiceUnknown' in pr['Traceback'], pr['Traceback'])
self.assertTrue(pr['DbusErrorAnalysis'].startswith('provided by /usr/share/dbus-1/services/gvfs-metadata.service'),
pr['DbusErrorAnalysis'])
self.assertTrue('gvfsd-metadata is running' in pr['DbusErrorAnalysis'], pr['DbusErrorAnalysis'])
def test_dbus_service_timeout_running(self):
'''DBus.Error.NoReply with a running service'''
# ensure the service is running
metadata_obj = dbus.SessionBus().get_object('org.gtk.vfs.Metadata', '/org/gtk/vfs/metadata')
self.assertNotEqual(metadata_obj, None)
# timeout of zero will always fail with NoReply
try:
subprocess.call(['killall', '-STOP', 'gvfsd-metadata'])
self._test_crash(extracode='''import dbus
obj = dbus.SessionBus().get_object('org.gtk.vfs.Metadata', '/org/gtk/vfs/metadata')
assert obj
i = dbus.Interface(obj, 'org.freedesktop.DBus.Peer')
i.Ping(timeout=1)
''')
finally:
subprocess.call(['killall', '-CONT', 'gvfsd-metadata'])
# check report contents
reports = apport.fileutils.get_new_reports()
self.assertEqual(len(reports), 0, 'NoReply is an useless exception and should not create a report')
# This is disabled for now as we cannot get the bus name from the NoReply exception
#pr = self._load_report()
#self.assertTrue('org.freedesktop.DBus.Error.NoReply' in pr['Traceback'], pr['Traceback'])
#self.assertTrue(pr['DbusErrorAnalysis'].startswith('provided by /usr/share/dbus-1/services/gvfs-metadata.service'),
# pr['DbusErrorAnalysis'])
#self.assertTrue('gvfsd-metadata is running' in pr['DbusErrorAnalysis'], pr['DbusErrorAnalysis'])
# This is disabled for now as we cannot get the bus name from the NoReply exception
# def test_dbus_service_timeout_notrunning(self):
# '''DBus.Error.NoReply with a crashing method'''
#
# # run our own mock service with a crashing method
# subprocess.call(['killall', 'gvfsd-metadata'])
# service = subprocess.Popen([os.getenv('PYTHON', 'python3')],
# stdin=subprocess.PIPE,
# universal_newlines=True)
# service.stdin.write('''import os
#import dbus, dbus.service, dbus.mainloop.glib
#from gi.repository import GLib
#
#class MockMetadata(dbus.service.Object):
# @dbus.service.method('com.ubuntu.Test', in_signature='', out_signature='i')
# def Crash(self):
# os.kill(os.getpid(), 5)
#
#dbus.mainloop.glib.DBusGMainLoop(set_as_default=True)
#dbus_name = dbus.service.BusName('org.gtk.vfs.Metadata', dbus.SessionBus())
#svr = MockMetadata(bus_name=dbus_name, object_path='/org/gtk/vfs/metadata')
#GLib.MainLoop().run()
#''')
# service.stdin.close()
# self.addCleanup(service.terminate)
# time.sleep(0.5)
#
# self._test_crash(extracode='''import dbus
#obj = dbus.SessionBus().get_object('org.gtk.vfs.Metadata', '/org/gtk/vfs/metadata')
#assert obj
#dbus.Interface(obj, 'com.ubuntu.Test').Crash()
#''')
#
# pr = self._load_report()
# self.assertTrue('org.freedesktop.DBus.Error.NoReply' in pr['Traceback'], pr['Traceback'])
# self.assertTrue(pr['DbusErrorAnalysis'].startswith('provided by /usr/share/dbus-1/services/gvfs-metadata.service'),
# pr['DbusErrorAnalysis'])
# self.assertTrue('gvfsd-metadata is not running' in pr['DbusErrorAnalysis'], pr['DbusErrorAnalysis'])
def _load_report(self):
'''Ensure that there is exactly one crash report and load it'''
reports = apport.fileutils.get_new_reports()
self.assertEqual(len(reports), 1, 'crashed Python program produced a report')
pr = problem_report.ProblemReport()
with open(reports[0], 'rb') as f:
pr.load(f)
return pr
unittest.main()
|