CI Test Fixes Round 2

nbclassic/tests/end_to_end/test_save_readonly_as.py

@@ -1,61 +1,116 @@
 """Test readonly notebook saved and renamed"""
 
 
-from .utils import EDITOR_PAGE
+import traceback
+
+from .utils import EDITOR_PAGE, TimeoutError as TestingTimeout
 from playwright.sync_api import sync_playwright, TimeoutError as PlaywrightTimeoutError
 
 
 def save_as(nb):
     JS = '() => Jupyter.notebook.save_notebook_as()'
     return nb.evaluate(JS, page=EDITOR_PAGE)
 
+
 def get_notebook_name(nb):
     JS = '() => Jupyter.notebook.notebook_name'
     return nb.evaluate(JS, page=EDITOR_PAGE)
 
+
 def set_notebook_name(nb, name):
     JS = f'() => Jupyter.notebook.rename("{name}")'
     nb.evaluate(JS, page=EDITOR_PAGE)
 
 
 def test_save_readonly_as(notebook_frontend):
+    print('[Test] [test_save_readonly_as]')
     notebook_frontend.edit_cell(index=0, content='a=10; print(a)')
     notebook_frontend.wait_for_kernel_ready()
     notebook_frontend.wait_for_selector(".input", page=EDITOR_PAGE)
 
     # Set a name for comparison later
+    print('[Test] Set notebook name')
     set_notebook_name(notebook_frontend, name="nb1.ipynb")
     assert get_notebook_name(notebook_frontend) == "nb1.ipynb"
 
     # Wait for Save As modal, save
+    print('[Test] Save')
     save_as(notebook_frontend)
 
-    # Wait for modal to pop up
-    notebook_frontend.wait_for_selector('//input[@data-testid="save-as"]', page=EDITOR_PAGE)
-
-    # TODO: Add a function for locator assertions to FrontendElement
-    locator_element = notebook_frontend.locate_and_focus('//input[@data-testid="save-as"]', page=EDITOR_PAGE)
-    locator_element.wait_for('visible')
-
-    modal_footer = notebook_frontend.locate('.modal-footer', page=EDITOR_PAGE)
-    modal_footer.wait_for('visible')
-
-    notebook_frontend.insert_text('new_notebook.ipynb', page=EDITOR_PAGE)
-
-    save_btn = modal_footer.locate('text=Save')
-    save_btn.wait_for('visible')
-    save_btn.click()
-    # notebook_frontend.try_click_selector('//html//body//div[8]//div//div//div[3]//button[2]', page=EDITOR_PAGE)
-
-    # locator_element.expect_not_to_be_visible()
-    notebook_frontend.wait_for_condition(
-        lambda: get_notebook_name(notebook_frontend) == "new_notebook.ipynb", timeout=120, period=5
-    )
-
-    # notebook_frontend.locate('#notebook_name', page=EDITOR_PAGE)
-
-    # # Test that the name changed
-    # assert get_notebook_name(notebook_frontend) == "new_notebook.ipynb"
+    # # Wait for modal to pop up
+    print('[Test] Waiting for modal popup')
+    notebook_frontend.wait_for_selector(".modal-footer", page=EDITOR_PAGE)
+    dialog_element = notebook_frontend.locate(".modal-footer", page=EDITOR_PAGE)
+    dialog_element.focus()
+
+    print('[Test] Focus the notebook name input field, then click and modify its .value')
+    notebook_frontend.wait_for_selector('.modal-body .form-control', page=EDITOR_PAGE)
+    name_input_element = notebook_frontend.locate('.modal-body .form-control', page=EDITOR_PAGE)
+    name_input_element.focus()
+    name_input_element.click()
+
+    # Begin attempts to fill the save dialog input and save the notebook
+    fill_attempts = 0
+
+    def attempt_form_fill_and_save():
+        # Application behavior here is HIGHLY variable, we use this for repeated attempts
+        # ....................
+        # This may be a retry, check if the application state reflects a successful save operation
+        nonlocal fill_attempts
+        if fill_attempts and get_notebook_name(notebook_frontend) == "new_notebook.ipynb":
+            print('[Test]   Success from previous save attempt!')
+            return True
+        fill_attempts += 1
+        print(f'[Test] Attempt form fill and save #{fill_attempts}')
+
+        # Make sure the save prompt is visible
+        if not name_input_element.is_visible():
+            save_as(notebook_frontend)
+            name_input_element.wait_for('visible')
+
+        # Set the notebook name field in the save dialog
+        print('[Test] Fill the input field')
+        name_input_element.evaluate(f'(elem) => {{ elem.value = "new_notebook.ipynb"; return elem.value; }}')
+        notebook_frontend.wait_for_condition(
+            lambda: name_input_element.evaluate(
+                f'(elem) => {{ elem.value = "new_notebook.ipynb"; return elem.value; }}') == 'new_notebook.ipynb',
+            timeout=120,
+            period=.25
+        )
+        # Show the input field value
+        print('[Test] Name input field contents:')
+        field_value = name_input_element.evaluate(f'(elem) => {{ return elem.value; }}')
+        print('[Test]   ' + field_value)
+        if field_value != 'new_notebook.ipynb':
+            return False
+
+        print('[Test] Locate and click the save button')
+        save_element = dialog_element.locate('text=Save')
+        save_element.wait_for('visible')
+        save_element.focus()
+        save_element.click()
+
+        # Application lag may cause the save dialog to linger,
+        # if it's visible wait for it to disappear before proceeding
+        if save_element.is_visible():
+            print('[Test] Save element still visible after save, wait for hidden')
+            try:
+                save_element.expect_not_to_be_visible(timeout=120)
+            except PlaywrightTimeoutError as err:
+                traceback.print_exc()
+                print('[Test]   Save button failed to hide...')
+
+        # Check if the save operation succeeded (by checking notebook name change)
+        notebook_frontend.wait_for_condition(
+            lambda: get_notebook_name(notebook_frontend) == "new_notebook.ipynb", timeout=120, period=5
+        )
+        print(f'[Test] Notebook name: {get_notebook_name(notebook_frontend)}')
+        print('[Test] Notebook name was changed!')
+        return True
+
+    # Retry until timeout (wait_for_condition retries upon func exception)
+    notebook_frontend.wait_for_condition(attempt_form_fill_and_save, timeout=900, period=1)
 
     # Test that address bar was updated
+    print('[Test] Test address bar')
     assert "new_notebook.ipynb" in notebook_frontend.get_page_url(page=EDITOR_PAGE)

nbclassic/tests/end_to_end/utils.py

@@ -173,9 +173,10 @@ def get_user_data(self):
         """Currently this is an unmanaged user data area, use it as you please"""
         return self._user_data
 
-    def expect_not_to_be_visible(self):
+    def expect_not_to_be_visible(self, timeout=30):
+        seconds_to_milliseconds = 1000
         try:
-            expect(self._element).not_to_be_visible()
+            expect(self._element).not_to_be_visible(timeout=timeout * seconds_to_milliseconds)
         except ValueError as err:
             raise Exception('Cannot expect not_to_be_visible on this type!') from err