client/common_lib/test.py

# Shell class for a test, inherited by all individual tests
#
# Methods:
#	__init__	initialise
#	initialize	run once for each job
#	setup		run once for each new version of the test installed
#	run		run the test (wrapped by job.run_test())
#
# Data:
#	job		backreference to the job this test instance is part of
#	outputdir	eg. results/<job>/<testname.tag>
#	resultsdir	eg. results/<job>/<testname.tag>/results
#	profdir		eg. results/<job>/<testname.tag>/profiling
#	debugdir	eg. results/<job>/<testname.tag>/debug
#	bindir		eg. tests/<test>
#	src		eg. tests/<test>/src
#	tmpdir		eg. tmp/<testname.tag>

import os, sys, re, fcntl, shutil, tarfile, warnings

from autotest_lib.client.common_lib import error, utils


class base_test:
	preserve_srcdir = False

	def __init__(self, job, bindir, outputdir):
		self.job = job
		self.autodir = job.autodir

		self.outputdir = outputdir
		tagged_testname = os.path.basename(self.outputdir)
		# check if the outputdir already exists, because if it does
		# then this test has already been run with the same tag earlier
		# in this job
		if os.path.exists(self.outputdir):
			testname, tag = (tagged_testname + '.').split('.', 1)
			msg = ("%s already exists, test <%s> may have already "
			       + "run with tag <%s>") % (tagged_testname,
							 testname, tag)
			raise error.TestError(msg)
		else:
			os.mkdir(self.outputdir)

		self.resultsdir = os.path.join(self.outputdir, 'results')
		os.mkdir(self.resultsdir)
		self.profdir = os.path.join(self.outputdir, 'profiling')
		os.mkdir(self.profdir)
		self.debugdir = os.path.join(self.outputdir, 'debug')
		os.mkdir(self.debugdir)
		self.bindir = bindir
		if hasattr(job, 'libdir'):
			self.libdir = job.libdir
		self.srcdir = os.path.join(self.bindir, 'src')

		self.tmpdir = os.path.join(job.tmpdir, tagged_testname)

		if os.path.exists(self.tmpdir):
			shutil.rmtree(self.tmpdir)
		os.mkdir(self.tmpdir)

		self.job.stdout.tee_redirect(
			os.path.join(self.debugdir, 'stdout'))
		self.job.stderr.tee_redirect(
			os.path.join(self.debugdir, 'stderr'))
		try:
			self.initialize()
			# compile and install the test, if needed.
			utils.update_version(self.srcdir, self.preserve_srcdir,
					     self.version, self.setup)
		finally:
			self.job.stderr.restore()
			self.job.stdout.restore()


	def assert_(self, expr, msg='Assertion failed.'):
		if not expr:
			raise error.TestError(msg)


	def write_test_keyval(self, attr_dict):
		utils.write_keyval(self.outputdir, attr_dict)


	@staticmethod
	def _append_type_to_keys(dictionary, typename):
		new_dict = {}
		for key, value in dictionary.iteritems():
			new_key = "%s{%s}" % (key, typename)
			new_dict[new_key] = value
		return new_dict


	def write_iteration_keyval(self, attr_dict, perf_dict):
		attr_dict = self._append_type_to_keys(attr_dict, "attr")
		perf_dict = self._append_type_to_keys(perf_dict, "perf")

		utils.write_keyval(self.resultsdir, attr_dict,
				   type_tag="attr")
		utils.write_keyval(self.resultsdir, perf_dict,
				   type_tag="perf")

		keyval_path = os.path.join(self.resultsdir, "keyval")
		print >> open(keyval_path, "a"), ""


	# TODO: deprecate, remove from code in favour of
	# the write_*_keyval methods
        def write_keyval(self, dictionary):
		warnings.warn("test.write_keyval is deprecated, use "
			      "test.write_test_keyval or "
			      "test.write_iteration_keyval instead",
			      DeprecationWarning)
		self.write_iteration_keyval({}, dictionary)


	def initialize(self):
		pass


	def setup(self):
		pass


	def cleanup(self):
		pass


	def _exec(self, args, dargs):
		try:
			self.job.stdout.tee_redirect(
			    os.path.join(self.debugdir, 'stdout'))
			self.job.stderr.tee_redirect(
			    os.path.join(self.debugdir, 'stderr'))

			try:
				os.chdir(self.outputdir)
				version_dict = {'version': self.version}
				self.write_test_keyval(version_dict)
				self.execute(*args, **dargs)
			finally:
				self.cleanup()
				self.job.stderr.restore()
				self.job.stdout.restore()
		except error.AutotestError:
			raise
		except Exception, e:
			msg = "Unhandled %s error occured during test\n"
			msg %= str(e.__class__.__name__)
			raise error.UnhandledError(msg)


def testname(url):
	# Extract the testname from the test url.
	match = re.match('[^:]+://(.*)/([^/]*)$', url)
	if not match:
		return ('', url)
	(group, filename) = match.groups()

	# Generate the group prefix.
	group = re.sub(r'\W', '_', group)

	# Drop the extension to get the raw test name.
	testname = re.sub(r'\.tgz', '', filename)

	return (group, testname)


def _installtest(job, url):
	(group, name) = testname(url)

	# Bail if the test is already installed
	group_dir = os.path.join(job.testdir, "download", group)
	if os.path.exists(os.path.join(group_dir, name)):
		return (group, name)

	# If the group directory is missing create it and add
	# an empty  __init__.py so that sub-directories are
	# considered for import.
	if not os.path.exists(group_dir):
		os.mkdir(group_dir)
		f = file(os.path.join(group_dir, '__init__.py'), 'w+')
		f.close()

	print name + ": installing test url=" + url
	get_file(url, os.path.join(group_dir, 'test.tgz'))
	old_wd = os.getcwd()
	os.chdir(group_dir)
	tar = tarfile.open('test.tgz')
	for member in tar.getmembers():
		tar.extract(member)
	tar.close()
	os.chdir(old_wd)
	os.remove(os.path.join(group_dir, 'test.tgz'))

	# For this 'sub-object' to be importable via the name
	# 'group.name' we need to provide an __init__.py,
	# so link the main entry point to this.
	os.symlink(name + '.py', os.path.join(group_dir, name,
				'__init__.py'))

	# The test is now installed.
	return (group, name)


def runtest(job, url, tag, args, dargs,
	    local_namespace={}, global_namespace={}, after_test_hook=None):
	local_namespace = local_namespace.copy()
	global_namespace = global_namespace.copy()

	# if this is not a plain test name then download and install the
	# specified test
	if utils.is_url(url):
		(group, testname) = _installtest(job, url)
		bindir = os.path.join(job.testdir, 'download', group, testname)
		site_bindir = None
	else:
		# if the test is local, it can be found in either testdir
		# or site_testdir. tests in site_testdir override tests
		# defined in testdir
		(group, testname) = ('', url)
		bindir = os.path.join(job.testdir, group, testname)
		if hasattr(job, 'site_testdir'):
			site_bindir = os.path.join(job.site_testdir,
						   group, testname)
		else:
			site_bindir = None

	outputdir = os.path.join(job.resultdir, testname)
	if tag:
		outputdir += '.' + tag

	# if we can find the test in site_bindir, use this version
	if site_bindir and os.path.exists(site_bindir):
		bindir = site_bindir
		testdir = job.site_testdir
	elif os.path.exists(bindir):
		testdir = job.testdir
	elif not os.path.exists(bindir):
		raise error.TestError(testname + ': test does not exist')

	if group:
		sys.path.insert(0, os.path.join(testdir, 'download'))
		group += '.'
	else:
		sys.path.insert(0, os.path.join(testdir, testname))

	local_namespace['job'] = job
	local_namespace['bindir'] = bindir
	local_namespace['outputdir'] = outputdir

	lockfile = open(os.path.join(job.tmpdir, '.testlock'), 'w')
	try:
		fcntl.flock(lockfile, fcntl.LOCK_EX)
		exec ("import %s%s" % (group, testname),
		      local_namespace, global_namespace)
		exec ("mytest = %s%s.%s(job, bindir, outputdir)" %
		      (group, testname, testname),
		      local_namespace, global_namespace)
	finally:
		fcntl.flock(lockfile, fcntl.LOCK_UN)
		lockfile.close()
		sys.path.pop(0)

	pwd = os.getcwd()
	os.chdir(outputdir)
	try:
		mytest = global_namespace['mytest']
		mytest._exec(args, dargs)
	finally:
		if after_test_hook:
			after_test_hook(mytest)