author ffxbld
Tue, 06 May 2014 18:25:52 -0400
changeset 2718 58d72bb4a6bc
parent 2709 d0e0755311e6
child 2770 f2ce40efae6c
permissions -rwxr-xr-x
Added FIREFOX_29_0_1_RELEASE FIREFOX_29_0_1_BUILD2 tag(s) for changeset production. DONTBUILD CLOSED TREE a=release
#!/usr/bin/env python
# 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
# ***** END LICENSE BLOCK *****
"""Generic script objects., along with and, represents the core of

import codecs
from contextlib import contextmanager
import gzip
import inspect
import os
import platform
import pprint
import re
import shutil
import socket
import subprocess
import sys
import time
import traceback
import urllib2
import urlparse
if == 'nt':
        import win32file
        import win32api
        PYWIN32 = True
    except ImportError:
        PYWIN32 = False

    import simplejson as json
    assert json
except ImportError:
    import json

from mozprocess import ProcessHandler
from mozharness.base.config import BaseConfig
from mozharness.base.log import SimpleFileLogger, MultiFileLogger, \
    LogMixin, OutputParser, DEBUG, INFO, ERROR, FATAL

# ScriptMixin {{{1
class ScriptMixin(object):
    """This mixin contains simple filesystem commands and the like.

    It also contains some very special but very complex methods that,
    together with logging and config, provide the base for all scripts
    in this harness.

    Depends on LogMixin and a self.config of some sort.

    env = None

    # Simple filesystem commands {{{2
    def mkdir_p(self, path, error_level=ERROR):
        Returns None for success, not None for failure
        if not os.path.exists(path):
  "mkdir: %s" % path)
            except OSError:
                self.log("Can't create directory %s!" % path,
                return -1
            self.debug("mkdir_p: %s Already exists." % path)

    def rmtree(self, path, log_level=INFO, error_level=ERROR,
        Returns None for success, not None for failure
        self.log("rmtree: %s" % path, level=log_level)
        error_message = "Unable to remove %s!" % path
        if self._is_windows():
            # Call _rmtree_windows() directly, since even checking
            # os.path.exists(path) will hang if path is longer than MAX_PATH.
  "Using _rmtree_windows ...")
            return self.retry(
                args=(path, ),
        if os.path.exists(path):
            if os.path.isdir(path):
                return self.retry(
                    retry_exceptions=(OSError, ),
                    args=(path, ),
                return self.retry(
                    retry_exceptions=(OSError, ),
                    args=(path, ),
            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
        if == 'nt':
            return True

    def query_msys_path(self, path):
        if not isinstance(path, basestring):
            return path
        path = path.replace("\\", "/")

        def repl(m):
            return '/%s/' %
        path = re.sub(r'''^([a-zA-Z]):/''', repl, path)
        return path

    def _rmtree_windows(self, path):
        """ Windows-specific rmtree that handles path lengths longer than MAX_PATH.
            Ported from
        assert self._is_windows()
        path = os.path.realpath(path)
        full_path = '\\\\?\\' + path
        if not os.path.exists(full_path):
        if not PYWIN32:
            if not os.path.isdir(path):
                return self.run_command('del /F /Q "%s"' % path)
                return self.run_command('rmdir /S /Q "%s"' % path)
        # Make sure directory is writable
        win32file.SetFileAttributesW('\\\\?\\' + path, win32file.FILE_ATTRIBUTE_NORMAL)
        # Since we call rmtree() with a file, sometimes
        if not os.path.isdir('\\\\?\\' + path):
            return win32file.DeleteFile('\\\\?\\' + path)

        for ffrec in win32api.FindFiles('\\\\?\\' + path + '\\*.*'):
            file_attr = ffrec[0]
            name = ffrec[8]
            if name == '.' or name == '..':
            full_name = os.path.join(path, name)

            if file_attr & win32file.FILE_ATTRIBUTE_DIRECTORY:
                win32file.SetFileAttributesW('\\\\?\\' + full_name, win32file.FILE_ATTRIBUTE_NORMAL)
                win32file.DeleteFile('\\\\?\\' + full_name)
        win32file.RemoveDirectory('\\\\?\\' + path)

    def get_filename_from_url(self, url):
        parsed = urlparse.urlsplit(url.rstrip('/'))
        if parsed.path != '':
            return parsed.path.rsplit('/', 1)[-1]
            return parsed.netloc

    def _download_file(self, url, file_name):
        """ Helper script for download_file()
            f_length = None
            f = urllib2.urlopen(url, timeout=30)
            if'content-length') is not None:
                f_length = int(['content-length'])
                got_length = 0
            local_file = open(file_name, 'wb')
            while True:
                block = ** 2)
                if not block:
                    if f_length is not None and got_length != f_length:
                        raise urllib2.URLError("Download incomplete; content-length was %d, but only received %d" % (f_length, got_length))
                if f_length is not None:
                    got_length += len(block)
            return file_name
        except urllib2.HTTPError, e:
            self.warning("Server returned status %s %s for %s" % (str(e.code), str(e), url))
        except urllib2.URLError, e:
            self.warning("URL Error: %s" % url)
            remote_host = urlparse.urlsplit(url)[1]
            if remote_host:
                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],
        except socket.timeout, e:
            self.warning("Timed out accessing %s: %s" % (url, str(e)))
        except socket.error, e:
            self.warning("Socket error when accessing %s: %s" % (url, str(e)))

    # 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,
        """Python wget.
        if not file_name:
                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)
        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)"Downloading %s to %s" % (url, file_name))
        status = self.retry(
            args=(url, file_name),
            retry_exceptions=(urllib2.HTTPError, urllib2.URLError,
                              socket.timeout, socket.error),
            error_message="Can't download from %s to %s!" % (url, file_name),
        if status == file_name:
  "Downloaded %d bytes." % os.path.getsize(file_name))
        return status

    def move(self, src, dest, log_level=INFO, error_level=ERROR,
        self.log("Moving %s to %s" % (src, dest), level=log_level)
            shutil.move(src, dest)
        except IOError, e:
            self.log("IO error: %s" % str(e),
                     level=error_level, exit_code=exit_code)
            return -1
        except shutil.Error, e:
            self.log("shutil error: %s" % str(e),
                     level=error_level, exit_code=exit_code)
            return -1
        return 0

    def chmod(self, path, mode):"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, compress=False):
        if compress:
            self.log("Compressing %s to %s" % (src, dest), level=log_level)
                infile = open(src, "rb")
                outfile =, "wb")
            except IOError, e:
                self.log("Can't compress %s to %s: %s!" % (src, dest, str(e)),
                return -1
            self.log("Copying %s to %s" % (src, dest), level=log_level)
                shutil.copyfile(src, dest)
            except (IOError, shutil.Error), e:
                self.log("Can't copy %s to %s: %s!" % (src, dest, str(e)),
                return -1

        if copystat:
                shutil.copystat(src, dest)
            except (IOError, shutil.Error), e:
                self.log("Can't copy attributes of %s to %s: %s!" % (src, dest, str(e)),
                return -1

    def copytree(self, src, dest, overwrite='no_overwrite', log_level=INFO,
        """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"""'copying tree: %s to %s' % (src, dest))
            if overwrite == 'clobber' or not os.path.exists(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.copytree(abs_src_f, abs_dest_f,
                            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,
                            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))

                        if os.path.isdir(abs_src_f):
                            self.copytree(abs_src_f, abs_dest_f,
                            shutil.copy2(abs_src_f, abs_dest_f)
                self.fatal("%s is not a valid argument for param overwrite" % (overwrite))
        except (IOError, shutil.Error):
            self.exception("There was an error while copying %s to %s!" % (src, dest),
            return -1

    def write_to_file(self, file_path, contents, verbose=True,
                      open_mode='w', create_parent_dir=False,
        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 ScriptMixin doesn't
        necessarily have access to query_abs_dirs().

        Returns file_path if successful, None if not.
        """"Writing to file %s" % file_path)
        if verbose:
            for line in contents.splitlines():
      " %s" % line)
        if create_parent_dir:
            parent_dir = os.path.dirname(file_path)
            self.mkdir_p(parent_dir, error_level=error_level)
            fh = open(file_path, open_mode)
            return file_path
        except IOError:
            self.log("%s can't be opened for writing!" % file_path,

    def opened(self, file_path, verbose=True, open_mode='r',
        Returns an open file, error pair, for use in a 'with' statement:

            with self.opened("file.txt") as (fh, err):
                if err:
                    for line in fh: ...
        # See opened_w_error in"Reading from file %s" % file_path)
            fh = open(file_path, open_mode)
        except IOError, err:
            self.log("unable to open %s: %s" % (file_path, err.strerror),
            yield None, err
                yield fh, None

    def read_from_file(self, file_path, verbose=True, open_mode='r',
        Reads from file_path.

        Returns contents if successful, None if not.
        with self.opened(file_path, verbose, open_mode, error_level) as (fh, err):
            if err:
                return None
            contents =
            if verbose:
                for line in contents.splitlines():
          " %s" % line)
            return contents

    def chdir(self, dir_name):
        self.log("Changing directory to %s." % 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
            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

    # More complex commands {{{2
    def retry(self, action, attempts=None, sleeptime=60, max_sleeptime=5 * 60,
              retry_exceptions=(Exception, ), good_statuses=None, cleanup=None,
              error_level=ERROR, error_message="%(action)s failed after %(attempts)d tries!",
              failure_status=-1, args=(), kwargs={}):
        """ Generic retry command.
            Ported from tools util.retry.

            Call `action' a maximum of `attempts' times until it succeeds,
            defaulting to self.config.get('global_retries', 5).

            `sleeptime' is the number of seconds to wait between attempts,
            defaulting to 60 and doubling each retry attempt, to a maximum of

            `retry_exceptions' is a tuple of Exceptions that should be caught.
            If exceptions other than those listed in `retry_exceptions' are
            raised from `action', they will be raised immediately.

            `good_statuses' is a tuple of return values which, if specified,
            will result in retrying if the return value isn't listed.

            If `cleanup' is provided and callable it will be called immediately
            after an Exception is caught.  No arguments will be passed to it.
            If your cleanup function requires arguments it is recommended that
            you wrap it in an argumentless function.

            `args' and `kwargs' are a tuple and dict of arguments to pass onto
            to `callable'.
        if not callable(action):
            self.fatal("retry() called with an uncallable method %s!" % action)
        if cleanup and not callable(cleanup):
            self.fatal("retry() called with an uncallable cleanup method %s!" % cleanup)
        if not attempts:
            attempts = self.config.get("global_retries", 5)
        if max_sleeptime < sleeptime:
            self.debug("max_sleeptime %d less than sleeptime %d" % (
                       max_sleeptime, sleeptime))
        n = 0
        while n <= attempts:
            retry = False
            n += 1
      "retry: Calling %s with args: %s, kwargs: %s, attempt #%d" %
                          (action, str(args), str(kwargs), n))
                status = action(*args, **kwargs)
                if good_statuses and status not in good_statuses:
                    retry = True
            except retry_exceptions, e:
                retry = True
                error_message = "%s\nCaught exception: %s" % (error_message, str(e))

            if not retry:
                return status
                if cleanup:
                if n == attempts:
                    self.log(error_message % {'action': action, 'attempts': n}, level=error_level)
                    return failure_status
                if sleeptime > 0:
          "retry: Failed, sleeping %d seconds before retrying" %
                    sleeptime = sleeptime * 2
                    if sleeptime > max_sleeptime:
                        sleeptime = max_sleeptime

    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
            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)
        for k in purge_env:
            if k in env:
                del env[k]
        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
        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)
        repl_dict = {}
        if hasattr(self, 'query_abs_dirs'):
            # allow for 'make': '%(abs_work_dir)s/...' etc.
            dirs = self.query_abs_dirs()
            repl_dict['abs_work_dir'] = dirs['abs_work_dir']
        if isinstance(exe, list) or isinstance(exe, tuple):
            exe = [x % repl_dict for x in exe]
        elif isinstance(exe, str):
            exe = exe % repl_dict
            self.log("query_exe: %s is not a list, tuple or string: %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,
                    halt_on_failure=False, success_codes=None,
                    env=None, partial_env=None, return_type='status',
                    throw_exception=False, output_parser=None,
                    output_timeout=None, fatal_exit_code=2, **kwargs):
        """Run a command, with logging and error parsing.

        output_timeout is the number of seconds without output before the process
        is killed.

        TODO: context_lines
        TODO: error_level_override?

        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
  "Running command: %s in %s" % (command, cwd))
  "Running command: %s" % command)
        if isinstance(command, list) or isinstance(command, tuple):
  "Copy/paste: %s" % subprocess.list2cmdline(command))
        shell = True
        if isinstance(command, list) or isinstance(command, tuple):
            shell = False
        if env is None:
            if partial_env:
      "Using partial env: %s" % pprint.pformat(partial_env))
                env = self.query_env(partial_env=partial_env)
  "Using env: %s" % pprint.pformat(env))

        if output_parser is None:
            parser = OutputParser(config=self.config, log_obj=self.log_obj,
            parser = output_parser

            if output_timeout:
                def processOutput(line):

                def onTimeout():
          "Automation Error: mozprocess timed out after %s seconds running %s" % (str(output_timeout), str(command)))

                p = ProcessHandler(command,
      "Calling %s with output_timeout %d" % (command, output_timeout))
                if p.timedOut:
                    self.error('timed out after %s seconds of no output' % output_timeout)
                returncode = int(p.proc.returncode)
                p = subprocess.Popen(command, shell=shell, stdout=subprocess.PIPE,
                                     cwd=cwd, stderr=subprocess.STDOUT, env=env)
                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:
                returncode = p.returncode
        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

        return_level = INFO
        if returncode not in success_codes:
            return_level = ERROR
            if throw_exception:
                raise subprocess.CalledProcessError(returncode, command)
        self.log("Return code: %d" % returncode, level=return_level)

        if halt_on_failure:
            _fail = False
            if returncode not in success_codes:
                self.error("%s not in success codes: %s" % (returncode,
                _fail = True
            if parser.num_errors:
                self.error("failures found while parsing output")
                _fail = True
            if _fail:
                self.return_code = fatal_exit_code
                self.fatal("Halting on failure while running %s" % command,
        if return_type == 'num_errors':
            return parser.num_errors
        return returncode

    def get_output_from_command(self, command, cwd=None,
                                halt_on_failure=False, env=None,
                                silent=False, log_level=INFO,
                                return_type='output', save_tmpfiles=False,
                                throw_exception=False, fatal_exit_code=2):
        """Similar to run_command, but where run_command is an
        os.system(command) analog, get_output_from_command is a `command`

        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
  "Getting output from command: %s in %s" % (command, cwd))
  "Getting output from command: %s" % command)
        if isinstance(command, list):
  "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
            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.exception(), level=level)
            return None
            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.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)
        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,
            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():
                    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,
            for line in errors.rstrip().splitlines():
                if not line or line.isspace():
                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.return_code = fatal_exit_code
            self.fatal("Halting on failure while running %s" % command,
        # 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)
            return output

    def _touch_file(self, file_name, times=None):
        """touch a file; If times is None, then the file's access and modified
           times are set to the current time
        """"Touching: %s" % file_name)
            os.utime(file_name, times)
        except OSError:
                open(file_name, 'w').close()
            except IOError as e:
                self.fatal("I/O error({0}): {1}".format(e.errno, e.strerror))

        os.utime(file_name, times)

    def unpack(self, filename, extract_to):
        This method allows us to extract a file regardless of its extension
        # XXX: Make sure that filename has a extension of one of our supported file formats
        m ='\.tar\.(bz2|gz)$', filename)
        if m:
            command = self.query_exe('tar', return_type='list')
            tar_cmd = "jxfv"
            if == "gz":
                tar_cmd = "zxfv"
            command.extend([tar_cmd, filename, "-C", extract_to])
            self.run_command(command, halt_on_failure=True)
            # XXX implement

def PreScriptRun(func):
    """Decorator for methods that will be called before script execution.

    Each method on a BaseScript having this decorator will be called at the
    beginning of

    The return value is ignored. Exceptions will abort execution.
    func._pre_run_listener = True
    return func

def PostScriptRun(func):
    """Decorator for methods that will be called after script execution.

    This is similar to PreScriptRun except it is called at the end of
    execution. The method will always be fired, even if execution fails.
    func._post_run_listener = True
    return func

def PreScriptAction(action=None):
    """Decorator for methods that will be called at the beginning of each action.

    Each method on a BaseScript having this decorator will be called during before an individual action is executed. The method will
    receive the action's name as an argument.

    If no values are passed to the decorator, it will be applied to every
    action. If a string is passed, the decorated function will only be called
    for the action of that name.

    The return value of the method is ignored. Exceptions will abort execution.
    def _wrapped(func):
        func._pre_action_listener = action
        return func

    def _wrapped_none(func):
        func._pre_action_listener = None
        return func

    if type(action) == type(_wrapped):
        return _wrapped_none(action)

    return _wrapped

def PostScriptAction(action=None):
    """Decorator for methods that will be called at the end of each action.

    This behaves similarly to PreScriptAction. It varies in that it is called
    after execution of the action.

    The decorated method will receive the action name as a positional argument.
    It will then receive the following named arguments:

        success - Bool indicating whether the action finished successfully.

    The decorated method will always be called, even if the action threw an

    The return value is ignored.
    def _wrapped(func):
        func._post_action_listener = action
        return func

    def _wrapped_none(func):
        func._post_action_listener = None
        return func

    if type(action) == type(_wrapped):
        return _wrapped_none(action)

    return _wrapped

# BaseScript {{{1
class BaseScript(ScriptMixin, LogMixin, object):
    def __init__(self, config_options=None, ConfigClass=BaseConfig,
                 default_log_level="info", **kwargs):
        super(BaseScript, self).__init__()

        # Collect decorated methods. We simply iterate over the attributes of
        # the current class instance and look for signatures deposited by
        # the decorators.
        self._listeners = dict(
        for k in dir(self):
            item = getattr(self, k)

            # We only decorate methods, so ignore other types.
            if not inspect.ismethod(item):

            if hasattr(item, '_pre_run_listener'):

            if hasattr(item, '_pre_action_listener'):

            if hasattr(item, '_post_action_listener'):

            if hasattr(item, '_post_run_listener'):

        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 = ConfigClass(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

        # 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._config_lock()"Run as %s" % rw_config.command_line)
        if self.config.get("dump_config_hierarchy"):
            # we only wish to dump and display what self.config is made up of,
            # against the current script + args, without actually running any
            # actions
        if self.config.get("dump_config"):

    def _dump_config_hierarchy(self, cfg_files):
        """ interpret each config file used.

        This will show which keys/values are being added or overwritten by
        other config files depending on their hierarchy (when they were added).
        # go through each config_file. We will start with the lowest and
        # print its keys/values that are being used in self.config. If any
        # keys/values are present in a config file with a higher precedence,
        # ignore those.
        dirs = self.query_abs_dirs()
        cfg_files_dump_config = {}  # we will dump this to file
        # keep track of keys that did not come from a config file
        keys_not_from_file = set(self.config.keys())
        if not cfg_files:
            cfg_files = []"Total config files: %d" % (len(cfg_files)))
        if len(cfg_files):
  "cfg files used from lowest precedence to highest:")
        for i, (target_file, target_dict) in enumerate(cfg_files):
            unique_keys = set(target_dict.keys())
            unique_dict = {}
            # iterate through the target_dicts remaining 'higher' cfg_files
            remaining_cfgs = cfg_files[slice(i + 1, len(cfg_files))]
            # where higher == more precedent
            for ii, (higher_file, higher_dict) in enumerate(remaining_cfgs):
                # now only keep keys/values that are not overwritten by a
                # higher config
                unique_keys = unique_keys.difference(set(higher_dict.keys()))
            # unique_dict we know now has only keys/values that are unique to
            # this config file.
            unique_dict = dict(
                (key, target_dict.get(key)) for key in unique_keys
            cfg_files_dump_config[target_file] = unique_dict
            self.action_message("Config File %d: %s" % (i + 1, target_file))
            # let's also find out which keys/values from self.config are not
            # from each target config file dict
            keys_not_from_file = keys_not_from_file.difference(
        not_from_file_dict = dict(
            (key, self.config.get(key)) for key in keys_not_from_file
        cfg_files_dump_config["not_from_cfg_file"] = not_from_file_dict
        self.action_message("Not from any config file (default_config, "
                            "cmd line options, etc)")

        # finally, let's dump this output as JSON and exit early
            os.path.join(dirs['abs_log_dir'], "localconfigfiles.json"),
            cfg_files_dump_config, console_output=False, exit_on_finish=True

    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.

    def _config_lock(self):
        """After this point, the config is locked and should not be
        manipulated (based on mozharness.base.config.ReadOnlyDict)

    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""""Copying logs to upload dir...")
        log_files = ['localconfig.json']
        for log_name in self.log_obj.log_files.keys():
        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,
                                    max_backups=self.config.get("log_max_rotate", 0))

    def run_action(self, action):
        if action not in self.actions:
            self.action_message("Skipping %s step." % action)

        method_name = action.replace("-", "_")
        self.action_message("Running %s step." % action)

        # An exception during a pre action listener should abort execution.
        for fn, target in self._listeners['pre_action']:
            if target is not None and target != action:

      "Running pre-action listener: %s" % fn)
                method = getattr(self, fn)
            except Exception:
                self.error("Exception during pre-action for %s: %s" % (
                    action, traceback.format_exc()))

                for fn, target in self._listeners['post_action']:
                    if target is not None and target != action:

              "Running post-action listener: %s" % fn)
                        method = getattr(self, fn)
                        method(action, success=False)
                    except Exception:
                        self.error("An additional exception occurred during "
                                   "post-action for %s: %s" % (action,

                self.fatal("Aborting due to exception in pre-action listener.")

        # We always run post action listeners, even if the main routine failed.
        success = False
  "Running main action method: %s" % method_name)
            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)
            success = True
            post_success = True
            for fn, target in self._listeners['post_action']:
                if target is not None and target != action:

          "Running post-action listener: %s" % fn)
                    method = getattr(self, fn)
                    method(action, success=success and self.return_code == 0)
                except Exception:
                    post_success = False
                    self.error("Exception during post-action for %s: %s" % (
                        action, traceback.format_exc()))

            if not post_success:
                self.fatal("Aborting due to failure in post-action listener.")

    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

        Postflight is quick testing for success after an action.

        for fn in self._listeners['pre_run']:
      "Running pre-run listener: %s" % fn)
                method = getattr(self, fn)
            except Exception:
                self.error("Exception during pre-run listener: %s" %

                for fn in self._listeners['post_run']:
                        method = getattr(self, fn)
                    except Exception:
                        self.error("An additional exception occurred during a "
                                   "post-run listener: %s" % traceback.format_exc())

                self.fatal("Aborting due to failure in pre-run listener.")

            for action in self.all_actions:
        except Exception:
            self.fatal("Uncaught exception: %s" % traceback.format_exc())
            post_success = True
            for fn in self._listeners['post_run']:
          "Running post-run listener: %s" % fn)
                    method = getattr(self, fn)
                except Exception:
                    post_success = False
                    self.error("Exception during post-run listener: %s" %

            if not post_success:
                self.fatal("Aborting due to failure in post-run listener.")
        if self.config.get("copy_logs_post_run", True):

        return self.return_code

    def run_and_exit(self):
        """Runs the script and exits the current interpreter."""

    def clobber(self):
        Delete the working directory
        dirs = self.query_abs_dirs()
        self.rmtree(dirs['abs_work_dir'], error_level=FATAL)

    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, config=None,
                    console_output=True, exit_on_finish=False):
        """Dump self.config to localconfig.json
        config = config or self.config
        dirs = self.query_abs_dirs()
        if not file_path:
            file_path = os.path.join(dirs['abs_log_dir'], "localconfig.json")"Dumping config to %s." % file_path)
        json_config = json.dumps(config, sort_keys=True, indent=4)
        fh =, encoding='utf-8', mode='w+')
        if console_output:
        if exit_on_finish:

    # 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)
            self.log_obj = SimpleFileLogger(**log_config)

    def action_message(self, message):"#####")"##### %s" % message)"#####")

    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:
                    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.add_summary(message % {'key': key}, level=level)
            if increment_return_code:
                self.return_code += 1

    def query_failure(self, key):
        return key in self.failures

    def summarize_success_count(self, success_count, total_count,
                                message="%d of %d successful.",
        if level is None:
            level = INFO
            if success_count < total_count:
                level = ERROR
        self.add_summary(message % (success_count, total_count),

    def copy_to_upload_dir(self, target, dest=None, short_desc="unknown",
                           long_desc="unknown", log_level=DEBUG,
                           error_level=ERROR, max_backups=None,
                           compress=False, upload_dir=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

        short_desc and long_desc are placeholders for if/when we add
        upload_dir manifests.
        dest_filename_given = dest is not None
        if upload_dir is None:
            upload_dir = self.query_abs_dirs()['abs_upload_dir']
        if dest is None:
            dest = os.path.basename(target)
        if dest.endswith('/'):
            dest_file = os.path.basename(target)
            dest_dir = os.path.join(upload_dir, dest)
            dest_filename_given = False
            dest_file = os.path.basename(dest)
            dest_dir = os.path.join(upload_dir, os.path.dirname(dest))
        if compress and not dest_filename_given:
            dest_file += ".gz"
        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
        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 max_backups:
                # 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, "%s.%d" % (dest_file, backup_num)),
                        self.move(os.path.join(dest_dir, "%s.%d" % (dest_file, backup_num)),
                                  os.path.join(dest_dir, "%s.%d" % (dest_file, backup_num + 1)),
                if self.move(dest, "%s.1" % dest, log_level=log_level):
                    self.log("Unable to move %s!" % dest, level=error_level)
                    return -1
                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, compress=compress)
        if os.path.exists(dest):
            return dest
            self.log("%s doesn't exist after copy!" % dest, level=error_level)
            return None

# __main__ {{{1
if __name__ == '__main__':