Georg Brandl | 243ad66 | 2009-05-05 09:00:19 +0000 | [diff] [blame] | 1 | # A test suite for pdb; at the moment, this only validates skipping of |
| 2 | # specified test modules (RFE #5142). |
| 3 | |
| 4 | import imp |
| 5 | import os |
| 6 | import sys |
| 7 | import doctest |
| 8 | import tempfile |
| 9 | |
| 10 | from test import support |
| 11 | # This little helper class is essential for testing pdb under doctest. |
| 12 | from test.test_doctest import _FakeInput |
| 13 | |
| 14 | |
Georg Brandl | 9fa2e02 | 2009-09-16 16:40:45 +0000 | [diff] [blame] | 15 | class PdbTestInput(object): |
| 16 | """Context manager that makes testing Pdb in doctests easier.""" |
| 17 | |
| 18 | def __init__(self, input): |
| 19 | self.input = input |
| 20 | |
| 21 | def __enter__(self): |
| 22 | self.real_stdin = sys.stdin |
| 23 | sys.stdin = _FakeInput(self.input) |
| 24 | |
| 25 | def __exit__(self, *exc): |
| 26 | sys.stdin = self.real_stdin |
| 27 | |
| 28 | |
| 29 | def test_pdb_displayhook(): |
| 30 | """This tests the custom displayhook for pdb. |
| 31 | |
| 32 | >>> def test_function(foo, bar): |
| 33 | ... import pdb; pdb.Pdb().set_trace() |
| 34 | ... pass |
| 35 | |
| 36 | >>> with PdbTestInput([ |
| 37 | ... 'foo', |
| 38 | ... 'bar', |
| 39 | ... 'for i in range(5): print(i)', |
| 40 | ... 'continue', |
| 41 | ... ]): |
| 42 | ... test_function(1, None) |
| 43 | > <doctest test.test_pdb.test_pdb_displayhook[0]>(3)test_function() |
| 44 | -> pass |
| 45 | (Pdb) foo |
| 46 | 1 |
| 47 | (Pdb) bar |
| 48 | (Pdb) for i in range(5): print(i) |
| 49 | 0 |
| 50 | 1 |
| 51 | 2 |
| 52 | 3 |
| 53 | 4 |
| 54 | (Pdb) continue |
| 55 | """ |
| 56 | |
| 57 | |
Georg Brandl | 243ad66 | 2009-05-05 09:00:19 +0000 | [diff] [blame] | 58 | def test_pdb_skip_modules(): |
| 59 | """This illustrates the simple case of module skipping. |
| 60 | |
| 61 | >>> def skip_module(): |
| 62 | ... import string |
| 63 | ... import pdb; pdb.Pdb(skip=['stri*']).set_trace() |
| 64 | ... string.capwords('FOO') |
Georg Brandl | 243ad66 | 2009-05-05 09:00:19 +0000 | [diff] [blame] | 65 | |
Georg Brandl | 9fa2e02 | 2009-09-16 16:40:45 +0000 | [diff] [blame] | 66 | >>> with PdbTestInput([ |
| 67 | ... 'step', |
| 68 | ... 'continue', |
| 69 | ... ]): |
Georg Brandl | 243ad66 | 2009-05-05 09:00:19 +0000 | [diff] [blame] | 70 | ... skip_module() |
Georg Brandl | 243ad66 | 2009-05-05 09:00:19 +0000 | [diff] [blame] | 71 | > <doctest test.test_pdb.test_pdb_skip_modules[0]>(4)skip_module() |
| 72 | -> string.capwords('FOO') |
| 73 | (Pdb) step |
| 74 | --Return-- |
| 75 | > <doctest test.test_pdb.test_pdb_skip_modules[0]>(4)skip_module()->None |
| 76 | -> string.capwords('FOO') |
| 77 | (Pdb) continue |
Georg Brandl | 9fa2e02 | 2009-09-16 16:40:45 +0000 | [diff] [blame] | 78 | """ |
Georg Brandl | 243ad66 | 2009-05-05 09:00:19 +0000 | [diff] [blame] | 79 | |
| 80 | |
| 81 | # Module for testing skipping of module that makes a callback |
| 82 | mod = imp.new_module('module_to_skip') |
| 83 | exec('def foo_pony(callback): x = 1; callback(); return None', mod.__dict__) |
| 84 | |
| 85 | |
| 86 | def test_pdb_skip_modules_with_callback(): |
| 87 | """This illustrates skipping of modules that call into other code. |
| 88 | |
| 89 | >>> def skip_module(): |
| 90 | ... def callback(): |
| 91 | ... return None |
Georg Brandl | 9fa2e02 | 2009-09-16 16:40:45 +0000 | [diff] [blame] | 92 | ... import pdb; pdb.Pdb(skip=['module_to_skip*']).set_trace() |
Georg Brandl | 243ad66 | 2009-05-05 09:00:19 +0000 | [diff] [blame] | 93 | ... mod.foo_pony(callback) |
Georg Brandl | 243ad66 | 2009-05-05 09:00:19 +0000 | [diff] [blame] | 94 | |
Georg Brandl | 9fa2e02 | 2009-09-16 16:40:45 +0000 | [diff] [blame] | 95 | >>> with PdbTestInput([ |
| 96 | ... 'step', |
| 97 | ... 'step', |
| 98 | ... 'step', |
| 99 | ... 'step', |
| 100 | ... 'step', |
| 101 | ... 'continue', |
| 102 | ... ]): |
Georg Brandl | 243ad66 | 2009-05-05 09:00:19 +0000 | [diff] [blame] | 103 | ... skip_module() |
Georg Brandl | 9fa2e02 | 2009-09-16 16:40:45 +0000 | [diff] [blame] | 104 | ... pass # provides something to "step" to |
Georg Brandl | 243ad66 | 2009-05-05 09:00:19 +0000 | [diff] [blame] | 105 | > <doctest test.test_pdb.test_pdb_skip_modules_with_callback[0]>(5)skip_module() |
| 106 | -> mod.foo_pony(callback) |
| 107 | (Pdb) step |
| 108 | --Call-- |
| 109 | > <doctest test.test_pdb.test_pdb_skip_modules_with_callback[0]>(2)callback() |
| 110 | -> def callback(): |
| 111 | (Pdb) step |
| 112 | > <doctest test.test_pdb.test_pdb_skip_modules_with_callback[0]>(3)callback() |
| 113 | -> return None |
| 114 | (Pdb) step |
| 115 | --Return-- |
| 116 | > <doctest test.test_pdb.test_pdb_skip_modules_with_callback[0]>(3)callback()->None |
| 117 | -> return None |
| 118 | (Pdb) step |
| 119 | --Return-- |
| 120 | > <doctest test.test_pdb.test_pdb_skip_modules_with_callback[0]>(5)skip_module()->None |
| 121 | -> mod.foo_pony(callback) |
| 122 | (Pdb) step |
Georg Brandl | 9fa2e02 | 2009-09-16 16:40:45 +0000 | [diff] [blame] | 123 | > <doctest test.test_pdb.test_pdb_skip_modules_with_callback[1]>(10)<module>() |
| 124 | -> pass # provides something to "step" to |
Georg Brandl | 243ad66 | 2009-05-05 09:00:19 +0000 | [diff] [blame] | 125 | (Pdb) continue |
Georg Brandl | 9fa2e02 | 2009-09-16 16:40:45 +0000 | [diff] [blame] | 126 | """ |
Georg Brandl | 243ad66 | 2009-05-05 09:00:19 +0000 | [diff] [blame] | 127 | |
| 128 | |
| 129 | def test_main(): |
| 130 | from test import test_pdb |
| 131 | support.run_doctest(test_pdb, verbosity=True) |
| 132 | |
| 133 | |
| 134 | if __name__ == '__main__': |
| 135 | test_main() |