add tests and test configuration

Author: jbweston

tests/test_execute.py

@@ -0,0 +1,162 @@
+import tempfile
+import shutil
+import os
+import sys
+from io import StringIO
+
+from sphinx.testing.util import SphinxTestApp, path
+from sphinx.errors import ExtensionError
+
+import pytest
+
+from jupyter_sphinx.execute import JupyterCellNode, JupyterKernelNode
+
+@pytest.fixture()
+def doctree():
+    source_trees = []
+    apps = []
+    syspath = sys.path[:]
+
+    def doctree(source):
+        src_dir = tempfile.mkdtemp()
+        source_trees.append(src_dir)
+        with open(os.path.join(src_dir, 'conf.py'), 'w') as f:
+            f.write("extensions = ['jupyter_sphinx.execute']")
+        with open(os.path.join(src_dir, 'index.rst'), 'w') as f:
+            f.write(source)
+        app = SphinxTestApp(srcdir=path(src_dir), status=StringIO(),
+                            warning=StringIO())
+        apps.append(app)
+        app.build()
+        return app.env.get_doctree('index')
+
+    yield doctree
+
+    sys.path[:] = syspath
+    for app in reversed(apps):
+        app.cleanup()
+    for tree in source_trees:
+        shutil.rmtree(tree)
+
+
+def test_basic(doctree):
+    source = '''
+    .. jupyter-execute::
+
+        2 + 2
+    '''
+    tree = doctree(source)
+    cell, = tree.traverse(JupyterCellNode)
+    assert cell.attributes['code_below'] is False
+    assert cell.attributes['hide_code'] is False
+    assert cell.attributes['hide_output'] is False
+    assert cell.children[0].rawsource.strip() == "2 + 2"
+    assert cell.children[1].rawsource.strip() == "4"
+
+
+def test_hide_output(doctree):
+    source = '''
+    .. jupyter-execute::
+        :hide-output:
+
+        2 + 2
+    '''
+    tree = doctree(source)
+    cell, = tree.traverse(JupyterCellNode)
+    assert cell.attributes['hide_output'] is True
+    assert len(cell.children) == 1
+    assert cell.children[0].rawsource.strip() == "2 + 2"
+
+
+def test_hide_code(doctree):
+    source = '''
+    .. jupyter-execute::
+        :hide-code:
+
+        2 + 2
+    '''
+    tree = doctree(source)
+    cell, = tree.traverse(JupyterCellNode)
+    assert cell.attributes['hide_code'] is True
+    assert len(cell.children) == 1
+    assert cell.children[0].rawsource.strip() == "4"
+
+
+def test_code_below(doctree):
+    source = '''
+    .. jupyter-execute::
+        :code-below:
+
+        2 + 2
+    '''
+    tree = doctree(source)
+    cell, = tree.traverse(JupyterCellNode)
+    assert cell.attributes['code_below'] is True
+    assert cell.children[0].rawsource.strip() == "4"
+    assert cell.children[1].rawsource.strip() == "2 + 2"
+
+
+def test_execution_environment_carries_over(doctree):
+    source = '''
+    .. jupyter-execute::
+
+        a = 1
+
+    .. jupyter-execute::
+
+        a += 1
+        a
+    '''
+    tree = doctree(source)
+    cell0, cell1 = tree.traverse(JupyterCellNode)
+    assert cell1.children[1].rawsource.strip() == "2"
+
+
+def test_kernel_restart(doctree):
+    source = '''
+    .. jupyter-execute::
+
+        a = 1
+
+    .. jupyter-kernel::
+        :id: new-kernel
+
+    .. jupyter-execute::
+        :raises:
+
+        a += 1
+        a
+    '''
+    tree = doctree(source)
+    cell0, cell1 = tree.traverse(JupyterCellNode)
+    assert 'NameError' in cell1.children[1].rawsource
+
+
+def test_raises(doctree):
+    source = '''
+    .. jupyter-execute::
+
+        raise ValueError()
+    '''
+    with pytest.raises(ExtensionError):
+        doctree(source)
+
+    source = '''
+    .. jupyter-execute::
+        :raises:
+
+        raise ValueError()
+    '''
+    tree = doctree(source)
+    cell, = tree.traverse(JupyterCellNode)
+    'ValueError' in cell.children[1].rawsource
+
+    source = '''
+    .. jupyter-execute::
+        :raises: KeyError, ValueError
+
+        raise ValueError()
+    '''
+    tree = doctree(source)
+    cell, = tree.traverse(JupyterCellNode)
+    'ValueError' in cell.children[1].rawsource

tox.ini

@@ -0,0 +1,9 @@
+[tox]
+envlist = py36,py37
+
+[testenv]
+deps =
+  sphinx
+  pytest
+commands =
+  pytest