Merge pull request #4445 from emiliotl/convert_shutdown_js_to_py_selenium

Converted shutdown.js test to selenium python test

Author: takluyver

notebook/tests/notebook/shutdown.js

@@ -0,0 +1,15 @@
+"""Tests shutdown of the Kernel."""
+from .utils import wait_for_selector, wait_for_xpath
+
+def test_shutdown(notebook):
+    notebook.edit_cell(content="print(21)")
+    wait_for_xpath(notebook.browser, '//a[text()="Kernel"]', single=True).click()
+    wait_for_selector(notebook.browser, '#shutdown_kernel', single=True).click()
+    wait_for_selector(notebook.browser, '.btn.btn-default.btn-sm.btn-danger', single=True).click()
+
+    #Wait until all shutdown modal elements dissapear before trying to execute the cell
+    wait_for_xpath(notebook.browser, "//div[contains(@class,'modal')]", obscures=True)
+    notebook.execute_cell(0)
+
+    assert not notebook.is_kernel_running()
+    assert len(notebook.get_cell_output()) == 0

notebook/tests/selenium/test_shutdown.py

@@ -13,21 +13,28 @@
 pjoin = os.path.join
 
 
-def wait_for_selector(driver, selector, timeout=10, visible=False, single=False, wait_for_n=1):
+def wait_for_selector(driver, selector, timeout=10, visible=False, single=False, wait_for_n=1, obscures=False):
     if wait_for_n > 1:
         return _wait_for_multiple(
             driver, By.CSS_SELECTOR, selector, timeout, wait_for_n, visible)
-    return _wait_for(driver, By.CSS_SELECTOR, selector, timeout, visible, single)
+    return _wait_for(driver, By.CSS_SELECTOR, selector, timeout, visible, single, obscures)
 
 
-def wait_for_tag(driver, tag, timeout=10, visible=False, single=False, wait_for_n=1):
+def wait_for_tag(driver, tag, timeout=10, visible=False, single=False, wait_for_n=1, obscures=False):
     if wait_for_n > 1:
         return _wait_for_multiple(
             driver, By.TAG_NAME, tag, timeout, wait_for_n, visible)
-    return _wait_for(driver, By.TAG_NAME, tag, timeout, visible, single)
+    return _wait_for(driver, By.TAG_NAME, tag, timeout, visible, single, obscures)
 
 
-def _wait_for(driver, locator_type, locator, timeout=10, visible=False, single=False):
+def wait_for_xpath(driver, xpath, timeout=10, visible=False, single=False, wait_for_n=1, obscures=False):
+    if wait_for_n > 1:
+        return _wait_for_multiple(
+            driver, By.XPATH, xpath, timeout, wait_for_n, visible)
+    return _wait_for(driver, By.XPATH, xpath, timeout, visible, single, obscures)
+
+
+def _wait_for(driver, locator_type, locator, timeout=10, visible=False, single=False, obscures=False):
     """Waits `timeout` seconds for the specified condition to be met. Condition is
     met if any matching element is found. Returns located element(s) when found.
 
@@ -39,9 +46,12 @@ def _wait_for(driver, locator_type, locator, timeout=10, visible=False, single=F
         visible: if True, require that element is not only present, but visible
         single: if True, return a single element, otherwise return a list of matching
         elements
+        osbscures: if True, waits until the element becomes invisible
     """
     wait = WebDriverWait(driver, timeout)
-    if single:
+    if obscures:
+        conditional = EC.invisibility_of_element_located
+    elif single:
         if visible:
             conditional = EC.visibility_of_element_located
         else:
@@ -195,13 +205,19 @@ def wait_for_stale_cell(self, cell):
         wait = WebDriverWait(self.browser, 10)
         element = wait.until(EC.staleness_of(cell))
 
+    def wait_for_element_availability(self, element):
+        _wait_for(self.browser, By.CLASS_NAME, element, visible=True)
+
     def get_cells_contents(self):
         JS = 'return Jupyter.notebook.get_cells().map(function(c) {return c.get_text();})'
         return self.browser.execute_script(JS)
 
     def get_cell_contents(self, index=0, selector='div .CodeMirror-code'):
         return self.cells[index].find_element_by_css_selector(selector).text
 
+    def get_cell_output(self, index=0, output='output_subarea'):
+        return self.cells[index].find_elements_by_class_name(output)
+
     def set_cell_metadata(self, index, key, value):
         JS = 'Jupyter.notebook.get_cell({}).metadata.{} = {}'.format(index, key, value)
         return self.browser.execute_script(JS)
@@ -282,6 +298,9 @@ def run_all(self):
 
     def trigger_keydown(self, keys):
         trigger_keystrokes(self.body, keys)
+    
+    def is_kernel_running(self):
+        return self.browser.execute_script("return Jupyter.notebook.kernel.is_connected()")
 
     @classmethod
     def new_notebook(cls, browser, kernel_name='kernel-python3'):