Merge pull request #913 from krinsman/step7_13

Migrate to traitlets from tornado.options

Author: krinsman

README.md

@@ -199,7 +199,9 @@ NBViewer is configurable using a config file, by default called `nbviewer_config
 
 If you don't know which attributes of NBViewer you can configure using the config file, run `python -m nbviewer --generate-config` (or `python -m nbviewer --generate-config --config-file="my_custom_name.py"`) to write a default config file which has all of the configurable options commented out and set to their default values. To change a configurable option to a new value, uncomment the corresponding line and change the default value to the new value.
 
-The config file uses [the standard configuration syntax for Jupyter projects](https://traitlets.readthedocs.io/en/stable/config.html).
+You can also run `python -m nbviewer --help-all` to see all of the configurable options. This is a more comprehensive version of `python -m nbviewer --help`, which gives a list of the most common ones along with flags and aliases you can use to set their values temporarily via the command line.
+
+The config file uses [the standard configuration syntax for Jupyter projects](https://traitlets.readthedocs.io/en/stable/config.html). For example, to configure the default port used to be 9000, add the line `c.NBViewer.port = 9000` to the config file. If you want to do this just once, you can also run `python -m nbviewer --NBViewer.port=9000` at the command line. (`NBViewer.port` also has the alias `port`, making it also possible to do, in this specific case, `python -m nbviewer --port=9000`. However not all configurable options have shorthand aliases like this; you can check using the outputs of `python -m nbviewer --help` and `python -m nbviewer --help-all` to see which ones do and which ones don't.)
 
 One thing this allows you to do, for example, is to write your custom implementations of any of the standard page rendering [handlers](https://www.tornadoweb.org/en/stable/guide/structure.html#subclassing-requesthandler) included in NBViewer, e.g. by subclassing the original handlers to include custom logic along with custom output possibilities, and then have these custom handlers always loaded by default, by modifying the corresponding lines in the config file. This is effectively another way to extend NBViewer.
 

nbviewer/app.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/github/tests/test_github.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/providers/local/tests/test_localfile.py

@@ -1,14 +1,14 @@
 # -*- coding: utf-8 -*-
 
-from ....tests.async_base import AsyncNbviewerTestCase
+import requests
+from ....tests.base import NBViewerTestCase
 
-
-class ForceUTF8TestCase(AsyncNbviewerTestCase):
+class ForceUTF8TestCase(NBViewerTestCase):
     def test_utf8(self):
         """ #507, bitbucket returns no content headers, but _is_ serving utf-8
         """
-        response = self.fetch(
-            '/urls/bitbucket.org/sandiego206/asdasd/raw/master/Untitled.ipynb'
+        response = requests.get(
+            self.url('/urls/bitbucket.org/sandiego206/asdasd/raw/master/Untitled.ipynb')
         )
-        self.assertEqual(response.code, 200)
-        self.assertIn("ñ", response.body)
+        self.assertEqual(response.status_code, 200)
+        self.assertIn("ñ", response.content)

nbviewer/providers/url/tests/test_content.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/async_base.py

@@ -36,5 +36,57 @@ def test_generate_config():
     os.remove(cfg_file)
     assert cfg_file in out
     assert 'NBViewer.name' not in cfg_text # This shouldn't be configurable
+    assert 'NBViewer.answer_yes' in cfg_text
+    assert 'NBViewer.base_url' in cfg_text
+    assert 'NBViewer._base_url' not in cfg_text # This shouldn't be configurable
+    assert 'NBViewer.binder_base_url' in cfg_text
+    assert 'NBViewer.cache_expiry_max' in cfg_text
+    assert 'NBViewer.cache_expiry_min' in cfg_text
+    assert 'NBViewer.client' in cfg_text
+    assert 'NBViewer.config_file' in cfg_text
+    assert 'NBViewer.content_security_policy' in cfg_text
+    assert 'NBViewer.default_format' in cfg_text
+    assert 'NBViewer.frontpage' in cfg_text
+    assert 'NBViewer.generate_config' in cfg_text
+    assert 'NBViewer.host' in cfg_text
+    assert 'NBViewer.index' in cfg_text
+    assert 'NBViewer.ipywidgets_base_url' in cfg_text
+    assert 'NBViewer.jupyter_js_widgets_version' in cfg_text
+    assert 'NBViewer.jupyter_widgets_html_manager_version' in cfg_text
+    assert 'NBViewer.localfile_any_user' in cfg_text
     assert 'NBViewer.local_handler' in cfg_text
+    assert 'NBViewer.localfile_follow_symlinks' in cfg_text
+    assert 'NBViewer.localfiles' in cfg_text
+    assert 'NBViewer.mathjax_url' in cfg_text
+    assert 'NBViewer.max_cache_uris' in cfg_text
+    assert 'NBViewer.mc_threads' in cfg_text
+    assert 'NBViewer.no_cache' in cfg_text
+    assert 'NBViewer.no_check_certificate' in cfg_text
+    assert 'NBViewer.port' in cfg_text
+    assert 'NBViewer.processes' in cfg_text
+    assert 'NBViewer.providers' in cfg_text
+    assert 'NBViewer.provider_rewrites' in cfg_text
+    assert 'NBViewer.proxy_host' in cfg_text
+    assert 'NBViewer.proxy_port' in cfg_text
+    assert 'NBViewer.rate_limit' in cfg_text
+    assert 'NBViewer.rate_limit_interval' in cfg_text
+    assert 'NBViewer.render_timeout' in cfg_text
+    assert 'NBViewer.sslcert' in cfg_text
+    assert 'NBViewer.sslkey' in cfg_text
     assert 'NBViewer.static_path' in cfg_text
+    assert 'NBViewer.static_url_prefix' in cfg_text
+    assert 'NBViewer._static_url_prefix' not in cfg_text # This shouldn't be configurable
+    assert 'NBViewer.statsd_host' in cfg_text
+    assert 'NBViewer.statsd_port' in cfg_text
+    assert 'NBViewer.statsd_prefix' in cfg_text
+    assert 'NBViewer.template_path' in cfg_text
+    assert 'NBViewer.default_endpoint' not in cfg_text # Shouldn't be configurable, is a property
+    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
+    assert 'NBViewer.pool' not in cfg_text
+    assert 'NBViewer.rate_limiter' not in cfg_text
+    assert 'NBViewer.static_paths' not in cfg_text
+    assert 'NBViewer.template_paths' not in cfg_text
+

nbviewer/tests/base.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_app.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