Selenium test fixture to open a notebook with prefilled content

This makes several tests shorter and (hopefully) more efficient

Author: takluyver

notebook/tests/selenium/conftest.py

@@ -1,9 +1,12 @@
 import json
+import nbformat
+from nbformat.v4 import new_notebook, new_code_cell
 import os
 import pytest
 import requests
 from subprocess import Popen
 import sys
+from tempfile import mkstemp
 from testpath.tempdir import TemporaryDirectory
 import time
 from urllib.parse import urljoin
@@ -121,3 +124,20 @@ def notebook(authenticated_browser):
     tree_wh = authenticated_browser.current_window_handle
     yield Notebook.new_notebook(authenticated_browser)
     authenticated_browser.switch_to.window(tree_wh)
+
+@pytest.fixture
+def prefill_notebook(selenium_driver, notebook_server):
+    def inner(cells):
+        cells = [new_code_cell(c) if isinstance(c, str) else c
+                 for c in cells]
+        nb = new_notebook(cells=cells)
+        fd, path = mkstemp(dir=notebook_server['nbdir'], suffix='.ipynb')
+        with open(fd, 'w', encoding='utf-8') as f:
+            nbformat.write(nb, f)
+        fname = os.path.basename(path)
+        selenium_driver.get(
+            "{url}notebooks/{}?token={token}".format(fname, **notebook_server)
+        )
+        return Notebook(selenium_driver)
+
+    return inner

notebook/tests/selenium/test_buffering.py

@@ -13,23 +13,22 @@ def wait_for_kernel_ready(notebook):
     wait_for_selector(notebook.browser, ".kernel_idle_icon")
 
 
-def kernels_buffer_without_conn(notebook):
+def test_kernels_buffer_without_conn(prefill_notebook):
     """Test that execution request made while disconnected is buffered."""
-    # Assert that cell executed while kernel is disconnected still
-    # executes when reconnected
+    notebook = prefill_notebook(["print(1 + 2)"])
+
     wait_for_kernel_ready(notebook)
     notebook.browser.execute_script("IPython.notebook.kernel.stop_channels();")
-    notebook.edit_cell(index=0, content="print(1 + 2)")
     notebook.execute_cell(0)
     notebook.browser.execute_script("IPython.notebook.kernel.reconnect();")
     wait_for_kernel_ready(notebook)
+
     assert wait_for_cell_text_output(notebook, 0) == "3"
-    notebook.delete_cell(0)
 
 
-def buffered_cells_execute_in_order(notebook):
+def test_buffered_cells_execute_in_order(prefill_notebook):
     """Test that buffered requests execute in order."""
-    notebook.append('k=1', 'k+=1', 'k*=3', 'print(k)')
+    notebook = prefill_notebook(['', 'k=1', 'k+=1', 'k*=3', 'print(k)'])
 
     # Repeated execution of cell queued up in the kernel executes
     # each execution request in order.
@@ -49,8 +48,3 @@ def buffered_cells_execute_in_order(notebook):
 
     # Check that current value of k is 7
     assert wait_for_cell_text_output(notebook, 4) == "7"
-
-
-def test_buffering(notebook):
-    kernels_buffer_without_conn(notebook)
-    buffered_cells_execute_in_order(notebook)

notebook/tests/selenium/test_clipboard_multiselect.py

@@ -2,11 +2,8 @@
 from selenium.webdriver.common.keys import Keys
 from .utils import wait_for_selector, wait_for_xpath
 
-def test_clipboard_multiselect(notebook):
-
-    # Cell contents setup
-    values = ['1', '2', '3', '4', '5a', '6b', '7c', '8d']
-    notebook.extend(values)
+def test_clipboard_multiselect(prefill_notebook):
+    notebook = prefill_notebook(['', '1', '2', '3', '4', '5a', '6b', '7c', '8d'])
 
     assert notebook.get_cells_contents() == ['', '1', '2', '3', '4', '5a', '6b', '7c', '8d']
 

notebook/tests/selenium/test_deletecell.py

@@ -7,15 +7,12 @@ def remove_all_cells(notebook):
     for i in range(len(notebook.cells)):
         notebook.delete_cell(0)
 
-def test_delete_cells(notebook):
-    a = 'print("a")'
-    b = 'print("b")'
-    c = 'print("c")'
+INITIAL_CELLS = ['print("a")', 'print("b")', 'print("c")']
+
+def test_delete_cells(prefill_notebook):
+    a, b, c = INITIAL_CELLS
+    notebook = prefill_notebook(INITIAL_CELLS)
 
-    notebook.edit_cell(index=0, content=a)
-    notebook.append(b, c)
-    notebook.to_command_mode()
-    
     # Validate initial state
     assert notebook.get_cells_contents() == [a, b, c]
     for cell in range(0, 3):

notebook/tests/selenium/test_dualmode_clipboard.py

@@ -1,18 +1,13 @@
 """Test"""
 from .utils import shift, validate_dualmode_state
 
-def test_dualmode_clipboard(notebook):
-    a = 'print("a")'
-    notebook.append(a)
-    notebook.execute_cell(1)
+INITIAL_CELLS = ['', 'print("a")', 'print("b")', 'print("c")']
 
-    b = 'print("b")'
-    notebook.append(b)
-    notebook.execute_cell(2)
-
-    c = 'print("c")'
-    notebook.append(c)
-    notebook.execute_cell(3)
+def test_dualmode_clipboard(prefill_notebook):
+    notebook = prefill_notebook(INITIAL_CELLS)
+    _, a, b, c = INITIAL_CELLS
+    for i in range(1, 4):
+        notebook.execute_cell(i)
 
     #Copy/past/cut
     num_cells = len(notebook.cells)
@@ -56,4 +51,4 @@ def test_dualmode_clipboard(notebook):
     shift(notebook.browser, 'v') #Paste
     validate_dualmode_state(notebook, 'command', 0)
     assert notebook.get_cell_contents(0) == c #Cell 0 has the copied contents
-    assert len(notebook.cells) == num_cells+3 #A cell was added 
+    assert len(notebook.cells) == num_cells+3 #A cell was added

notebook/tests/selenium/test_dualmode_execute.py

@@ -4,19 +4,12 @@
 
 from .utils import shift, cmdtrl, alt, validate_dualmode_state
 
+INITIAL_CELLS = ['', 'print("a")', 'print("b")', 'print("c")']
 
-def test_dualmode_execute(notebook):
-    a = 'print("a")'
-    notebook.append(a)
-    notebook.execute_cell(1)
-
-    b = 'print("b")'
-    notebook.append(b)
-    notebook.execute_cell(2)
-
-    c = 'print("c")'
-    notebook.append(c)
-    notebook.execute_cell(3)
+def test_dualmode_execute(prefill_notebook):
+    notebook = prefill_notebook(INITIAL_CELLS)
+    for i in range(1, 4):
+        notebook.execute_cell(i)
 
     #shift-enter
     #last cell in notebook

notebook/tests/selenium/test_dualmode_insertcell.py

@@ -1,16 +1,10 @@
 from selenium.webdriver.common.keys import Keys
 from .utils import shift
 
-def test_insert_cell(notebook):
-    a = "print('a')"
-    b = "print('b')"
-    c = "print('c')"
+INITIAL_CELLS = ['print("a")', 'print("b")', 'print("c")']
 
-    notebook.edit_cell(index=0, content=a)
-    notebook.append(b, c)
-    notebook.to_command_mode()
-
-    assert notebook.get_cells_contents() == [a, b, c] 
+def test_insert_cell(prefill_notebook):
+    notebook = prefill_notebook(INITIAL_CELLS)
 
     notebook.to_command_mode()
     notebook.focus_cell(2)

notebook/tests/selenium/test_find_and_replace.py

@@ -1,24 +1,16 @@
-import pytest
+INITIAL_CELLS = ["hello", "hellohello", "abc", "ello"]
 
-
-def test_find_and_replace(notebook):
+def test_find_and_replace(prefill_notebook):
     """ test find and replace on all the cells """
-    cell_0, cell_1, cell_2, cell_3 = "hello", "hellohello", "abc", "ello"
-
-    find_str = "ello"                            # string to replace
-    replace_str = "foo"                          # string to replace to
+    notebook = prefill_notebook(INITIAL_CELLS)
 
-    # set the contents of the cells
-    notebook.add_cell(index=0, content=cell_0);
-    notebook.add_cell(index=1, content=cell_1);
-    notebook.add_cell(index=2, content=cell_2);
-    notebook.add_cell(index=3, content=cell_3);
+    find_str = "ello"
+    replace_str = "foo"
 
     # replace the strings
     notebook.find_and_replace(index=0, find_txt=find_str, replace_txt=replace_str)
 
     # check content of the cells
-    assert notebook.get_cell_contents(0) == cell_0.replace(find_str, replace_str)
-    assert notebook.get_cell_contents(1) == cell_1.replace(find_str, replace_str)
-    assert notebook.get_cell_contents(2) == cell_2.replace(find_str, replace_str)
-    assert notebook.get_cell_contents(3) == cell_3.replace(find_str, replace_str)
+    assert notebook.get_cells_contents() == [
+        s.replace(find_str, replace_str) for s in INITIAL_CELLS
+    ]

notebook/tests/selenium/test_markdown.py

@@ -1,3 +1,4 @@
+from nbformat.v4 import new_markdown_cell
 
 def get_rendered_contents(nb):
     cl = ["text_cell", "render"]
@@ -9,21 +10,15 @@ def get_rendered_contents(nb):
             if x is not None]
 
 
-def test_markdown_cell(notebook):
-    nb = notebook
-    cell_text = ["# Foo",
-                 '**Bar**',
-                 '*Baz*',
-                 '```\nx = 1\n```',
-                 '```aaaa\nx = 1\n```',
-                 ]
-    expected_contents = ['<h1 id="Foo">Foo<a class="anchor-link" href="#Foo">¶</a></h1>',
-                         '<p><strong>Bar</strong></p>',
-                         '<p><em>Baz</em></p>', 
-                         '<pre><code>x = 1</code></pre>',
-                         '<pre><code class="cm-s-ipython language-aaaa">x = 1</code></pre>'
-                         ]
-    nb.append(*cell_text, cell_type="markdown")
-    nb.run_all()
-    rendered_contents = get_rendered_contents(nb)
-    assert rendered_contents == expected_contents
+def test_markdown_cell(prefill_notebook):
+    nb = prefill_notebook([new_markdown_cell(md) for md in [
+        '# Foo', '**Bar**', '*Baz*', '```\nx = 1\n```', '```aaaa\nx = 1\n```',
+    ]])
+
+    assert get_rendered_contents(nb) == [
+        '<h1 id="Foo">Foo<a class="anchor-link" href="#Foo">¶</a></h1>',
+        '<p><strong>Bar</strong></p>',
+        '<p><em>Baz</em></p>',
+        '<pre><code>x = 1</code></pre>',
+        '<pre><code class="cm-s-ipython language-aaaa">x = 1</code></pre>',
+    ]

notebook/tests/selenium/test_merge_cells.py

@@ -1,15 +1,17 @@
 """Tests the merge cell api."""
 
-def test_merge_cells(notebook):
-    # Add cells to notebook
-    a = "foo = 5"
-    b = "bar = 10"
-    c = "baz = 15"
-    d = "print(foo)"
-    e = "print(bar)"
-    f = "print(baz)"
-    notebook.edit_cell(index=0, content=a)
-    notebook.append(b, c, d, e, f)
+INITIAL_CELLS = [
+    "foo = 5",
+    "bar = 10",
+    "baz = 15",
+    "print(foo)",
+    "print(bar)",
+    "print(baz)",
+]
+
+def test_merge_cells(prefill_notebook):
+    notebook = prefill_notebook(INITIAL_CELLS)
+    a, b, c, d, e, f = INITIAL_CELLS
 
     # Before merging, there are 6 separate cells
     assert notebook.get_cells_contents() == [a, b, c, d, e, f]