blob: 438239bd77d63c979e0f3604a65fd1f58ff871c8 [file] [log] [blame]
#!/usr/bin/python
#
# 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.
"""Script to archive old Autotest results to Google Storage.
Uses gsutil to archive files to the configured Google Storage bucket.
Upon successful copy, the local results directory is deleted.
"""
import datetime
import logging
import os
import shutil
import signal
import socket
import subprocess
import sys
import tempfile
import time
from optparse import OptionParser
import common
import job_directories
from autotest_lib.client.common_lib import global_config
from autotest_lib.scheduler import email_manager
from chromite.lib import parallel
# Google Storage bucket URI to store results in.
GS_URI = global_config.global_config.get_config_value(
'CROS', 'results_storage_server')
GS_URI_PATTERN = GS_URI + '%s'
# Nice setting for process, the higher the number the lower the priority.
NICENESS = 10
# Maximum number of seconds to allow for offloading a single
# directory.
OFFLOAD_TIMEOUT_SECS = 3 * 60 * 60
# Sleep time per loop.
SLEEP_TIME_SECS = 5
# Minimum number of seconds between e-mail reports.
REPORT_INTERVAL_SECS = 60 * 60
# Location of Autotest results on disk.
RESULTS_DIR = '/usr/local/autotest/results'
# Hosts sub-directory that contains cleanup, verify and repair jobs.
HOSTS_SUB_DIR = 'hosts'
LOG_LOCATION = '/usr/local/autotest/logs/'
LOG_FILENAME_FORMAT = 'gs_offloader_%s_log_%s.txt'
LOG_TIMESTAMP_FORMAT = '%Y%m%d_%H%M%S'
LOGGING_FORMAT = '%(asctime)s - %(levelname)s - %(message)s'
# pylint: disable=E1120
NOTIFY_ADDRESS = global_config.global_config.get_config_value(
'SCHEDULER', 'notify_email', default='')
ERROR_EMAIL_SUBJECT_FORMAT = 'GS Offloader notifications from %s'
ERROR_EMAIL_REPORT_FORMAT = '''\
gs_offloader is failing to offload results directories.
First failure Count Directory name
=================== ====== ==============================
'''
# --+----1----+---- ----+ ----+----1----+----2----+----3
ERROR_EMAIL_DIRECTORY_FORMAT = '%19s %5d %-1s\n'
ERROR_EMAIL_TIME_FORMAT = '%Y-%m-%d %H:%M:%S'
class TimeoutException(Exception):
"""Exception raised by the timeout_handler."""
pass
def timeout_handler(_signum, _frame):
"""Handler for SIGALRM when the offloading process times out.
@param _signum: Signal number of the signal that was just caught.
14 for SIGALRM.
@param _frame: Current stack frame.
@raise TimeoutException: Automatically raises so that the time out is caught
by the try/except surrounding the Popen call.
"""
raise TimeoutException('Process Timed Out')
def get_cmd_list(dir_entry, relative_path):
"""Return the command to offload a specified directory.
@param dir_entry: Directory entry/path that which we need a cmd_list to
offload.
@param relative_path: Location in google storage where we will
offload the directory.
@return: A command list to be executed by Popen.
"""
logging.debug('Using google storage for offloading %s to %s.',
dir_entry, relative_path)
return ['gsutil', '-m', 'cp', '-eR', '-a', 'project-private',
dir_entry, GS_URI_PATTERN % relative_path]
def offload_dir(dir_entry, dest_path):
"""Offload the specified directory entry to Google storage.
@param dir_entry: Directory entry to offload.
@param dest_path: Location in google storage where we will offload
the directory.
"""
try:
error = False
signal.alarm(OFFLOAD_TIMEOUT_SECS)
stdout_file = tempfile.TemporaryFile('w+')
stderr_file = tempfile.TemporaryFile('w+')
process = subprocess.Popen(get_cmd_list(dir_entry, dest_path),
stdout=stdout_file, stderr=stderr_file)
process.wait()
signal.alarm(0)
if process.returncode == 0:
shutil.rmtree(dir_entry)
else:
error = True
except TimeoutException:
process.terminate()
logging.error('Offloading %s timed out after waiting %d seconds.',
dir_entry, OFFLOAD_TIMEOUT_SECS)
error = True
finally:
signal.alarm(0)
if error:
# Rewind the log files for stdout and stderr and log their contents.
stdout_file.seek(0)
stderr_file.seek(0)
logging.error('Error occurred when offloading %s:', dir_entry)
logging.error('Stdout:\n%s \nStderr:\n%s',
stdout_file.read(), stderr_file.read())
stdout_file.close()
stderr_file.close()
def delete_files(dir_entry, dest_path):
"""Simply deletes the dir_entry from the filesystem.
Uses same arguments as offload_dir so that it can be used in replace of it on
systems that only want to delete files instead of offloading them.
@param dir_entry: Directory entry to offload.
@param dest_path: NOT USED.
"""
shutil.rmtree(dir_entry)
def report_offload_failures(joblist):
"""Generate e-mail notification for failed offloads.
The e-mail report will include data from all jobs in `joblist`.
@param joblist List of jobs to be reported in the message.
"""
def _format_job(job):
d = datetime.datetime.fromtimestamp(job.get_failure_time())
data = (d.strftime(ERROR_EMAIL_TIME_FORMAT),
job.get_failure_count(),
job.get_job_directory())
return ERROR_EMAIL_DIRECTORY_FORMAT % data
joblines = [_format_job(job) for job in joblist]
joblines.sort()
email_subject = ERROR_EMAIL_SUBJECT_FORMAT % socket.gethostname()
email_message = ERROR_EMAIL_REPORT_FORMAT + ''.join(joblines)
email_manager.manager.send_email(NOTIFY_ADDRESS, email_subject,
email_message)
class Offloader(object):
"""State of the offload process.
Contains the following member fields:
* _offload_func: Function to call for each attempt to offload
a job directory.
* _jobdir_classes: List of classes of job directory to be
offloaded.
* _processes: Maximum number of outstanding offload processes
to allow during an offload cycle.
* _age_limit: Minimum age in days at which a job may be
offloaded.
* _open_jobs: a dictionary mapping directory paths to Job
objects.
* _next_report_time: Earliest time that we should send e-mail
if there are failures to be reported.
"""
def __init__(self, options):
if options.delete_only:
self._offload_func = delete_files
else:
self._offload_func = offload_dir
classlist = []
if options.process_hosts_only or options.process_all:
classlist.append(job_directories.SpecialJobDirectory)
if not options.process_hosts_only:
classlist.append(job_directories.RegularJobDirectory)
self._jobdir_classes = classlist
assert self._jobdir_classes
self._processes = options.parallelism
self._age_limit = options.days_old
self._open_jobs = {}
self._next_report_time = time.time()
def _add_new_jobs(self):
"""Find new job directories that need offloading.
Go through the file system looking for valid job directories
that are currently not in `self._open_jobs`, and add them in.
"""
for cls in self._jobdir_classes:
for resultsdir in cls.get_job_directories():
if resultsdir in self._open_jobs:
continue
self._open_jobs[resultsdir] = cls(resultsdir)
def _remove_offloaded_jobs(self):
"""Removed offloaded jobs from `self._open_jobs`."""
for jobkey, job in self._open_jobs.items():
if job.is_offloaded():
del self._open_jobs[jobkey]
def _have_reportable_errors(self):
"""Return whether any jobs need reporting via e-mail.
@returns True if there are reportable jobs in `self._open_jobs`,
or False otherwise.
"""
for job in self._open_jobs.values():
if job.is_reportable():
return True
return False
def _update_offload_results(self):
"""Check and report status after attempting offload.
This function processes all jobs in `self._open_jobs`, assuming
an attempt has just been made to offload all of them.
Any jobs that have been successfully offloaded are removed.
If any jobs have reportable errors, and we haven't generated
an e-mail report in the last `REPORT_INTERVAL_SECS` seconds,
send new e-mail describing the failures.
"""
self._remove_offloaded_jobs()
if (self._have_reportable_errors() and
time.time() >= self._next_report_time):
# N.B. We include all jobs that have failed at least once,
# which may include jobs that aren't otherwise reportable.
report_offload_failures([j for j in self._open_jobs.values()
if j.get_failure_time()])
self._next_report_time = time.time() + REPORT_INTERVAL_SECS
def offload_once(self):
"""Perform one offload cycle.
Find all job directories for new jobs that we haven't seen
before. Then, attempt to offload the directories for any
jobs that have finished running. Offload of multiple jobs
is done in parallel, up to `self._processes` at a time.
After we've tried uploading all directories, go through the list
checking the status of all uploaded directories. If necessary,
report failures via e-mail.
"""
self._add_new_jobs()
with parallel.BackgroundTaskRunner(
self._offload_func, processes=self._processes) as queue:
for job in self._open_jobs.values():
job.enqueue_offload(queue, self._age_limit)
self._update_offload_results()
def parse_options():
"""Parse the args passed into gs_offloader."""
defaults = 'Defaults:\n Destination: %s\n Results Path: %s' % (GS_URI,
RESULTS_DIR)
usage = 'usage: %prog [options]\n' + defaults
parser = OptionParser(usage)
parser.add_option('-a', '--all', dest='process_all', action='store_true',
help='Offload all files in the results directory.')
parser.add_option('-s', '--hosts', dest='process_hosts_only',
action='store_true',
help='Offload only the special tasks result files located'
'in the results/hosts subdirectory')
parser.add_option('-p', '--parallelism', dest='parallelism', type='int',
default=1, help='Number of parallel workers to use.')
parser.add_option('-o', '--delete_only', dest='delete_only',
action='store_true',
help='GS Offloader will only the delete the directories '
'and will not offload them to google storage.',
default=False)
parser.add_option('-d', '--days_old', dest='days_old',
help='Minimum job age in days before a result can be '
'offloaded.', type='int', default=0)
options = parser.parse_args()[0]
if options.process_all and options.process_hosts_only:
parser.print_help()
print ('Cannot process all files and only the hosts subdirectory. '
'Please remove an argument.')
sys.exit(1)
return options
def main():
"""Main method of gs_offloader."""
options = parse_options()
if options.process_all:
offloader_type = 'all'
elif options.process_hosts_only:
offloader_type = 'hosts'
else:
offloader_type = 'jobs'
log_timestamp = time.strftime(LOG_TIMESTAMP_FORMAT)
log_filename = os.path.join(LOG_LOCATION,
LOG_FILENAME_FORMAT % (offloader_type, log_timestamp))
logging.basicConfig(filename=log_filename, level=logging.DEBUG,
format=LOGGING_FORMAT)
# Nice our process (carried to subprocesses) so we don't overload
# the system.
logging.debug('Set process to nice value: %d', NICENESS)
os.nice(NICENESS)
# os.listdir returns relative paths, so change to where we need to be to avoid
# an os.path.join on each loop.
logging.debug('Offloading Autotest results in %s', RESULTS_DIR)
os.chdir(RESULTS_DIR)
signal.signal(signal.SIGALRM, timeout_handler)
offloader = Offloader(options)
while True:
offloader.offload_once()
time.sleep(SLEEP_TIME_SECS)
if __name__ == '__main__':
main()