Improved memory tool test wrapper script
* Clarified that the test only supports specifying a single test (multiple didn't work before, so better not claim to support it).
* No longer needs test executable arguments to use ++ instead of --
* Only appends the build_dir path to the test executable if not already
present.
* Simplified suppression path handling.
* Fixed crash when -v was used (import logging was missing)
* Style fixes.
* Thorougly tested with all the supported flags.
I noted that the --gtest_filter flag does not work as expected (it's
only for 'additional gtest_filter arguments', which seems to mean
additional arguments to the gtest filter text files that are used by
Chrome. I left it in here anyway. If --gtest_filter is given after the
test executable it will work, since those arguments are added straight
to the test executable
the test
BUG=none
TEST=I ran the following commands and verified that the suppressions and flags were handled correct:
tools/valgrind-webrtc/webrtc_tests.sh -v --gtest_repeat=2 --keep_logs --tool_flags=--trace-children=yes -t out/Debug/test_support_unittests --foo --bar
tools/valgrind-webrtc/webrtc_tests.sh -v --gtest_repeat=2 --keep_logs --tool_flags=--trace-children=yes -b out/Debug -t test_support_unittests --foo --bar
tools/valgrind-webrtc/webrtc_tests.sh -v --gtest_repeat=2 --keep_logs --tool_flags=--trace-children=yes -b out/Debug -t out/Debug/test_support_unittests --foo --bar
tools/valgrind-webrtc/webrtc_tests.sh -v --tool=tsan --gtest_repeat=2 --keep_logs --tool_flags=--trace-children=yes -t out/Debug/test_support_unittests --foo --bar
tools/valgrind-webrtc/webrtc_tests.sh -v --tool=tsan --gtest_repeat=2 --keep_logs --tool_flags=--trace-children=yes -b out/Debug -t test_support_unittests --foo --bar
tools/valgrind-webrtc/webrtc_tests.sh -v --tool=tsan --gtest_repeat=2 --keep_logs --tool_flags=--trace-children=yes -b out/Debug -t out/Debug/test_support_unittests --foo --bar
Review URL: https://webrtc-codereview.appspot.com/1029005
git-svn-id: http://webrtc.googlecode.com/svn/trunk@3354 4adac7df-926f-26a2-2b94-8c16560cd09d
diff --git a/tools/valgrind-webrtc/webrtc_tests.py b/tools/valgrind-webrtc/webrtc_tests.py
index 028759f..d97dff2 100755
--- a/tools/valgrind-webrtc/webrtc_tests.py
+++ b/tools/valgrind-webrtc/webrtc_tests.py
@@ -7,14 +7,11 @@
# in the file PATENTS. All contributing project authors may
# be found in the AUTHORS file in the root of the source tree.
-'''Runs various WebRTC tests through valgrind_test.py.
+"""Runs various WebRTC tests through valgrind_test.py.
-This script inherits the chrome_tests.py in Chrome, replacing its tests. We do
-this by taking chrome's faux cmdline test and making that the standard, so that
-we effectively can pass in any binary we feel like. It's also possible to pass
-arguments to the test, provided that the arguments do not contain dashes (these
-can be "escaped" by passing + instead, so -a becomes +a, and --my-option becomes
-++my_option).
+This script inherits the chrome_tests.py in Chrome, but allows running any test
+instead of only the hard-coded ones. It uses the -t cmdline flag to do this, and
+only supports specifying a single test for each run.
Suppression files:
The Chrome valgrind directory we use as a DEPS dependency contains the following
@@ -28,8 +25,9 @@
below the directory of this script. When executing, this script will setup both
Chrome's suppression files and our own, so we can easily maintain WebRTC
specific suppressions in our own files.
-'''
+"""
+import logging
import optparse
import os
import sys
@@ -39,7 +37,8 @@
import chrome_tests
-class WebRTCTests(chrome_tests.ChromeTests):
+
+class WebRTCTest(chrome_tests.ChromeTests):
"""Class that handles setup of suppressions for WebRTC.
Everything else is inherited from chrome_tests.ChromeTests.
@@ -61,53 +60,40 @@
# ../valgrind. If we would simply replace 'valgrind-webrtc' with 'valgrind'
# we may produce invalid paths if other parts of the path contain that
# string. That's why the code below only replaces the end of the path.
- old_base, old_dir = _split_script_path()
- new_dir = old_base + 'valgrind'
+ script_dir = path_utils.ScriptDir()
+ old_base, _ = os.path.split(script_dir)
+ new_dir = os.path.join(old_base, 'valgrind')
add_suppressions = []
for token in cmd:
if '--suppressions' in token:
- add_suppressions.append(token.replace(old_base + old_dir, new_dir))
+ add_suppressions.append(token.replace(script_dir, new_dir))
return add_suppressions + cmd
-def _split_script_path():
- """Splits the script's path into a tuple separating the last directory.
-
- Returns a tuple where the first item is the whole path except the last
- directory and the second item is the name of the last directory.
- """
- script_dir = path_utils.ScriptDir()
- last_sep_index = script_dir.rfind(os.sep)
- return script_dir[0:last_sep_index+1], script_dir[last_sep_index+1:]
-
-
-def _main(_):
- parser = optparse.OptionParser("usage: %prog -b <dir> -t <test> "
- "[-t <test> ...] <arguments to all tests>"
- "NOTE: when passing arguments to all tests, "
- " replace any - with +.")
- parser.add_option("-b", "--build_dir",
- help="the location of the compiler output")
- parser.add_option("-t", "--test", action="append", default=[],
- help="which test to run, supports test:gtest_filter format "
- "as well.")
- parser.add_option("", "--baseline", action="store_true", default=False,
- help="generate baseline data instead of validating")
- parser.add_option("", "--gtest_filter",
- help="additional arguments to --gtest_filter")
- parser.add_option("", "--gtest_repeat",
- help="argument for --gtest_repeat")
- parser.add_option("-v", "--verbose", action="store_true", default=False,
- help="verbose output - enable debug log messages")
- parser.add_option("", "--tool", dest="valgrind_tool", default="memcheck",
- help="specify a valgrind tool to run the tests under")
- parser.add_option("", "--tool_flags", dest="valgrind_tool_flags", default="",
- help="specify custom flags for the selected valgrind tool")
- parser.add_option("", "--keep_logs", action="store_true", default=False,
- help="store memory tool logs in the <tool>.logs directory "
- "instead of /tmp.\nThis can be useful for tool "
- "developers/maintainers.\nPlease note that the <tool>"
- ".logs directory will be clobbered on tool startup.")
+def main(_):
+ parser = optparse.OptionParser('usage: %prog -b <dir> -t <test> <test args>')
+ parser.disable_interspersed_args()
+ parser.add_option('-b', '--build_dir',
+ help=('Location of the compiler output. Can only be used '
+ 'when the test argument does not contain this path.'))
+ parser.add_option('-t', '--test', help='Test to run.')
+ parser.add_option('', '--baseline', action='store_true', default=False,
+ help='Generate baseline data instead of validating')
+ parser.add_option('', '--gtest_filter',
+ help='Additional arguments to --gtest_filter')
+ parser.add_option('', '--gtest_repeat',
+ help='Argument for --gtest_repeat')
+ parser.add_option('-v', '--verbose', action='store_true', default=False,
+ help='Verbose output - enable debug log messages')
+ parser.add_option('', '--tool', dest='valgrind_tool', default='memcheck',
+ help='Specify a valgrind tool to run the tests under')
+ parser.add_option('', '--tool_flags', dest='valgrind_tool_flags', default='',
+ help='Specify custom flags for the selected valgrind tool')
+ parser.add_option('', '--keep_logs', action='store_true', default=False,
+ help=('Store memory tool logs in the <tool>.logs directory '
+ 'instead of /tmp.\nThis can be useful for tool '
+ 'developers/maintainers.\nPlease note that the <tool>'
+ '.logs directory will be clobbered on tool startup.'))
options, args = parser.parse_args()
if options.verbose:
@@ -116,39 +102,20 @@
logging_utils.config_root()
if not options.test:
- parser.error("--test not specified")
+ parser.error('--test not specified')
- if len(options.test) != 1 and options.gtest_filter:
- parser.error("--gtest_filter and multiple tests don't make sense together")
-
- # If --build_dir is provided, prepend that path to the test name to make it a
- # valid path when running on the build slaves using Chromium's runtest.py
- if options.build_dir and 'cmdline' in options.test:
+ # If --build_dir is provided, prepend it to the test executable if needed.
+ if options.build_dir and not args[0].startswith(options.build_dir):
args[0] = os.path.join(options.build_dir, args[0])
- # Performs the deferred-argument black magic described in the usage.
- translated_args = map(lambda arg: arg.replace('+', '-'), args)
+ test = WebRTCTest(options, args, options.test)
+ return test.Run()
- for t in options.test:
- tests = WebRTCTests(options, translated_args, t)
- ret = tests.Run()
- if ret: return ret
- return 0
-
-if __name__ == "__main__":
- # Overwrite the ChromeTests tests dictionary. The cmdline option allows the
- # user to pass any executable as parameter to the test script, so we'll use
- # that to get our binaries in (hackish but convenient).
- chrome_tests.ChromeTests._test_list = {
- "cmdline": chrome_tests.ChromeTests.RunCmdLine,
- }
-
+if __name__ == '__main__':
# We do this so the user can write -t <binary> instead of -t cmdline <binary>.
if '-t' in sys.argv:
sys.argv.insert(sys.argv.index('-t') + 1, 'cmdline')
elif '--test' in sys.argv:
sys.argv.insert(sys.argv.index('--test') + 1, 'cmdline')
-
- print sys.argv
- ret = _main(sys.argv)
- sys.exit(ret)
+ return_code = main(sys.argv)
+ sys.exit(return_code)