More waiting improvements

Author: runestonetest

runestone/activecode/test/test_activecode.py

@@ -19,9 +19,8 @@ def test_hello(self):
         :return:
         """
         self.driver.get(self.host + "/index.html")
-        wait = WebDriverWait(self.driver, 10)
         try:
-            wait.until(EC.presence_of_element_located((By.ID, "test1")))
+            self.wait.until(EC.presence_of_element_located((By.ID, "test1")))
         except:
             text = self.driver.page_source
             print(text[:300])
@@ -30,10 +29,9 @@ def test_hello(self):
         rb = t1.find_element_by_class_name("run-button")
         self.assertIsNotNone(rb)
         rb.click()
-        time.sleep(0.5)
-        wait = WebDriverWait(self.driver, 10)
-        wait.until(
-            EC.text_to_be_present_in_element((By.ID, "test1_stdout"), "Hello")
+        self.wait.until(
+            EC.text_to_be_present_in_element((By.ID, "test1_stdout"), "Hello World"),
+            message="Did not find expected text",
         )
         output = t1.find_element_by_class_name("ac_output")
         self.assertEqual(output.text.strip(), "Hello World")
@@ -47,9 +45,8 @@ def test_hidden(self):
         :return:
         """
         self.driver.get(self.host + "/index.html")
-        wait = WebDriverWait(self.driver, 10)
         try:
-            wait.until(EC.presence_of_element_located((By.ID, "testprefixcode")))
+            self.wait.until(EC.presence_of_element_located((By.ID, "testprefixcode")))
         except:
             text = self.driver.page_source
             print(text[:300])
@@ -58,11 +55,12 @@ def test_hidden(self):
         rb = t1.find_element_by_class_name("run-button")
         self.assertIsNotNone(rb)
         rb.click()
-        wait.until(
-            EC.text_to_be_present_in_element((By.ID, "testprefixcode_stdout"), "My")
+        self.wait.until(
+            EC.text_to_be_present_in_element(
+                (By.ID, "testprefixcode_stdout"), "My Code"
+            )
         )
         output = t1.find_element_by_class_name("ac_output")
-        self.assertIn("My Code", output.text.strip())
         self.assertIn("hidden code", output.text.strip())
         self.assertIn("i\nx", output.text.strip())
 
@@ -98,9 +96,7 @@ def test_history(self):
         self.driver.execute_script(
             """window.edList['test1'].editor.setValue("print('GoodBye')")"""
         )
-        WebDriverWait(self.driver, 10).until(
-            EC.element_to_be_clickable((By.CLASS_NAME, "run-button"))
-        )
+        self.wait.until(EC.element_to_be_clickable((By.CLASS_NAME, "run-button")))
         try:
             rb.click()
         except ElementClickInterceptedException:
@@ -179,10 +175,7 @@ def test_sql_activecode(self):
         rb = t2.find_element_by_class_name("run-button")
         self.assertIsNotNone(rb)
         rb.click()
-        wait = WebDriverWait(self.driver, 10)
-        wait.until(
-            EC.text_to_be_present_in_element((By.ID, "sql1_stdout"), "You")
-        )
+        self.wait.until(EC.text_to_be_present_in_element((By.ID, "sql1_stdout"), "You"))
         res = self.driver.find_element_by_id("sql1_sql_out")
         self.assertIsNotNone(res)
         out = self.driver.find_element_by_id("sql1_stdout")
@@ -204,8 +197,7 @@ def test_readfiles(self):
         rb = t2.find_element_by_class_name("run-button")
         self.assertIsNotNone(rb)
         rb.click()
-        wait = WebDriverWait(self.driver, 10)
-        wait.until(
+        self.wait.until(
             EC.text_to_be_present_in_element((By.ID, "ac9_13_1_stdout"), "Lind")
         )
         out = t2.find_element_by_id("ac9_13_1_stdout")
@@ -221,11 +213,11 @@ def test_altair(self):
         rb.click()
         out = t2.find_element_by_id("alt_kiva_bar1_stdout")
         self.assertIsNotNone(out)
-        wait = WebDriverWait(self.driver, 10)
-        wait.until(
-            EC.text_to_be_present_in_element((By.ID, "alt_kiva_bar1_stdout"), "mark")
+        self.wait.until(
+            EC.text_to_be_present_in_element(
+                (By.ID, "alt_kiva_bar1_stdout"), "mark = bar"
+            )
         )
-        self.assertIn("mark = bar", out.text)
         self.assertIn("{'field': 'customer', 'type': 'nominal'}", out.text)
         can = t2.find_element_by_tag_name("canvas")
         self.assertIsNotNone(can)
@@ -237,13 +229,11 @@ def test_image(self):
         rb = t2.find_element_by_class_name("run-button")
         self.assertIsNotNone(rb)
         rb.click()
-        wait = WebDriverWait(self.driver, 10)
-        wait.until(
+        self.wait.until(
             EC.text_to_be_present_in_element((By.ID, "ac14_7_2_stdout"), "400")
         )
         out = t2.find_element_by_id("ac14_7_2_stdout")
         self.assertIsNotNone(out)
-        self.assertTrue("400" in out.text)
         self.assertTrue("244" in out.text)
         self.assertTrue(("165 161 158" in out.text) or ("165 162 157" in out.text))
         can = t2.find_element_by_tag_name("canvas")

runestone/unittest_base.py

@@ -24,6 +24,7 @@
 # -------------------
 from selenium import webdriver
 from selenium.webdriver.chrome.options import Options
+from selenium.webdriver.support.ui import WebDriverWait
 import pytest
 from pyvirtualdisplay import Display
 
@@ -70,14 +71,15 @@ def setUpModule(self):
         # Change to this directory for running Runestone.
         self.old_cwd = os.getcwd()
         os.chdir(self.base_path)
-        # use call so that npm run build completes before we move on to runestone build
+        # use `run` so that `npm run build` completes before we move on to `runestone build`
         # otherwise the runestone build may fail due to lack of a runestone.js file!
-        p = subprocess.call(
+        p = subprocess.run(
             ["npm.cmd" if IS_WINDOWS else "npm", "run", "build"],
             stdout=subprocess.PIPE,
             stderr=subprocess.PIPE,
             universal_newlines=True,
         )
+        self.assertFalse(p.returncode)
         # Compile the docs. Save the stdout and stderr for examination.
         p = subprocess.Popen(
             ["runestone", "build", "--all"],
@@ -230,6 +232,9 @@ def setUp(self):
         self.host = HOST_URL
         # Add an `implicit wait <https://selenium-python.readthedocs.io/waits.html#implicit-waits>`_.
         self.driver.implicitly_wait(5)
+        # For cases where an implicit wait does not help.  For example waiting for text to appear
+        # after running an activecode.  We create an explicit wait object.
+        self.wait = WebDriverWait(self.driver, 5)
 
     def tearDown(self):
         # Clear as much as possible, to present an almost-fresh instance of a browser for the next test. (Shutting down then starting up a browswer is very slow.)