1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
from xdoctest.utils import util_misc
import sys
from xdoctest import utils
def cmd(command):
# simplified version of ub.cmd no fancy tee behavior
import subprocess
proc = subprocess.Popen(
command, shell=True, universal_newlines=True,
stdout=subprocess.PIPE, stderr=subprocess.PIPE
)
out, err = proc.communicate()
ret = proc.wait()
info = {
'proc': proc,
'out': out,
'err': err,
'ret': ret,
}
return info
def test_simple_pytest_cli():
module_text = utils.codeblock(
'''
def module_func1():
"""
This module has a doctest
Example:
>>> print('hello world')
"""
''')
temp_module = util_misc.TempModule(module_text)
temp_module.print_contents()
modpath = temp_module.modpath
info = cmd(sys.executable + ' -m pytest --xdoctest ' + modpath)
print('COMMAND OUT:')
print(info['out'])
print('COMMAND ERR:')
print(info['err'])
print('COMMAND RET:')
print(info['ret'])
assert info['ret'] == 0
def test_simple_pytest_import_error_cli():
"""
This test case triggers an excessively long callback in xdoctest <
dev/0.15.7
CommandLine:
xdoctest ~/code/xdoctest/tests/test_pytest_cli.py test_simple_pytest_import_error_cli
pytest ~/code/xdoctest/tests/test_pytest_cli.py -k test_simple_pytest_import_error_cli -s
"""
module_text = utils.codeblock(
'''
# There are lines before the bad line
import os
import sys
import does_not_exist
def module_func1():
"""
This module has a doctest
Example:
>>> print('hello world')
"""
''')
temp_module = util_misc.TempModule(module_text, modname='imperr_test_mod')
temp_module.print_contents()
if sys.platform.startswith('win'):
info = cmd('(dir 2>&1 *`|echo CMD);&<# rem #>echo PowerShell')
print(f'info={info}')
print(info['out'])
info = cmd(f'dir {temp_module.dpath}')
print(f'info={info}')
print(info['out'])
info = cmd(f'{sys.executable} {temp_module.modpath}')
print(f'info={info}')
print(info['out'])
info = cmd(f'{sys.executable} "{temp_module.modpath}"')
print(f'info={info}')
print(info['out'])
command = sys.executable + ' -m pytest -v -s --xdoctest-verbose=3 --xdoctest-supress-import-errors --xdoctest ' + temp_module.dpath
print('-- PRINT COMMAND 1:')
print(command)
print('-- RUN COMMAND 1:')
info = cmd(command)
print('-- COMMAND OUTPUT 1:')
print(info['out'])
# We patched doctest_example so it no longer outputs this in the traceback
assert 'util_import' not in info['out']
print('-- COMMAND RETURN CODE 1:')
print(info['ret'])
# Note: flaky changes the return code from 1 to 3, so test non-zero
assert info['ret'] != 0
# Remove the suppress import error flag and now we should get the traceback
temp_module = util_misc.TempModule(module_text, modname='imperr_test_mod')
command = sys.executable + ' -m pytest -v -s --xdoctest-verbose=3 --xdoctest ' + temp_module.dpath
print('-- PRINT COMMAND 2:')
print(command)
print('-- RUN COMMAND 2:')
info = cmd(command)
print('-- COMMAND OUTPUT 2:')
print(info['out'])
# We patched doctest_example so it no longer outputs this in the traceback
assert 'util_import' in info['out']
print('-- COMMAND RETURN CODE 2:')
print(info['ret'])
# Note: flaky changes the return code from 1 to 3, so test non-zero
assert info['ret'] != 0
def test_simple_pytest_syntax_error_cli():
"""
"""
module_text = utils.codeblock(
'''
&&does_not_exist
def module_func1():
"""
This module has a doctest
Example:
>>> print('hello world')
"""
''')
temp_module = util_misc.TempModule(module_text)
info = cmd(sys.executable + ' -m pytest --xdoctest ' + temp_module.dpath)
print(info['out'])
assert info['ret'] != 0
info = cmd(sys.executable + ' -m pytest --xdoctest ' + temp_module.modpath)
print(info['out'])
assert info['ret'] != 0
def test_simple_pytest_import_error_no_xdoctest():
"""
"""
module_text = utils.codeblock(
'''
import does_not_exist
def test_this():
print('hello world')
''')
temp_module = util_misc.TempModule(module_text)
info = cmd(sys.executable + ' -m pytest ' + temp_module.modpath)
print(info['out'])
assert info['ret'] != 0
info = cmd(sys.executable + ' -m pytest ' + temp_module.dpath)
print(info['out'])
assert info['ret'] != 0
def test_simple_pytest_syntax_error_no_xdoctest():
"""
"""
module_text = utils.codeblock(
'''
&&does_not_exist
def test_this():
print('hello world')
''')
temp_module = util_misc.TempModule(module_text)
info = cmd(sys.executable + ' -m pytest ' + temp_module.modpath)
print(info['out'])
assert info['ret'] != 0
info = cmd(sys.executable + ' -m pytest ' + temp_module.dpath)
print(info['out'])
assert info['ret'] != 0
def test_version_and_cli_info():
"""
"""
import xdoctest
info = cmd(sys.executable + ' -m xdoctest --version')
assert info['out'].strip() == xdoctest.__version__
info = cmd(sys.executable + ' -m xdoctest --version-info')
assert xdoctest.__version__ in info['out']
def test_simple_xdoctest_cli():
module_text = utils.codeblock(
'''
def module_func1():
"""
This module has a doctest
Example:
>>> print('hello world')
"""
''')
temp_module = util_misc.TempModule(module_text)
modpath = temp_module.modpath
info = cmd(sys.executable + ' -m xdoctest ' + modpath + ' --time')
assert 'time:' in info['out']
info = cmd(sys.executable + ' -m xdoctest ' + modpath + ' all')
assert 'passed' in info['out']
info = cmd(sys.executable + ' -m xdoctest ' + modpath + ' list')
assert 'passed' not in info['out']
info = cmd(sys.executable + ' -m xdoctest ' + modpath + ' --verbose=0')
print(repr(info['out']))
assert info['out'].strip() == ''
def test_simple_xdoctest_cli_errors():
module_text = utils.codeblock(
'''
def module_func1():
"""
This module has a doctest
Example:
>>> raise Exception
"""
''')
temp_module = util_misc.TempModule(module_text)
modpath = temp_module.modpath
info = cmd(sys.executable + ' -m xdoctest ' + modpath + ' --time')
assert '1 failed' in info['out']
|
