gecko/testing/xpcshell/runxpcshelltests.py

#!/usr/bin/env python
#
# ***** BEGIN LICENSE BLOCK *****
# Version: MPL 1.1/GPL 2.0/LGPL 2.1
#
# The contents of this file are subject to the Mozilla Public License Version
# 1.1 (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
# http://www.mozilla.org/MPL/
#
# Software distributed under the License is distributed on an "AS IS" basis,
# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
# for the specific language governing rights and limitations under the
# License.
#
# The Original Code is mozilla.org code.
#
# The Initial Developer of the Original Code is The Mozilla Foundation
# Portions created by the Initial Developer are Copyright (C) 2009
# the Initial Developer. All Rights Reserved.
#
# Contributor(s):
#  Serge Gautherie <sgautherie.bz@free.fr>
#  Ted Mielczarek <ted.mielczarek@gmail.com>
#  Joel Maher <joel.maher@gmail.com>
#
# Alternatively, the contents of this file may be used under the terms of
# either the GNU General Public License Version 2 or later (the "GPL"), or
# the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
# in which case the provisions of the GPL or the LGPL are applicable instead
# of those above. If you wish to allow use of your version of this file only
# under the terms of either the GPL or the LGPL, and not to allow others to
# use your version of this file under the terms of the MPL, indicate your
# decision by deleting the provisions above and replace them with the notice
# and other provisions required by the GPL or the LGPL. If you do not delete
# the provisions above, a recipient may use your version of this file under
# the terms of any one of the MPL, the GPL or the LGPL.
#
# ***** END LICENSE BLOCK ***** */

import re, sys, os, os.path, logging, shutil, signal
from glob import glob
from optparse import OptionParser
from subprocess import Popen, PIPE, STDOUT
from tempfile import mkdtemp

from automationutils import *

class XPCShellTests(object):

  log = logging.getLogger()
  oldcwd = os.getcwd()

  def __init__(self):
    # Init logging
    handler = logging.StreamHandler(sys.stdout)
    self.log.setLevel(logging.INFO)
    self.log.addHandler(handler)

  def readManifest(self, manifest):
    """Given a manifest file containing a list of test directories,
    return a list of absolute paths to the directories contained within."""
    manifestdir = os.path.dirname(manifest)
    testdirs = []
    try:
      f = open(manifest, "r")
      for line in f:
        dir = line.rstrip()
        path = os.path.join(manifestdir, dir)
        if os.path.isdir(path):
          testdirs.append(path)
      f.close()
    except:
      pass # just eat exceptions
    return testdirs

  def runTests(self, xpcshell, xrePath=None, symbolsPath=None,
               manifest=None, testdirs=[], testPath=None,
               interactive=False, logfiles=True,
               debuggerInfo=None):
    """Run xpcshell tests.

    |xpcshell|, is the xpcshell executable to use to run the tests.
    |xrePath|, if provided, is the path to the XRE to use.
    |symbolsPath|, if provided is the path to a directory containing
      breakpad symbols for processing crashes in tests.
    |manifest|, if provided, is a file containing a list of
      test directories to run.
    |testdirs|, if provided, is a list of absolute paths of test directories.
      No-manifest only option.
    |testPath|, if provided, indicates a single path and/or test to run.
    |interactive|, if set to True, indicates to provide an xpcshell prompt
      instead of automatically executing the test.
    |logfiles|, if set to False, indicates not to save output to log files.
      Non-interactive only option.
    |debuggerInfo|, if set, specifies the debugger and debugger arguments
      that will be used to launch xpcshell.
    """

    if not testdirs and not manifest:
      # nothing to test!
      print >>sys.stderr, "Error: No test dirs or test manifest specified!"
      return False

    passCount = 0
    failCount = 0

    testharnessdir = os.path.dirname(os.path.abspath(__file__))
    xpcshell = os.path.abspath(xpcshell)
    # we assume that httpd.js lives in components/ relative to xpcshell
    httpdJSPath = os.path.join(os.path.dirname(xpcshell), "components", "httpd.js").replace("\\", "/");

    env = dict(os.environ)
    # Make assertions fatal
    env["XPCOM_DEBUG_BREAK"] = "stack-and-abort"
    # Don't launch the crash reporter client
    env["MOZ_CRASHREPORTER_NO_REPORT"] = "1"

    if xrePath is None:
      xrePath = os.path.dirname(xpcshell)
    else:
      xrePath = os.path.abspath(xrePath)
    if sys.platform == 'win32':
      env["PATH"] = env["PATH"] + ";" + xrePath
    elif sys.platform in ('os2emx', 'os2knix'):
      os.environ["BEGINLIBPATH"] = xrePath + ";" + env["BEGINLIBPATH"]
      os.environ["LIBPATHSTRICT"] = "T"
    elif sys.platform == 'osx':
      env["DYLD_LIBRARY_PATH"] = xrePath
    else: # unix or linux?
      env["LD_LIBRARY_PATH"] = xrePath

    # xpcsRunArgs: <head.js> function to call to run the test.
    # pStdout, pStderr: Parameter values for later |Popen()| call.
    if interactive:
      xpcsRunArgs = [
      '-e', 'print("To start the test, type |_execute_test();|.");',
      '-i']
      pStdout = None
      pStderr = None
    else:
      xpcsRunArgs = ['-e', '_execute_test();']
      if (debuggerInfo and debuggerInfo["interactive"]):
        pStdout = None
        pStderr = None
      else:
        if sys.platform == 'os2emx':
          pStdout = None
        else:
          pStdout = PIPE
        pStderr = STDOUT

    # <head.js> has to be loaded by xpchell: it can't load itself.
    xpcsCmd = [xpcshell, '-g', xrePath, '-j', '-s'] + \
              ['-e', 'const _HTTPD_JS_PATH = "%s";' % httpdJSPath,
              '-f', os.path.join(testharnessdir, 'head.js')]

    if debuggerInfo:
      xpcsCmd = [debuggerInfo["path"]] + debuggerInfo["args"] + xpcsCmd

    # |testPath| will be the optional path only, or |None|.
    # |singleFile| will be the optional test only, or |None|.
    singleFile = None
    if testPath:
      if testPath.endswith('.js'):
        # Split into path and file.
        if testPath.find('/') == -1:
          # Test only.
          singleFile = testPath
          testPath = None
        else:
          # Both path and test.
          # Reuse |testPath| temporarily.
          testPath = testPath.rsplit('/', 1)
          singleFile = testPath[1]
          testPath = testPath[0]
      else:
        # Path only.
        # Simply remove optional ending separator.
        testPath = testPath.rstrip("/")

    # Override testdirs.
    if manifest is not None:
      testdirs = self.readManifest(os.path.abspath(manifest))

    # Process each test directory individually.
    for testdir in testdirs:
      if testPath and not testdir.endswith(testPath):
        continue

      testdir = os.path.abspath(testdir)

      # get the list of head and tail files from the directory
      testHeadFiles = []
      for f in sorted(glob(os.path.join(testdir, "head_*.js"))):
        if os.path.isfile(f):
          testHeadFiles += [f]
      testTailFiles = []
      # Tails are executed in the reverse order, to "match" heads order,
      # as in "h1-h2-h3 then t3-t2-t1".
      for f in reversed(sorted(glob(os.path.join(testdir, "tail_*.js")))):
        if os.path.isfile(f):
          testTailFiles += [f]

      # if a single test file was specified, we only want to execute that test
      testfiles = sorted(glob(os.path.join(testdir, "test_*.js")))
      if singleFile:
        if singleFile in [os.path.basename(x) for x in testfiles]:
          testfiles = [os.path.join(testdir, singleFile)]
        else: # not in this dir? skip it
          continue

      cmdH = ", ".join(['"' + f.replace('\\', '/') + '"'
                 for f in testHeadFiles])
      cmdT = ", ".join(['"' + f.replace('\\', '/') + '"'
                 for f in testTailFiles])
      cmdH = xpcsCmd + \
                ['-e', 'const _SERVER_ADDR = "localhost";'] + \
                ['-e', 'const _HEAD_FILES = [%s];' % cmdH] + \
                ['-e', 'const _TAIL_FILES = [%s];' % cmdT]

      # Now execute each test individually.
      for test in testfiles:
        # The test file will have to be loaded after the head files.
        cmdT = ['-e', 'const _TEST_FILE = ["%s"];' %
                os.path.join(testdir, test).replace('\\', '/')]

        # create a temp dir that the JS harness can stick a profile in
        profileDir = None
        try:
          profileDir = mkdtemp()
          env["XPCSHELL_TEST_PROFILE_DIR"] = profileDir

          # Enable leaks (only) detection to its own log file.
          leakLogFile = os.path.join(profileDir, "runxpcshelltests_leaks.log")
          env["XPCOM_MEM_LEAK_LOG"] = leakLogFile

          proc = Popen(cmdH + cmdT + xpcsRunArgs,
                      stdout=pStdout, stderr=pStderr, env=env, cwd=testdir)

          # allow user to kill hung subprocess with SIGINT w/o killing this script
          # - don't move this line above Popen, or child will inherit the SIG_IGN
          signal.signal(signal.SIGINT, signal.SIG_IGN)
          # |stderr == None| as |pStderr| was either |None| or redirected to |stdout|.
          stdout, stderr = proc.communicate()
          signal.signal(signal.SIGINT, signal.SIG_DFL)

          if interactive:
            # Not sure what else to do here...
            return True

          if proc.returncode != 0 or (stdout and re.search("^TEST-UNEXPECTED-FAIL", stdout, re.MULTILINE)):
            print """TEST-UNEXPECTED-FAIL | %s | test failed (with xpcshell return code: %d), see following log:
  >>>>>>>
  %s
  <<<<<<<""" % (test, proc.returncode, stdout)
            failCount += 1
          else:
            print "TEST-PASS | %s | test passed" % test
            passCount += 1

          checkForCrashes(testdir, symbolsPath, testName=test)
          dumpLeakLog(leakLogFile, True)

          if logfiles and stdout:
            try:
              f = open(test + ".log", "w")
              f.write(stdout)

              if os.path.exists(leakLogFile):
                leaks = open(leakLogFile, "r")
                f.write(leaks.read())
                leaks.close()
            finally:
              if f:
                f.close()
        finally:
          if profileDir:
            shutil.rmtree(profileDir)

    if passCount == 0 and failCount == 0:
      print "TEST-UNEXPECTED-FAIL | runxpcshelltests.py | No tests run. Did you pass an invalid --test-path?"
      failCount = 1

    print """INFO | Result summary:
INFO | Passed: %d
INFO | Failed: %d""" % (passCount, failCount)

    return failCount == 0

def main():
  """Process command line arguments and call runTests() to do the real work."""
  parser = OptionParser()

  addCommonOptions(parser)
  parser.add_option("--interactive",
                    action="store_true", dest="interactive", default=False,
                    help="don't automatically run tests, drop to an xpcshell prompt")
  parser.add_option("--logfiles",
                    action="store_true", dest="logfiles", default=True,
                    help="create log files (default, only used to override --no-logfiles)")
  parser.add_option("--manifest",
                    type="string", dest="manifest", default=None,
                    help="Manifest of test directories to use")
  parser.add_option("--no-logfiles",
                    action="store_false", dest="logfiles",
                    help="don't create log files")
  parser.add_option("--test-path",
                    type="string", dest="testPath", default=None,
                    help="single path and/or test filename to test")
  options, args = parser.parse_args()

  if len(args) < 2 and options.manifest is None or \
     (len(args) < 1 and options.manifest is not None):
     print >>sys.stderr, """Usage: %s <path to xpcshell> <test dirs>
           or: %s --manifest=test.manifest <path to xpcshell>""" % (sys.argv[0],
                                                           sys.argv[0])
     sys.exit(1)

  xpcsh = XPCShellTests()
  debuggerInfo = getDebuggerInfo(xpcsh.oldcwd, options.debugger, options.debuggerArgs,
    options.debuggerInteractive);

  if options.interactive and not options.testPath:
    print >>sys.stderr, "Error: You must specify a test filename in interactive mode!"
    sys.exit(1)

    
  if not xpcsh.runTests(args[0],
                        xrePath=options.xrePath,
                        symbolsPath=options.symbolsPath,
                        manifest=options.manifest,
                        testdirs=args[1:],
                        testPath=options.testPath,
                        interactive=options.interactive,
                        logfiles=options.logfiles,
                        debuggerInfo=debuggerInfo):
    sys.exit(1)

if __name__ == '__main__':
  main()