gem5/tests/testing/helpers.py
Andreas Sandberg f385adc8af tests: Add test infrastructure as a Python module
Implement gem5's test infrastructure as a Python module and a run
script that can be used without scons. The new implementation has
several features that were lacking from the previous test
infrastructure such as support for multiple output formats, automatic
runtime tracking, and better support for being run in a cluster
environment.

Tests consist of one or more steps (TestUnit). Units are run in two
stages, the first a run stage and then a verify stage. Units in the
verify stage are automatically skipped if any unit run stage wasn't
run. The library currently contains TestUnit implementations that run
gem5, diff stat files, and diff output files.

Existing tests are implemented by the ClassicTest class and "just
work". New tests can that don't rely on the old "run gem5 once and
diff output" strategy can be implemented by subclassing the Test base
class or ClassicTest.

Test results can be output in multiple formats. The module currently
supports JUnit, text (short and verbose), and Python's pickle
format. JUnit output allows CI systems to automatically get more
information about test failures. The pickled output contains all state
necessary to reconstruct a tests results object and is mainly intended
for the build system and CI systems.

Since many JUnit parsers parsers assume that test suite names look
like Java package names. We currently output path-like names with
slashes separating components. Test names are translated according to
these rules:

  * '.' -> '-"
  * '/' -> '.'

The test tool, tests.py, supports the following features:

  * Test listing. Example: ./tests.py list arm/quick

  * Running tests. Example:
    ./tests.py run -o output.pickle --format pickle \
        ../build/ARM/gem5.opt \
        quick/se/00.hello/arm/linux/simple-timing

  * Displaying pickled results. Example:
    ./tests.py show --format summary *.pickle

Change-Id: I527164bd791237aacfc65e7d7c0b67b695c5d17c
Signed-off-by: Andreas Sandberg <andreas.sandberg@arm.com>
Reviewed-by: Curtis Dunham <curtis.dunham@arm.com>
Reviewed-by: Joel Hestness <jthestness@gmail.com>
2016-05-26 11:56:24 +01:00

132 lines
4.6 KiB
Python
Executable file

#!/usr/bin/env python
#
# Copyright (c) 2016 ARM Limited
# All rights reserved
#
# The license below extends only to copyright in the software and shall
# not be construed as granting a license to any other intellectual
# property including but not limited to intellectual property relating
# to a hardware implementation of the functionality of the software
# licensed hereunder. You may use the software subject to the license
# terms below provided that you ensure that this notice is replicated
# unmodified and in its entirety in all distributions of the software,
# modified or unmodified, in source code or in binary form.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met: redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer;
# redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution;
# neither the name of the copyright holders nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
#
# Authors: Andreas Sandberg
import subprocess
from threading import Timer
import time
class CallTimeoutException(Exception):
"""Exception that indicates that a process call timed out"""
def __init__(self, status, stdout, stderr):
self.status = status
self.stdout = stdout
self.stderr = stderr
class ProcessHelper(subprocess.Popen):
"""Helper class to run child processes.
This class wraps a subprocess.Popen class and adds support for
using it in a with block. When the process goes out of scope, it's
automatically terminated.
with ProcessHelper(["/bin/ls"], stdout=subprocess.PIPE) as p:
return p.call()
"""
def __init__(self, *args, **kwargs):
super(ProcessHelper, self).__init__(*args, **kwargs)
def _terminate_nicely(self, timeout=5):
def on_timeout():
self.kill()
if self.returncode is not None:
return self.returncode
timer = Timer(timeout, on_timeout)
self.terminate()
status = self.wait()
timer.cancel()
return status
def __enter__(self):
return self
def __exit__(self, exc_type, exc_value, traceback):
if self.returncode is None:
self._terminate_nicely()
def call(self, timeout=0):
self._timeout = False
def on_timeout():
self._timeout = True
self._terminate_nicely()
status, stdout, stderr = None, None, None
timer = Timer(timeout, on_timeout)
if timeout:
timer.start()
stdout, stderr = self.communicate()
status = self.wait()
timer.cancel()
if self._timeout:
self._terminate_nicely()
raise CallTimeoutException(self.returncode, stdout, stderr)
else:
return status, stdout, stderr
if __name__ == "__main__":
# Run internal self tests to ensure that the helpers are working
# properly. The expected output when running this script is
# "SUCCESS!".
cmd_foo = [ "/bin/echo", "-n", "foo" ]
cmd_sleep = [ "/bin/sleep", "10" ]
# Test that things don't break if the process hasn't been started
with ProcessHelper(cmd_foo) as p:
pass
with ProcessHelper(cmd_foo, stdout=subprocess.PIPE) as p:
status, stdout, stderr = p.call()
assert stdout == "foo"
assert status == 0
try:
with ProcessHelper(cmd_sleep) as p:
status, stdout, stderr = p.call(timeout=1)
assert False, "Timeout not triggered"
except CallTimeoutException:
pass
print "SUCCESS!"