-
Notifications
You must be signed in to change notification settings - Fork 10
/
stoneridge.py
780 lines (605 loc) · 22.9 KB
/
stoneridge.py
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
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
# This Source Code Form is subject to the terms of the Mozilla Public License,
# v. 2.0. If a copy of the MPL was not distributed with this file, You can
# obtain one at http://mozilla.org/MPL/2.0/.
import argparse
import ConfigParser
import copy
import email
import inspect
import json
import logging
import os
import platform
import requests
import signal
import smtplib
import subprocess
import sys
import time
import traceback
import pika
# Quiet logging from pika so it doesn't mess with our local logs
pika_logger = logging.getLogger('pika')
pika_logger.setLevel(logging.ERROR)
# Names of netconfigs and operating systems
NETCONFIGS = ('broadband', 'umts', 'gsm')
OPERATING_SYSTEMS = ('linux', 'mac', 'windows')
# RabbitMQ queue names
INCOMING_QUEUE = 'sr_incoming'
OUTGOING_QUEUE = 'sr_outgoing'
NETCONFIG_QUEUES = {
'broadband': 'sr_nc_broadband',
'umts': 'sr_nc_umts',
'gsm': 'sr_nc_gsm'
}
CLIENT_QUEUES = {
'linux': 'sr_ct_linux',
'mac': 'sr_ct_mac',
'windows': 'sr_ct_windows'
}
# Logging configuration
LOG_FMT = '%(asctime)s %(pathname)s:%(lineno)d %(levelname)s: %(message)s'
_parser = argparse.ArgumentParser(add_help=False)
_parser.add_argument('--log')
_args, _ = _parser.parse_known_args()
if _args.log:
_logger = logging.getLogger()
_logger.setLevel(logging.DEBUG)
_handler = logging.FileHandler(_args.log)
_formatter = logging.Formatter(fmt=LOG_FMT)
_handler.setFormatter(_formatter)
_logger.addHandler(_handler)
def log(msg):
if _args.log:
logging.debug(msg)
def log_exc(msg):
if _args.log:
logging.exception(msg)
def main(_main):
"""Mark a function as the main function to run when run as a script.
If that function throws an exception, we'll print the traceback to
stderr and exit.
"""
parent = inspect.stack()[1][0]
name = parent.f_locals.get('__name__', None)
if name == '__main__':
log('%s' % (' '.join(sys.argv),))
try:
_main()
except Exception as e:
log_exc('EXCEPTION')
traceback.print_exception(type(e), e, sys.exc_info()[2], None,
sys.stderr)
sys.exit(1)
log('FINISHED')
sys.exit(0)
return _main
class cwd(object):
"""A context manager to change our working directory when we enter the
context, and then change back to the original working directory when we
exit the context
"""
def __init__(self, dirname):
self.newcwd = dirname
self.oldcwd = os.getcwd()
logging.debug('creating cwd object with newcwd %s and oldcwd %s' %
(self.newcwd, self.oldcwd))
def __enter__(self):
logging.debug('changing cwd to %s' % (self.newcwd,))
os.chdir(self.newcwd)
def __exit__(self, *args):
logging.debug('returning cwd to %s' % (self.oldcwd,))
os.chdir(self.oldcwd)
class Process(subprocess.Popen):
"""A subclass of subprocess.Popen that does the right things by default for
capturing stdout and stderr from programs run as part of stone ridge.
"""
def __init__(self, args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT,
**kwargs):
kwargs['universal_newlines'] = True
subprocess.Popen.__init__(self, args, stdout=stdout, stderr=stderr,
**kwargs)
class StreamLogger(object):
"""Redirect a stream to a logger
"""
def __init__(self, logger):
self.logger = logger
def write(self, buf):
for line in buf.rstrip().splitlines():
self.logger.log(logging.DEBUG, line.rstrip())
@staticmethod
def bottle_inject():
"""Do some nasty hackery to make sure everything bottle prints goes to
our log, too.
"""
# We do the import here, because we don't want to import bottle into
# the stoneridge namespace unless the process is already using bottle,
# which will be evident by the fact that it's asking us to inject this
# stream logger into bottle!
import bottle
streamlogger = StreamLogger(logging.getLogger())
# Redirecting sys.stdout and sys.stderr is ok, because anything that
# calls this is a daemon process that shouldn't be printing anything
# to the console, anyway.
sys.stdout = sys.stderr = streamlogger
bottle._stdout = bottle._stderr = streamlogger.write
_cp = None
_srconf = None
_runconf = None
def get_config_file():
return _srconf
def get_config(section, option, default=None):
"""Read a config entry from the stoneridge ini files.
"""
global _cp
logging.debug('reading %s.%s (default %s)' % (section, option, default))
if _cp is None:
_cp = ConfigParser.SafeConfigParser()
if _srconf:
logging.debug('loading stoneridge config file %s' % (_srconf,))
_cp.read(_srconf)
if _runconf:
logging.debug('loading run config file %s' % (_runconf,))
_cp.read(_runconf)
try:
val = _cp.get(section, option)
logging.debug('found %s.%s, returning %s' % (section, option, val))
return val
except (ConfigParser.NoSectionError, ConfigParser.NoOptionError):
logging.debug('unable to find %s.%s, returning default %s' %
(section, option, default))
return default
def get_config_int(section, option, default=0):
"""Get an integer config variable from the stoneridge ini files
"""
value = get_config(section, option, default=default)
try:
return int(value)
except ValueError:
logging.debug('invalid int value %s, returning default %s' %
(value, default))
return default
def get_config_bool(section, option):
"""Get a boolean config variable from the stoneridge ini files
"""
value = get_config(section, option)
if value is None:
value = False
else:
truthy_values = ('y', 'yes', 't', 'true', 'ok', '1')
if value.lower() in truthy_values:
value = True
else:
value = False
return value
# Supporting variables for running test processes (xpcshell & firefox in
# pageloader mode)
_test_process_environ = None
_bindir = None
_binaries = {
'firefox': None,
'xpcshell': None
}
_timeouts = {
'firefox': None,
'xpcshell': None
}
class TestProcessTimeout(Exception):
"""Exception type for when we manually time out the test process
"""
def __init__(self, process_type, timeout_secs, process_stdout):
self.process_type = process_type
self.timeout_secs = timeout_secs
self.process_output_fd = process_stdout
Exception.__init__(self,
'Killed test process %s after %s seconds' %
(process_type, timeout_secs))
def _ensure_bindir():
"""Make sure our bindir for the tests exists.
"""
global _bindir
if _bindir is None:
_bindir = get_config('run', 'bin')
if _bindir is None:
raise Exception('Missing bindir for tests!')
if not os.path.exists(_bindir):
raise Exception('Missing bindir for tests!')
def _ensure_test_process_environ():
"""Make sure we have an environment for our test process containing the
appropriate LD_LIBRARY_PATH.
"""
global _test_process_environ
if _test_process_environ is None:
_test_process_environ = copy.copy(os.environ)
ldlibpath = _test_process_environ.get('LD_LIBRARY_PATH')
if ldlibpath:
ldlibpath = os.path.pathsep.join([_bindir, ldlibpath])
else:
ldlibpath = _bindir
_test_process_environ['LD_LIBRARY_PATH'] = ldlibpath
def _ensure_binary(proctype):
"""Make sure we know where the binary for our test lives.
proctype - one of 'xpcshell' or 'firefox'
"""
if _binaries[proctype] is None:
binary = get_config('machine', proctype)
_binaries[proctype] = os.path.join(_bindir, binary)
if not os.path.exists(_binaries[proctype]):
_binaries[proctype] = None
raise Exception('Missing binary for %s' % (proctype,))
def _ensure_timeout(proctype):
"""Make sure we know how long to wait before timing out the test process.
We default to 15 minutes (900 seconds)
proctype - one of 'xpcshell' or 'firefox'
"""
if _timeouts[proctype] is None:
_timeouts[proctype] = get_config_int(proctype, 'timeout', 900)
def _run_test_process(proctype, args, stdout):
"""Run a test process, either xpcshell or firefox.
proctype - one of 'xpcshell' or 'firefox'
args - list of arguments to be passed to the process
stdout - where to shove the stdout data from the process
"""
start = int(time.time())
procargs = [_binaries[proctype]] + args
proc = Process(procargs, stdout=stdout, cwd=_bindir,
env=_test_process_environ)
timeout = _timeouts[proctype]
while (int(time.time()) - start) < timeout:
time.sleep(5)
if proc.poll() is not None:
return proc.returncode
# If we get here, that means we hit the timeout
proc.kill()
raise TestProcessTimeout(proctype, timeout, proc.stdout)
def run_firefox(args, stdout):
"""Run firefox with the appropriate args
"""
_ensure_bindir()
_ensure_test_process_environ()
_ensure_binary('firefox')
_ensure_timeout('firefox')
return _run_test_process('firefox', args, stdout)
def run_xpcshell(args, stdout):
"""Run xpcshell with the appropriate args.
"""
_ensure_bindir()
_ensure_test_process_environ()
_ensure_binary('xpcshell')
_ensure_timeout('xpcshell')
return _run_test_process('xpcshell', args, stdout)
_os_version = None
def get_os_version():
"""Return the OS version in use.
"""
global _os_version
if _os_version is None:
os_name = get_config('machine', 'os')
if os_name == 'linux':
_os_version = ' '.join(platform.linux_distribution()[0:2])
elif os_name == 'mac':
_os_version = platform.mac_ver()[0]
elif os_name == 'windows':
_os_version = platform.win32_ver()[1]
else:
_os_version = 'Unknown'
return _os_version
_netconfig_ids = {
'broadband': '0',
'umts': '1',
'gsm': '2',
}
_os_ids = {
'windows': 'w',
'linux': 'l',
'mac': 'm',
}
_buildid_suffix = None
def get_buildid_suffix():
"""Return the suffix to be used to uniquify the build id.
"""
global _buildid_suffix
if _buildid_suffix is None:
os_name = get_config('machine', 'os')
current_netconfig = get_config('run', 'netconfig')
if os_name is None or current_netconfig is None:
return ''
_buildid_suffix = _os_ids[os_name] + _netconfig_ids[current_netconfig]
return _buildid_suffix
_root = None
def run_process(procname, *args, **kwargs):
"""Run a python process under the stoneridge environment.
"""
global _root
if _root is None:
_root = get_config('stoneridge', 'root')
logger = kwargs.get('logger', logging)
command = [sys.executable, os.path.join(_root, procname)] + map(str, args)
logger.debug('Running %s' % (procname,))
logger.debug(' '.join(command))
try:
proc_stdout = subprocess.check_output(command,
stderr=subprocess.STDOUT)
logger.debug(proc_stdout)
logger.debug('SUCCEEDED: %s' % (procname,))
except subprocess.CalledProcessError as e:
logger.error('FAILED: %s (%s)' % (procname, e.returncode))
logger.error(e.output)
raise # Do this in case caller has any special handling
class ArgumentParser(argparse.ArgumentParser):
"""An argument parser for stone ridge programs that handles the arguments
required by all of them.
"""
def __init__(self, **kwargs):
argparse.ArgumentParser.__init__(self, **kwargs)
self.add_argument('--config', dest='_sr_config_', required=True,
help='Configuration file')
self.add_argument('--log', dest='_sr_log_', default=None,
required=True, help='File to place log info in')
def parse_args(self, **kwargs):
global _srconf
args = argparse.ArgumentParser.parse_args(self, **kwargs)
_srconf = args._sr_config_
logging.debug('_srconf: %s' % (_srconf,))
logging.debug('_srlog: %s' % (args._sr_log_,))
return args
def daemon_sig(pidfile):
"""Signal handler for daemons created with stoneridge.daemonize.
"""
logging.debug('signal handler: unlinking pidfile')
os.unlink(pidfile)
logging.debug('signal handler: daemon exiting')
sys.exit(0)
def daemonize(pidfile, function, **kwargs):
"""Run a function as a daemon.
pidfile - Name of file to write PID to
function - Function object to call as the daemon
kwargs - Arguments to pass to <function>
"""
import fcntl
import resource
logging.debug('forking for daemonization')
pid = os.fork()
if pid < 0:
# Fork failure
logging.error('fork failed (%s)' % (os.strerror(pid,)))
sys.exit(1)
if pid:
# Parent
sys.exit(0)
sid = os.setsid()
if sid == -1:
# Error setting session ID
logging.error('error setting sid')
sys.exit(1)
devnull = getattr(os, 'devnull', '/dev/null')
logging.debug('devnull = %s' % (devnull,))
log_fds = set()
logger = logging.getLogger()
for handler in logger.handlers:
if isinstance(handler, logging.FileHandler):
log_fds.add(handler.stream.fileno())
logging.debug('log fds = %s' % (log_fds,))
for fd in range(resource.getrlimit(resource.RLIMIT_NOFILE)[0]):
if fd in log_fds:
logging.debug('not closing fd %s (log)' % (fd,))
else:
try:
os.close(fd)
logging.debug('closed fd %s' % (fd,))
except OSError:
# Didn't have it open, don't care
pass
# Make stdin, stdout & stderr point to /dev/null
logging.debug('pointing std{in,out,err} -> devnull')
os.open(devnull, os.O_RDWR)
os.dup(0)
os.dup(0)
# Set a sane umask
logging.debug('setting umask 022')
os.umask(022)
# Change to the usual daemon directory
logging.debug('chdir -> /')
os.chdir('/')
with file(pidfile, 'w') as f:
logging.debug('locking %s' % (pidfile,))
fcntl.lockf(f, fcntl.LOCK_EX | fcntl.LOCK_NB)
logging.debug('writing pid')
f.write('%s' % (os.getpid(),))
f.flush()
logging.debug('setting up sigterm handler')
signal.signal(signal.SIGTERM, lambda sig, frame: daemon_sig(pidfile))
logging.debug('calling daemon function')
function(**kwargs)
# If we get here, we assume the program is exiting cleanly
logging.debug('unlinking pidfile')
os.unlink(pidfile)
logging.debug('daemon exiting')
sys.exit(0)
class DaemonArgumentParser(ArgumentParser):
"""An argument parser for stone ridge programs that run as daemons.
"""
def __init__(self, **kwargs):
ArgumentParser.__init__(self, **kwargs)
self.add_argument('--nodaemon', dest='nodaemon', action='store_true')
self.add_argument('--pidfile', dest='pidfile')
def do_exit(self, msg):
self.print_usage()
self.exit(2, msg % (self.prog,))
def do_mutex_exit(self, arg):
msg = '%%s: error: argument %s: not allowed with argument --nodaemon\n'
self.do_exit(msg % (arg,))
def do_missing_exit(self, arg):
msg = '%%s: error: argument %s is required\n'
self.do_exit(msg % (arg,))
def parse_args(self, **kwargs):
self.args = ArgumentParser.parse_args(self, **kwargs)
if self.args.nodaemon:
if self.args.pidfile:
self.do_mutex_exit('--pidfile')
elif not self.args.pidfile:
self.do_missing_exit('--pidfile')
return self.args
def start_daemon(self, daemon_func, **kwargs):
if self.args.nodaemon:
logging.debug('not running daemonized')
daemon_func(**kwargs)
sys.exit(0)
logging.debug('starting daemon')
daemonize(self.args.pidfile, daemon_func, **kwargs)
class TestRunArgumentParser(ArgumentParser):
"""Like stoneridge.ArgumentParser, but adds arguments specific for programs
that are run as part of a test run.
"""
def __init__(self, **kwargs):
ArgumentParser.__init__(self, **kwargs)
self.add_argument('--runconfig', dest='_sr_runconfig_', required=True,
help='Run-specific configuration file')
def parse_args(self, **kwargs):
global _runconf
args = ArgumentParser.parse_args(self, **kwargs)
_runconf = args._sr_runconfig_
logging.debug('_runconf: %s' % (_runconf,))
return args
class QueueListener(object):
"""A class to be used as the base for stone ridge daemons that need to
respond to entries on a queue.
"""
def __init__(self, queue, **kwargs):
self._host = get_config('stoneridge', 'mqhost')
self._queue = queue
self._params = pika.ConnectionParameters(host=self._host)
self._args = kwargs
self._connection = None
self.setup(**kwargs)
def setup(self, **kwargs):
"""Used for class-specific things that would normally go in __init__.
"""
pass
def handle(self, **kwargs):
"""The callback that is called when a message is received on the queue.
All subclasses must override this. Nothing is done with the returned
value.
"""
raise NotImplementedError
def _handle(self, channel, method, properties, body):
"""Internal callback for when a message is received. Deserializes the
message and calls handle. Once handle succeeds, the message is
acknowledged.
"""
msg = json.loads(body)
self.handle(**msg)
channel.basic_ack(delivery_tag=method.delivery_tag)
def _handle_onclose(self, method_frame):
"""Handle the case when our connection drops out from under us, for
whatever reason, by re-connecting (and trying to do so indefinitely).
"""
logging.debug('Got close on channel, retrying')
self._connection.close()
self._connection = None
self.run()
def run(self):
"""Main event loop for a queue listener.
"""
logging.debug('Running queue listener for %s' % (self._queue,))
if self._queue is None:
raise Exception('You must set queue for %s' % (type(self),))
self._connection = pika.BlockingConnection(self._params)
channel = self._connection.channel()
channel.add_on_close_callback(self._handle_onclose)
channel.basic_qos(prefetch_count=1)
channel.basic_consume(self._handle, queue=self._queue)
channel.start_consuming()
class QueueWriter(object):
"""Used when someone needs to write to a stone ridge queue.
"""
def __init__(self, queue):
self._host = get_config('stoneridge', 'mqhost')
self._params = pika.ConnectionParameters(host=self._host)
self._queue = queue
def enqueue(self, **msg):
"""Place a message on the queue. The message is serialized as a JSON
string before being placed on the queue.
"""
connection = pika.BlockingConnection(self._params)
channel = connection.channel()
body = json.dumps(msg)
properties = pika.BasicProperties(delivery_mode=2) # Durable
channel.basic_publish(exchange='', routing_key=self._queue, body=body,
properties=properties)
connection.close() # Ensures the message is sent
def enqueue(nightly=True, ldap='', sha='', netconfigs=None,
operating_systems=None, srid=None, attempt=1):
"""Convenience function to kick off a test run. If called with no
arguments, this will kick off a run for all operating systems with all
netconfigs against the latest nightly build.
"""
if not netconfigs:
netconfigs = _netconfig_ids.keys()
else:
for nc in netconfigs:
if nc not in _netconfig_ids:
raise ValueError('Invalid net config %s' % (nc,))
if not operating_systems:
operating_systems = _os_ids.keys()
else:
for ops in operating_systems:
if ops not in _os_ids:
raise ValueError('Invalid operating system %s' % (nc,))
if nightly:
if ldap or sha:
raise ValueError('ldap and sha are not compatible with nightly')
else:
if not ldap or not sha:
raise ValueError('both ldap and sha must be set')
writer = QueueWriter(INCOMING_QUEUE)
writer.enqueue(nightly=nightly, ldap=ldap, sha=sha, netconfigs=netconfigs,
operating_systems=operating_systems, srid=srid,
attempt=attempt)
def sendmail(to, subject, message, *attachments):
"""Send an email, with optional attachments
to - email address to send the email to
subject - subject of the email
message - body text of the email
attachments - optional (path, name) tuples, where <path> is the path to
the file to be attached on disk, and <name> is the name to
be used as the attachment's name in the email.
"""
msg = email.MIMEMultipart.MIMEMultipart()
msg['from'] = 'stoneridge@noreply.mozilla.com'
msg['to'] = to
msg['date'] = email.Utils.formatdate()
msg['subject'] = subject
# Create the main part that displays
msg.attach(email.MIMEText.MIMEText(message))
# Add the attachments as base64-encoded application/octet-stream parts
for fpath, fname in attachments:
mpart = email.MIMEBase.MIMEBase('application', 'octet-stream')
with file(fpath, 'rb') as f:
mpart.set_payload(f.read())
email.Encoders.encode_base64(mpart)
mpart.add_header('Content-Disposition',
'attachment; filename=%s' % (fname,))
msg.attach(mpart)
# And now we can actuall send the email
try:
smtp = smtplib.SMTP('localhost')
smtp.sendmail('stoneridge@noreply.mozilla.com', [to],
msg.as_string())
smtp.close()
except:
logging.exception('Error sending email to %s' % (to,))
_mailurl = None
def mail(to, subject, message):
"""Like sendmail, but for clients (which don't run an smtpd) to use.
"""
global _mailurl
if _mailurl is None:
_mailurl = get_config('stoneridge', 'mailurl')
logging.debug('to: %s' % (to,))
logging.debug('subject: %s' % (subject,))
logging.debug('message: %s' % (message,))
requests.post(_mailurl, data={'to': to,
'subject': subject,
'message': message})
logging.debug('mail sent')