Merge pull request #6714 from CAM-Gerlach/fix-test-elapsed-time

PR: Make several GUI/qtbot tests more reliable by increasing timeouts and tweaking the methods used
spyder-ide · Mar 11, 2018 · 7bcab6a · 7bcab6a
2 parents 7171f76 + bc77221
commit 7bcab6a
Show file tree

Hide file tree

Showing 4 changed files with 134 additions and 74 deletions.
diff --git a/spyder/app/tests/test_mainwindow.py b/spyder/app/tests/test_mainwindow.py
@@ -7,7 +7,7 @@
 # -----------------------------------------------------------------------------
 
 """
-Tests for the main window
+Tests for the main window.
 """
 
 # Standard library imports
@@ -216,12 +216,12 @@ def test_calltip(main_window, qtbot):
 @pytest.mark.use_introspection
 def test_get_help(main_window, qtbot):
     """
-    Test that Help is working when called from the Editor and the
-    IPython console.
+    Test that Help works when called from the Editor and the IPython console.
     """
     shell = main_window.ipyconsole.get_current_shellwidget()
     control = shell._control
-    qtbot.waitUntil(lambda: shell._prompt_html is not None, timeout=SHELL_TIMEOUT)
+    qtbot.waitUntil(lambda: shell._prompt_html is not None,
+                    timeout=SHELL_TIMEOUT)
 
     help_plugin = main_window.help
     webview = help_plugin.rich_text.webview._webview
@@ -238,10 +238,10 @@ def test_get_help(main_window, qtbot):
     control.inspect_current_object()
 
     # Check that a expected text is part of the page
-    qtbot.waitUntil(lambda: check_text(webpage, "namespace"), timeout=4000)
+    qtbot.waitUntil(lambda: check_text(webpage, "namespace"), timeout=6000)
 
     # --- From the editor ---
-    qtbot.wait(2000)
+    qtbot.wait(3000)
     main_window.editor.new()
     code_editor = main_window.editor.get_focus_widget()
     editorstack = main_window.editor.get_current_editorstack()
@@ -254,7 +254,7 @@ def test_get_help(main_window, qtbot):
     editorstack.inspect_current_object()
 
     # Check that a expected text is part of the page
-    qtbot.waitUntil(lambda: check_text(webpage, "range"), timeout=4000)
+    qtbot.waitUntil(lambda: check_text(webpage, "range"), timeout=6000)
 
 
 @pytest.mark.slow

diff --git a/spyder/plugins/tests/test_ipythonconsole.py b/spyder/plugins/tests/test_ipythonconsole.py
@@ -1,16 +1,24 @@
 # -*- coding: utf-8 -*-
-#
+# -----------------------------------------------------------------------------
 # Copyright © Spyder Project Contributors
-# Licensed under the terms of the MIT License
 #
+# Licensed under the terms of the MIT License
+# (see spyder/__init__.py for details)
+# -----------------------------------------------------------------------------
+
+"""
+Tests for the IPython console plugin.
+"""
 
+# Standard library imports
 import codecs
 import os
 import os.path as osp
 import shutil
 import tempfile
 from textwrap import dedent
 
+# Third party imports
 import cloudpickle
 from flaky import flaky
 import ipykernel
@@ -20,6 +28,7 @@
 from qtpy.QtCore import Qt
 import zmq
 
+# Local imports
 from spyder.config.gui import get_color_scheme
 from spyder.config.main import CONF
 from spyder.py3compat import PY2, to_text_string
@@ -28,17 +37,17 @@
 from spyder.utils.programs import TEMPDIR
 
 
-#==============================================================================
+# =============================================================================
 # Constants
-#==============================================================================
+# =============================================================================
 SHELL_TIMEOUT = 20000
 TEMP_DIRECTORY = tempfile.gettempdir()
 NON_ASCII_DIR = osp.join(TEMP_DIRECTORY, u'測試', u'اختبار')
 
 
-#==============================================================================
+# =============================================================================
 # Utillity Functions
-#==============================================================================
+# =============================================================================
 def get_console_font_color(syntax_style):
     styles = create_style_class(syntax_style).styles
     font_color = styles[Name]
@@ -51,9 +60,9 @@ def get_console_background_color(style_sheet):
     return background_color
 
 
-#==============================================================================
+# =============================================================================
 # Qt Test Fixtures
-#==============================================================================
+# =============================================================================
 @pytest.fixture
 def ipyconsole(qtbot, request):
     """IPython console fixture."""
@@ -97,9 +106,9 @@ def close_console():
     return console
 
 
-#==============================================================================
+# =============================================================================
 # Tests
-#==============================================================================
+# =============================================================================
 @pytest.mark.slow
 @flaky(max_runs=3)
 @pytest.mark.auto_backend
@@ -824,25 +833,25 @@ def test_sys_argv_clear(ipyconsole, qtbot):
 @pytest.mark.slow
 @flaky(max_runs=3)
 def test_set_elapsed_time(ipyconsole, qtbot):
-    """Test timer."""
+    """Test that the IPython console elapsed timer is set correctly."""
     shell = ipyconsole.get_current_shellwidget()
     client = ipyconsole.get_current_client()
     qtbot.waitUntil(lambda: shell._prompt_html is not None,
                     timeout=SHELL_TIMEOUT)
 
     # Set time to 2 minutes ago.
     client.t0 -= 120
-    with qtbot.waitSignal(client.timer.timeout, timeout=3000):
+    with qtbot.waitSignal(client.timer.timeout, timeout=5000):
         ipyconsole.set_elapsed_time(client)
     assert '00:02:00' in client.time_label.text()
 
-    with qtbot.waitSignal(client.timer.timeout, timeout=3000):
+    with qtbot.waitSignal(client.timer.timeout, timeout=5000):
         pass
     assert '00:02:01' in client.time_label.text()
 
     # Make previous time later than current time.
     client.t0 += 2000
-    with qtbot.waitSignal(client.timer.timeout, timeout=3000):
+    with qtbot.waitSignal(client.timer.timeout, timeout=5000):
         pass
     assert '00:00:00' in client.time_label.text()
 

diff --git a/spyder/widgets/variableexplorer/tests/test_arrayeditor.py b/spyder/widgets/variableexplorer/tests/test_arrayeditor.py
@@ -1,10 +1,13 @@
 # -*- coding: utf-8 -*-
-#
+# -----------------------------------------------------------------------------
 # Copyright © Spyder Project Contributors
+#
 # Licensed under the terms of the MIT License
+# (see spyder/__init__.py for details)
+# -----------------------------------------------------------------------------
 
 """
-Tests for arrayeditor.py
+Tests for the array editor.
 """
 
 # Standard library imports
@@ -26,28 +29,35 @@
 from spyder.widgets.variableexplorer.arrayeditor import ArrayEditor, ArrayModel
 
 
+# =============================================================================
+# Utility functions
+# =============================================================================
 def launch_arrayeditor(data, title="", xlabels=None, ylabels=None):
-    """Helper routine to launch an arrayeditor and return its result"""
+    """Helper routine to launch an arrayeditor and return its result."""
     dlg = ArrayEditor()
     assert dlg.setup_and_check(data, title, xlabels=xlabels, ylabels=ylabels)
     dlg.show()
     dlg.accept()  # trigger slot connected to OK button
     return dlg.get_value()
 
+
 def setup_arrayeditor(qbot, data, title="", xlabels=None, ylabels=None):
     """Setups an arrayeditor."""
     dlg = ArrayEditor()
-    dlg.setup_and_check(data, title, xlabels=xlabels, ylabels=ylabels)    
+    dlg.setup_and_check(data, title, xlabels=xlabels, ylabels=ylabels)
     dlg.show()
     qbot.addWidget(dlg)
     return dlg
 
-# --- Tests
-# -----------------------------------------------------------------------------
+
+# =============================================================================
+# Tests
+# =============================================================================
 def test_type_errors(qtbot):
-    """Verify that we don't get a TypeError for certain structured arrays.
+    """
+    Verify that we don't get a TypeError for certain structured arrays.
 
-    Fixes issue 5254.
+    Fixes issue #5254.
     """
     arr = np.ones(2, dtype=[('X', 'f8', (2,10)), ('S', 'S10')])
     dlg = setup_arrayeditor(qtbot, arr)
@@ -186,7 +196,11 @@ def test_arrayeditor_edit_2d_array(qtbot):
 
 
 def test_arraymodel_set_data_overflow(monkeypatch):
-    """Unit test #6114: entry of an overflow int caught and handled properly"""
+    """
+    Test that entry of an overflowing integer is caught and handled properly.
+
+    Unit regression test for #6114 .
+    """
     MockQMessageBox = Mock()
     attr_to_patch = 'spyder.widgets.variableexplorer.arrayeditor.QMessageBox'
     monkeypatch.setattr(attr_to_patch, MockQMessageBox)
@@ -210,7 +224,11 @@ def test_arraymodel_set_data_overflow(monkeypatch):
 
 @flaky(max_runs=3)
 def test_arrayeditor_edit_overflow(qtbot, monkeypatch):
-    """Int. test #6114: entry of an overflow int caught and handled properly"""
+    """
+    Test that entry of an overflowing integer is caught and handled properly.
+
+    Integration regression test for #6114 .
+    """
     MockQMessageBox = Mock()
     attr_to_patch = 'spyder.widgets.variableexplorer.arrayeditor.QMessageBox'
     monkeypatch.setattr(attr_to_patch, MockQMessageBox)
@@ -232,20 +250,22 @@ def test_arrayeditor_edit_overflow(qtbot, monkeypatch):
         qtbot.waitForWindowShown(dialog)
         view = dialog.arraywidget.view
 
-        qtbot.keyPress(view, Qt.Key_Down)
-        qtbot.keyPress(view, Qt.Key_Up)
+        qtbot.keyClick(view, Qt.Key_Down)
+        qtbot.keyClick(view, Qt.Key_Up)
         qtbot.keyClicks(view, '5')
-        qtbot.keyPress(view, Qt.Key_Down)
-        qtbot.keyPress(view, Qt.Key_Space)
+        qtbot.keyClick(view, Qt.Key_Down)
+        qtbot.keyClick(view, Qt.Key_Space)
         qtbot.keyClicks(view.focusWidget(), str(int(2 ** bit_exponent)))
-        qtbot.keyPress(view.focusWidget(), Qt.Key_Down)
+        qtbot.keyClick(view.focusWidget(), Qt.Key_Down)
         MockQMessageBox.critical.assert_called_with(ANY, "Error", ANY)
         assert MockQMessageBox.critical.call_count == idx
         qtbot.keyClicks(view, '7')
-        qtbot.keyPress(view, Qt.Key_Up)
+        qtbot.keyClick(view, Qt.Key_Up)
         qtbot.keyClicks(view, '6')
-        qtbot.keyPress(view, Qt.Key_Down)
-        qtbot.keyPress(view, Qt.Key_Return)
+        qtbot.keyClick(view, Qt.Key_Down)
+        qtbot.wait(200)
+        dialog.accept()
+        qtbot.wait(500)
         assert np.sum(expected_array ==
                       dialog.get_value()) == len(expected_array)