mirror of
https://gitlab.winehq.org/wine/wine-gecko.git
synced 2024-09-13 09:24:08 -07:00
292 lines
12 KiB
Python
292 lines
12 KiB
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 http://mozilla.org/MPL/2.0/.
|
|
|
|
"""
|
|
Runs the reftest test harness.
|
|
"""
|
|
|
|
import sys, shutil, os, os.path
|
|
SCRIPT_DIRECTORY = os.path.abspath(os.path.realpath(os.path.dirname(sys.argv[0])))
|
|
sys.path.append(SCRIPT_DIRECTORY)
|
|
|
|
from automation import Automation
|
|
from automationutils import *
|
|
from optparse import OptionParser
|
|
from tempfile import mkdtemp
|
|
|
|
class RefTest(object):
|
|
|
|
oldcwd = os.getcwd()
|
|
|
|
def __init__(self, automation):
|
|
self.automation = automation
|
|
|
|
def getFullPath(self, path):
|
|
"Get an absolute path relative to self.oldcwd."
|
|
return os.path.normpath(os.path.join(self.oldcwd, os.path.expanduser(path)))
|
|
|
|
def getManifestPath(self, path):
|
|
"Get the path of the manifest, and for remote testing this function is subclassed to point to remote manifest"
|
|
path = self.getFullPath(path)
|
|
if os.path.isdir(path):
|
|
defaultManifestPath = os.path.join(path, 'reftest.list')
|
|
if os.path.exists(defaultManifestPath):
|
|
path = defaultManifestPath
|
|
else:
|
|
defaultManifestPath = os.path.join(path, 'crashtests.list')
|
|
if os.path.exists(defaultManifestPath):
|
|
path = defaultManifestPath
|
|
return path
|
|
|
|
def createReftestProfile(self, options, profileDir, manifest, server='localhost'):
|
|
"""
|
|
Sets up a profile for reftest.
|
|
'manifest' is the path to the reftest.list file we want to test with. This is used in
|
|
the remote subclass in remotereftest.py so we can write it to a preference for the
|
|
bootstrap extension.
|
|
"""
|
|
|
|
self.automation.setupPermissionsDatabase(profileDir,
|
|
{'allowXULXBL': [(server, True), ('<file>', True)]})
|
|
|
|
# Set preferences for communication between our command line arguments
|
|
# and the reftest harness. Preferences that are required for reftest
|
|
# to work should instead be set in reftest-cmdline.js .
|
|
prefsFile = open(os.path.join(profileDir, "user.js"), "a")
|
|
prefsFile.write('user_pref("reftest.timeout", %d);\n' % (options.timeout * 1000))
|
|
|
|
if options.totalChunks != None:
|
|
prefsFile.write('user_pref("reftest.totalChunks", %d);\n' % options.totalChunks)
|
|
if options.thisChunk != None:
|
|
prefsFile.write('user_pref("reftest.thisChunk", %d);\n' % options.thisChunk)
|
|
if options.logFile != None:
|
|
prefsFile.write('user_pref("reftest.logFile", "%s");\n' % options.logFile)
|
|
if options.ignoreWindowSize != False:
|
|
prefsFile.write('user_pref("reftest.ignoreWindowSize", true);\n')
|
|
|
|
for v in options.extraPrefs:
|
|
thispref = v.split("=")
|
|
if len(thispref) < 2:
|
|
print "Error: syntax error in --setpref=" + v
|
|
sys.exit(1)
|
|
part = 'user_pref("%s", %s);\n' % (thispref[0], thispref[1])
|
|
prefsFile.write(part)
|
|
prefsFile.close()
|
|
|
|
# install the reftest extension bits into the profile
|
|
self.automation.installExtension(os.path.join(SCRIPT_DIRECTORY, "reftest"),
|
|
profileDir,
|
|
"reftest@mozilla.org")
|
|
|
|
# I would prefer to use "--install-extension reftest/specialpowers", but that requires tight coordination with
|
|
# release engineering and landing on multiple branches at once.
|
|
if manifest.endswith('crashtests.list'):
|
|
self.automation.installExtension(os.path.join(SCRIPT_DIRECTORY, "specialpowers"),
|
|
profileDir,
|
|
"special-powers@mozilla.org")
|
|
|
|
def buildBrowserEnv(self, options, profileDir):
|
|
browserEnv = self.automation.environment(xrePath = options.xrePath)
|
|
browserEnv["XPCOM_DEBUG_BREAK"] = "stack"
|
|
|
|
for v in options.environment:
|
|
ix = v.find("=")
|
|
if ix <= 0:
|
|
print "Error: syntax error in --setenv=" + v
|
|
return None
|
|
browserEnv[v[:ix]] = v[ix + 1:]
|
|
|
|
# Enable leaks detection to its own log file.
|
|
self.leakLogFile = os.path.join(profileDir, "runreftest_leaks.log")
|
|
browserEnv["XPCOM_MEM_BLOAT_LOG"] = self.leakLogFile
|
|
return browserEnv
|
|
|
|
def cleanup(self, profileDir):
|
|
if profileDir:
|
|
shutil.rmtree(profileDir, True)
|
|
|
|
def runTests(self, testPath, options, cmdlineArgs = None):
|
|
debuggerInfo = getDebuggerInfo(self.oldcwd, options.debugger, options.debuggerArgs,
|
|
options.debuggerInteractive);
|
|
|
|
profileDir = None
|
|
try:
|
|
reftestlist = self.getManifestPath(testPath)
|
|
if cmdlineArgs == None:
|
|
cmdlineArgs = ['-reftest', reftestlist]
|
|
profileDir = mkdtemp()
|
|
self.copyExtraFilesToProfile(options, profileDir)
|
|
self.createReftestProfile(options, profileDir, reftestlist)
|
|
self.installExtensionsToProfile(options, profileDir)
|
|
|
|
# browser environment
|
|
browserEnv = self.buildBrowserEnv(options, profileDir)
|
|
|
|
self.automation.log.info("REFTEST INFO | runreftest.py | Running tests: start.\n")
|
|
status = self.automation.runApp(None, browserEnv, options.app, profileDir,
|
|
cmdlineArgs,
|
|
utilityPath = options.utilityPath,
|
|
xrePath=options.xrePath,
|
|
debuggerInfo=debuggerInfo,
|
|
symbolsPath=options.symbolsPath,
|
|
# give the JS harness 30 seconds to deal
|
|
# with its own timeouts
|
|
timeout=options.timeout + 30.0)
|
|
processLeakLog(self.leakLogFile, options.leakThreshold)
|
|
self.automation.log.info("\nREFTEST INFO | runreftest.py | Running tests: end.")
|
|
finally:
|
|
self.cleanup(profileDir)
|
|
return status
|
|
|
|
def copyExtraFilesToProfile(self, options, profileDir):
|
|
"Copy extra files or dirs specified on the command line to the testing profile."
|
|
for f in options.extraProfileFiles:
|
|
abspath = self.getFullPath(f)
|
|
if os.path.isfile(abspath):
|
|
shutil.copy2(abspath, profileDir)
|
|
elif os.path.isdir(abspath):
|
|
dest = os.path.join(profileDir, os.path.basename(abspath))
|
|
shutil.copytree(abspath, dest)
|
|
else:
|
|
self.automation.log.warning("WARNING | runreftest.py | Failed to copy %s to profile", abspath)
|
|
continue
|
|
|
|
def installExtensionsToProfile(self, options, profileDir):
|
|
"Install application distributed extensions and specified on the command line ones to testing profile."
|
|
# Install distributed extensions, if application has any.
|
|
distExtDir = os.path.join(options.app[ : options.app.rfind(os.sep)], "distribution", "extensions")
|
|
if os.path.isdir(distExtDir):
|
|
for f in os.listdir(distExtDir):
|
|
self.automation.installExtension(os.path.join(distExtDir, f), profileDir)
|
|
|
|
# Install custom extensions.
|
|
for f in options.extensionsToInstall:
|
|
self.automation.installExtension(self.getFullPath(f), profileDir)
|
|
|
|
|
|
class ReftestOptions(OptionParser):
|
|
|
|
def __init__(self, automation):
|
|
self._automation = automation
|
|
OptionParser.__init__(self)
|
|
defaults = {}
|
|
|
|
# we want to pass down everything from automation.__all__
|
|
addCommonOptions(self,
|
|
defaults=dict(zip(self._automation.__all__,
|
|
[getattr(self._automation, x) for x in self._automation.__all__])))
|
|
self._automation.addCommonOptions(self)
|
|
self.add_option("--appname",
|
|
action = "store", type = "string", dest = "app",
|
|
default = os.path.join(SCRIPT_DIRECTORY, automation.DEFAULT_APP),
|
|
help = "absolute path to application, overriding default")
|
|
self.add_option("--extra-profile-file",
|
|
action = "append", dest = "extraProfileFiles",
|
|
default = [],
|
|
help = "copy specified files/dirs to testing profile")
|
|
self.add_option("--timeout",
|
|
action = "store", dest = "timeout", type = "int",
|
|
default = 5 * 60, # 5 minutes per bug 479518
|
|
help = "reftest will timeout in specified number of seconds. [default %default s].")
|
|
self.add_option("--leak-threshold",
|
|
action = "store", type = "int", dest = "leakThreshold",
|
|
default = 0,
|
|
help = "fail if the number of bytes leaked through "
|
|
"refcounted objects (or bytes in classes with "
|
|
"MOZ_COUNT_CTOR and MOZ_COUNT_DTOR) is greater "
|
|
"than the given number")
|
|
self.add_option("--utility-path",
|
|
action = "store", type = "string", dest = "utilityPath",
|
|
default = self._automation.DIST_BIN,
|
|
help = "absolute path to directory containing utility "
|
|
"programs (xpcshell, ssltunnel, certutil)")
|
|
defaults["utilityPath"] = self._automation.DIST_BIN
|
|
|
|
self.add_option("--total-chunks",
|
|
type = "int", dest = "totalChunks",
|
|
help = "how many chunks to split the tests up into")
|
|
defaults["totalChunks"] = None
|
|
|
|
self.add_option("--this-chunk",
|
|
type = "int", dest = "thisChunk",
|
|
help = "which chunk to run between 1 and --total-chunks")
|
|
defaults["thisChunk"] = None
|
|
|
|
self.add_option("--log-file",
|
|
action = "store", type = "string", dest = "logFile",
|
|
default = None,
|
|
help = "file to log output to in addition to stdout")
|
|
defaults["logFile"] = None
|
|
|
|
self.add_option("--skip-slow-tests",
|
|
dest = "skipSlowTests", action = "store_true",
|
|
help = "skip tests marked as slow when running")
|
|
defaults["skipSlowTests"] = False
|
|
|
|
self.add_option("--ignore-window-size",
|
|
dest = "ignoreWindowSize", action = "store_true",
|
|
help = "ignore the window size, which may cause spurious failures and passes")
|
|
defaults["ignoreWindowSize"] = False
|
|
|
|
self.add_option("--install-extension",
|
|
action = "append", dest = "extensionsToInstall",
|
|
help = "install the specified extension in the testing profile."
|
|
"The extension file's name should be <id>.xpi where <id> is"
|
|
"the extension's id as indicated in its install.rdf."
|
|
"An optional path can be specified too.")
|
|
defaults["extensionsToInstall"] = []
|
|
|
|
self.add_option("--setenv",
|
|
action = "append", type = "string",
|
|
dest = "environment", metavar = "NAME=VALUE",
|
|
help = "sets the given variable in the application's "
|
|
"environment")
|
|
defaults["environment"] = []
|
|
|
|
self.set_defaults(**defaults)
|
|
|
|
def main():
|
|
automation = Automation()
|
|
parser = ReftestOptions(automation)
|
|
reftest = RefTest(automation)
|
|
|
|
options, args = parser.parse_args()
|
|
if len(args) != 1:
|
|
print >>sys.stderr, "No reftest.list specified."
|
|
sys.exit(1)
|
|
|
|
options.app = reftest.getFullPath(options.app)
|
|
if not os.path.exists(options.app):
|
|
print """Error: Path %(app)s doesn't exist.
|
|
Are you executing $objdir/_tests/reftest/runreftest.py?""" \
|
|
% {"app": options.app}
|
|
sys.exit(1)
|
|
|
|
if options.xrePath is None:
|
|
options.xrePath = os.path.dirname(options.app)
|
|
else:
|
|
# allow relative paths
|
|
options.xrePath = reftest.getFullPath(options.xrePath)
|
|
|
|
if options.symbolsPath and not isURL(options.symbolsPath):
|
|
options.symbolsPath = reftest.getFullPath(options.symbolsPath)
|
|
options.utilityPath = reftest.getFullPath(options.utilityPath)
|
|
|
|
if options.totalChunks is not None and options.thisChunk is None:
|
|
print "thisChunk must be specified when totalChunks is specified"
|
|
sys.exit(1)
|
|
|
|
if options.totalChunks:
|
|
if not 1 <= options.thisChunk <= options.totalChunks:
|
|
print "thisChunk must be between 1 and totalChunks"
|
|
sys.exit(1)
|
|
|
|
if options.logFile:
|
|
options.logFile = reftest.getFullPath(options.logFile)
|
|
|
|
sys.exit(reftest.runTests(args[0], options))
|
|
|
|
if __name__ == "__main__":
|
|
main()
|