This repository has been archived by the owner on Sep 15, 2021. It is now read-only.
/
script.py
executable file
·913 lines (831 loc) · 36.5 KB
/
script.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
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
#!/usr/bin/env python
# ***** BEGIN LICENSE BLOCK *****
# 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/.
# ***** END LICENSE BLOCK *****
"""Generic script objects.
script.py, along with config.py and log.py, represents the core of
mozharness.
"""
import codecs
import os
import platform
import pprint
import re
import shutil
import subprocess
import sys
import time
import urllib2
import urlparse
try:
import simplejson as json
except ImportError:
import json
from mozharness.base.config import BaseConfig
from mozharness.base.log import SimpleFileLogger, MultiFileLogger, \
LogMixin, OutputParser, DEBUG, INFO, ERROR, WARNING, FATAL
# OSMixin {{{1
class OSMixin(object):
"""Filesystem commands and the like.
Depends on LogMixin, ShellMixin, and a self.config of some sort.
"""
def mkdir_p(self, path, error_level=ERROR):
"""
Returns None for success, not None for failure
"""
if not os.path.exists(path):
self.info("mkdir: %s" % path)
try:
os.makedirs(path)
except OSError:
self.log("Can't create directory %s!" % path,
level=error_level)
return -1
else:
self.debug("mkdir_p: %s Already exists." % path)
def rmtree(self, path, num_retries=None, log_level=INFO,
error_level=ERROR, exit_code=-1):
"""
Returns None for success, not None for failure
"""
self.log("rmtree: %s" % path, level=log_level)
if num_retries is None:
num_retries = self.config.get('global_retries', 5)
try_num = 0
if os.path.exists(path):
while try_num <= num_retries:
if os.path.isdir(path):
if self._is_windows():
# bug 789520: using rmdir /s /q instead of
# self._rmdir_recursive
self.run_command('rmdir /S /Q "%s"' % path)
else:
shutil.rmtree(path)
else:
os.remove(path)
try_num += 1
if os.path.exists(path):
self.warning("Failed to remove %s on try %d." % (path, try_num))
if try_num <= num_retries:
sleep_time = try_num * 2
self.info("Sleeping %d seconds..." % sleep_time)
time.sleep(sleep_time)
else:
break
else:
self.log('Unable to remove %s!' % path, level=error_level,
exit_code=exit_code)
return -1
else:
self.debug("%s doesn't exist." % path)
def _is_windows(self):
system = platform.system()
if system in ("Windows", "Microsoft"):
return True
if system.startswith("CYGWIN"):
return True
def query_msys_path(self, path):
if not isinstance(path, basestring):
return path
path = path.replace("\\", "/")
def repl(m):
return '/%s/' % m.group(1)
path = re.sub(r'''^([a-zA-Z]):/''', repl, path)
return path
def _rmdir_recursive(self, path):
"""This is a replacement for shutil.rmtree that works better under
windows. Thanks to Bear at the OSAF for the code."""
if not os.path.exists(path):
return
# Verify the directory is read/write/execute for the current user
os.chmod(path, 0700)
for name in os.listdir(path):
full_name = os.path.join(path, name)
# on Windows, if we don't have write permission we can't remove
# the file/directory either, so turn that on
if self._is_windows():
if not os.access(full_name, os.W_OK):
# I think this is now redundant, but I don't have an NT
# machine to test on, so I'm going to leave it in place
# -warner
os.chmod(full_name, 0600)
if os.path.islink(full_name):
os.remove(full_name) # as suggested in bug #792
elif os.path.isdir(full_name):
self._rmdir_recursive(full_name)
else:
if os.path.isfile(full_name):
os.chmod(full_name, 0700)
os.remove(full_name)
os.rmdir(path)
def get_filename_from_url(self, url):
parsed = urlparse.urlsplit(url.rstrip('/'))
if parsed.path != '':
return parsed.path.rsplit('/', 1)[-1]
else:
return parsed.netloc
# http://www.techniqal.com/blog/2008/07/31/python-file-read-write-with-urllib2/
# TODO thinking about creating a transfer object.
def download_file(self, url, file_name=None, parent_dir=None,
create_parent_dir=True, error_level=ERROR,
num_retries=None, exit_code=-1):
"""Python wget.
"""
if not file_name:
try:
file_name = self.get_filename_from_url(url)
except AttributeError:
self.log("Unable to get filename from %s; bad url?" % url,
level=error_level, exit_code=exit_code)
return
if parent_dir:
file_name = os.path.join(parent_dir, file_name)
if create_parent_dir:
self.mkdir_p(parent_dir, error_level=error_level)
if num_retries is None:
num_retries = self.config.get("global_retries", 5)
self.info("Downloading %s to %s" % (url, file_name))
try_num = 0
while try_num <= num_retries:
try_num += 1
level = WARNING
if try_num > num_retries:
level = error_level
try:
f = urllib2.urlopen(url)
local_file = open(file_name, 'wb')
while True:
block = f.read(1024**2)
if not block:
break
local_file.write(block)
local_file.close()
return file_name
except urllib2.HTTPError, e:
self.log("Try %d: Server returned status %s %s for %s" % (try_num, str(e.code), str(e), url),
level=level, exit_code=exit_code)
except urllib2.URLError, e:
if try_num > num_retries:
remote_host = urlparse.urlsplit(url)[1]
if not remote_host:
return
nslookup = self.query_exe('nslookup')
error_list = [{
'substr': "server can't find %s" % remote_host,
'level': ERROR,
'explanation': "Either %s is an invalid hostname, or DNS is busted." % remote_host,
}]
self.run_command([nslookup, remote_host],
error_list=error_list)
self.log("Try %d: URL Error: %s" % (try_num, url), level=level,
exit_code=exit_code)
if try_num <= num_retries:
sleep_time = try_num * 20
self.info("Sleeping %d seconds..." % sleep_time)
time.sleep(sleep_time)
def move(self, src, dest, log_level=INFO, error_level=ERROR,
exit_code=-1):
self.log("Moving %s to %s" % (src, dest), level=log_level)
try:
shutil.move(src, dest)
# http://docs.python.org/tutorial/errors.html
except IOError, e:
self.log("IO error: %s" % str(e),
level=error_level, exit_code=exit_code)
return -1
return 0
def chmod(self, path, mode):
self.info("Chmoding %s to %s" % (path, str(oct(mode))))
os.chmod(path, mode)
def copyfile(self, src, dest, log_level=INFO, error_level=ERROR, copystat=False):
self.log("Copying %s to %s" % (src, dest), level=log_level)
try:
shutil.copyfile(src, dest)
if copystat:
shutil.copystat(src, dest)
except (IOError, shutil.Error), e:
self.log("Can't copy %s to %s: %s!" % (src, dest, str(e)),
level=error_level)
return -1
def copytree(self, src, dest, overwrite='no_overwrite', log_level=INFO,
error_level=ERROR):
"""an implementation of shutil.copytree however it allows for
dest to exist and implements different overwrite levels.
overwrite uses:
'no_overwrite' will keep all(any) existing files in destination tree
'overwrite_if_exists' will only overwrite destination paths that have
the same path names relative to the root of the src and
destination tree
'clobber' will replace the whole destination tree(clobber) if it exists"""
self.info('copying tree: %s to %s' % (src, dest))
try:
if overwrite == 'clobber':
self.rmtree(dest)
shutil.copytree(src, dest)
elif overwrite == 'no_overwrite' or overwrite == 'overwrite_if_exists':
files = os.listdir(src)
for f in files:
abs_src_f = os.path.join(src, f)
abs_dest_f = os.path.join(dest, f)
if not os.path.exists(abs_dest_f):
if os.path.isdir(abs_src_f):
self.mkdir_p(abs_dest_f)
self.copytree(abs_src_f, abs_dest_f,
overwrite='clobber')
else:
shutil.copy2(abs_src_f, abs_dest_f)
elif overwrite == 'no_overwrite': # destination path exists
if os.path.isdir(abs_src_f) and os.path.isdir(abs_dest_f):
self.copytree(abs_src_f, abs_dest_f,
overwrite='no_overwrite')
else:
self.debug('ignoring path: %s as destination: \
%s exists' % (abs_src_f, abs_dest_f))
else: # overwrite == 'overwrite_if_exists' and destination exists
self.debug('overwriting: %s with: %s' %
(abs_dest_f, abs_src_f))
self.rmtree(abs_dest_f)
if os.path.isdir(abs_src_f):
self.mkdir_p(abs_dest_f)
self.copytree(abs_src_f, abs_dest_f,
overwrite='overwrite_if_exists')
else:
shutil.copy2(abs_src_f, abs_dest_f)
else:
self.fatal("%s is not a valid argument for param overwrite" % (overwrite))
except (IOError, shutil.Error):
self.dump_exception("There was an error while copying %s to %s!" % (src, dest),
level=error_level)
return -1
def write_to_file(self, file_path, contents, verbose=True,
open_mode='w', create_parent_dir=False,
error_level=ERROR):
"""
Write contents to file_path.
This doesn't currently create the parent_dir or translate into
abs_path; that needs to be done beforehand, since OSMixin doesn't
necessarily have access to query_abs_dirs().
Returns file_path if successful, None if not.
"""
self.info("Writing to file %s" % file_path)
if verbose:
self.info("Contents:")
for line in contents.splitlines():
self.info(" %s" % line)
if create_parent_dir:
parent_dir = os.path.dirname(file_path)
self.mkdir_p(parent_dir, error_level=error_level)
try:
fh = open(file_path, open_mode)
fh.write(contents)
fh.close()
return file_path
except IOError:
self.log("%s can't be opened for writing!" % file_path,
level=error_level)
def read_from_file(self, file_path, verbose=True, open_mode='r',
error_level=ERROR):
"""
Reads from file_path.
Returns contents if successful, None if not.
"""
self.info("Reading from file %s" % file_path)
if not os.path.exists(file_path):
self.log("%s doesn't exist!" % file_path, level=error_level)
return
try:
fh = open(file_path, open_mode)
contents = fh.read()
fh.close()
if verbose:
self.info("Contents:")
for line in contents.splitlines():
self.info(" %s" % line)
return contents
except IOError:
self.log("%s can't be opened for reading!" % file_path,
level=error_level)
def chdir(self, dir_name):
self.log("Changing directory to %s." % dir_name)
os.chdir(dir_name)
def which(self, program):
"""
OS independent implementation of Unix's which command
Takes in a program name
Returns path to executable or None
"""
def is_exe(fpath):
return os.path.isfile(fpath) and os.access(fpath, os.X_OK)
if self._is_windows() and not program.endswith(".exe"):
program += ".exe"
fpath, fname = os.path.split(program)
if fpath:
if is_exe(program):
return program
else:
env = self.query_env()
for path in env["PATH"].split(os.pathsep):
exe_file = os.path.join(path, program)
if is_exe(exe_file):
return exe_file
return None
# ShellMixin {{{1
class ShellMixin(object):
"""These are very special but very complex methods that, together with
logging and config, provide the base for all scripts in this harness.
This is currently dependent on LogMixin and OSMixin, and assumes that
there is a self.config of some sort.
"""
def __init__(self):
self.env = None
def query_env(self, partial_env=None, replace_dict=None,
set_self_env=None, log_level=DEBUG):
"""Environment query/generation method.
The default, self.query_env(), will look for self.config['env']
and replace any special strings in there ( %(PATH)s ).
It will then store it as self.env for speeding things up later.
If you specify partial_env, partial_env will be used instead of
self.config['env'], and we don't save self.env as it's a one-off.
"""
if partial_env is None:
if self.env is not None:
return self.env
partial_env = self.config.get('env', None)
if partial_env is None:
partial_env = {}
if set_self_env is None:
set_self_env = True
env = os.environ.copy()
default_replace_dict = self.query_abs_dirs()
default_replace_dict['PATH'] = os.environ['PATH']
if not replace_dict:
replace_dict = default_replace_dict
else:
for key in default_replace_dict:
if key not in replace_dict:
replace_dict[key] = default_replace_dict[key]
for key in partial_env.keys():
env[key] = partial_env[key] % replace_dict
self.log("ENV: %s is now %s" % (key, env[key]), level=log_level)
if set_self_env:
self.env = env
return env
def query_exe(self, exe_name, exe_dict='exes', default=None,
return_type=None, error_level=FATAL):
"""One way to work around PATH rewrites.
By default, return exe_name, and we'll fall through to searching
os.environ["PATH"].
However, if self.config[exe_dict][exe_name] exists, return that.
This lets us override exe paths via config file.
'return_type' can be None (don't do anything to the value),
'list' (return a list), or 'string' (return a string).
If we need runtime setting, we can build in self.exes support later.
"""
if default is None:
default = exe_name
exe = self.config.get(exe_dict, {}).get(exe_name, default)
if isinstance(exe, list):
exe = exe[:]
elif not isinstance(exe, str):
self.log("query_exe: %s is not a string or list: %s!" % (exe_name, str(exe)), level=error_level)
return exe
if return_type == "list":
if isinstance(exe, str):
exe = [exe]
elif return_type == "string":
if isinstance(exe, list):
exe = subprocess.list2cmdline(exe)
elif return_type is not None:
self.log("Unknown return_type type %s requested in query_exe!" % return_type, level=error_level)
return exe
def run_command(self, command, cwd=None, error_list=None, parse_at_end=False,
halt_on_failure=False, success_codes=None,
env=None, return_type='status', throw_exception=False,
output_parser=None):
"""Run a command, with logging and error parsing.
TODO: parse_at_end, context_lines
TODO: retry_interval?
TODO: error_level_override?
TODO: Add a copy-pastable version of |command| if it's a list.
TODO: print env if set
output_parser lets you provide an instance of your own OutputParser
subclass, or pass None to use OutputParser.
error_list example:
[{'regex': re.compile('^Error: LOL J/K'), level=IGNORE},
{'regex': re.compile('^Error:'), level=ERROR, contextLines='5:5'},
{'substr': 'THE WORLD IS ENDING', level=FATAL, contextLines='20:'}
]
(context_lines isn't written yet)
"""
if success_codes is None:
success_codes = [0]
if cwd is not None:
if not os.path.isdir(cwd):
level = ERROR
if halt_on_failure:
level = FATAL
self.log("Can't run command %s in non-existent directory '%s'!" % \
(command, cwd), level=level)
return -1
self.info("Running command: %s in %s" % (command, cwd))
else:
self.info("Running command: %s" % command)
if isinstance(command, list):
self.info("Copy/paste: %s" % subprocess.list2cmdline(command))
shell = True
if isinstance(command, list):
shell = False
try:
p = subprocess.Popen(command, shell=shell, stdout=subprocess.PIPE,
cwd=cwd, stderr=subprocess.STDOUT, env=env)
except OSError, e:
level = ERROR
if halt_on_failure:
level = FATAL
self.log('caught OS error %s: %s while running %s' % (e.errno,
e.strerror, command), level=level)
return -1
if output_parser is None:
parser = OutputParser(config=self.config, log_obj=self.log_obj,
error_list=error_list)
else:
parser = output_parser
loop = True
while loop:
if p.poll() is not None:
"""Avoid losing the final lines of the log?"""
loop = False
while True:
line = p.stdout.readline()
if not line:
break
parser.add_lines(line)
return_level = INFO
if p.returncode not in success_codes:
return_level = ERROR
if throw_exception:
raise subprocess.CalledProcessError(p.returncode, command)
self.log("Return code: %d" % p.returncode, level=return_level)
if halt_on_failure:
if parser.num_errors or p.returncode not in success_codes:
self.fatal("Halting on failure while running %s" % command,
exit_code=p.returncode)
if return_type == 'num_errors':
return parser.num_errors
return p.returncode
def get_output_from_command(self, command, cwd=None,
halt_on_failure=False, env=None,
silent=False, log_level=INFO,
tmpfile_base_path='tmpfile',
return_type='output', save_tmpfiles=False,
throw_exception=False):
"""Similar to run_command, but where run_command is an
os.system(command) analog, get_output_from_command is a `command`
analog.
Less error checking by design, though if we figure out how to
do it without borking the output, great.
TODO: binary mode? silent is kinda like that.
TODO: since p.wait() can take a long time, optionally log something
every N seconds?
TODO: optionally only keep the first or last (N) line(s) of output?
TODO: optionally only return the tmp_stdout_filename?
"""
if cwd:
if not os.path.isdir(cwd):
level = ERROR
if halt_on_failure:
level = FATAL
self.log("Can't run command %s in non-existent directory %s!" % \
(command, cwd), level=level)
return None
self.info("Getting output from command: %s in %s" % (command, cwd))
else:
self.info("Getting output from command: %s" % command)
if isinstance(command, list):
self.info("Copy/paste: %s" % subprocess.list2cmdline(command))
# This could potentially return something?
tmp_stdout = None
tmp_stderr = None
tmp_stdout_filename = '%s_stdout' % tmpfile_base_path
tmp_stderr_filename = '%s_stderr' % tmpfile_base_path
# TODO probably some more elegant solution than 2 similar passes
try:
tmp_stdout = open(tmp_stdout_filename, 'w')
except IOError:
level = ERROR
if halt_on_failure:
level = FATAL
self.log("Can't open %s for writing!" % tmp_stdout_filename + \
self.dump_exception(), level=level)
return None
try:
tmp_stderr = open(tmp_stderr_filename, 'w')
except IOError:
level = ERROR
if halt_on_failure:
level = FATAL
self.log("Can't open %s for writing!" % tmp_stderr_filename + \
self.dump_exception(), level=level)
return None
shell = True
if isinstance(command, list):
shell = False
p = subprocess.Popen(command, shell=shell, stdout=tmp_stdout,
cwd=cwd, stderr=tmp_stderr, env=env)
#XXX: changed from self.debug to self.log due to this error:
# TypeError: debug() takes exactly 1 argument (2 given)
self.log("Temporary files: %s and %s" % (tmp_stdout_filename, tmp_stderr_filename), level=DEBUG)
p.wait()
tmp_stdout.close()
tmp_stderr.close()
return_level = DEBUG
output = None
if os.path.exists(tmp_stdout_filename) and os.path.getsize(tmp_stdout_filename):
output = self.read_from_file(tmp_stdout_filename,
verbose=False)
if not silent:
self.log("Output received:", level=log_level)
output_lines = output.rstrip().splitlines()
for line in output_lines:
if not line or line.isspace():
continue
line = line.decode("utf-8")
self.log(' %s' % line, level=log_level)
output = '\n'.join(output_lines)
if os.path.exists(tmp_stderr_filename) and os.path.getsize(tmp_stderr_filename):
return_level = ERROR
self.error("Errors received:")
errors = self.read_from_file(tmp_stderr_filename,
verbose=False)
for line in errors.rstrip().splitlines():
if not line or line.isspace():
continue
line = line.decode("utf-8")
self.error(' %s' % line)
elif p.returncode:
return_level = ERROR
# Clean up.
if not save_tmpfiles:
self.rmtree(tmp_stderr_filename, log_level=DEBUG)
self.rmtree(tmp_stdout_filename, log_level=DEBUG)
if p.returncode and throw_exception:
raise subprocess.CalledProcessError(p.returncode, command)
self.log("Return code: %d" % p.returncode, level=return_level)
if halt_on_failure and return_level == ERROR:
self.fatal("Halting on failure while running %s" % command,
exit_code=p.returncode)
# Hm, options on how to return this? I bet often we'll want
# output_lines[0] with no newline.
if return_type != 'output':
return (tmp_stdout_filename, tmp_stderr_filename)
else:
return output
# BaseScript {{{1
class BaseScript(ShellMixin, OSMixin, LogMixin, object):
def __init__(self, config_options=None, default_log_level="info", **kwargs):
super(BaseScript, self).__init__()
self.return_code = 0
self.log_obj = None
self.abs_dirs = None
if config_options is None:
config_options = []
self.summary_list = []
self.failures = []
rw_config = BaseConfig(config_options=config_options,
**kwargs)
self.config = rw_config.get_read_only_config()
self.actions = tuple(rw_config.actions)
self.all_actions = tuple(rw_config.all_actions)
self.env = None
self.new_log_obj(default_log_level=default_log_level)
# Set self.config to read-only.
#
# We can create intermediate config info programmatically from
# this in a repeatable way, with logs; this is how we straddle the
# ideal-but-not-user-friendly static config and the
# easy-to-write-hard-to-debug writable config.
#
# To allow for other, script-specific configurations
# (e.g., hgtool's buildbot props json parsing), before locking,
# call self._pre_config_lock(). If needed, this method can
# alter self.config.
self._pre_config_lock(rw_config)
self._config_lock()
self.info("Run as %s" % rw_config.command_line)
def _pre_config_lock(self, rw_config):
"""This empty method can allow for config checking and manipulation
before the config lock, when overridden in scripts.
"""
pass
def _config_lock(self):
"""After this point, the config is locked and should not be
manipulated (based on mozharness.base.config.ReadOnlyDict)
"""
self.config.lock()
def _possibly_run_method(self, method_name, error_if_missing=False):
"""This is here for run().
"""
if hasattr(self, method_name) and callable(getattr(self, method_name)):
return getattr(self, method_name)()
elif error_if_missing:
self.error("No such method %s!" % method_name)
def copy_logs_to_upload_dir(self):
"""Copies logs to the upload directory"""
self.info("Copying logs to upload dir...")
log_files = ['localconfig.json']
for log_name in self.log_obj.log_files.keys():
log_files.append(self.log_obj.log_files[log_name])
dirs = self.query_abs_dirs()
for log_file in log_files:
self.copy_to_upload_dir(os.path.join(dirs['abs_log_dir'], log_file),
dest=os.path.join('logs', log_file),
short_desc='%s log' % log_name,
long_desc='%s log' % log_name,
rotate=True)
def run(self):
"""Default run method.
This is the "do everything" method, based on actions and all_actions.
First run self.dump_config() if it exists.
Second, go through the list of all_actions.
If they're in the list of self.actions, try to run
self.preflight_ACTION(), self.ACTION(), and self.postflight_ACTION().
Preflight is sanity checking before doing anything time consuming or
destructive.
Postflight is quick testing for success after an action.
Run self.summary() at the end.
"""
self.dump_config()
for action in self.all_actions:
if action not in self.actions:
self.action_message("Skipping %s step." % action)
else:
method_name = action.replace("-", "_")
self.action_message("Running %s step." % action)
self._possibly_run_method("preflight_%s" % method_name)
self._possibly_run_method(method_name, error_if_missing=True)
self._possibly_run_method("postflight_%s" % method_name)
self.summary()
self.copy_logs_to_upload_dir()
sys.exit(self.return_code)
def clobber(self):
"""
Delete the working directory
"""
dirs = self.query_abs_dirs()
self.rmtree(dirs['abs_work_dir'])
def query_abs_dirs(self):
"""We want to be able to determine where all the important things
are. Absolute paths lend themselves well to this, though I wouldn't
be surprised if this causes some issues somewhere.
This should be overridden in any script that has additional dirs
to query.
The query_* methods tend to set self.VAR variables as their
runtime cache.
"""
if self.abs_dirs:
return self.abs_dirs
c = self.config
dirs = {}
dirs['base_work_dir'] = c['base_work_dir']
dirs['abs_work_dir'] = os.path.join(c['base_work_dir'], c['work_dir'])
dirs['abs_upload_dir'] = os.path.join(dirs['abs_work_dir'], 'upload')
dirs['abs_log_dir'] = os.path.join(c['base_work_dir'], c.get('log_dir', 'logs'))
self.abs_dirs = dirs
return self.abs_dirs
def dump_config(self, file_path=None):
"""Dump self.config to localconfig.json
"""
dirs = self.query_abs_dirs()
if not file_path:
file_path = os.path.join(dirs['abs_log_dir'], "localconfig.json")
self.info("Dumping config to %s." % file_path)
self.mkdir_p(os.path.dirname(file_path))
json_config = json.dumps(self.config, sort_keys=True, indent=4)
fh = codecs.open(file_path, encoding='utf-8', mode='w+')
fh.write(json_config)
fh.close()
self.info(pprint.pformat(self.config))
# logging {{{2
def new_log_obj(self, default_log_level="info"):
dirs = self.query_abs_dirs()
log_config = {"logger_name": 'Simple',
"log_name": 'log',
"log_dir": dirs['abs_log_dir'],
"log_level": default_log_level,
"log_format": '%(asctime)s %(levelname)8s - %(message)s',
"log_to_console": True,
"append_to_log": False,
}
log_type = self.config.get("log_type", "multi")
if log_type == "multi":
log_config['logger_name'] = 'Multi'
for key in log_config.keys():
value = self.config.get(key, None)
if value is not None:
log_config[key] = value
if log_type == "multi":
self.log_obj = MultiFileLogger(**log_config)
else:
self.log_obj = SimpleFileLogger(**log_config)
def action_message(self, message):
self.info("#####")
self.info("##### %s" % message)
self.info("#####")
def summary(self):
"""Print out all the summary lines added via add_summary()
throughout the script.
I'd like to revisit how to do this in a prettier fashion.
"""
self.action_message("%s summary:" % self.__class__.__name__)
if self.summary_list:
for item in self.summary_list:
try:
self.log(item['message'], level=item['level'])
except ValueError:
"""log is closed; print as a default. Ran into this
when calling from __del__()"""
print "### Log is closed! (%s)" % item['message']
def add_summary(self, message, level=INFO):
self.summary_list.append({'message': message, 'level': level})
# TODO write to a summary-only log?
# Summaries need a lot more love.
self.log(message, level=level)
def add_failure(self, key, message="%(key)s failed.", level=ERROR):
if key not in self.failures:
self.failures.append(key)
self.return_code += 1
self.add_summary(message % {'key': key}, level=level)
def query_failure(self, key):
return key in self.failures
def summarize_success_count(self, success_count, total_count,
message="%d of %d successful."):
level = INFO
if success_count < total_count:
level = ERROR
self.add_summary(message % (success_count, total_count),
level=level)
def copy_to_upload_dir(self, target, dest=None, short_desc="unknown",
long_desc="unknown", log_level=DEBUG,
error_level=ERROR, rotate=False,
max_backups=None):
"""Copy target file to upload_dir/dest.
Potentially update a manifest in the future if we go that route.
Currently only copies a single file; would be nice to allow for
recursive copying; that would probably done by creating a helper
_copy_file_to_upload_dir().
short_desc and long_desc are placeholders for if/when we add
upload_dir manifests.
"""
dirs = self.query_abs_dirs()
if dest is None:
dest = os.path.basename(target)
if dest.endswith('/'):
dest_file = os.path.basename(target)
dest_dir = os.path.join(dirs['abs_upload_dir'], dest)
else:
dest_file = os.path.basename(dest)
dest_dir = os.path.join(dirs['abs_upload_dir'], os.path.dirname(dest))
dest = os.path.join(dest_dir, dest_file)
if not os.path.exists(target):
self.log("%s doesn't exist!" % target, level=error_level)
return None
self.mkdir_p(dest_dir)
if os.path.exists(dest):
if os.path.isdir(dest):
self.log("%s exists and is a directory!" % dest, level=error_level)
return -1
if rotate:
# Probably a better way to do this
oldest_backup = 0
backup_regex = re.compile("^%s\.(\d+)$" % dest_file)
for filename in os.listdir(dest_dir):
r = backup_regex.match(filename)
if r and int(r.groups()[0]) > oldest_backup:
oldest_backup = int(r.groups()[0])
for backup_num in range(oldest_backup, 0, -1):
# TODO more error checking?
if backup_num >= max_backups:
self.rmtree(os.path.join(dest_dir, dest_file, str(backup_num)),
log_level=log_level)
else:
self.move(os.path.join(dest_dir, dest_file, '.%d' % backup_num),
os.path.join(dest_dir, dest_file, '.%d' % backup_num +1),
log_level=log_level)
if self.move(dest, "%s.1" % dest, log_level=log_level):
self.log("Unable to move %s!" % dest, level=error_level)
return -1
else:
if self.rmtree(dest, log_level=log_level):
self.log("Unable to remove %s!" % dest, level=error_level)
return -1
self.copyfile(target, dest, log_level=log_level)
if os.path.exists(dest):
return dest
else:
self.log("%s doesn't exist after copy!" % dest, level=error_level)
return None
# __main__ {{{1
if __name__ == '__main__':
pass