cros_generate_breakpad_symbols: rewrite in python
This will allow us to be able to better maintain/integrate/extend this
code rather than trying to use the existing bash version.
BUG=chromium:271251
TEST=`cros_generate_breakpad_symbols --board daisy` generates all the symbols
TEST=`./cros_generate_breakpad_symbols_unittest.py` passes
TEST+`./upload_symbols_unittest.py` passes
Change-Id: I75042561f7abaa9d53fb573e8567bb1ef8bcfb69
Reviewed-on: https://gerrit.chromium.org/gerrit/65534
Commit-Queue: Mike Frysinger <vapier@chromium.org>
Reviewed-by: Mike Frysinger <vapier@chromium.org>
Tested-by: Mike Frysinger <vapier@chromium.org>
diff --git a/scripts/cros_generate_breakpad_symbols_unittest.py b/scripts/cros_generate_breakpad_symbols_unittest.py
new file mode 100755
index 0000000..f6dfe9b
--- /dev/null
+++ b/scripts/cros_generate_breakpad_symbols_unittest.py
@@ -0,0 +1,305 @@
+#!/usr/bin/python
+# Copyright (c) 2013 The Chromium OS Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+import ctypes
+import logging
+import os
+import StringIO
+import sys
+
+sys.path.insert(0, os.path.join(os.path.dirname(os.path.realpath(__file__)),
+ '..', '..'))
+from chromite.lib import cros_build_lib_unittest
+from chromite.lib import cros_test_lib
+from chromite.lib import osutils
+from chromite.lib import parallel
+from chromite.lib import parallel_unittest
+from chromite.lib import partial_mock
+from chromite.scripts import cros_generate_breakpad_symbols
+
+# TODO(build): Finish test wrapper (http://crosbug.com/37517).
+# Until then, this has to be after the chromite imports.
+import mock
+
+
+class FindDebugDirMock(partial_mock.PartialMock):
+ """Mock out the DebugDir helper so we can point it to a tempdir."""
+
+ TARGET = 'chromite.scripts.cros_generate_breakpad_symbols'
+ ATTRS = ('FindDebugDir',)
+ DEFAULT_ATTR = 'FindDebugDir'
+
+ def __init__(self, path, *args, **kwds):
+ self.path = path
+ super(FindDebugDirMock, self).__init__(*args, **kwds)
+
+ def FindDebugDir(self, _board):
+ return self.path
+
+
+@mock.patch('chromite.scripts.cros_generate_breakpad_symbols.'
+ 'GenerateBreakpadSymbol')
+class GenerateSymbolsTest(cros_test_lib.MockTempDirTestCase):
+
+ def setUp(self):
+ self.board = 'monkey-board'
+ self.board_dir = os.path.join(self.tempdir, 'build', self.board)
+ self.debug_dir = os.path.join(self.board_dir, 'usr', 'lib', 'debug')
+ self.breakpad_dir = os.path.join(self.debug_dir, 'breakpad')
+
+ # Generate a tree of files which we'll scan through.
+ elf_files = [
+ 'bin/elf',
+ 'iii/large-elf',
+ # Need some kernel modules (with & without matching .debug).
+ 'lib/modules/3.10/module.ko',
+ 'lib/modules/3.10/module-no-debug.ko',
+ # Need a file which has an ELF only, but not a .debug.
+ 'usr/bin/elf-only',
+ 'usr/sbin/elf',
+ ]
+ debug_files = [
+ 'bin/bad-file',
+ 'bin/elf.debug',
+ 'iii/large-elf.debug',
+ 'lib/modules/3.10/module.ko.debug',
+ # Need a file which has a .debug only, but not an ELF.
+ 'sbin/debug-only.debug',
+ 'usr/sbin/elf.debug',
+ ]
+ for f in ([os.path.join(self.board_dir, x) for x in elf_files] +
+ [os.path.join(self.debug_dir, x) for x in debug_files]):
+ osutils.Touch(f, makedirs=True)
+
+ # Set up random build dirs and symlinks.
+ buildid = os.path.join(self.debug_dir, '.build-id', '00')
+ osutils.SafeMakedirs(buildid)
+ os.symlink('/asdf', os.path.join(buildid, 'foo'))
+ os.symlink('/bin/sh', os.path.join(buildid, 'foo.debug'))
+ os.symlink('/bin/sh', os.path.join(self.debug_dir, 'file.debug'))
+ osutils.WriteFile(os.path.join(self.debug_dir, 'iii', 'large-elf.debug'),
+ 'just some content')
+
+ self.StartPatcher(FindDebugDirMock(self.debug_dir))
+
+ def testNormal(self, gen_mock):
+ """Verify all the files we expect to get generated do"""
+ with parallel_unittest.ParallelMock():
+ ret = cros_generate_breakpad_symbols.GenerateBreakpadSymbols(
+ self.board, sysroot=self.board_dir)
+ self.assertEquals(ret, 0)
+ self.assertEquals(gen_mock.call_count, 3)
+
+ # The largest ELF should be processed first.
+ call1 = (os.path.join(self.board_dir, 'iii/large-elf'),
+ os.path.join(self.debug_dir, 'iii/large-elf.debug'))
+ self.assertEquals(gen_mock.call_args_list[0][0], call1)
+
+ # The other ELFs can be called in any order.
+ call2 = (os.path.join(self.board_dir, 'bin/elf'),
+ os.path.join(self.debug_dir, 'bin/elf.debug'))
+ call3 = (os.path.join(self.board_dir, 'usr/sbin/elf'),
+ os.path.join(self.debug_dir, 'usr/sbin/elf.debug'))
+ exp_calls = set((call2, call3))
+ actual_calls = set((gen_mock.call_args_list[1][0],
+ gen_mock.call_args_list[2][0]))
+ self.assertEquals(exp_calls, actual_calls)
+
+ def testGenLimit(self, gen_mock):
+ """Verify generate_count arg works"""
+ with parallel_unittest.ParallelMock():
+ # Generate nothing!
+ ret = cros_generate_breakpad_symbols.GenerateBreakpadSymbols(
+ self.board, sysroot=self.board_dir, breakpad_dir=self.breakpad_dir,
+ generate_count=0)
+ self.assertEquals(ret, 0)
+ self.assertEquals(gen_mock.call_count, 0)
+
+ # Generate just one.
+ ret = cros_generate_breakpad_symbols.GenerateBreakpadSymbols(
+ self.board, sysroot=self.board_dir, breakpad_dir=self.breakpad_dir,
+ generate_count=1)
+ self.assertEquals(ret, 0)
+ self.assertEquals(gen_mock.call_count, 1)
+
+ # The largest ELF should be processed first.
+ call1 = (os.path.join(self.board_dir, 'iii/large-elf'),
+ os.path.join(self.debug_dir, 'iii/large-elf.debug'))
+ self.assertEquals(gen_mock.call_args_list[0][0], call1)
+
+ def testGenErrors(self, gen_mock):
+ """Verify we handle errors from generation correctly"""
+ def _SetError(*_args, **kwds):
+ kwds['num_errors'].value += 1
+ return 1
+ gen_mock.side_effect = _SetError
+ with parallel_unittest.ParallelMock():
+ ret = cros_generate_breakpad_symbols.GenerateBreakpadSymbols(
+ self.board, sysroot=self.board_dir)
+ self.assertEquals(ret, 3)
+ self.assertEquals(gen_mock.call_count, 3)
+
+
+class GenerateSymbolTest(cros_test_lib.MockTempDirTestCase):
+
+ def setUp(self):
+ self.elf_file = os.path.join(self.tempdir, 'elf')
+ osutils.Touch(self.elf_file)
+ self.debug_dir = os.path.join(self.tempdir, 'debug')
+ self.debug_file = os.path.join(self.debug_dir, 'elf.debug')
+ osutils.Touch(self.debug_file, makedirs=True)
+ # Not needed as the code itself should create it as needed.
+ self.breakpad_dir = os.path.join(self.debug_dir, 'breakpad')
+
+ self.rc_mock = self.StartPatcher(cros_build_lib_unittest.RunCommandMock())
+ self.rc_mock.SetDefaultCmdResult(output='MODULE OS CPU ID NAME')
+ self.assertCommandContains = self.rc_mock.assertCommandContains
+ self.sym_file = os.path.join(self.breakpad_dir, 'NAME/ID/NAME.sym')
+
+ self.StartPatcher(FindDebugDirMock(self.debug_dir))
+
+ def assertCommandArgs(self, i, args):
+ """Helper for looking at the args of the |i|th call"""
+ self.assertEqual(self.rc_mock.call_args_list[i][0][0], args)
+
+ def testNormal(self):
+ """Normal run -- given an ELF and a debug file"""
+ ret = cros_generate_breakpad_symbols.GenerateBreakpadSymbol(
+ self.elf_file, self.debug_file, breakpad_dir=self.breakpad_dir)
+ self.assertEqual(ret, 0)
+ self.assertEqual(self.rc_mock.call_count, 1)
+ self.assertCommandArgs(0, ['dump_syms', self.elf_file, self.debug_dir])
+ self.assertExists(self.sym_file)
+
+ def testNormalBoard(self):
+ """Normal run w/board info but not breakpad dir"""
+ ret = cros_generate_breakpad_symbols.GenerateBreakpadSymbol(
+ self.elf_file, board='foo')
+ self.assertEqual(ret, 0)
+ self.assertCommandArgs(0, ['dump_syms', self.elf_file])
+ self.assertEqual(self.rc_mock.call_count, 1)
+ self.assertExists(self.sym_file)
+
+ def testNormalNoCfi(self):
+ """Normal run w/out CFI"""
+ # Make sure the num_errors flag works too.
+ num_errors = ctypes.c_int()
+ ret = cros_generate_breakpad_symbols.GenerateBreakpadSymbol(
+ self.elf_file, strip_cfi=True, num_errors=num_errors)
+ self.assertEqual(ret, 0)
+ self.assertEqual(num_errors.value, 0)
+ self.assertCommandArgs(0, ['dump_syms', '-c', self.elf_file])
+ self.assertEqual(self.rc_mock.call_count, 1)
+ self.assertExists(self.sym_file)
+
+ def testNormalElfOnly(self):
+ """Normal run -- given just an ELF"""
+ ret = cros_generate_breakpad_symbols.GenerateBreakpadSymbol(self.elf_file)
+ self.assertEqual(ret, 0)
+ self.assertCommandArgs(0, ['dump_syms', self.elf_file])
+ self.assertEqual(self.rc_mock.call_count, 1)
+ self.assertExists(self.sym_file)
+
+ def testNormalSudo(self):
+ """Normal run where ELF is readable only by root"""
+ with mock.patch.object(os, 'access') as mock_access:
+ mock_access.return_value = False
+ ret = cros_generate_breakpad_symbols.GenerateBreakpadSymbol(self.elf_file)
+ self.assertEqual(ret, 0)
+ self.assertCommandArgs(0, ['sudo', '--', 'dump_syms', self.elf_file])
+
+ def testLargeDebugFail(self):
+ """Running w/large .debug failed, but retry worked"""
+ self.rc_mock.AddCmdResult(['dump_syms', self.elf_file, self.debug_dir],
+ returncode=1)
+ ret = cros_generate_breakpad_symbols.GenerateBreakpadSymbol(
+ self.elf_file, self.debug_file)
+ self.assertEqual(ret, 0)
+ self.assertEqual(self.rc_mock.call_count, 2)
+ self.assertCommandArgs(0, ['dump_syms', self.elf_file, self.debug_dir])
+ self.assertCommandArgs(
+ 1, ['dump_syms', '-c', '-r', self.elf_file, self.debug_dir])
+ self.assertExists(self.sym_file)
+
+ def testDebugFail(self):
+ """Running w/.debug always failed, but works w/out"""
+ self.rc_mock.AddCmdResult(['dump_syms', self.elf_file, self.debug_dir],
+ returncode=1)
+ self.rc_mock.AddCmdResult(['dump_syms', '-c', '-r', self.elf_file,
+ self.debug_dir],
+ returncode=1)
+ ret = cros_generate_breakpad_symbols.GenerateBreakpadSymbol(
+ self.elf_file, self.debug_file)
+ self.assertEqual(ret, 0)
+ self.assertEqual(self.rc_mock.call_count, 3)
+ self.assertCommandArgs(0, ['dump_syms', self.elf_file, self.debug_dir])
+ self.assertCommandArgs(
+ 1, ['dump_syms', '-c', '-r', self.elf_file, self.debug_dir])
+ self.assertCommandArgs(2, ['dump_syms', self.elf_file])
+ self.assertExists(self.sym_file)
+
+ def testCompleteFail(self):
+ """Running dump_syms always fails"""
+ self.rc_mock.SetDefaultCmdResult(returncode=1)
+ ret = cros_generate_breakpad_symbols.GenerateBreakpadSymbol(self.elf_file)
+ self.assertEqual(ret, 1)
+ # Make sure the num_errors flag works too.
+ num_errors = ctypes.c_int()
+ ret = cros_generate_breakpad_symbols.GenerateBreakpadSymbol(
+ self.elf_file, num_errors=num_errors)
+ self.assertEqual(ret, 1)
+ self.assertEqual(num_errors.value, 1)
+
+
+class UtilsTestDir(cros_test_lib.TempDirTestCase):
+
+ def testReadSymsHeaderGoodFile(self):
+ """Make sure ReadSymsHeader can parse sym files"""
+ sym_file = os.path.join(self.tempdir, 'sym')
+ osutils.WriteFile(sym_file, 'MODULE Linux x86 s0m31D chrooome')
+ result = cros_generate_breakpad_symbols.ReadSymsHeader(sym_file)
+ self.assertEquals(result.cpu, 'x86')
+ self.assertEquals(result.id, 's0m31D')
+ self.assertEquals(result.name, 'chrooome')
+ self.assertEquals(result.os, 'Linux')
+
+
+class UtilsTest(cros_test_lib.TestCase):
+
+ def testReadSymsHeaderGoodBuffer(self):
+ """Make sure ReadSymsHeader can parse sym file handles"""
+ result = cros_generate_breakpad_symbols.ReadSymsHeader(
+ StringIO.StringIO('MODULE Linux arm MY-ID-HERE blkid'))
+ self.assertEquals(result.cpu, 'arm')
+ self.assertEquals(result.id, 'MY-ID-HERE')
+ self.assertEquals(result.name, 'blkid')
+ self.assertEquals(result.os, 'Linux')
+
+ def testReadSymsHeaderBadd(self):
+ """Make sure ReadSymsHeader throws on bad sym files"""
+ self.assertRaises(ValueError, cros_generate_breakpad_symbols.ReadSymsHeader,
+ StringIO.StringIO('asdf'))
+
+ def testBreakpadDir(self):
+ """Make sure board->breakpad path expansion works"""
+ expected = '/build/blah/usr/lib/debug/breakpad'
+ result = cros_generate_breakpad_symbols.FindBreakpadDir('blah')
+ self.assertEquals(expected, result)
+
+ def testDebugDir(self):
+ """Make sure board->debug path expansion works"""
+ expected = '/build/blah/usr/lib/debug'
+ result = cros_generate_breakpad_symbols.FindDebugDir('blah')
+ self.assertEquals(expected, result)
+
+
+if __name__ == '__main__':
+ # pylint: disable=W0212
+ # Set timeouts small so that if the unit test hangs, it won't hang for long.
+ parallel._BackgroundTask.STARTUP_TIMEOUT = 5
+ parallel._BackgroundTask.EXIT_TIMEOUT = 5
+
+ # Run the tests.
+ cros_test_lib.main(level=logging.INFO)