updated tests to use get_output_error_code

IPython/nbconvert/tests/base.py

@@ -1,177 +1,171 b''
 """
 Contains base test class for nbconvert
 """
 #-----------------------------------------------------------------------------
 #Copyright (c) 2013, the IPython Development Team.
 #
 #Distributed under the terms of the Modified BSD License.
 #
 #The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
-import subprocess
 import os
 import glob
 import shutil
-import sys
 
 import IPython
 from IPython.utils.tempdir import TemporaryDirectory
-from IPython.utils import py3compat
+from IPython.utils.process import get_output_error_code
 
 #-----------------------------------------------------------------------------
 # Classes and functions
 #-----------------------------------------------------------------------------
 
 class TemporaryWorkingDirectory(TemporaryDirectory):
     """
     Creates a temporary directory and sets the cwd to that directory.
     Automatically reverts to previous cwd upon cleanup.
     Usage example:
 
         with TemporaryWorakingDirectory() as tmpdir:
             ...
     """
 
     def __init__(self, **kw):
         """
         Constructor
         """
         super(TemporaryWorkingDirectory, self).__init__(**kw)
 
         #Change cwd to new temp dir.  Remember old cwd.
         self.old_wd = os.getcwd()
         os.chdir(self.name)
 
 
     def cleanup(self):
         """
         Destructor
         """
 
         #Revert to old cwd.
         os.chdir(self.old_wd)
 
         #Cleanup
         super(TemporaryWorkingDirectory, self).cleanup()
 
 
 class TestsBase(object):
     """Base tests class.  Contains usefull fuzzy comparison and nbconvert
     functions."""
 
 
     def fuzzy_compare(self, a, b, newlines_are_spaces=True, tabs_are_spaces=True, 
                       fuzzy_spacing=True, ignore_spaces=False, 
                       ignore_newlines=False, case_sensitive=False):
         """
         Performs a fuzzy comparison of two strings.  A fuzzy comparison is a
         comparison that ignores insignificant differences in the two comparands.
         The significance of certain differences can be specified via the keyword
         parameters of this method.
         """
 
         if newlines_are_spaces:
             a = a.replace('\n', ' ')
             b = b.replace('\n', ' ')
 
         if tabs_are_spaces:
             a = a.replace('\t', ' ')
             b = b.replace('\t', ' ')
 
         if ignore_spaces:
             a = a.replace(' ', '')
             b = b.replace(' ', '')
 
         if fuzzy_spacing:
             a = self.recursive_replace(a, '  ', ' ')
             b = self.recursive_replace(b, '  ', ' ')
 
         if ignore_newlines:
             a = a.replace('\n', '')
             b = b.replace('\n', '')
 
         if not case_sensitive:
             a = a.lower()
             b = b.lower()
 
         return a == b
 
 
     def recursive_replace(self, text, search, replacement):
         """
         Performs a recursive replacement operation.  Replaces all instances
         of a search string in a text string with a replacement string until
         the search string no longer exists.  Recursion is needed because the
         replacement string may generate additional search strings.
 
         For example:
            Replace "ii" with "i" in the string "Hiiii" yields "Hii"
            Another replacement yields "Hi" (the desired output)
 
         Parameters:
         -----------
         text : string
             Text to replace in.
         search : string
             String to search for within "text"
         replacement : string
             String to replace "search" with
         """
         while search in text:
             text = text.replace(search, replacement)
         return text
 
             
     def create_temp_cwd(self, copy_filenames=None):
         temp_dir = TemporaryWorkingDirectory()
 
         #Copy the files if requested.
         if not copy_filenames is None:
             self.copy_files_to(copy_filenames)
 
         #Return directory handler
         return temp_dir
 
 
     def copy_files_to(self, copy_filenames=None, destination=None):
         
         #Copy test files into the destination directory.
         if copy_filenames:
             for pattern in copy_filenames:
                 for match in glob.glob(os.path.join(self._get_files_path(), pattern)):
                     if destination is None:
                         shutil.copyfile(match, os.path.basename(match))
                     else:
                         if not os.path.isdir(destination):
                             os.makedirs(destination)
                         shutil.copyfile(match, os.path.join(destination, os.path.basename(match)))
 
 
     def _get_files_path(self):
 
         #Get the relative path to this module in the IPython directory.
         names = self.__module__.split('.')[1:-1]
         names.append('files')
         
         #Build a path using the IPython directory and the relative path we just
         #found.
         path = IPython.__path__[0]
         for name in names:
             path = os.path.join(path, name)
         return path
 
 
-    def call(self, parameters):
-        output = subprocess.Popen(parameters, stdout=subprocess.PIPE).communicate()[0]
-        
-        #Convert the output to a string if running Python3
-        if py3compat.PY3:
-            return output.decode('utf-8')
-        else:
-            return output
-     
  No newline at end of file
+    def call(self, parameters, raise_on_error=True):
+        stdout, stderr, retcode = get_output_error_code(parameters)
+        if retcode != 0 and raise_on_error:
+            raise OSError(stderr)
+        return stdout, stderr

IPython/nbconvert/tests/test_nbconvertapp.py

@@ -1,149 +1,152 b''
 """
 Contains tests for the nbconvertapp
 """
 #-----------------------------------------------------------------------------
 #Copyright (c) 2013, the IPython Development Team.
 #
 #Distributed under the terms of the Modified BSD License.
 #
 #The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 import os
 from .base import TestsBase
 
 from IPython.utils import py3compat
 from IPython.testing import decorators as dec
 
     
 #-----------------------------------------------------------------------------
 # Constants
 #-----------------------------------------------------------------------------
 
 # Define ipython commandline name
 if py3compat.PY3:
     IPYTHON = 'ipython3'
 else:
     IPYTHON = 'ipython'
 
 
 #-----------------------------------------------------------------------------
 # Classes and functions
 #-----------------------------------------------------------------------------
 
 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():
-            assert "see '--help-all'" in self.call([IPYTHON, 'nbconvert'])
+            out, err = self.call(IPYTHON + ' nbconvert', raise_on_error=False)
+            assert "see '--help-all'" in out
 
 
     def test_glob(self):
         """
         Do search patterns work for notebook names?
         """
         with self.create_temp_cwd(['notebook*.ipynb']):
-            assert not 'error' in self.call([IPYTHON, 'nbconvert', 
-                '--to="python"', '--notebooks=["*.ipynb"]']).lower()
+            self.call(IPYTHON + ' nbconvert --to="python"'
+                       ' --notebooks=["*.ipynb"]')
             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() as cwd:
+        with self.create_temp_cwd():
             self.copy_files_to(['notebook*.ipynb'], 'subdir/')
-            assert not 'error' in self.call([IPYTHON, 'nbconvert', '--to="python"', 
-                '--notebooks=["%s"]' % os.path.join('subdir', '*.ipynb')]).lower()
+            self.call(IPYTHON + ' nbconvert --to="python"',
+                      ' --notebooks=["%s"]' % 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']):
-            assert not 'error' in self.call([IPYTHON, 'nbconvert', '--to="python"', 
-                '--notebooks=["notebook2.ipynb"]']).lower()
+            self.call(IPYTHON + ' nbconvert --to="python"'
+                      ' --notebooks=["notebook2.ipynb"]')
             assert not os.path.isfile('notebook1.py')
             assert os.path.isfile('notebook2.py')
 
 
     @dec.onlyif_cmds_exist('pdflatex')
     def test_post_processor(self):
         """
         Do post processors work?
         """
         with self.create_temp_cwd(['notebook1.ipynb']):
-            assert not 'error' in self.call([IPYTHON, 'nbconvert', '--to="latex"', 
-                'notebook1', '--post="PDF"', '--PDFPostProcessor.verbose=True']).lower()
+            self.call(IPYTHON + ' nbconvert --to="latex" notebook1'
+                       ' --post="PDF" --PDFPostProcessor.verbose=True')
             assert os.path.isfile('notebook1.tex')
             print("\n\n\t" + "\n\t".join([f for f in os.listdir('.') if os.path.isfile(f)]) + "\n\n")
             assert os.path.isfile('notebook1.pdf')
 
 
     def test_template(self):
         """
         Do export templates work?
         """
         with self.create_temp_cwd(['notebook2.ipynb']):
-            assert not 'error' in self.call([IPYTHON, 'nbconvert', '--to=slides', 
-                '--notebooks=["notebook2.ipynb"]', '--template=reveal']).lower()
+            self.call(IPYTHON + ' nbconvert --to=slides'
+                       ' --notebooks=["notebook2.ipynb"]'
+                       ' --template=reveal')
             assert os.path.isfile('notebook2.slides.html')
             with open('notebook2.slides.html') as f:
                 assert '/reveal.css' in f.read()
 
 
     def test_glob_explicit(self):
         """
         Can a search pattern be used along with matching explicit notebook names?
         """
         with self.create_temp_cwd(['notebook*.ipynb']):
-            assert not 'error' in self.call([IPYTHON, 'nbconvert', '--to="python"', 
-                '--notebooks=["*.ipynb", "notebook1.ipynb", "notebook2.ipynb"]']).lower()
+            self.call(IPYTHON + ' nbconvert --to="python" --notebooks='
+                      '["*.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']):
-            assert not 'error' in self.call([IPYTHON, 'nbconvert', '--to="python"', 
-                '--notebooks=["notebook1.ipynb", "notebook2.ipynb", "*.ipynb"]']).lower()
+            self.call(IPYTHON + ' nbconvert --to="python" --notebooks='
+                      '["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']):
-            assert not 'error' in self.call([IPYTHON, 'nbconvert']).lower()
+            self.call(IPYTHON + ' nbconvert')
             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', 
+        with self.create_temp_cwd(['notebook*.ipynb',
+                                   'ipython_nbconvert_config.py',
                                    'override.py']):
-            assert not 'error' in self.call([IPYTHON, 'nbconvert', '--config="override.py"']).lower()
+            self.call(IPYTHON + ' nbconvert --config="override.py"')
             assert not os.path.isfile('notebook1.py')
             assert os.path.isfile('notebook2.py')