blob: a7d2b0babd39cca39499503df97f285865d804d3 [file] [log] [blame]
# Copyright (c) 2012 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
import common
from autotest_lib.client.bin import utils
from autotest_lib.client.common_lib import error
from constants import CLEANUP_LOGS_PAUSED_FILE
class LogReader(object):
A class to read system log files.
def __init__(self, filename='/var/log/messages', include_rotated_logs=True):
self._start_line = 1
self._filename = filename
self._include_rotated_logs = include_rotated_logs
if not os.path.exists(CLEANUP_LOGS_PAUSED_FILE):
raise error.TestError('LogReader created without ' +
def read_all_logs(self, start=0):
"""Read all content from log files.
Generator function.
Return an iterator on the content of files.
log_files = []
line_number = 1
if self._include_rotated_logs:
'ls -tr1 %s.*' % self._filename,
for log_file in log_files:
f = open(log_file)
for line in f:
if line_number >= start:
yield line
line_number += 1
def set_start_by_regexp(self, index, regexp):
"""Set the start of logs based on a regular expression.
@param index: line matching regexp to start at, earliest log at 0.
Negative numbers indicate matches since end of log.
regexp_compiled = re.compile(regexp)
starts = []
line_number = 1
for line in self.read_all_logs():
if regexp_compiled.match(line):
line_number += 1
if index < -len(starts):
self._start_line = 1
elif index >= len(starts):
self._start_line = line_number
self._start_line = starts[index]
def set_start_by_reboot(self, index):
""" Set the start of logs (must be system log) based on reboot.
@param index: reboot to start at, earliest log at 0. Negative
numbers indicate reboots since end of log.
return self.set_start_by_regexp(index,
r'.*000\] Linux version \d')
def set_start_by_current(self, relative=0):
""" Set start of logs based on current last line.
@param relative: line relative to current to start at. 1 means
to start the log after this line.
count = self._start_line + relative
for line in self.read_all_logs(start=self._start_line):
count += 1
self._start_line = count
def get_logs(self):
""" Get logs since the start line.
Start line is set by set_start_* functions or
since the start of the file if none were called.
@return string of contents of file since start line.
logs = []
for line in self.read_all_logs(start=self._start_line):
return ''.join(logs)
def can_find(self, string):
""" Try to find string in the logs.
@return boolean indicating if we found the string.
return string in self.get_logs()
class LogRotationPauser(object):
Class to control when logs are rotated from either server or client.
Assumes all setting of CLEANUP_LOGS_PAUSED_FILE is done by this class
and that all calls to begin and end are properly
nested. For instance, [ a.begin(), b.begin(), b.end(), a.end() ] is
supported, but [ a.begin(), b.begin(), a.end(), b.end() ] is not.
We do support redundant calls to the same class, such as
[ a.begin(), a.begin(), a.end() ].
def __init__(self, host=None):
self._host = host
self._begun = False
self._is_nested = True
def _run(self, command, *args, **dargs):
if self._host:
return, *args, **dargs).exit_status
return utils.system(command, *args, **dargs)
def begin(self):
"""Make sure that log rotation is disabled."""
if self._begun:
print "in begin " + str(self._begun)
self._is_nested = (self._run(('[ -r %s ]' %
ignore_status=True) == 0)
print "in begin is nested: " + str(self._is_nested)
if self._is_nested:
print logging.__file__'File %s was already present' %
print 1
self._run('touch ' + CLEANUP_LOGS_PAUSED_FILE)
print 2
self._begun = True
def end(self):
print "in end" + str(self._begun)
assert self._begun
if not self._is_nested:
self._run('rm -f ' + CLEANUP_LOGS_PAUSED_FILE)
else:'Leaving existing %s file' % CLEANUP_LOGS_PAUSED_FILE)
self._begun = False