Move the meat of autoserv into a separate job class, and provide logging
functionality to a server-level status file
Signed-off-by: Martin J. Bligh <mbligh@google.com>
git-svn-id: http://test.kernel.org/svn/autotest/trunk@801 592f7852-d20e-0410-864c-8624ca9c26a4
diff --git a/server/server_job.py b/server/server_job.py
new file mode 100755
index 0000000..495b970
--- /dev/null
+++ b/server/server_job.py
@@ -0,0 +1,264 @@
+"""
+The main job wrapper for the server side.
+
+This is the core infrastructure. Derived from the client side job.py
+
+Copyright Martin J. Bligh, Andy Whitcroft 2007
+"""
+
+__author__ = """
+Martin J. Bligh <mbligh@google.com>
+Andy Whitcroft <apw@shadowen.org>
+"""
+
+import os, sys, re
+from utils import *
+
+preamble = """\
+import os, sys
+
+import errors, hosts, autotest, kvm
+import source_kernel, rpm_kernel, deb_kernel
+from subcommand import *
+from utils import run, get_tmp_dir, sh_escape
+
+"""
+
+client_wrapper = """
+at = autotest.Autotest()
+
+def run_client(machine):
+ host = hosts.SSHHost(machine)
+ at.run(control, host=host)
+
+if len(machines) > 1:
+ parallel_simple(run_client, machines)
+else:
+ run_client(machines[0])
+"""
+
+cleanup="""\
+def cleanup(machine):
+ host = hosts.SSHHost(machine, initialize=False)
+ host.reboot()
+
+parallel_simple(cleanup, machines)
+"""
+
+class server_job:
+ """The actual job against which we do everything.
+
+ Properties:
+ autodir
+ The top level autotest directory (/usr/local/autotest).
+ serverdir
+ <autodir>/server/
+ clientdir
+ <autodir>/client/
+ conmuxdir
+ <autodir>/conmux/
+ testdir
+ <autodir>/server/tests/
+ control
+ the control file for this job
+ """
+
+ def __init__(self, control, args, resultdir, tag, user, client=False):
+ """
+ control
+ The control file (pathname of)
+ args
+ args to pass to the control file
+ resultdir
+ where to throw the results
+ tag
+ tag for the job
+ user
+ Username for the job (email address)
+ client
+ True if a client-side control file
+ """
+ path = sys.modules['server_job'].__file__
+ self.autodir = os.path.abspath(os.path.join(path, '..'))
+ self.serverdir = os.path.join(self.autodir, 'server')
+ self.testdir = os.path.join(self.autodir, 'tests')
+ self.conmuxdir = os.path.join(self.autodir, 'conmux')
+ self.clientdir = os.path.join(self.autodir, 'client')
+ self.control = re.sub('\r\n', '\n', open(control, 'r').read())
+ self.resultdir = resultdir
+ if not os.path.exists(resultdir):
+ os.mkdir(resultdir)
+ self.tag = tag
+ self.user = user
+ self.args = args
+ self.client = client
+ self.record_prefix = ''
+
+ job_data = { 'tag' : tag, 'user' : user}
+ write_keyval(self.resultdir, job_data)
+
+
+ def run(self, machines, reboot = False, namespace = {}):
+ namespace['machines'] = machines
+ namespace['args'] = self.args
+ namespace['job'] = self
+
+ os.chdir(self.resultdir)
+ try:
+ if self.client:
+ namespace['control'] = self.control
+ open('control', 'w').write(self.control)
+ open('control.srv', 'w').write(client_wrapper)
+ server_control = client_wrapper
+ else:
+ open('control.srv', 'w').write(self.control)
+ server_control = self.control
+ print preamble
+ print server_control
+ exec(preamble + server_control, namespace, namespace)
+
+ finally:
+ if reboot and machines:
+ exec(preamble + cleanup, namespace, namespace)
+
+
+ def run_test(self, url, *args, **dargs):
+ """Summon a test object and run it.
+
+ tag
+ tag to add to testname
+ url
+ url of the test to run
+ """
+
+ if not url:
+ raise "Test name is invalid. Switched arguments?"
+ (group, testname) = test.testname(url)
+ tag = None
+ subdir = testname
+ if dargs.has_key('tag'):
+ tag = dargs['tag']
+ del dargs['tag']
+ if tag:
+ subdir += '.' + tag
+ try:
+ try:
+ self.__runtest(url, tag, args, dargs)
+ except Exception, detail:
+ self.record('FAIL', subdir, testname, \
+ detail.__str__())
+
+ raise
+ else:
+ self.record('GOOD', subdir, testname, \
+ 'completed successfully')
+ except TestError:
+ return 0
+ except:
+ raise
+ else:
+ return 1
+
+
+ def run_group(self, function, *args, **dargs):
+ """\
+ function:
+ subroutine to run
+ *args:
+ arguments for the function
+ """
+
+ result = None
+ name = function.__name__
+
+ # Allow the tag for the group to be specified.
+ if dargs.has_key('tag'):
+ tag = dargs['tag']
+ del dargs['tag']
+ if tag:
+ name = tag
+
+ # if tag:
+ # name += '.' + tag
+ old_record_prefix = self.record_prefix
+ try:
+ try:
+ self.record('START', None, name)
+ self.record_prefix += '\t'
+ result = function(*args, **dargs)
+ self.record_prefix = old_record_prefix
+ self.record('END GOOD', None, name)
+ except:
+ self.record_prefix = old_record_prefix
+ self.record('END FAIL', None, name, format_error())
+ # We don't want to raise up an error higher if it's just
+ # a TestError - we want to carry on to other tests. Hence
+ # this outer try/except block.
+ except TestError:
+ pass
+ except:
+ raise TestError(name + ' failed\n' + format_error())
+
+ return result
+
+
+ def record(self, status_code, subdir, operation, status = ''):
+ """
+ Record job-level status
+
+ The intent is to make this file both machine parseable and
+ human readable. That involves a little more complexity, but
+ really isn't all that bad ;-)
+
+ Format is <status code>\t<subdir>\t<operation>\t<status>
+
+ status code: (GOOD|WARN|FAIL|ABORT)
+ or START
+ or END (GOOD|WARN|FAIL|ABORT)
+
+ subdir: MUST be a relevant subdirectory in the results,
+ or None, which will be represented as '----'
+
+ operation: description of what you ran (e.g. "dbench", or
+ "mkfs -t foobar /dev/sda9")
+
+ status: error message or "completed sucessfully"
+
+ ------------------------------------------------------------
+
+ Initial tabs indicate indent levels for grouping, and is
+ governed by self.record_prefix
+
+ multiline messages have secondary lines prefaced by a double
+ space (' ')
+ """
+
+ if subdir:
+ if re.match(r'[\n\t]', subdir):
+ raise "Invalid character in subdir string"
+ substr = subdir
+ else:
+ substr = '----'
+
+ if not re.match(r'(START|(END )?(GOOD|WARN|FAIL|ABORT))$', \
+ status_code):
+ raise "Invalid status code supplied: %s" % status_code
+ if re.match(r'[\n\t]', operation):
+ raise "Invalid character in operation string"
+ operation = operation.rstrip()
+ status = status.rstrip()
+ status = re.sub(r"\t", " ", status)
+ # Ensure any continuation lines are marked so we can
+ # detect them in the status file to ensure it is parsable.
+ status = re.sub(r"\n", "\n" + self.record_prefix + " ", status)
+
+ msg = '%s\t%s\t%s\t%s' %(status_code, substr, operation, status)
+
+ status_file = os.path.join(self.resultdir, 'status')
+ print status_file
+ print msg
+ open(status_file, "a").write(self.record_prefix + msg + "\n")
+ if subdir:
+ status_file = os.path.join(self.resultdir, subdir, 'status')
+ open(status_file, "a").write(msg + "\n")
+