use traitlets.tests.utils for help output tests

for non-IPython projects

IPython/html/tests/test_notebookapp.py

@@ -1,74 +1,62 b''
 """Test NotebookApp"""
 
-#-----------------------------------------------------------------------------
-#  Copyright (C) 2013 The IPython Development Team
-#
-#  Distributed under the terms of the BSD License.  The full license is in
-#  the file COPYING, distributed as part of this software.
-#-----------------------------------------------------------------------------
-
-#-----------------------------------------------------------------------------
-# Imports
-#-----------------------------------------------------------------------------
 
 import logging
 import os
 from tempfile import NamedTemporaryFile
 
 import nose.tools as nt
 
+from traitlets.tests.utils import check_help_all_output
+
 from IPython.utils.tempdir import TemporaryDirectory
 from IPython.utils.traitlets import TraitError
-import IPython.testing.tools as tt
 from IPython.html import notebookapp
 NotebookApp = notebookapp.NotebookApp
 
-#-----------------------------------------------------------------------------
-# Test functions
-#-----------------------------------------------------------------------------
 
 def test_help_output():
     """ipython notebook --help-all works"""
-    tt.help_all_output_test('notebook')
+    check_help_all_output('IPython.html')
 
 def test_server_info_file():
     nbapp = NotebookApp(profile='nbserver_file_test', log=logging.getLogger())
     def get_servers():
         return list(notebookapp.list_running_servers(profile='nbserver_file_test'))
     nbapp.initialize(argv=[])
     nbapp.write_server_info_file()
     servers = get_servers()
     nt.assert_equal(len(servers), 1)
     nt.assert_equal(servers[0]['port'], nbapp.port)
     nt.assert_equal(servers[0]['url'], nbapp.connection_url)
     nbapp.remove_server_info_file()
     nt.assert_equal(get_servers(), [])
 
     # The ENOENT error should be silenced.
     nbapp.remove_server_info_file()
 
 def test_nb_dir():
     with TemporaryDirectory() as td:
         app = NotebookApp(notebook_dir=td)
         nt.assert_equal(app.notebook_dir, td)
 
 def test_no_create_nb_dir():
     with TemporaryDirectory() as td:
         nbdir = os.path.join(td, 'notebooks')
         app = NotebookApp()
         with nt.assert_raises(TraitError):
             app.notebook_dir = nbdir
 
 def test_missing_nb_dir():
     with TemporaryDirectory() as td:
         nbdir = os.path.join(td, 'notebook', 'dir', 'is', 'missing')
         app = NotebookApp()
         with nt.assert_raises(TraitError):
             app.notebook_dir = nbdir
 
 def test_invalid_nb_dir():
     with NamedTemporaryFile() as tf:
         app = NotebookApp()
         with nt.assert_raises(TraitError):
             app.notebook_dir = tf
 

IPython/html/tests/test_utils.py

@@ -1,76 +1,66 b''
 """Test HTML utils"""
 
-#-----------------------------------------------------------------------------
-#  Copyright (C) 2013 The IPython Development Team
-#
-#  Distributed under the terms of the BSD License.  The full license is in
-#  the file COPYING, distributed as part of this software.
-#-----------------------------------------------------------------------------
-
-#-----------------------------------------------------------------------------
-# Imports
-#-----------------------------------------------------------------------------
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
 
 import os
 
 import nose.tools as nt
 
-import IPython.testing.tools as tt
+from traitlets.tests.utils import check_help_all_output
 from IPython.html.utils import url_escape, url_unescape, is_hidden
 from IPython.utils.tempdir import TemporaryDirectory
 
-#-----------------------------------------------------------------------------
-# Test functions
-#-----------------------------------------------------------------------------
 
 def test_help_output():
-    """ipython notebook --help-all works"""
-    tt.help_all_output_test('notebook')
+    """jupyter notebook --help-all works"""
+    # FIXME: will be jupyter_notebook
+    check_help_all_output('IPython.html')
 
 
 def test_url_escape():
 
     # changes path or notebook name with special characters to url encoding
     # these tests specifically encode paths with spaces
     path = url_escape('/this is a test/for spaces/')
     nt.assert_equal(path, '/this%20is%20a%20test/for%20spaces/')
 
     path = url_escape('notebook with space.ipynb')
     nt.assert_equal(path, 'notebook%20with%20space.ipynb')
 
     path = url_escape('/path with a/notebook and space.ipynb')
     nt.assert_equal(path, '/path%20with%20a/notebook%20and%20space.ipynb')
     
     path = url_escape('/ !@$#%^&* / test %^ notebook @#$ name.ipynb')
     nt.assert_equal(path,
         '/%20%21%40%24%23%25%5E%26%2A%20/%20test%20%25%5E%20notebook%20%40%23%24%20name.ipynb')
 
 def test_url_unescape():
 
     # decodes a url string to a plain string
     # these tests decode paths with spaces
     path = url_unescape('/this%20is%20a%20test/for%20spaces/')
     nt.assert_equal(path, '/this is a test/for spaces/')
 
     path = url_unescape('notebook%20with%20space.ipynb')
     nt.assert_equal(path, 'notebook with space.ipynb')
 
     path = url_unescape('/path%20with%20a/notebook%20and%20space.ipynb')
     nt.assert_equal(path, '/path with a/notebook and space.ipynb')
 
     path = url_unescape(
         '/%20%21%40%24%23%25%5E%26%2A%20/%20test%20%25%5E%20notebook%20%40%23%24%20name.ipynb')
     nt.assert_equal(path, '/ !@$#%^&* / test %^ notebook @#$ name.ipynb')
 
 def test_is_hidden():
     with TemporaryDirectory() as root:
         subdir1 = os.path.join(root, 'subdir')
         os.makedirs(subdir1)
         nt.assert_equal(is_hidden(subdir1, root), False)
         subdir2 = os.path.join(root, '.subdir2')
         os.makedirs(subdir2)
         nt.assert_equal(is_hidden(subdir2, root), True)
         subdir34 = os.path.join(root, 'subdir3', '.subdir4')
         os.makedirs(subdir34)
         nt.assert_equal(is_hidden(subdir34, root), True)
         nt.assert_equal(is_hidden(subdir34), True)

jupyter_console/tests/test_console.py

@@ -1,78 +1,64 b''
-"""Tests for two-process terminal frontend
+"""Tests for two-process terminal frontend"""
 
-Currently only has the most simple test possible, starting a console and running
-a single command.
-
-Authors:
-
-* Min RK
-"""
-
-#-----------------------------------------------------------------------------
-# Imports
-#-----------------------------------------------------------------------------
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
 
 import sys
 
 from nose import SkipTest
 
-import IPython.testing.tools as tt
+from traitlets.tests.utils import check_help_all_output
 from IPython.testing import decorators as dec
 
-#-----------------------------------------------------------------------------
-# Tests
-#-----------------------------------------------------------------------------
-
 @dec.skip_win32
 def test_console_starts():
     """test that `ipython console` starts a terminal"""
     p, pexpect, t = start_console()
     p.sendline('5')
     idx = p.expect([r'Out\[\d+\]: 5', pexpect.EOF], timeout=t)
     idx = p.expect([r'In \[\d+\]', pexpect.EOF], timeout=t)
     stop_console(p, pexpect, t)
 
 def test_help_output():
     """ipython console --help-all works"""
-    tt.help_all_output_test('console')
-
+    check_help_all_output('jupyter_console')
 
 def test_display_text():
     "Ensure display protocol plain/text key is supported"
     # equivalent of:
     #
     #   x = %lsmagic
     #   from IPython.display import display; display(x);
     p, pexpect, t = start_console()
     p.sendline('x = %lsmagic')
     idx = p.expect([r'In \[\d+\]', pexpect.EOF], timeout=t)
     p.sendline('from IPython.display import display; display(x);')
     p.expect([r'Available line magics:', pexpect.EOF], timeout=t)
     stop_console(p, pexpect, t)
 
 def stop_console(p, pexpect, t):
     "Stop a running `ipython console` running via pexpect"
     # send ctrl-D;ctrl-D to exit
     p.sendeof()
     p.sendeof()
     p.expect([pexpect.EOF, pexpect.TIMEOUT], timeout=t)
     if p.isalive():
         p.terminate()
 
 
 def start_console():
     "Start `ipython console` using pexpect"
     import pexpect
     
     args = ['-m', 'IPython', 'console', '--colors=NoColor']
     cmd = sys.executable
     
     try:
         p = pexpect.spawn(cmd, args=args)
     except IOError:
         raise SkipTest("Couldn't find command %s" % cmd)
     
     # timeout after one minute
     t = 60
     idx = p.expect([r'In \[\d+\]', pexpect.EOF], timeout=t)
     return p, pexpect, t

jupyter_nbconvert/tests/test_nbconvertapp.py

@@ -1,243 +1,243 b''
 # -*- coding: utf-8 -*- 
 """Test NbConvertApp"""
 
 # Copyright (c) IPython Development Team.
 # Distributed under the terms of the Modified BSD License.
 
 import os
 import glob
 import sys
 
 from .base import TestsBase
 from ..postprocessors import PostProcessorBase
 
-import IPython.testing.tools as tt
+from traitlets.tests.utils import check_help_all_output
 from IPython.testing import decorators as dec
 
 #-----------------------------------------------------------------------------
 # Classes and functions
 #-----------------------------------------------------------------------------
 
 class DummyPost(PostProcessorBase):
     def postprocess(self, filename):
         print("Dummy:%s" % filename)
 
 class TestNbConvertApp(TestsBase):
     """Collection of NbConvertApp tests"""
 
 
     def test_notebook_help(self):
         """Will help show if no notebooks are specified?"""
         with self.create_temp_cwd():
             out, err = self.call('nbconvert --log-level 0', ignore_return_code=True)
             self.assertIn("see '--help-all'", out)
     
     def test_help_output(self):
         """ipython nbconvert --help-all works"""
-        tt.help_all_output_test('nbconvert')
+        check_help_all_output('jupyter_nbconvert')
 
     def test_glob(self):
         """
         Do search patterns work for notebook names?
         """
         with self.create_temp_cwd(['notebook*.ipynb']):
             self.call('nbconvert --to python *.ipynb --log-level 0')
             assert os.path.isfile('notebook1.py')
             assert os.path.isfile('notebook2.py')
 
 
     def test_glob_subdir(self):
         """
         Do search patterns work for subdirectory notebook names?
         """
         with self.create_temp_cwd():
             self.copy_files_to(['notebook*.ipynb'], 'subdir/')
             self.call('nbconvert --to python --log-level 0 ' + 
                       os.path.join('subdir', '*.ipynb'))
             assert os.path.isfile('notebook1.py')
             assert os.path.isfile('notebook2.py')
 
 
     def test_explicit(self):
         """
         Do explicit notebook names work?
         """
         with self.create_temp_cwd(['notebook*.ipynb']):
             self.call('nbconvert --log-level 0 --to python notebook2')
             assert not os.path.isfile('notebook1.py')
             assert os.path.isfile('notebook2.py')
 
 
     @dec.onlyif_cmds_exist('pdflatex')
     @dec.onlyif_cmds_exist('pandoc')
     def test_filename_spaces(self):
         """
         Generate PDFs with graphics if notebooks have spaces in the name?
         """
         with self.create_temp_cwd(['notebook2.ipynb']):
             os.rename('notebook2.ipynb', 'notebook with spaces.ipynb')
             self.call('nbconvert --log-level 0 --to pdf'
                     ' "notebook with spaces"'
                     ' --PDFExporter.latex_count=1'
                     ' --PDFExporter.verbose=True'
             )
             assert os.path.isfile('notebook with spaces.pdf')
 
     def test_post_processor(self):
         """Do post processors work?"""
         with self.create_temp_cwd(['notebook1.ipynb']):
             out, err = self.call('nbconvert --log-level 0 --to python notebook1 '
                       '--post jupyter_nbconvert.tests.test_nbconvertapp.DummyPost')
             self.assertIn('Dummy:notebook1.py', out)
 
     @dec.onlyif_cmds_exist('pandoc')
     def test_spurious_cr(self):
         """Check for extra CR characters"""
         with self.create_temp_cwd(['notebook2.ipynb']):
             self.call('nbconvert --log-level 0 --to latex notebook2')
             assert os.path.isfile('notebook2.tex')
             with open('notebook2.tex') as f:
                 tex = f.read()
             self.call('nbconvert --log-level 0 --to html notebook2')
             assert os.path.isfile('notebook2.html')
             with open('notebook2.html') as f:
                 html = f.read()
         self.assertEqual(tex.count('\r'), tex.count('\r\n'))
         self.assertEqual(html.count('\r'), html.count('\r\n'))
 
     @dec.onlyif_cmds_exist('pandoc')
     def test_png_base64_html_ok(self):
         """Is embedded png data well formed in HTML?"""
         with self.create_temp_cwd(['notebook2.ipynb']):
             self.call('nbconvert --log-level 0 --to HTML '
                       'notebook2.ipynb --template full')
             assert os.path.isfile('notebook2.html')
             with open('notebook2.html') as f:
                 assert "data:image/png;base64,b'" not in f.read()
 
     @dec.onlyif_cmds_exist('pandoc')
     def test_template(self):
         """
         Do export templates work?
         """
         with self.create_temp_cwd(['notebook2.ipynb']):
             self.call('nbconvert --log-level 0 --to slides '  
                       'notebook2.ipynb')
             assert os.path.isfile('notebook2.slides.html')
             with open('notebook2.slides.html') as f:
                 assert '/reveal.css' in f.read()
 
     def test_output_ext(self):
         """test --output=outputfile[.ext]"""
         with self.create_temp_cwd(['notebook1.ipynb']):
             self.call('nbconvert --log-level 0 --to python '
                       'notebook1.ipynb --output nb.py')
             assert os.path.exists('nb.py')
 
             self.call('nbconvert --log-level 0 --to python '
                       'notebook1.ipynb --output nb2')
             assert os.path.exists('nb2.py')
 
     def test_glob_explicit(self):
         """
         Can a search pattern be used along with matching explicit notebook names?
         """
         with self.create_temp_cwd(['notebook*.ipynb']):
             self.call('nbconvert --log-level 0 --to python '
                       '*.ipynb notebook1.ipynb notebook2.ipynb')
             assert os.path.isfile('notebook1.py')
             assert os.path.isfile('notebook2.py')
 
 
     def test_explicit_glob(self):
         """
         Can explicit notebook names be used and then a matching search pattern?
         """
         with self.create_temp_cwd(['notebook*.ipynb']):
             self.call('nbconvert --log-level 0 --to=python '
                       'notebook1.ipynb notebook2.ipynb *.ipynb')
             assert os.path.isfile('notebook1.py')
             assert os.path.isfile('notebook2.py')
 
 
     def test_default_config(self):
         """
         Does the default config work?
         """
         with self.create_temp_cwd(['notebook*.ipynb', 'ipython_nbconvert_config.py']):
             self.call('nbconvert --log-level 0')
             assert os.path.isfile('notebook1.py')
             assert not os.path.isfile('notebook2.py')
 
 
     def test_override_config(self):
         """
         Can the default config be overriden?
         """
         with self.create_temp_cwd(['notebook*.ipynb',
                                    'ipython_nbconvert_config.py',
                                    'override.py']):
             self.call('nbconvert --log-level 0 --config="override.py"')
             assert not os.path.isfile('notebook1.py')
             assert os.path.isfile('notebook2.py')
 
     def test_accents_in_filename(self):
         """
         Can notebook names include accents?
         """
         with self.create_temp_cwd():
             self.create_empty_notebook(u'nb1_análisis.ipynb')
             self.call('nbconvert --log-level 0 --to python nb1_*')
             assert os.path.isfile(u'nb1_análisis.py')
     
     @dec.onlyif_cmds_exist('pdflatex', 'pandoc')
     def test_filename_accent_pdf(self):
         """
         Generate PDFs if notebooks have an accent in their name?
         """
         with self.create_temp_cwd():
             self.create_empty_notebook(u'nb1_análisis.ipynb')
             self.call('nbconvert --log-level 0 --to pdf "nb1_*"'
                     ' --PDFExporter.latex_count=1'
                     ' --PDFExporter.verbose=True')
             assert os.path.isfile(u'nb1_análisis.pdf')
 
     def test_cwd_plugin(self):
         """
         Verify that an extension in the cwd can be imported.
         """
         with self.create_temp_cwd(['hello.py']):
             self.create_empty_notebook(u'empty.ipynb')
             self.call('nbconvert empty --to html --NbConvertApp.writer_class=\'hello.HelloWriter\'')
             assert os.path.isfile(u'hello.txt')
 
     def test_output_suffix(self):
         """
         Verify that the output suffix is applied
         """
         with self.create_temp_cwd():
             self.create_empty_notebook('empty.ipynb')
             self.call('nbconvert empty.ipynb --to notebook')
             assert os.path.isfile('empty.nbconvert.ipynb')
 
     def test_different_build_dir(self):
         """
         Verify that the output suffix is not applied
         """
         with self.create_temp_cwd():
             self.create_empty_notebook('empty.ipynb')
             os.mkdir('output')
             self.call(
                 'nbconvert empty.ipynb --to notebook '
                 '--FilesWriter.build_directory=output')
             assert os.path.isfile('output/empty.ipynb')
 
     def test_inplace(self):
         """
         Verify that the notebook is converted in place
         """
         with self.create_temp_cwd():
             self.create_empty_notebook('empty.ipynb')
             self.call('nbconvert empty.ipynb --to notebook --inplace')
             assert os.path.isfile('empty.ipynb')
             assert not os.path.isfile('empty.nbconvert.ipynb')

jupyter_qtconsole/console/tests/test_app.py

@@ -1,27 +1,15 b''
 """Test QtConsoleApp"""
 
-#-----------------------------------------------------------------------------
-#  Copyright (C) 2013 The IPython Development Team
-#
-#  Distributed under the terms of the BSD License.  The full license is in
-#  the file COPYING, distributed as part of this software.
-#-----------------------------------------------------------------------------
-
-#-----------------------------------------------------------------------------
-# Imports
-#-----------------------------------------------------------------------------
+# Copyright (c) Jupyter Development Team.
+# Distributed under the terms of the Modified BSD License.
 
 import nose.tools as nt
 
-import IPython.testing.tools as tt
+from traitlets.tests.utils import check_help_all_output
 from IPython.testing.decorators import skip_if_no_x11
 
-#-----------------------------------------------------------------------------
-# Test functions
-#-----------------------------------------------------------------------------
-
 @skip_if_no_x11
 def test_help_output():
-    """ipython qtconsole --help-all works"""
-    tt.help_all_output_test('qtconsole')
+    """jupyter qtconsole --help-all works"""
+    check_help_all_output('jupyter_qtconsole')