Clean up test runner

test/run-test.py

@@ -6,12 +6,13 @@ from __future__ import print_function, absolute_import
 import atexit
 import json
 import os
+from subprocess import Popen
 import sys
 import shutil
 import tempfile
 
+from tornado import gen
 from tornado.ioloop import IOLoop
-from tornado.process import Subprocess
 from notebook.notebookapp import NotebookApp
 from traitlets import Bool, Unicode
 
@@ -19,24 +20,6 @@ from traitlets import Bool, Unicode
 HERE = os.path.dirname(__file__)
 
 
-def create_notebook_dir():
-    """Create a temporary directory with some file structure."""
-    root_dir = tempfile.mkdtemp(prefix='mock_contents')
-    os.mkdir(os.path.join(root_dir, 'src'))
-    with open(os.path.join(root_dir, 'src', 'temp.txt'), 'w') as fid:
-        fid.write('hello')
-    atexit.register(lambda: shutil.rmtree(root_dir, True))
-    return root_dir
-
-
-def run_command(cmd):
-    """Run a task in a thread and exit with the return code."""
-    shell = os.name == 'nt'
-    p = Subprocess(cmd, shell=shell)
-    print('\n\nRunning command: "%s"\n\n' % ' '.join(cmd))
-    p.set_exit_callback(sys.exit)
-
-
 def get_command(nbapp):
     """Get the command to run."""
     terminalsAvailable = nbapp.web_app.settings['terminals_available']
@@ -57,35 +40,85 @@ def get_command(nbapp):
         document.body.appendChild(node);
         """ % json.dumps(config))
 
-    return ['karma', 'start'] + ARGS
+    return ['karma', 'start'] + sys.argv[1:]
+
+
+def create_notebook_dir():
+    """Create a temporary directory with some file structure."""
+    root_dir = tempfile.mkdtemp(prefix='mock_contents')
+    os.mkdir(os.path.join(root_dir, 'src'))
+    with open(os.path.join(root_dir, 'src', 'temp.txt'), 'w') as fid:
+        fid.write('hello')
+    atexit.register(lambda: shutil.rmtree(root_dir, True))
+    return root_dir
+
+
+class TaskRunner(object):
+    """Run a task using the notebook app and exit with the return code.
+    """
+
+    def __init__(self, nbapp):
+        self.nbapp = nbapp
+
+    def start(self, cmd):
+        """Start the task."""
+        # Run the command after the ioloop starts.
+        self._command = cmd
+        IOLoop.current().add_callback(self._run_command)
+
+    def exit(self, returncode):
+        """Safely stop the app and then exit with the given code."""
+        self._return_code = returncode
+        self.nbapp.io_loop.add_callback(self._exit)
+
+    @gen.coroutine
+    def _run_command(self):
+        """Run a task in a thread and exit with the return code."""
+        cmd = self._command
+        shell = os.name == 'nt'
+        proc = Popen(cmd, shell=shell)
+        print('\n\nRunning command: "%s"\n\n' % ' '.join(cmd))
+
+        # Poll the process once per second until finished.
+        while 1:
+            yield gen.sleep(1)
+            if proc.poll() is not None:
+                break
+
+        self.exit(proc.returncode)
+
+    def _exit(self):
+        self.nbapp.io_loop.stop()
+        sys.exit(self._return_code)
 
 
 class TestApp(NotebookApp):
-    """A notebook app that runs a karma test."""
+    """A notebook app that supports a unit test."""
 
     open_browser = Bool(False)
     notebook_dir = Unicode(create_notebook_dir())
     allow_origin = Unicode('*')
 
-    def start(self):
-        # Cannot run against Notebook 4.3.0 due to auth incompatibilities.
-        if self.version == '4.3.0':
-            msg = ('Cannot run unit tests against Notebook 4.3.0.  '
-                   'Please upgrade to Notebook 4.3.1+')
-            self.log.error(msg)
-            sys.exit(1)
 
-        # Run the command after the ioloop starts.
-        IOLoop.current().add_callback(run_command, get_command(self))
-        super(TestApp, self).start()
+def main():
+    """Run the unit test."""
+    app = TestApp()
 
+    if app.version == '4.3.0':
+        msg = ('Cannot run unit tests against Notebook 4.3.0.  '
+               'Please upgrade to Notebook 4.3.1+')
+        print(msg)
+        sys.exit(1)
 
-if __name__ == '__main__':
-    # Reserve the command line arguments for karma.
-    ARGS = sys.argv[1:]
-    sys.argv = sys.argv[:1]
+    app.initialize([])  # reserve sys.argv for the command
+    task = TaskRunner(app)
+    task.start(get_command(app))
 
     try:
-        nbapp = TestApp.launch_instance()
+        app.start()
     except KeyboardInterrupt:
-        nbapp.stop()
+        task.exit(1)
+
+
+if __name__ == '__main__':
+    main()