run_tests Namespace Reference

Classes
class	TestCase
class	TestSuite

Functions
	main ()
	write_junit_xml (test_results)
	print_captured_output (test_results)
	safe_str (obj)
	run_tests (tests_dir)

Variables
	unichr = chr
str	__author__ = "Tamas Gal"
str	__credits__ = "Brian Beyer"
str	__license__ = "MIT"
str	__email__ = "tgal@km3net.de"
str	__status__ = "Development"
	TESTS_DIR = sys.argv[1]
str	JUNIT_XML = 'out/junit_{}.xml'.format(os.path.basename(TESTS_DIR))
str	INFO = '\033[94m'
str	OK = '\033[92m'
str	FAIL = '\033[91m'
str	RST = '\033[0m'
str	BOLD = '\033[1m'

Detailed Description

A test runner for Jpp.
This script traverses the tests directory and reports a summary.

Function Documentation

main()

run_tests.main

(

)

Definition at line 50 of file run_tests.py.

def main():
    test_results = run_tests(TESTS_DIR)
    n_tests = len(test_results)
    n_failed_tests = sum(1 for r in test_results.values() if r[0] > 0)
    total_time = sum(r[1] for r in test_results.values())
 
    print("\n{}"
          "Test summary\n"
          "============\n{}"
          "Total number of tests: {}\n{}"
          "Failed tests: {}{}\n"
          "Elapsed time: {:.1f}s\n".format(
              INFO, RST, n_tests, BOLD + FAIL if n_failed_tests > 0 else OK,
              n_failed_tests, RST, total_time))
 
    write_junit_xml(test_results)
 
    if n_failed_tests > 0:
        print_captured_output(test_results)
        exit(1)
    else:
        exit(0)
 
 

write_junit_xml()

run_tests.write_junit_xml

(

test_results

)

Generate XML file according to JUnit specs

Definition at line 74 of file run_tests.py.

def write_junit_xml(test_results):
    """Generate XML file according to JUnit specs"""
    test_cases = []
    for test_script, (exit_code, t, stdout, stderr) in test_results.items():
        test_case = TestCase(test_script,
                             elapsed_sec=t,
                             stdout=stdout,
                             stderr=stderr)
        if exit_code > 0:
            test_case.add_error_info('non-zero exit-code: %d' % exit_code)
        test_cases.append(test_case)
    test_suite = TestSuite("Jpp Test Suite", test_cases)
    with open(JUNIT_XML, 'w') as f:
        TestSuite.to_file(f, [test_suite])
 
 

print_captured_output()

run_tests.print_captured_output

(

test_results

)

Prints the STDOUT and STDERR of failing test scripts

Definition at line 90 of file run_tests.py.

def print_captured_output(test_results):
    """Prints the STDOUT and STDERR of failing test scripts"""
    print("{}"
          "Captured output of failing tests\n"
          "================================\n{}".format(INFO, RST))
    for test_script, (exit_code, t, stdout, stderr) in test_results.items():
        if exit_code > 0:
            print("{}\n{}\n".format(test_script, len(test_script) * '-'))
            print('{}stdout:{}\n{}\n{}stderr:{}\n{}'.format(
                OK + BOLD, RST, stdout, FAIL + BOLD, RST, stderr))
 
 

safe_str()

run_tests.safe_str

(

obj

)

Definition at line 102 of file run_tests.py.

def safe_str(obj):
    return obj.decode('utf-8').encode('ascii', 'ignore').decode('ascii')
 
 

run_tests()

run_tests.run_tests

(

tests_dir

)

Runs each script in the tests directory and returns the results.

Parameters
----------
tests_dir: str
  The path to the test dir, containing the test scripts (`*.sh`).

Returns
-------
dict: key = script path, value = (exit_code, elapsed_time, stdout, stderr)

Definition at line 106 of file run_tests.py.

def run_tests(tests_dir):
    """Runs each script in the tests directory and returns the results.
 
    Parameters
    ----------
    tests_dir: str
      The path to the test dir, containing the test scripts (`*.sh`).
 
    Returns
    -------
    dict: key = script path, value = (exit_code, elapsed_time, stdout, stderr)
 
    """
    test_results = {}
 
    for subdir in sorted(glob(join(tests_dir, '*'))):
        component_group = basename(subdir)
        print("\n{}{}\n{}{}".format(INFO, component_group,
                                    len(component_group) * '=', RST))
        for test_script in sorted(glob(join(subdir, '*.sh')) + glob(join(subdir, '*.csh'))):
            print("+ {}".format(test_script), end=' => ')
            sys.stdout.flush()
            start_time = time()
            proc = Popen(test_script, stdout=PIPE, stderr=PIPE)
            out, err = [safe_str(t) for t in proc.communicate()]
            exit_code = proc.wait()
            delta_t = time() - start_time
            test_results[test_script] = (exit_code, delta_t, out, err)
            print(" ({:.2f} s) ".format(delta_t), end='')
            sys.stdout.flush()
            if exit_code > 0:
                print("{}FAILED (exit code {}){}".format(FAIL, exit_code, RST))
                sys.stdout.flush()
            else:
                print("{}OK{}".format(OK, RST))
                sys.stdout.flush()
 
    return test_results
 
 

Variable Documentation

unichr

run_tests.unichr = chr

Definition at line 29 of file run_tests.py.

__author__

str run_tests.__author__ = "Tamas Gal"

private

Definition at line 31 of file run_tests.py.

__credits__

str run_tests.__credits__ = "Brian Beyer"

private

Definition at line 32 of file run_tests.py.

__license__

str run_tests.__license__ = "MIT"

private

Definition at line 33 of file run_tests.py.

__email__

str run_tests.__email__ = "tgal@km3net.de"

private

Definition at line 34 of file run_tests.py.

__status__

str run_tests.__status__ = "Development"

private

Definition at line 35 of file run_tests.py.

TESTS_DIR

run_tests.TESTS_DIR = sys.argv[1]

Definition at line 37 of file run_tests.py.

JUNIT_XML

str run_tests.JUNIT_XML = 'out/junit_{}.xml'.format(os.path.basename(TESTS_DIR))

Definition at line 38 of file run_tests.py.

INFO

run_tests.INFO = '\033[94m'

Definition at line 41 of file run_tests.py.

OK

run_tests.OK = '\033[92m'

Definition at line 42 of file run_tests.py.

FAIL

run_tests.FAIL = '\033[91m'

Definition at line 43 of file run_tests.py.

RST

run_tests.RST = '\033[0m'

Definition at line 44 of file run_tests.py.

BOLD

run_tests.BOLD = '\033[1m'

Definition at line 45 of file run_tests.py.