| Index: third_party/crashpad/crashpad/snapshot/win/end_to_end_test.py
|
| diff --git a/third_party/crashpad/crashpad/snapshot/win/end_to_end_test.py b/third_party/crashpad/crashpad/snapshot/win/end_to_end_test.py
|
| new file mode 100755
|
| index 0000000000000000000000000000000000000000..f3172ba7a79630354e0077375ed36b01db2c97cb
|
| --- /dev/null
|
| +++ b/third_party/crashpad/crashpad/snapshot/win/end_to_end_test.py
|
| @@ -0,0 +1,315 @@
|
| +#!/usr/bin/env python
|
| +
|
| +# Copyright 2015 The Crashpad Authors. All rights reserved.
|
| +#
|
| +# Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
|
| +#
|
| +# Unless required by applicable law or agreed to in writing, software
|
| +# distributed under the License is distributed on an "AS IS" BASIS,
|
| +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
| +# See the License for the specific language governing permissions and
|
| +# limitations under the License.
|
| +
|
| +import os
|
| +import platform
|
| +import random
|
| +import re
|
| +import subprocess
|
| +import sys
|
| +import tempfile
|
| +import time
|
| +
|
| +g_temp_dirs = []
|
| +
|
| +
|
| +def MakeTempDir():
|
| + global g_temp_dirs
|
| + new_dir = tempfile.mkdtemp()
|
| + g_temp_dirs.append(new_dir)
|
| + return new_dir
|
| +
|
| +
|
| +def CleanUpTempDirs():
|
| + global g_temp_dirs
|
| + for d in g_temp_dirs:
|
| + subprocess.call(['rmdir', '/s', '/q', d], shell=True)
|
| +
|
| +
|
| +def FindInstalledWindowsApplication(app_path):
|
| + search_paths = [os.getenv('PROGRAMFILES(X86)'),
|
| + os.getenv('PROGRAMFILES'),
|
| + os.getenv('PROGRAMW6432'),
|
| + os.getenv('LOCALAPPDATA')]
|
| + search_paths += os.getenv('PATH', '').split(os.pathsep)
|
| +
|
| + for search_path in search_paths:
|
| + if not search_path:
|
| + continue
|
| + path = os.path.join(search_path, app_path)
|
| + if os.path.isfile(path):
|
| + return path
|
| +
|
| + return None
|
| +
|
| +
|
| +def GetCdbPath():
|
| + """Search in some reasonable places to find cdb.exe. Searches x64 before x86
|
| + and newer versions before older versions.
|
| + """
|
| + possible_paths = (
|
| + os.path.join('Windows Kits', '10', 'Debuggers', 'x64'),
|
| + os.path.join('Windows Kits', '10', 'Debuggers', 'x86'),
|
| + os.path.join('Windows Kits', '8.1', 'Debuggers', 'x64'),
|
| + os.path.join('Windows Kits', '8.1', 'Debuggers', 'x86'),
|
| + os.path.join('Windows Kits', '8.0', 'Debuggers', 'x64'),
|
| + os.path.join('Windows Kits', '8.0', 'Debuggers', 'x86'),
|
| + 'Debugging Tools For Windows (x64)',
|
| + 'Debugging Tools For Windows (x86)',
|
| + 'Debugging Tools For Windows',)
|
| + for possible_path in possible_paths:
|
| + app_path = os.path.join(possible_path, 'cdb.exe')
|
| + app_path = FindInstalledWindowsApplication(app_path)
|
| + if app_path:
|
| + return app_path
|
| + return None
|
| +
|
| +
|
| +def GetDumpFromProgram(out_dir, pipe_name, executable_name):
|
| + """Initialize a crash database, and run |executable_name| connecting to a
|
| + crash handler. If pipe_name is set, crashpad_handler will be started first. If
|
| + pipe_name is empty, the executable is responsible for starting
|
| + crashpad_handler. Returns the minidump generated by crashpad_handler for
|
| + further testing.
|
| + """
|
| + test_database = MakeTempDir()
|
| + handler = None
|
| +
|
| + try:
|
| + if subprocess.call(
|
| + [os.path.join(out_dir, 'crashpad_database_util.exe'), '--create',
|
| + '--database=' + test_database]) != 0:
|
| + print 'could not initialize report database'
|
| + return None
|
| +
|
| + if pipe_name is not None:
|
| + handler = subprocess.Popen([
|
| + os.path.join(out_dir, 'crashpad_handler.exe'),
|
| + '--pipe-name=' + pipe_name,
|
| + '--database=' + test_database
|
| + ])
|
| +
|
| + # Wait until the server is ready.
|
| + printed = False
|
| + while not os.path.exists(pipe_name):
|
| + if not printed:
|
| + print 'Waiting for crashpad_handler to be ready...'
|
| + printed = True
|
| + time.sleep(0.1)
|
| +
|
| + subprocess.call([os.path.join(out_dir, executable_name), pipe_name])
|
| + else:
|
| + subprocess.call([os.path.join(out_dir, executable_name),
|
| + os.path.join(out_dir, 'crashpad_handler.exe'),
|
| + test_database])
|
| +
|
| + out = subprocess.check_output([
|
| + os.path.join(out_dir, 'crashpad_database_util.exe'),
|
| + '--database=' + test_database,
|
| + '--show-completed-reports',
|
| + '--show-all-report-info',
|
| + ])
|
| + for line in out.splitlines():
|
| + if line.strip().startswith('Path:'):
|
| + return line.partition(':')[2].strip()
|
| + finally:
|
| + if handler:
|
| + handler.kill()
|
| +
|
| +
|
| +def GetDumpFromCrashyProgram(out_dir, pipe_name):
|
| + return GetDumpFromProgram(out_dir, pipe_name, 'crashy_program.exe')
|
| +
|
| +
|
| +def GetDumpFromSelfDestroyingProgram(out_dir, pipe_name):
|
| + return GetDumpFromProgram(out_dir, pipe_name, 'self_destroying_program.exe')
|
| +
|
| +
|
| +def GetDumpFromZ7Program(out_dir, pipe_name):
|
| + return GetDumpFromProgram(out_dir, pipe_name, 'crashy_z7_loader.exe')
|
| +
|
| +
|
| +class CdbRun(object):
|
| + """Run cdb.exe passing it a cdb command and capturing the output.
|
| + `Check()` searches for regex patterns in sequence allowing verification of
|
| + expected output.
|
| + """
|
| +
|
| + def __init__(self, cdb_path, dump_path, command):
|
| + # Run a command line that loads the dump, runs the specified cdb command,
|
| + # and then quits, and capturing stdout.
|
| + self.out = subprocess.check_output([
|
| + cdb_path,
|
| + '-z', dump_path,
|
| + '-c', command + ';q'
|
| + ])
|
| +
|
| + def Check(self, pattern, message, re_flags=0):
|
| + match_obj = re.search(pattern, self.out, re_flags)
|
| + if match_obj:
|
| + # Matched. Consume up to end of match.
|
| + self.out = self.out[match_obj.end(0):]
|
| + print 'ok - %s' % message
|
| + sys.stdout.flush()
|
| + else:
|
| + print >>sys.stderr, '-' * 80
|
| + print >>sys.stderr, 'FAILED - %s' % message
|
| + print >>sys.stderr, '-' * 80
|
| + print >>sys.stderr, 'did not match:\n %s' % pattern
|
| + print >>sys.stderr, '-' * 80
|
| + print >>sys.stderr, 'remaining output was:\n %s' % self.out
|
| + print >>sys.stderr, '-' * 80
|
| + sys.stderr.flush()
|
| + sys.exit(1)
|
| +
|
| +
|
| +def RunTests(cdb_path,
|
| + dump_path,
|
| + start_handler_dump_path,
|
| + destroyed_dump_path,
|
| + z7_dump_path,
|
| + pipe_name):
|
| + """Runs various tests in sequence. Runs a new cdb instance on the dump for
|
| + each block of tests to reduce the chances that output from one command is
|
| + confused for output from another.
|
| + """
|
| + out = CdbRun(cdb_path, dump_path, '.ecxr')
|
| + out.Check('This dump file has an exception of interest stored in it',
|
| + 'captured exception')
|
| + out.Check(
|
| + 'crashy_program!crashpad::`anonymous namespace\'::SomeCrashyFunction',
|
| + 'exception at correct location')
|
| +
|
| + out = CdbRun(cdb_path, start_handler_dump_path, '.ecxr')
|
| + out.Check('This dump file has an exception of interest stored in it',
|
| + 'captured exception (using StartHandler())')
|
| + out.Check(
|
| + 'crashy_program!crashpad::`anonymous namespace\'::SomeCrashyFunction',
|
| + 'exception at correct location (using StartHandler())')
|
| +
|
| + out = CdbRun(cdb_path, dump_path, '!peb')
|
| + out.Check(r'PEB at', 'found the PEB')
|
| + out.Check(r'Ldr\.InMemoryOrderModuleList:.*\d+ \. \d+', 'PEB_LDR_DATA saved')
|
| + out.Check(r'Base TimeStamp Module', 'module list present')
|
| + pipe_name_escaped = pipe_name.replace('\\', '\\\\')
|
| + out.Check(r'CommandLine: *\'.*crashy_program.exe *' + pipe_name_escaped,
|
| + 'some PEB data is correct')
|
| + out.Check(r'SystemRoot=C:\\Windows', 'some of environment captured',
|
| + re.IGNORECASE)
|
| +
|
| + out = CdbRun(cdb_path, dump_path, '!teb')
|
| + out.Check(r'TEB at', 'found the TEB')
|
| + out.Check(r'ExceptionList:\s+[0-9a-fA-F]+', 'some valid teb data')
|
| + out.Check(r'LastErrorValue:\s+2', 'correct LastErrorValue')
|
| +
|
| + out = CdbRun(cdb_path, dump_path, '!gle')
|
| + out.Check('LastErrorValue: \(Win32\) 0x2 \(2\) - The system cannot find the '
|
| + 'file specified.', '!gle gets last error')
|
| + out.Check('LastStatusValue: \(NTSTATUS\) 0xc000000f - {File Not Found} The '
|
| + 'file %hs does not exist.', '!gle gets last ntstatus')
|
| +
|
| + if False:
|
| + # TODO(scottmg): Re-enable when we grab ntdll!RtlCriticalSectionList.
|
| + out = CdbRun(cdb_path, dump_path, '!locks')
|
| + out.Check(r'CritSec crashy_program!crashpad::`anonymous namespace\'::'
|
| + r'g_test_critical_section', 'lock was captured')
|
| + if platform.win32_ver()[0] != '7':
|
| + # We can't allocate CRITICAL_SECTIONs with .DebugInfo on Win 7.
|
| + out.Check(r'\*\*\* Locked', 'lock debug info was captured, and is locked')
|
| +
|
| + out = CdbRun(cdb_path, dump_path, '!handle')
|
| + out.Check(r'\d+ Handles', 'captured handles')
|
| + out.Check(r'Event\s+\d+', 'capture some event handles')
|
| + out.Check(r'File\s+\d+', 'capture some file handles')
|
| +
|
| + out = CdbRun(cdb_path, destroyed_dump_path, '.ecxr;!peb;k 2')
|
| + out.Check(r'Ldr\.InMemoryOrderModuleList:.*\d+ \. \d+', 'PEB_LDR_DATA saved')
|
| + out.Check(r'ntdll\.dll', 'ntdll present', re.IGNORECASE)
|
| +
|
| + # Check that there is no stack trace in the self-destroyed process. Confirm
|
| + # that the top is where we expect it (that's based only on IP), but subsequent
|
| + # stack entries will not be available. This confirms that we have a mostly
|
| + # valid dump, but that the stack was omitted.
|
| + out.Check(r'self_destroying_program!crashpad::`anonymous namespace\'::'
|
| + r'FreeOwnStackAndBreak.*\nquit:',
|
| + 'at correct location, no additional stack entries')
|
| +
|
| + if z7_dump_path:
|
| + out = CdbRun(cdb_path, z7_dump_path, '.ecxr;lm')
|
| + out.Check('This dump file has an exception of interest stored in it',
|
| + 'captured exception in z7 module')
|
| + # Older versions of cdb display relative to exports for /Z7 modules, newer
|
| + # ones just display the offset.
|
| + out.Check(r'z7_test(!CrashMe\+0xe|\+0x100e):',
|
| + 'exception in z7 at correct location')
|
| + out.Check(r'z7_test C \(codeview symbols\) z7_test.dll',
|
| + 'expected non-pdb symbol format')
|
| +
|
| +
|
| +def main(args):
|
| + try:
|
| + if len(args) != 1:
|
| + print >>sys.stderr, 'must supply binary dir'
|
| + return 1
|
| +
|
| + cdb_path = GetCdbPath()
|
| + if not cdb_path:
|
| + print >>sys.stderr, 'could not find cdb'
|
| + return 1
|
| +
|
| + # Make sure we can download Windows symbols.
|
| + if not os.environ.get('_NT_SYMBOL_PATH'):
|
| + symbol_dir = MakeTempDir()
|
| + protocol = 'https' if platform.win32_ver()[0] != 'XP' else 'http'
|
| + os.environ['_NT_SYMBOL_PATH'] = (
|
| + 'SRV*' + symbol_dir + '*' +
|
| + protocol + '://msdl.microsoft.com/download/symbols')
|
| +
|
| + pipe_name = r'\\.\pipe\end-to-end_%s_%s' % (
|
| + os.getpid(), str(random.getrandbits(64)))
|
| +
|
| + crashy_dump_path = GetDumpFromCrashyProgram(args[0], pipe_name)
|
| + if not crashy_dump_path:
|
| + return 1
|
| +
|
| + start_handler_dump_path = GetDumpFromCrashyProgram(args[0], None)
|
| + if not start_handler_dump_path:
|
| + return 1
|
| +
|
| + destroyed_dump_path = GetDumpFromSelfDestroyingProgram(args[0], pipe_name)
|
| + if not destroyed_dump_path:
|
| + return 1
|
| +
|
| + z7_dump_path = None
|
| + if not args[0].endswith('x64'):
|
| + z7_dump_path = GetDumpFromZ7Program(args[0], pipe_name)
|
| + if not z7_dump_path:
|
| + return 1
|
| +
|
| + RunTests(cdb_path,
|
| + crashy_dump_path,
|
| + start_handler_dump_path,
|
| + destroyed_dump_path,
|
| + z7_dump_path,
|
| + pipe_name)
|
| +
|
| + return 0
|
| + finally:
|
| + CleanUpTempDirs()
|
| +
|
| +
|
| +if __name__ == '__main__':
|
| + sys.exit(main(sys.argv[1:]))
|
|
|