source: trunk/anuga_work/development/2010-projects/anuga_1d/test_all.py @ 7884

Last change on this file since 7884 was 7884, checked in by steve, 12 years ago

Moving 2010 project

File size: 6.5 KB
Line 
1"""Regression testing framework
2This module will search for scripts in the same directory named
3test_*.py.  Each such script should be a test suite that tests a
4module through PyUnit. This script will aggregate all
5found test suites into one big test suite and run them all at once.
6"""
7
8# Author: Mark Pilgrim
9# Modified by Ole Nielsen
10
11import unittest
12import os
13import sys
14import tempfile
15import time
16import anuga.utilities.system_tools as aust
17from anuga.utilities.terminal_width import terminal_width
18
19
20#List files that should be excluded from the testing process.
21#E.g. if they are known to fail and under development
22exclude_files = []
23
24# Directories that should not be searched for test files.
25exclude_dirs = ['channel',  '.svn'] 
26               
27
28
29##
30# @brief List a string sequence on the screen in columns.
31# @param names Sequence of strings to list.
32# @param func Function to apply to each string in sequence.
33# @param col_width Force columns to this width (default calculated).
34# @param page_width Set displayable page width to this (default 132).
35def list_names(names, func=None, col_width=None, page_width=None):
36    # set defaults
37    p_width = page_width - 1            # set page width
38    if p_width is None:
39        p_width = 132                   # default page width
40
41    c_width = col_width                 # set column width
42    if c_width is None:
43        c_width = 0
44        for name in names:
45            if func:
46                name = func(name)
47            c_width = max(c_width, len(name))
48    c_width += 2                        # 2 column padding
49
50    # calculate number of columns allowed
51    max_columns = int(p_width / c_width)
52
53    # print columns
54    column = 0
55    for name in names:
56        if func:
57            name = func(name)
58        print '%-*s' % (c_width-1, name),
59        column += 1
60        if column >= max_columns:
61            column = 0
62            print
63
64    # if last line not finished, end it here
65    if column > 0:
66        print
67
68
69##
70# @brief Get 'test_*.py' files and paths to directories.
71# @param path Path to directory to start walk in.
72# @return A tuple (<files>, <dirs>).
73# @note Don't include any files in and below forbidden directories.
74def get_test_files(path):
75    walk = os.walk(path)
76
77    test_files = []
78    path_files = []
79
80    for (dirpath, dirnames, filenames) in walk:
81        # exclude forbidden directories
82        for e_dir in exclude_dirs:
83            try:
84                dirnames.remove(e_dir)
85            except ValueError:
86                pass
87
88        # check for test_*.py files
89        for filename in filenames:
90            if filename.startswith('test_') and filename.endswith('.py'):
91                test_files.append(filename)
92                if dirpath not in path_files:
93                    path_files.append(dirpath)
94
95    return test_files, path_files
96
97
98def regressionTest(test_verbose=False):
99    # start off with where we are
100    path = os.getcwd()
101    print
102    print 'Testing path: %s' % path
103
104    # get the terminal width
105    term_width = terminal_width()
106
107    # explain what we are doing
108    print
109    print "The following directories will be skipped over:"
110    exclude_dirs.sort()
111    list_names(exclude_dirs, page_width=term_width)
112
113    # get all test_*.py and enclosing directories
114    test_files, path_files = get_test_files(path)
115    path_files.sort()
116
117    files = [x for x in test_files if not x == 'test_all.py']
118    files.sort()        # Ensure same order on all platforms
119
120    print
121    print 'Paths searched:'
122    list_names(path_files, os.path.basename, page_width=term_width)
123
124    print   
125    print 'Files tested:'
126    list_names(files, page_width=term_width)
127    print
128
129    # update system path with found paths
130    for path in path_files:
131        sys.path.append(path)
132   
133    # exclude files that we can't handle
134    for file in exclude_files:
135        print 'WARNING: File '+ file + ' to be excluded from testing'
136        try:
137            files.remove(file)
138        except ValueError, e:
139            msg = 'File "%s" was not found in test suite.\n' % file
140            msg += 'Original error is "%s"\n' % e
141            msg += 'Perhaps it should be removed from exclude list?'
142            raise Exception, msg
143
144    # import all test_*.py files
145    # NOTE: This implies that test_*.py files MUST HAVE UNIQUE NAMES!
146    filenameToModuleName = lambda f: os.path.splitext(f)[0]
147    moduleNames = map(filenameToModuleName, files)
148    modules = map(__import__, moduleNames)
149
150    # Fix up the system path
151    for file in path_files:
152        sys.path.remove(file)
153
154    # bundle up all the tests
155    load = unittest.defaultTestLoader.loadTestsFromModule
156    testCaseClasses = map(load, modules)
157
158    if test_verbose is True:
159        # Test the code by setting verbose to True.
160        # The test cases have to be set up for this to work.
161        # See test data manager for an example.
162        for test_suite in testCaseClasses:
163            for tests in test_suite._tests:
164                # tests is of class TestSuite
165                if len(tests._tests) > 1:
166                    # these are the test functions
167                    try:
168                        # Calls class method set_verbose in test case classes
169                        tests._tests[0].set_verbose()
170                    except:
171                        pass                # No all classes have set_verbose
172
173    return unittest.TestSuite(testCaseClasses)
174
175
176##
177# @brief Check that the environment is sane.
178# @note Stops here if there is an error.
179def check_anuga_1d_import():
180    try:
181        # importing something that loads quickly
182        import anuga_1d.config
183    except ImportError:
184        print "Python cannot import ANUGA_1D module."
185        print "Check you have followed all steps of its installation."
186        import sys
187        sys.exit()
188
189
190if __name__ == '__main__':
191    check_anuga_1d_import()
192
193    if len(sys.argv) > 1 and sys.argv[1][0].upper() == 'V':
194        test_verbose = True
195        saveout = sys.stdout
196        filename = ".temp"
197        fid = open(filename, 'w')
198        sys.stdout = fid
199    else:
200        test_verbose = False
201    suite = regressionTest(test_verbose)
202    runner = unittest.TextTestRunner() #verbosity=2
203    runner.run(suite)
204
205    # timestamp at the end
206    timestamp = time.asctime()
207    version = aust.get_revision_number()
208    print
209    print 'Finished at %s, version %s' % (timestamp, version)
210
211    # Cleaning up
212    if len(sys.argv) > 1 and sys.argv[1][0].upper() == 'V':
213        sys.stdout = saveout
214        #fid.close() # This was causing an error in windows
215        #os.remove(filename)
216
217   
218    if sys.platform == 'win32':
219        raw_input('Press the RETURN key')
Note: See TracBrowser for help on using the repository browser.