Mercurial > hg > MakeItSo
annotate makeitso/python_package/tests/run_doctests.py @ 197:bb57bec165b7
fix errors with template
author | Jeff Hammel <k0scist@gmail.com> |
---|---|
date | Mon, 09 Jun 2014 20:25:45 -0700 (2014-06-10) |
parents | 44bd0cc9bbc3 |
children |
rev | line source |
---|---|
81 | 1 #!/usr/bin/env python |
2 | |
3 """ | |
4 doctest runner | |
5 """ | |
6 | |
7 import doctest | |
8 import os | |
123
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
9 import sys |
125 | 10 from optparse import OptionParser |
11 | |
81 | 12 |
123
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
13 def run_tests(raise_on_error=False, report_first=False): |
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
14 |
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
15 # add results here |
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
16 results = {} |
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
17 |
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
18 # doctest arguments |
81 | 19 directory = os.path.dirname(os.path.abspath(__file__)) |
20 extraglobs = {'here': directory} | |
123
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
21 doctest_args = dict(extraglobs=extraglobs, raise_on_error=raise_on_error) |
145
c07dd14d5842
we always want doctest.ELLIPSIS. why the hell wouldnt we?
Jeff Hammel <jhammel@mozilla.com>
parents:
127
diff
changeset
|
22 doctest_args['optionsflags'] = doctest.ELLIPSIS |
123
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
23 if report_first: |
145
c07dd14d5842
we always want doctest.ELLIPSIS. why the hell wouldnt we?
Jeff Hammel <jhammel@mozilla.com>
parents:
127
diff
changeset
|
24 doctest_args['optionflags'] |= doctest.REPORT_ONLY_FIRST_FAILURE |
123
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
25 |
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
26 # gather tests |
146 | 27 tests = [test for test in os.listdir(directory) |
28 if test.endswith('.txt')] | |
123
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
29 |
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
30 # run the tests |
81 | 31 for test in tests: |
124 | 32 try: |
33 results[test] = doctest.testfile(test, **doctest_args) | |
34 except doctest.DocTestFailure, failure: | |
35 raise | |
36 except doctest.UnexpectedException, failure: | |
37 raise failure.exc_info[0], failure.exc_info[1], failure.exc_info[2] | |
123
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
38 |
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
39 return results |
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
40 |
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
41 def main(args=sys.argv[1:]): |
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
42 |
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
43 # parse command line args |
126
ea3225facbcf
add a description to the OptionParser
Jeff Hammel <jhammel@mozilla.com>
parents:
125
diff
changeset
|
44 parser = OptionParser(description=__doc__) |
123
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
45 parser.add_option('--raise', dest='raise_on_error', |
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
46 default=False, action='store_true', |
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
47 help="raise on first error") |
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
48 parser.add_option('--report-first', dest='report_first', |
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
49 default=False, action='store_true', |
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
50 help="report the first error only (all tests will still run)") |
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
51 options, args = parser.parse_args(args) |
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
52 |
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
53 # run the tests |
127 | 54 results = run_tests(**options.__dict__) |
123
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
55 if sum([i.failed for i in results.values()]): |
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
56 sys.exit(1) # error |
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
57 |
81 | 58 |
59 if __name__ == '__main__': | |
123
8db34885ebe4
tame that beast called doctest
Jeff Hammel <jhammel@mozilla.com>
parents:
102
diff
changeset
|
60 main() |