Change-Id: Ib50962111d0c6c07a135679d80930af4bc52915b
Move site_chrome_test, site_logging, site_log_reader,
site_crash_test into cros dir.
site_chrome_test --> cros/chrome_test
site_crash_test --> cros/crash_test
site_logging --> cros/cros_logging
site_log_reader --> cros/cros_logging
site_ui_test --> cros/cros_ui_test
I had removed site_logging module and moved its code into cros_logging, since its new name (logging) has conflict with python's logging module.
site_log_reader has also been merged into cros_logging module.
As I am touching all the files in the list, I also removed some unnecessary import to autotest_lib.client.bin.test.
Change-Id: I2c8f101a6c7a0499619e227e4cb0cfb8ceec4690
BUG=7236
TEST=run bvt and every other tests been touched from both source (third_party/autotest/files) and chroot (/build/board/usr/local/autotest)
Review URL: http://codereview.chromium.org/5740004
diff --git a/client/cros/crash_test.py b/client/cros/crash_test.py
new file mode 100644
index 0000000..774f5bb
--- /dev/null
+++ b/client/cros/crash_test.py
@@ -0,0 +1,365 @@
+# Copyright (c) 2010 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 logging, os, re, shutil
+import common
+import cros_logging
+from autotest_lib.client.bin import test, utils
+from autotest_lib.client.common_lib import error
+
+
+class CrashTest(test.test):
+
+ _CONSENT_FILE = '/home/chronos/Consent To Send Stats'
+ _CORE_PATTERN = '/proc/sys/kernel/core_pattern'
+ _CRASH_REPORTER_PATH = '/sbin/crash_reporter'
+ _CRASH_SENDER_PATH = '/sbin/crash_sender'
+ _CRASH_SENDER_RATE_DIR = '/var/lib/crash_sender'
+ _CRASH_SENDER_RUN_PATH = '/var/run/crash_sender.pid'
+ _MOCK_CRASH_SENDING = '/tmp/mock-crash-sending'
+ _PAUSE_FILE = '/var/lib/crash_sender_paused'
+ _SYSTEM_CRASH_DIR = '/var/spool/crash'
+ _USER_CRASH_DIR = '/home/chronos/user/crash'
+
+ def _set_system_sending(self, is_enabled):
+ """Sets whether or not the system crash_sender is allowed to run.
+
+ crash_sender may still be allowed to run if _set_child_sending is
+ called with true and it is run as a child process."""
+ if is_enabled:
+ if os.path.exists(self._PAUSE_FILE):
+ os.remove(self._PAUSE_FILE)
+ else:
+ utils.system('touch ' + self._PAUSE_FILE)
+
+
+ def _set_child_sending(self, is_enabled):
+ """Overrides crash sending enabling for child processes."""
+ if is_enabled:
+ os.environ['OVERRIDE_PAUSE_SENDING'] = "1"
+ else:
+ del os.environ['OVERRIDE_PAUSE_SENDING']
+
+
+ def _reset_rate_limiting(self):
+ utils.system('rm -rf ' + self._CRASH_SENDER_RATE_DIR)
+
+
+ def _clear_spooled_crashes(self):
+ utils.system('rm -rf ' + self._SYSTEM_CRASH_DIR)
+ utils.system('rm -rf ' + self._USER_CRASH_DIR)
+
+
+ def _kill_running_sender(self):
+ if not os.path.exists(self._CRASH_SENDER_RUN_PATH):
+ return
+ running_pid = int(utils.read_file(self._CRASH_SENDER_RUN_PATH))
+ logging.warning('Detected running crash sender (%d), killing' %
+ running_pid)
+ utils.system('kill -9 %d' % running_pid)
+ os.remove(self._CRASH_SENDER_RUN_PATH)
+
+
+ def _set_sending_mock(self, mock_enabled, send_success=True):
+ if mock_enabled:
+ if send_success:
+ data = ''
+ else:
+ data = '1'
+ logging.info('Setting sending mock')
+ utils.open_write_close(self._MOCK_CRASH_SENDING, data)
+ else:
+ utils.system('rm -f ' + self._MOCK_CRASH_SENDING)
+
+
+ def _set_consent(self, has_consent):
+ if has_consent:
+ utils.open_write_close(self._CONSENT_FILE, 'test-consent')
+ logging.info('Created ' + self._CONSENT_FILE)
+ else:
+ utils.system('rm -f "%s"' % (self._CONSENT_FILE))
+
+
+ def _get_pushed_consent_file_path(self):
+ return os.path.join(self.bindir, 'pushed_consent')
+
+
+ def _push_consent(self):
+ if os.path.exists(self._CONSENT_FILE):
+ shutil.move(self._CONSENT_FILE,
+ self._get_pushed_consent_file_path())
+
+
+ def _pop_consent(self):
+ self._set_consent(False)
+ if os.path.exists(self._get_pushed_consent_file_path()):
+ shutil.move(self._get_pushed_consent_file_path(),
+ self._CONSENT_FILE)
+
+
+ def _get_crash_dir(self, username):
+ if username == 'chronos':
+ return self._USER_CRASH_DIR
+ else:
+ return self._SYSTEM_CRASH_DIR
+
+
+ def _initialize_crash_reporter(self):
+ utils.system('%s --init --nounclean_check' % self._CRASH_REPORTER_PATH)
+ # Completely disable crash_reporter from generating crash dumps
+ # while any tests are running, otherwise a crashy system can make
+ # these tests flaky.
+ self.enable_crash_filtering('none')
+
+
+ def write_crash_dir_entry(self, name, contents):
+ entry = os.path.join(self._SYSTEM_CRASH_DIR, name)
+ if not os.path.exists(self._SYSTEM_CRASH_DIR):
+ os.makedirs(self._SYSTEM_CRASH_DIR)
+ utils.open_write_close(entry, contents)
+ return entry
+
+
+ def write_fake_meta(self, name, exec_name, payload, log=None,
+ complete=True):
+ last_line = ''
+ if complete:
+ last_line = 'done=1\n'
+ contents = ('exec_name=%s\n'
+ 'ver=my_ver\n'
+ 'payload=%s\n'
+ '%s' % (exec_name, payload,
+ last_line))
+ if log:
+ contents = ('log=%s\n' % log) + contents
+ return self.write_crash_dir_entry(name, contents)
+
+
+ def _prepare_sender_one_crash(self,
+ send_success,
+ reports_enabled,
+ username,
+ report):
+ self._set_sending_mock(mock_enabled=True, send_success=send_success)
+ self._set_consent(reports_enabled)
+ if report is None:
+ payload = self.write_crash_dir_entry('fake.dmp', '')
+ report = self.write_fake_meta('fake.meta', 'fake', payload)
+ return report
+
+
+ def _parse_sender_output(self, output):
+ """Parse the log output from the crash_sender script.
+
+ This script can run on the logs from either a mocked or true
+ crash send.
+
+ Args:
+ output: output from the script
+
+ Returns:
+ A dictionary with these values:
+ exec_name: name of executable which crashed
+ meta_path: path to the report metadata file
+ output: the output from the script, copied
+ report_kind: kind of report sent (minidump vs kernel)
+ send_attempt: did the script attempt to send a crash.
+ send_success: if it attempted, was the crash send successful.
+ sig: signature of the report, if given.
+ sleep_time: if it attempted, how long did it sleep before
+ sending (if mocked, how long would it have slept)
+ """
+ sleep_match = re.search('Scheduled to send in (\d+)s', output)
+ send_attempt = sleep_match is not None
+ if send_attempt:
+ sleep_time = int(sleep_match.group(1))
+ else:
+ sleep_time = None
+ meta_match = re.search('Metadata: (\S+) \((\S+)\)', output)
+ if meta_match:
+ meta_path = meta_match.group(1)
+ report_kind = meta_match.group(2)
+ else:
+ meta_path = None
+ report_kind = None
+ payload_match = re.search('Payload: (\S+)', output)
+ if payload_match:
+ report_payload = payload_match.group(1)
+ else:
+ report_payload = None
+ exec_name_match = re.search('Exec name: (\S+)', output)
+ if exec_name_match:
+ exec_name = exec_name_match.group(1)
+ else:
+ exec_name = None
+ sig_match = re.search('sig: (\S+)', output)
+ if sig_match:
+ sig = sig_match.group(1)
+ else:
+ sig = None
+ send_success = 'Mocking successful send' in output
+ return {'exec_name': exec_name,
+ 'report_kind': report_kind,
+ 'meta_path': meta_path,
+ 'report_payload': report_payload,
+ 'send_attempt': send_attempt,
+ 'send_success': send_success,
+ 'sig': sig,
+ 'sleep_time': sleep_time,
+ 'output': output}
+
+
+ def wait_for_sender_completion(self):
+ """Wait for crash_sender to complete.
+
+ Wait for no crash_sender's last message to be placed in the
+ system log before continuing and for the process to finish.
+ Otherwise we might get only part of the output."""
+ utils.poll_for_condition(
+ lambda: self._log_reader.can_find('crash_sender done.'),
+ timeout=60,
+ exception=error.TestError(
+ 'Timeout waiting for crash_sender to emit done: ' +
+ self._log_reader.get_logs()))
+ utils.poll_for_condition(
+ lambda: utils.system('pgrep crash_sender',
+ ignore_status=True) != 0,
+ timeout=60,
+ exception=error.TestError(
+ 'Timeout waiting for crash_sender to finish: ' +
+ self._log_reader.get_logs()))
+
+
+ def _call_sender_one_crash(self,
+ send_success=True,
+ reports_enabled=True,
+ username='root',
+ report=None):
+ """Call the crash sender script to mock upload one crash.
+
+ Args:
+ send_success: Mock a successful send if true
+ reports_enabled: Has the user consented to sending crash reports.
+ username: user to emulate a crash from
+ report: report to use for crash, if None we create one.
+
+ Returns:
+ Returns a dictionary describing the result with the keys
+ from _parse_sender_output, as well as:
+ report_exists: does the minidump still exist after calling
+ send script
+ rate_count: how many crashes have been uploaded in the past
+ 24 hours.
+ """
+ report = self._prepare_sender_one_crash(send_success,
+ reports_enabled,
+ username,
+ report)
+ self._log_reader.set_start_by_current()
+ script_output = utils.system_output(
+ '/bin/sh -c "%s" 2>&1' % self._CRASH_SENDER_PATH,
+ ignore_status=True)
+ self.wait_for_sender_completion()
+ output = self._log_reader.get_logs()
+ logging.debug('Crash sender message output:\n' + output)
+ if script_output != '':
+ raise error.TestFail(
+ 'Unexpected crash_sender stdout/stderr: ' + script_output)
+
+ if os.path.exists(report):
+ report_exists = True
+ os.remove(report)
+ else:
+ report_exists = False
+ if os.path.exists(self._CRASH_SENDER_RATE_DIR):
+ rate_count = len(os.listdir(self._CRASH_SENDER_RATE_DIR))
+ else:
+ rate_count = 0
+
+ result = self._parse_sender_output(output)
+ result['report_exists'] = report_exists
+ result['rate_count'] = rate_count
+
+ # Show the result for debugging but remove 'output' key
+ # since it's large and earlier in debug output.
+ debug_result = dict(result)
+ del debug_result['output']
+ logging.debug('Result of send (besides output): %s' % debug_result)
+
+ return result
+
+
+ def _replace_crash_reporter_filter_in(self, new_parameter):
+ core_pattern = utils.read_file(self._CORE_PATTERN)[:-1]
+ core_pattern = re.sub('--filter_in=\S*\s*', '',
+ core_pattern).rstrip()
+ if new_parameter:
+ core_pattern += ' ' + new_parameter
+ utils.system('echo "%s" > %s' % (core_pattern, self._CORE_PATTERN))
+
+
+ def enable_crash_filtering(self, name):
+ self._replace_crash_reporter_filter_in('--filter_in=' + name)
+
+
+ def disable_crash_filtering(self):
+ self._replace_crash_reporter_filter_in('')
+
+
+ def initialize(self):
+ test.test.initialize(self)
+ self._log_reader = cros_logging.LogReader()
+ self._leave_crash_sending = True
+ self._automatic_consent_saving = True
+ self.enable_crash_filtering('none')
+
+
+ def cleanup(self):
+ self._reset_rate_limiting()
+ self._clear_spooled_crashes()
+ self._set_system_sending(self._leave_crash_sending)
+ self._set_sending_mock(mock_enabled=False)
+ if self._automatic_consent_saving:
+ self._pop_consent()
+ self.disable_crash_filtering()
+ test.test.cleanup(self)
+
+
+ def run_crash_tests(self,
+ test_names,
+ initialize_crash_reporter=False,
+ clear_spool_first=True,
+ must_run_all=True):
+ """Run crash tests defined in this class.
+
+ Args:
+ test_names: array of test names
+ initialize_crash_reporter: should set up crash reporter for every run
+ must_run_all: should make sure every test in this class is mentioned
+ in test_names
+ """
+ if self._automatic_consent_saving:
+ self._push_consent()
+
+ if must_run_all:
+ # Sanity check test_names is complete
+ for attr in dir(self):
+ if attr.find('_test_') == 0:
+ test_name = attr[6:]
+ if not test_name in test_names:
+ raise error.TestError('Test %s is missing' % test_name)
+
+ for test_name in test_names:
+ logging.info(('=' * 20) + ('Running %s' % test_name) + ('=' * 20))
+ if initialize_crash_reporter:
+ self._initialize_crash_reporter()
+ # Disable crash_sender from running, kill off any running ones, but
+ # set environment so crash_sender may run as a child process.
+ self._set_system_sending(False)
+ self._set_child_sending(True)
+ self._kill_running_sender()
+ self._reset_rate_limiting()
+ if clear_spool_first:
+ self._clear_spooled_crashes()
+ getattr(self, '_test_' + test_name)()