##// END OF EJS Templates
More info about erroneous environment variable
Thomas Kluyver -
r18948:56972de1
parent child
Show More
@@ -1,495 +1,495
1 """Generic testing tools.
1 """Generic testing tools.
2
2
3 Authors
3 Authors
4 -------
4 -------
5 - Fernando Perez <Fernando.Perez@berkeley.edu>
5 - Fernando Perez <Fernando.Perez@berkeley.edu>
6 """
6 """
7
7
8 from __future__ import absolute_import
8 from __future__ import absolute_import
9
9
10 #-----------------------------------------------------------------------------
10 #-----------------------------------------------------------------------------
11 # Copyright (C) 2009 The IPython Development Team
11 # Copyright (C) 2009 The IPython Development Team
12 #
12 #
13 # Distributed under the terms of the BSD License. The full license is in
13 # Distributed under the terms of the BSD License. The full license is in
14 # the file COPYING, distributed as part of this software.
14 # the file COPYING, distributed as part of this software.
15 #-----------------------------------------------------------------------------
15 #-----------------------------------------------------------------------------
16
16
17 #-----------------------------------------------------------------------------
17 #-----------------------------------------------------------------------------
18 # Imports
18 # Imports
19 #-----------------------------------------------------------------------------
19 #-----------------------------------------------------------------------------
20
20
21 import os
21 import os
22 import re
22 import re
23 import sys
23 import sys
24 import tempfile
24 import tempfile
25
25
26 from contextlib import contextmanager
26 from contextlib import contextmanager
27 from io import StringIO
27 from io import StringIO
28 from subprocess import Popen, PIPE
28 from subprocess import Popen, PIPE
29
29
30 try:
30 try:
31 # These tools are used by parts of the runtime, so we make the nose
31 # These tools are used by parts of the runtime, so we make the nose
32 # dependency optional at this point. Nose is a hard dependency to run the
32 # dependency optional at this point. Nose is a hard dependency to run the
33 # test suite, but NOT to use ipython itself.
33 # test suite, but NOT to use ipython itself.
34 import nose.tools as nt
34 import nose.tools as nt
35 has_nose = True
35 has_nose = True
36 except ImportError:
36 except ImportError:
37 has_nose = False
37 has_nose = False
38
38
39 from IPython.config.loader import Config
39 from IPython.config.loader import Config
40 from IPython.utils.process import get_output_error_code
40 from IPython.utils.process import get_output_error_code
41 from IPython.utils.text import list_strings
41 from IPython.utils.text import list_strings
42 from IPython.utils.io import temp_pyfile, Tee
42 from IPython.utils.io import temp_pyfile, Tee
43 from IPython.utils import py3compat
43 from IPython.utils import py3compat
44 from IPython.utils.encoding import DEFAULT_ENCODING
44 from IPython.utils.encoding import DEFAULT_ENCODING
45
45
46 from . import decorators as dec
46 from . import decorators as dec
47 from . import skipdoctest
47 from . import skipdoctest
48
48
49 #-----------------------------------------------------------------------------
49 #-----------------------------------------------------------------------------
50 # Functions and classes
50 # Functions and classes
51 #-----------------------------------------------------------------------------
51 #-----------------------------------------------------------------------------
52
52
53 # The docstring for full_path doctests differently on win32 (different path
53 # The docstring for full_path doctests differently on win32 (different path
54 # separator) so just skip the doctest there. The example remains informative.
54 # separator) so just skip the doctest there. The example remains informative.
55 doctest_deco = skipdoctest.skip_doctest if sys.platform == 'win32' else dec.null_deco
55 doctest_deco = skipdoctest.skip_doctest if sys.platform == 'win32' else dec.null_deco
56
56
57 @doctest_deco
57 @doctest_deco
58 def full_path(startPath,files):
58 def full_path(startPath,files):
59 """Make full paths for all the listed files, based on startPath.
59 """Make full paths for all the listed files, based on startPath.
60
60
61 Only the base part of startPath is kept, since this routine is typically
61 Only the base part of startPath is kept, since this routine is typically
62 used with a script's ``__file__`` variable as startPath. The base of startPath
62 used with a script's ``__file__`` variable as startPath. The base of startPath
63 is then prepended to all the listed files, forming the output list.
63 is then prepended to all the listed files, forming the output list.
64
64
65 Parameters
65 Parameters
66 ----------
66 ----------
67 startPath : string
67 startPath : string
68 Initial path to use as the base for the results. This path is split
68 Initial path to use as the base for the results. This path is split
69 using os.path.split() and only its first component is kept.
69 using os.path.split() and only its first component is kept.
70
70
71 files : string or list
71 files : string or list
72 One or more files.
72 One or more files.
73
73
74 Examples
74 Examples
75 --------
75 --------
76
76
77 >>> full_path('/foo/bar.py',['a.txt','b.txt'])
77 >>> full_path('/foo/bar.py',['a.txt','b.txt'])
78 ['/foo/a.txt', '/foo/b.txt']
78 ['/foo/a.txt', '/foo/b.txt']
79
79
80 >>> full_path('/foo',['a.txt','b.txt'])
80 >>> full_path('/foo',['a.txt','b.txt'])
81 ['/a.txt', '/b.txt']
81 ['/a.txt', '/b.txt']
82
82
83 If a single file is given, the output is still a list::
83 If a single file is given, the output is still a list::
84
84
85 >>> full_path('/foo','a.txt')
85 >>> full_path('/foo','a.txt')
86 ['/a.txt']
86 ['/a.txt']
87 """
87 """
88
88
89 files = list_strings(files)
89 files = list_strings(files)
90 base = os.path.split(startPath)[0]
90 base = os.path.split(startPath)[0]
91 return [ os.path.join(base,f) for f in files ]
91 return [ os.path.join(base,f) for f in files ]
92
92
93
93
94 def parse_test_output(txt):
94 def parse_test_output(txt):
95 """Parse the output of a test run and return errors, failures.
95 """Parse the output of a test run and return errors, failures.
96
96
97 Parameters
97 Parameters
98 ----------
98 ----------
99 txt : str
99 txt : str
100 Text output of a test run, assumed to contain a line of one of the
100 Text output of a test run, assumed to contain a line of one of the
101 following forms::
101 following forms::
102
102
103 'FAILED (errors=1)'
103 'FAILED (errors=1)'
104 'FAILED (failures=1)'
104 'FAILED (failures=1)'
105 'FAILED (errors=1, failures=1)'
105 'FAILED (errors=1, failures=1)'
106
106
107 Returns
107 Returns
108 -------
108 -------
109 nerr, nfail
109 nerr, nfail
110 number of errors and failures.
110 number of errors and failures.
111 """
111 """
112
112
113 err_m = re.search(r'^FAILED \(errors=(\d+)\)', txt, re.MULTILINE)
113 err_m = re.search(r'^FAILED \(errors=(\d+)\)', txt, re.MULTILINE)
114 if err_m:
114 if err_m:
115 nerr = int(err_m.group(1))
115 nerr = int(err_m.group(1))
116 nfail = 0
116 nfail = 0
117 return nerr, nfail
117 return nerr, nfail
118
118
119 fail_m = re.search(r'^FAILED \(failures=(\d+)\)', txt, re.MULTILINE)
119 fail_m = re.search(r'^FAILED \(failures=(\d+)\)', txt, re.MULTILINE)
120 if fail_m:
120 if fail_m:
121 nerr = 0
121 nerr = 0
122 nfail = int(fail_m.group(1))
122 nfail = int(fail_m.group(1))
123 return nerr, nfail
123 return nerr, nfail
124
124
125 both_m = re.search(r'^FAILED \(errors=(\d+), failures=(\d+)\)', txt,
125 both_m = re.search(r'^FAILED \(errors=(\d+), failures=(\d+)\)', txt,
126 re.MULTILINE)
126 re.MULTILINE)
127 if both_m:
127 if both_m:
128 nerr = int(both_m.group(1))
128 nerr = int(both_m.group(1))
129 nfail = int(both_m.group(2))
129 nfail = int(both_m.group(2))
130 return nerr, nfail
130 return nerr, nfail
131
131
132 # If the input didn't match any of these forms, assume no error/failures
132 # If the input didn't match any of these forms, assume no error/failures
133 return 0, 0
133 return 0, 0
134
134
135
135
136 # So nose doesn't think this is a test
136 # So nose doesn't think this is a test
137 parse_test_output.__test__ = False
137 parse_test_output.__test__ = False
138
138
139
139
140 def default_argv():
140 def default_argv():
141 """Return a valid default argv for creating testing instances of ipython"""
141 """Return a valid default argv for creating testing instances of ipython"""
142
142
143 return ['--quick', # so no config file is loaded
143 return ['--quick', # so no config file is loaded
144 # Other defaults to minimize side effects on stdout
144 # Other defaults to minimize side effects on stdout
145 '--colors=NoColor', '--no-term-title','--no-banner',
145 '--colors=NoColor', '--no-term-title','--no-banner',
146 '--autocall=0']
146 '--autocall=0']
147
147
148
148
149 def default_config():
149 def default_config():
150 """Return a config object with good defaults for testing."""
150 """Return a config object with good defaults for testing."""
151 config = Config()
151 config = Config()
152 config.TerminalInteractiveShell.colors = 'NoColor'
152 config.TerminalInteractiveShell.colors = 'NoColor'
153 config.TerminalTerminalInteractiveShell.term_title = False,
153 config.TerminalTerminalInteractiveShell.term_title = False,
154 config.TerminalInteractiveShell.autocall = 0
154 config.TerminalInteractiveShell.autocall = 0
155 f = tempfile.NamedTemporaryFile(suffix=u'test_hist.sqlite', delete=False)
155 f = tempfile.NamedTemporaryFile(suffix=u'test_hist.sqlite', delete=False)
156 config.HistoryManager.hist_file = f.name
156 config.HistoryManager.hist_file = f.name
157 f.close()
157 f.close()
158 config.HistoryManager.db_cache_size = 10000
158 config.HistoryManager.db_cache_size = 10000
159 return config
159 return config
160
160
161
161
162 def get_ipython_cmd(as_string=False):
162 def get_ipython_cmd(as_string=False):
163 """
163 """
164 Return appropriate IPython command line name. By default, this will return
164 Return appropriate IPython command line name. By default, this will return
165 a list that can be used with subprocess.Popen, for example, but passing
165 a list that can be used with subprocess.Popen, for example, but passing
166 `as_string=True` allows for returning the IPython command as a string.
166 `as_string=True` allows for returning the IPython command as a string.
167
167
168 Parameters
168 Parameters
169 ----------
169 ----------
170 as_string: bool
170 as_string: bool
171 Flag to allow to return the command as a string.
171 Flag to allow to return the command as a string.
172 """
172 """
173 ipython_cmd = [sys.executable, "-m", "IPython"]
173 ipython_cmd = [sys.executable, "-m", "IPython"]
174
174
175 if as_string:
175 if as_string:
176 ipython_cmd = " ".join(ipython_cmd)
176 ipython_cmd = " ".join(ipython_cmd)
177
177
178 return ipython_cmd
178 return ipython_cmd
179
179
180 def ipexec(fname, options=None, commands=()):
180 def ipexec(fname, options=None, commands=()):
181 """Utility to call 'ipython filename'.
181 """Utility to call 'ipython filename'.
182
182
183 Starts IPython with a minimal and safe configuration to make startup as fast
183 Starts IPython with a minimal and safe configuration to make startup as fast
184 as possible.
184 as possible.
185
185
186 Note that this starts IPython in a subprocess!
186 Note that this starts IPython in a subprocess!
187
187
188 Parameters
188 Parameters
189 ----------
189 ----------
190 fname : str
190 fname : str
191 Name of file to be executed (should have .py or .ipy extension).
191 Name of file to be executed (should have .py or .ipy extension).
192
192
193 options : optional, list
193 options : optional, list
194 Extra command-line flags to be passed to IPython.
194 Extra command-line flags to be passed to IPython.
195
195
196 commands : optional, list
196 commands : optional, list
197 Commands to send in on stdin
197 Commands to send in on stdin
198
198
199 Returns
199 Returns
200 -------
200 -------
201 (stdout, stderr) of ipython subprocess.
201 (stdout, stderr) of ipython subprocess.
202 """
202 """
203 if options is None: options = []
203 if options is None: options = []
204
204
205 # For these subprocess calls, eliminate all prompt printing so we only see
205 # For these subprocess calls, eliminate all prompt printing so we only see
206 # output from script execution
206 # output from script execution
207 prompt_opts = [ '--PromptManager.in_template=""',
207 prompt_opts = [ '--PromptManager.in_template=""',
208 '--PromptManager.in2_template=""',
208 '--PromptManager.in2_template=""',
209 '--PromptManager.out_template=""'
209 '--PromptManager.out_template=""'
210 ]
210 ]
211 cmdargs = default_argv() + prompt_opts + options
211 cmdargs = default_argv() + prompt_opts + options
212
212
213 test_dir = os.path.dirname(__file__)
213 test_dir = os.path.dirname(__file__)
214
214
215 ipython_cmd = get_ipython_cmd()
215 ipython_cmd = get_ipython_cmd()
216 # Absolute path for filename
216 # Absolute path for filename
217 full_fname = os.path.join(test_dir, fname)
217 full_fname = os.path.join(test_dir, fname)
218 full_cmd = ipython_cmd + cmdargs + [full_fname]
218 full_cmd = ipython_cmd + cmdargs + [full_fname]
219 env = os.environ.copy()
219 env = os.environ.copy()
220 env.pop('PYTHONWARNINGS', None) # Avoid extraneous warnings appearing on stderr
220 env.pop('PYTHONWARNINGS', None) # Avoid extraneous warnings appearing on stderr
221 for k, v in env.items():
221 for k, v in env.items():
222 # Debug a bizarre failure we've seen on Windows:
222 # Debug a bizarre failure we've seen on Windows:
223 # TypeError: environment can only contain strings
223 # TypeError: environment can only contain strings
224 if not isinstance(v, str):
224 if not isinstance(v, str):
225 print(v)
225 print(k, v)
226 p = Popen(full_cmd, stdout=PIPE, stderr=PIPE, stdin=PIPE, env=env)
226 p = Popen(full_cmd, stdout=PIPE, stderr=PIPE, stdin=PIPE, env=env)
227 out, err = p.communicate(input=py3compat.str_to_bytes('\n'.join(commands)) or None)
227 out, err = p.communicate(input=py3compat.str_to_bytes('\n'.join(commands)) or None)
228 out, err = py3compat.bytes_to_str(out), py3compat.bytes_to_str(err)
228 out, err = py3compat.bytes_to_str(out), py3compat.bytes_to_str(err)
229 # `import readline` causes 'ESC[?1034h' to be output sometimes,
229 # `import readline` causes 'ESC[?1034h' to be output sometimes,
230 # so strip that out before doing comparisons
230 # so strip that out before doing comparisons
231 if out:
231 if out:
232 out = re.sub(r'\x1b\[[^h]+h', '', out)
232 out = re.sub(r'\x1b\[[^h]+h', '', out)
233 return out, err
233 return out, err
234
234
235
235
236 def ipexec_validate(fname, expected_out, expected_err='',
236 def ipexec_validate(fname, expected_out, expected_err='',
237 options=None, commands=()):
237 options=None, commands=()):
238 """Utility to call 'ipython filename' and validate output/error.
238 """Utility to call 'ipython filename' and validate output/error.
239
239
240 This function raises an AssertionError if the validation fails.
240 This function raises an AssertionError if the validation fails.
241
241
242 Note that this starts IPython in a subprocess!
242 Note that this starts IPython in a subprocess!
243
243
244 Parameters
244 Parameters
245 ----------
245 ----------
246 fname : str
246 fname : str
247 Name of the file to be executed (should have .py or .ipy extension).
247 Name of the file to be executed (should have .py or .ipy extension).
248
248
249 expected_out : str
249 expected_out : str
250 Expected stdout of the process.
250 Expected stdout of the process.
251
251
252 expected_err : optional, str
252 expected_err : optional, str
253 Expected stderr of the process.
253 Expected stderr of the process.
254
254
255 options : optional, list
255 options : optional, list
256 Extra command-line flags to be passed to IPython.
256 Extra command-line flags to be passed to IPython.
257
257
258 Returns
258 Returns
259 -------
259 -------
260 None
260 None
261 """
261 """
262
262
263 import nose.tools as nt
263 import nose.tools as nt
264
264
265 out, err = ipexec(fname, options, commands)
265 out, err = ipexec(fname, options, commands)
266 #print 'OUT', out # dbg
266 #print 'OUT', out # dbg
267 #print 'ERR', err # dbg
267 #print 'ERR', err # dbg
268 # If there are any errors, we must check those befor stdout, as they may be
268 # If there are any errors, we must check those befor stdout, as they may be
269 # more informative than simply having an empty stdout.
269 # more informative than simply having an empty stdout.
270 if err:
270 if err:
271 if expected_err:
271 if expected_err:
272 nt.assert_equal("\n".join(err.strip().splitlines()), "\n".join(expected_err.strip().splitlines()))
272 nt.assert_equal("\n".join(err.strip().splitlines()), "\n".join(expected_err.strip().splitlines()))
273 else:
273 else:
274 raise ValueError('Running file %r produced error: %r' %
274 raise ValueError('Running file %r produced error: %r' %
275 (fname, err))
275 (fname, err))
276 # If no errors or output on stderr was expected, match stdout
276 # If no errors or output on stderr was expected, match stdout
277 nt.assert_equal("\n".join(out.strip().splitlines()), "\n".join(expected_out.strip().splitlines()))
277 nt.assert_equal("\n".join(out.strip().splitlines()), "\n".join(expected_out.strip().splitlines()))
278
278
279
279
280 class TempFileMixin(object):
280 class TempFileMixin(object):
281 """Utility class to create temporary Python/IPython files.
281 """Utility class to create temporary Python/IPython files.
282
282
283 Meant as a mixin class for test cases."""
283 Meant as a mixin class for test cases."""
284
284
285 def mktmp(self, src, ext='.py'):
285 def mktmp(self, src, ext='.py'):
286 """Make a valid python temp file."""
286 """Make a valid python temp file."""
287 fname, f = temp_pyfile(src, ext)
287 fname, f = temp_pyfile(src, ext)
288 self.tmpfile = f
288 self.tmpfile = f
289 self.fname = fname
289 self.fname = fname
290
290
291 def tearDown(self):
291 def tearDown(self):
292 if hasattr(self, 'tmpfile'):
292 if hasattr(self, 'tmpfile'):
293 # If the tmpfile wasn't made because of skipped tests, like in
293 # If the tmpfile wasn't made because of skipped tests, like in
294 # win32, there's nothing to cleanup.
294 # win32, there's nothing to cleanup.
295 self.tmpfile.close()
295 self.tmpfile.close()
296 try:
296 try:
297 os.unlink(self.fname)
297 os.unlink(self.fname)
298 except:
298 except:
299 # On Windows, even though we close the file, we still can't
299 # On Windows, even though we close the file, we still can't
300 # delete it. I have no clue why
300 # delete it. I have no clue why
301 pass
301 pass
302
302
303 pair_fail_msg = ("Testing {0}\n\n"
303 pair_fail_msg = ("Testing {0}\n\n"
304 "In:\n"
304 "In:\n"
305 " {1!r}\n"
305 " {1!r}\n"
306 "Expected:\n"
306 "Expected:\n"
307 " {2!r}\n"
307 " {2!r}\n"
308 "Got:\n"
308 "Got:\n"
309 " {3!r}\n")
309 " {3!r}\n")
310 def check_pairs(func, pairs):
310 def check_pairs(func, pairs):
311 """Utility function for the common case of checking a function with a
311 """Utility function for the common case of checking a function with a
312 sequence of input/output pairs.
312 sequence of input/output pairs.
313
313
314 Parameters
314 Parameters
315 ----------
315 ----------
316 func : callable
316 func : callable
317 The function to be tested. Should accept a single argument.
317 The function to be tested. Should accept a single argument.
318 pairs : iterable
318 pairs : iterable
319 A list of (input, expected_output) tuples.
319 A list of (input, expected_output) tuples.
320
320
321 Returns
321 Returns
322 -------
322 -------
323 None. Raises an AssertionError if any output does not match the expected
323 None. Raises an AssertionError if any output does not match the expected
324 value.
324 value.
325 """
325 """
326 name = getattr(func, "func_name", getattr(func, "__name__", "<unknown>"))
326 name = getattr(func, "func_name", getattr(func, "__name__", "<unknown>"))
327 for inp, expected in pairs:
327 for inp, expected in pairs:
328 out = func(inp)
328 out = func(inp)
329 assert out == expected, pair_fail_msg.format(name, inp, expected, out)
329 assert out == expected, pair_fail_msg.format(name, inp, expected, out)
330
330
331
331
332 if py3compat.PY3:
332 if py3compat.PY3:
333 MyStringIO = StringIO
333 MyStringIO = StringIO
334 else:
334 else:
335 # In Python 2, stdout/stderr can have either bytes or unicode written to them,
335 # In Python 2, stdout/stderr can have either bytes or unicode written to them,
336 # so we need a class that can handle both.
336 # so we need a class that can handle both.
337 class MyStringIO(StringIO):
337 class MyStringIO(StringIO):
338 def write(self, s):
338 def write(self, s):
339 s = py3compat.cast_unicode(s, encoding=DEFAULT_ENCODING)
339 s = py3compat.cast_unicode(s, encoding=DEFAULT_ENCODING)
340 super(MyStringIO, self).write(s)
340 super(MyStringIO, self).write(s)
341
341
342 _re_type = type(re.compile(r''))
342 _re_type = type(re.compile(r''))
343
343
344 notprinted_msg = """Did not find {0!r} in printed output (on {1}):
344 notprinted_msg = """Did not find {0!r} in printed output (on {1}):
345 -------
345 -------
346 {2!s}
346 {2!s}
347 -------
347 -------
348 """
348 """
349
349
350 class AssertPrints(object):
350 class AssertPrints(object):
351 """Context manager for testing that code prints certain text.
351 """Context manager for testing that code prints certain text.
352
352
353 Examples
353 Examples
354 --------
354 --------
355 >>> with AssertPrints("abc", suppress=False):
355 >>> with AssertPrints("abc", suppress=False):
356 ... print("abcd")
356 ... print("abcd")
357 ... print("def")
357 ... print("def")
358 ...
358 ...
359 abcd
359 abcd
360 def
360 def
361 """
361 """
362 def __init__(self, s, channel='stdout', suppress=True):
362 def __init__(self, s, channel='stdout', suppress=True):
363 self.s = s
363 self.s = s
364 if isinstance(self.s, (py3compat.string_types, _re_type)):
364 if isinstance(self.s, (py3compat.string_types, _re_type)):
365 self.s = [self.s]
365 self.s = [self.s]
366 self.channel = channel
366 self.channel = channel
367 self.suppress = suppress
367 self.suppress = suppress
368
368
369 def __enter__(self):
369 def __enter__(self):
370 self.orig_stream = getattr(sys, self.channel)
370 self.orig_stream = getattr(sys, self.channel)
371 self.buffer = MyStringIO()
371 self.buffer = MyStringIO()
372 self.tee = Tee(self.buffer, channel=self.channel)
372 self.tee = Tee(self.buffer, channel=self.channel)
373 setattr(sys, self.channel, self.buffer if self.suppress else self.tee)
373 setattr(sys, self.channel, self.buffer if self.suppress else self.tee)
374
374
375 def __exit__(self, etype, value, traceback):
375 def __exit__(self, etype, value, traceback):
376 try:
376 try:
377 if value is not None:
377 if value is not None:
378 # If an error was raised, don't check anything else
378 # If an error was raised, don't check anything else
379 return False
379 return False
380 self.tee.flush()
380 self.tee.flush()
381 setattr(sys, self.channel, self.orig_stream)
381 setattr(sys, self.channel, self.orig_stream)
382 printed = self.buffer.getvalue()
382 printed = self.buffer.getvalue()
383 for s in self.s:
383 for s in self.s:
384 if isinstance(s, _re_type):
384 if isinstance(s, _re_type):
385 assert s.search(printed), notprinted_msg.format(s.pattern, self.channel, printed)
385 assert s.search(printed), notprinted_msg.format(s.pattern, self.channel, printed)
386 else:
386 else:
387 assert s in printed, notprinted_msg.format(s, self.channel, printed)
387 assert s in printed, notprinted_msg.format(s, self.channel, printed)
388 return False
388 return False
389 finally:
389 finally:
390 self.tee.close()
390 self.tee.close()
391
391
392 printed_msg = """Found {0!r} in printed output (on {1}):
392 printed_msg = """Found {0!r} in printed output (on {1}):
393 -------
393 -------
394 {2!s}
394 {2!s}
395 -------
395 -------
396 """
396 """
397
397
398 class AssertNotPrints(AssertPrints):
398 class AssertNotPrints(AssertPrints):
399 """Context manager for checking that certain output *isn't* produced.
399 """Context manager for checking that certain output *isn't* produced.
400
400
401 Counterpart of AssertPrints"""
401 Counterpart of AssertPrints"""
402 def __exit__(self, etype, value, traceback):
402 def __exit__(self, etype, value, traceback):
403 try:
403 try:
404 if value is not None:
404 if value is not None:
405 # If an error was raised, don't check anything else
405 # If an error was raised, don't check anything else
406 self.tee.close()
406 self.tee.close()
407 return False
407 return False
408 self.tee.flush()
408 self.tee.flush()
409 setattr(sys, self.channel, self.orig_stream)
409 setattr(sys, self.channel, self.orig_stream)
410 printed = self.buffer.getvalue()
410 printed = self.buffer.getvalue()
411 for s in self.s:
411 for s in self.s:
412 if isinstance(s, _re_type):
412 if isinstance(s, _re_type):
413 assert not s.search(printed),printed_msg.format(
413 assert not s.search(printed),printed_msg.format(
414 s.pattern, self.channel, printed)
414 s.pattern, self.channel, printed)
415 else:
415 else:
416 assert s not in printed, printed_msg.format(
416 assert s not in printed, printed_msg.format(
417 s, self.channel, printed)
417 s, self.channel, printed)
418 return False
418 return False
419 finally:
419 finally:
420 self.tee.close()
420 self.tee.close()
421
421
422 @contextmanager
422 @contextmanager
423 def mute_warn():
423 def mute_warn():
424 from IPython.utils import warn
424 from IPython.utils import warn
425 save_warn = warn.warn
425 save_warn = warn.warn
426 warn.warn = lambda *a, **kw: None
426 warn.warn = lambda *a, **kw: None
427 try:
427 try:
428 yield
428 yield
429 finally:
429 finally:
430 warn.warn = save_warn
430 warn.warn = save_warn
431
431
432 @contextmanager
432 @contextmanager
433 def make_tempfile(name):
433 def make_tempfile(name):
434 """ Create an empty, named, temporary file for the duration of the context.
434 """ Create an empty, named, temporary file for the duration of the context.
435 """
435 """
436 f = open(name, 'w')
436 f = open(name, 'w')
437 f.close()
437 f.close()
438 try:
438 try:
439 yield
439 yield
440 finally:
440 finally:
441 os.unlink(name)
441 os.unlink(name)
442
442
443
443
444 @contextmanager
444 @contextmanager
445 def monkeypatch(obj, name, attr):
445 def monkeypatch(obj, name, attr):
446 """
446 """
447 Context manager to replace attribute named `name` in `obj` with `attr`.
447 Context manager to replace attribute named `name` in `obj` with `attr`.
448 """
448 """
449 orig = getattr(obj, name)
449 orig = getattr(obj, name)
450 setattr(obj, name, attr)
450 setattr(obj, name, attr)
451 yield
451 yield
452 setattr(obj, name, orig)
452 setattr(obj, name, orig)
453
453
454
454
455 def help_output_test(subcommand=''):
455 def help_output_test(subcommand=''):
456 """test that `ipython [subcommand] -h` works"""
456 """test that `ipython [subcommand] -h` works"""
457 cmd = get_ipython_cmd() + [subcommand, '-h']
457 cmd = get_ipython_cmd() + [subcommand, '-h']
458 out, err, rc = get_output_error_code(cmd)
458 out, err, rc = get_output_error_code(cmd)
459 nt.assert_equal(rc, 0, err)
459 nt.assert_equal(rc, 0, err)
460 nt.assert_not_in("Traceback", err)
460 nt.assert_not_in("Traceback", err)
461 nt.assert_in("Options", out)
461 nt.assert_in("Options", out)
462 nt.assert_in("--help-all", out)
462 nt.assert_in("--help-all", out)
463 return out, err
463 return out, err
464
464
465
465
466 def help_all_output_test(subcommand=''):
466 def help_all_output_test(subcommand=''):
467 """test that `ipython [subcommand] --help-all` works"""
467 """test that `ipython [subcommand] --help-all` works"""
468 cmd = get_ipython_cmd() + [subcommand, '--help-all']
468 cmd = get_ipython_cmd() + [subcommand, '--help-all']
469 out, err, rc = get_output_error_code(cmd)
469 out, err, rc = get_output_error_code(cmd)
470 nt.assert_equal(rc, 0, err)
470 nt.assert_equal(rc, 0, err)
471 nt.assert_not_in("Traceback", err)
471 nt.assert_not_in("Traceback", err)
472 nt.assert_in("Options", out)
472 nt.assert_in("Options", out)
473 nt.assert_in("Class parameters", out)
473 nt.assert_in("Class parameters", out)
474 return out, err
474 return out, err
475
475
476 def assert_big_text_equal(a, b, chunk_size=80):
476 def assert_big_text_equal(a, b, chunk_size=80):
477 """assert that large strings are equal
477 """assert that large strings are equal
478
478
479 Zooms in on first chunk that differs,
479 Zooms in on first chunk that differs,
480 to give better info than vanilla assertEqual for large text blobs.
480 to give better info than vanilla assertEqual for large text blobs.
481 """
481 """
482 for i in range(0, len(a), chunk_size):
482 for i in range(0, len(a), chunk_size):
483 chunk_a = a[i:i + chunk_size]
483 chunk_a = a[i:i + chunk_size]
484 chunk_b = b[i:i + chunk_size]
484 chunk_b = b[i:i + chunk_size]
485 nt.assert_equal(chunk_a, chunk_b, "[offset: %i]\n%r != \n%r" % (
485 nt.assert_equal(chunk_a, chunk_b, "[offset: %i]\n%r != \n%r" % (
486 i, chunk_a, chunk_b))
486 i, chunk_a, chunk_b))
487
487
488 if len(a) > len(b):
488 if len(a) > len(b):
489 nt.fail("Length doesn't match (%i > %i). Extra text:\n%r" % (
489 nt.fail("Length doesn't match (%i > %i). Extra text:\n%r" % (
490 len(a), len(b), a[len(b):]
490 len(a), len(b), a[len(b):]
491 ))
491 ))
492 elif len(a) < len(b):
492 elif len(a) < len(b):
493 nt.fail("Length doesn't match (%i < %i). Extra text:\n%r" % (
493 nt.fail("Length doesn't match (%i < %i). Extra text:\n%r" % (
494 len(a), len(b), b[len(a):]
494 len(a), len(b), b[len(a):]
495 ))
495 ))
General Comments 0
You need to be logged in to leave comments. Login now