Modified tests to avoid 'bad config encountered during initialization: Unrecognized flag: '-v'' error from nosetests, by using/modifying subprocess.Popen based tests from JupyterHub and earlier versions of NBViewer

Author: krinsman

nbviewer/providers/github/tests/test_github.py

@@ -8,8 +8,6 @@
 
 import requests
 
-from unittest import SkipTest
-
 from ....tests.base import NBViewerTestCase, FormatHTMLMixin, skip_unless_github_auth
 
 class GitHubTestCase(NBViewerTestCase):

nbviewer/providers/local/tests/test_localfile.py

@@ -6,17 +6,13 @@
 #-----------------------------------------------------------------------------
 
 import requests
-import sys
-from nbviewer.utils import url_path_join
 
 from ....tests.base import NBViewerTestCase, FormatHTMLMixin
 
 class LocalFileDefaultTestCase(NBViewerTestCase):
     @classmethod
-    def get_server_args(cls):
-        return [
-            '--localfiles=.',
-            ]
+    def get_server_cmd(cls):
+        return super().get_server_cmd() + [ '--localfiles=.' ]
 
     def test_url(self):
         ## assumes being run from base of this repo
@@ -32,10 +28,8 @@ class FormatHTMLLocalFileDefaultTestCase(LocalFileDefaultTestCase,
 
 class LocalFileRelativePathTestCase(NBViewerTestCase):
     @classmethod
-    def get_server_args(cls):
-        return [
-            '--localfiles=nbviewer',
-            ]
+    def get_server_cmd(cls):
+        return super().get_server_cmd() + [ '--localfiles=nbviewer' ]
 
     def test_url(self):
         ## assumes being run from base of this repo

nbviewer/tests/base.py

@@ -13,24 +13,26 @@
 import time
 import requests
 from contextlib import contextmanager
-from threading import Thread, Event
 from unittest import TestCase, skipIf
 
 from tornado.escape import to_unicode
-from tornado.ioloop import IOLoop
 from tornado.log import app_log
-import tornado.options
 
 from nbviewer.utils import url_path_join
-from nbviewer.app import main
 from nbviewer.providers.github.client import AsyncGitHubClient
 
+from subprocess import Popen
+from subprocess import DEVNULL as devnull
+import os
+import sys
 
 class NBViewerTestCase(TestCase):
     """A base class for tests that need a running nbviewer server."""
 
     port = 12341
 
+    environment_variables = {}
+
     def assertIn(self, observed, expected, *args, **kwargs):
         return super().assertIn(
             to_unicode(observed),
@@ -69,30 +71,22 @@ def wait_until_dead(cls):
             else:
                 time.sleep(.1)
 
+    @classmethod
+    def get_server_cmd(cls):
+        return [ sys.executable, '-m', 'nbviewer', '--port=%d' % cls.port, ]
+                
     @classmethod
     def setup_class(cls):
-        cls._start_evt = Event()
-        cls.server = Thread(target=cls._server_main)
-        cls.server.start()
-        cls._start_evt.wait()
+        server_cmd = cls.get_server_cmd()
+        cls.server = Popen(server_cmd,
+                stdout=devnull, stderr=devnull,
+                # Set environment variables if any
+                env=dict(os.environ, **cls.environment_variables))
         cls.wait_until_alive()
 
-    @classmethod
-    def get_server_args(cls):
-        return []
-    
-    @classmethod
-    def _server_main(cls):
-        cls._server_loop = loop = IOLoop()
-        loop.make_current()
-        cls._server_loop.add_callback(cls._start_evt.set)
-        main(['', '--port=%d' % cls.port] + cls.get_server_args())
-        loop.close(all_fds=True)
-
     @classmethod
     def teardown_class(cls):
-        cls._server_loop.add_callback(cls._server_loop.stop)
-        cls.server.join()
+        cls.server.terminate()
         cls.wait_until_dead()
 
     @classmethod

nbviewer/tests/test_app.py

@@ -80,9 +80,8 @@ def test_generate_config():
     assert 'NBViewer.statsd_port' in cfg_text
     assert 'NBViewer.statsd_prefix' in cfg_text
     assert 'NBViewer.template_path' in cfg_text
-    assert 'NBViewer.cache' not in cfg_text # Shouldn't be configurable, is a property
     assert 'NBViewer.default_endpoint' not in cfg_text # Shouldn't be configurable, is a property
-    assert 'NBViewer.env' not in cfg_text # Ditto the above
+    assert 'NBViewer.env' not in cfg_text # Shouldn't be configurable, is a property
     assert 'NBViewer.fetch_kwargs' not in cfg_text
     assert 'NBViewer.formats' not in cfg_text
     assert 'NBViewer.frontpage_setup' not in cfg_text

nbviewer/tests/test_config.py

@@ -1,10 +1,7 @@
 import os
 from subprocess import Popen
 from .base import NBViewerTestCase
-import sys
 import requests
-from tornado.ioloop import IOLoop
-from nbviewer.app import main
 
 tmpl_fixture = "nbviewer/tests/templates"
 
@@ -19,22 +16,12 @@ def test_used_custom_template(self):
 
 class TemplatePathCLITestCase(NBViewerTestCase, CustomTemplateStub):
     @classmethod
-    def get_server_args(cls):
-        return super().get_server_args() + [
-            '--template_path={}'.format(tmpl_fixture),
-        ]
+    def get_server_cmd(cls):
+        return super().get_server_cmd() + [
+            '--template-path={}'.format(tmpl_fixture), ]
 
 
-class TemplatePathEnvTestCase(NBViewerTestCase, CustomTemplateStub):
-
-    @classmethod
-    def _server_main(cls):
-        cls._server_loop = loop = IOLoop()
-        loop.make_current()
-        cls._server_loop.add_callback(cls._start_evt.set)
 
-        # Set environment variable
-        os.environ['NBVIEWER_TEMPLATE_PATH'] = tmpl_fixture
+class TemplatePathEnvTestCase(NBViewerTestCase, CustomTemplateStub):
 
-        main(['', '--port=%d' % cls.port] + cls.get_server_args())
-        loop.close(all_fds=True)
+    environment_variables = {'NBVIEWER_TEMPLATE_PATH': tmpl_fixture}

nbviewer/tests/test_index.py

@@ -1,9 +1,10 @@
-from unittest import SkipTest
-
 from .base import NBViewerTestCase
 
+from unittest import skip
 from nbviewer import index
 
 class ElasticSearchTestCase(NBViewerTestCase):
+    @skip
+    @classmethod
     def test_finish_notebook(self):
         pass

nbviewer/tests/test_security.py

@@ -61,22 +61,11 @@ class JupyterHubServiceTestCase(NBViewerTestCase):
         'JUPYTERHUB_SERVICE_PREFIX': '/services/nbviewer-test'
     }
 
+    environment_variables = HUB_SETTINGS
+    
     @classmethod
-    def get_server_args(cls):
-        return [
-            '--localfiles=.'
-        ]
-
-    @classmethod
-    def setup_class(cls):
-        os.environ.update(cls.HUB_SETTINGS)
-        super().setup_class()
-
-    @classmethod
-    def teardown_class(cls):
-        for key in cls.HUB_SETTINGS.keys():
-            del os.environ[key]
-        super().teardown_class()
+    def get_server_cmd(cls):
+        return super().get_server_cmd() + [ '--localfiles=.' ]
 
     def test_login_redirect(self):
         url = self.url('/services/nbviewer-test/github/jupyter')

nbviewer/tests/test_utils.py

@@ -5,7 +5,6 @@
 #  Distributed under the terms of the BSD License.  The full license is in
 #  the file COPYING, distributed as part of this software.
 #-----------------------------------------------------------------------------
-from collections import OrderedDict
 
 import nose.tools as nt