| Eli Bendersky | b922360 | 2011-12-28 10:06:55 +0200 | [diff] [blame] | 1 | #!/usr/bin/env python |
| 2 | #------------------------------------------------------------------------------- |
| 3 | # test/run_examples_test.py |
| 4 | # |
| 5 | # Run the examples and compare their output to a reference |
| 6 | # |
| 7 | # Eli Bendersky (eliben@gmail.com) |
| 8 | # This code is in the public domain |
| 9 | #------------------------------------------------------------------------------- |
| 10 | import os, sys |
| 11 | import logging |
| 12 | sys.path.insert(0, '.') |
| 13 | from test.utils import run_exe, is_in_rootdir, dump_output_to_temp_files |
| 14 | |
| 15 | |
| 16 | # Create a global logger object |
| 17 | # |
| 18 | testlog = logging.getLogger('run_examples_test') |
| 19 | testlog.setLevel(logging.DEBUG) |
| 20 | testlog.addHandler(logging.StreamHandler(sys.stdout)) |
| 21 | |
| 22 | |
| 23 | def discover_examples(): |
| 24 | """ Return paths to all example scripts. Assume we're in the root source |
| 25 | dir of pyelftools. |
| 26 | """ |
| 27 | root = './examples' |
| 28 | for filename in os.listdir(root): |
| 29 | if os.path.splitext(filename)[1] == '.py': |
| 30 | yield os.path.join(root, filename) |
| 31 | |
| 32 | |
| 33 | def reference_output_path(example_path): |
| 34 | """ Compute the reference output path from a given example path. |
| 35 | """ |
| 36 | examples_root, example_name = os.path.split(example_path) |
| 37 | example_noext, _ = os.path.splitext(example_name) |
| 38 | return os.path.join(examples_root, 'reference_output', example_noext + '.out') |
| 39 | |
| 40 | |
| 41 | def run_example_and_compare(example_path): |
| 42 | testlog.info("Example '%s'" % example_path) |
| 43 | |
| 44 | reference_path = reference_output_path(example_path) |
| 45 | ref_str = '' |
| 46 | try: |
| 47 | with open(reference_path) as ref_f: |
| 48 | ref_str = ref_f.read() |
| 49 | except (IOError, OSError) as e: |
| 50 | testlog.info('.......ERROR - reference output cannot be read! - %s' % e) |
| 51 | return False |
| 52 | |
| 53 | rc, example_out = run_exe(example_path, ['./examples/sample_exe64.elf']) |
| 54 | if rc != 0: |
| 55 | testlog.info('.......ERROR - example returned error code %s' % rc) |
| 56 | return False |
| 57 | |
| 58 | if example_out == ref_str: |
| 59 | return True |
| 60 | else: |
| 61 | testlog.info('.......FAIL comparison') |
| 62 | dump_output_to_temp_files(testlog, example_out) |
| 63 | return False |
| 64 | |
| 65 | |
| 66 | def main(): |
| 67 | if not is_in_rootdir(): |
| 68 | testlog.error('Error: Please run me from the root dir of pyelftools!') |
| 69 | return 1 |
| 70 | |
| 71 | success = True |
| 72 | for example_path in discover_examples(): |
| 73 | if success: |
| 74 | success = success and run_example_and_compare(example_path) |
| 75 | |
| 76 | if success: |
| 77 | testlog.info('\nConclusion: SUCCESS') |
| 78 | return 0 |
| 79 | else: |
| 80 | testlog.info('\nConclusion: FAIL') |
| 81 | return 1 |
| 82 | |
| 83 | |
| 84 | if __name__ == '__main__': |
| 85 | sys.exit(main()) |
| 86 | |