testing/performance/talos/ffprocess.py

   1 # ***** BEGIN LICENSE BLOCK *****
   2 # Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3 #
   4 # The contents of this file are subject to the Mozilla Public License Version
   5 # 1.1 (the "License"); you may not use this file except in compliance with
   6 # the License. You may obtain a copy of the License at
   7 # http://www.mozilla.org/MPL/
   8 #
   9 # Software distributed under the License is distributed on an "AS IS" basis,
  10 # WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11 # for the specific language governing rights and limitations under the
  12 # License.
  13 #
  14 # The Original Code is standalone Firefox Windows performance test.
  15 #
  16 # The Initial Developer of the Original Code is Google Inc.
  17 # Portions created by the Initial Developer are Copyright (C) 2006
  18 # the Initial Developer. All Rights Reserved.
  19 #
  20 # Contributor(s):
  21 #   Annie Sullivan <annie.sullivan@gmail.com> (original author)
  22 #
  23 # Alternatively, the contents of this file may be used under the terms of
  24 # either the GNU General Public License Version 2 or later (the "GPL"), or
  25 # the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26 # in which case the provisions of the GPL or the LGPL are applicable instead
  27 # of those above. If you wish to allow use of your version of this file only
  28 # under the terms of either the GPL or the LGPL, and not to allow others to
  29 # use your version of this file under the terms of the MPL, indicate your
  30 # decision by deleting the provisions above and replace them with the notice
  31 # and other provisions required by the GPL or the LGPL. If you do not delete
  32 # the provisions above, a recipient may use your version of this file under
  33 # the terms of any one of the MPL, the GPL or the LGPL.
  34 #
  35 # ***** END LICENSE BLOCK *****
  36
  37 """A set of functions for process management on Windows.
  38 """
  39
  40 __author__ = 'annie.sullivan@gmail.com (Annie Sullivan)'
  41
  42
  43
  44 import platform
  45 import os
  46 import re
  47 import time
  48 import subprocess
  49
  50 if platform.system() == "Linux":
  51     from ffprocess_linux import *
  52 elif platform.system() in ("Windows", "Microsoft"):
  53     from ffprocess_win32 import *
  54 elif platform.system() == "Darwin":
  55     from ffprocess_mac import *
  56
  57
  58
  59 def Sleep():
  60   """Runs sync and sleeps for a few seconds between Firefox runs.
  61      Otherwise "Firefox is already running.." errors occur
  62   """
  63   time.sleep(5)
  64
  65
  66 def RunProcessAndWaitForOutput(command, process_name, output_regex, timeout):
  67   """Runs the given process and waits for the output that matches the given
  68      regular expression.  Stops if the process exits early or times out.
  69
  70   Args:
  71     command: String containing command to run
  72     process_name: Name of the process to run, in case it has to be killed
  73     output_regex: Regular expression to check against each output line.
  74                   If the output matches, the process is terminated and
  75                   the function returns.
  76     timeout: Time to wait before terminating the process and returning
  77
  78   Returns:
  79     A tuple (match, timedout) where match is the match of the regular
  80     expression, and timed out is true if the process timed out and
  81     false otherwise.
  82   """
  83
  84   # Start the process
  85   process = subprocess.Popen(command, stdout=subprocess.PIPE, universal_newlines=True, shell=True, env=os.environ)
  86   handle = process.stdout
  87
  88   # Wait for it to print output, terminate, or time out.
  89   time_elapsed = 0
  90   output = ''
  91   interval = 2 # Wait 2 seconds in between checks
  92
  93   while time_elapsed < timeout:
  94     time.sleep(interval)
  95     time_elapsed += interval
  96
  97     (bytes, current_output) = NonBlockingReadProcessOutput(handle)
  98     output += current_output
  99
 100     result = output_regex.search(output)
 101     if result:
 102       try:
 103         return_val = result.group(1)
 104         TerminateAllProcesses(process_name)
 105         return (return_val, False)
 106       except IndexError:
 107         # Didn't really match
 108         pass
 109
 110   # Timed out.
 111   TerminateAllProcesses(process_name)
 112   return (None, True)