Introduce toolkit-agnostic API for GUI testing

traitsui/qt4/enum_editor.py

@@ -30,6 +30,8 @@
 from .constants import OKColor, ErrorColor
 from .editor import Editor
 
+from traitsui.testing.api import BaseSimulator, Disabled, simulate
+from traitsui.testing.simulation import DEFAULT_REGISTRY
 
 # default formatting function (would import from string, but not in Python 3)
 capitalize = lambda s: s.capitalize()
@@ -299,6 +301,29 @@ def update_autoset_text_object(self):
             return self.update_text_object(text)
 
 
+@simulate(SimpleEditor, registry=DEFAULT_REGISTRY)
+class SimpleEnumEditorSimulator(BaseSimulator):
+    """ A simulator for testing GUI components with the simple EnumEditor.
+
+    See ``traitsui.testing.api``.
+    """
+
+    def click_index(self, index):
+        self.editor.control.setCurrentIndex(index)
+
+    def set_text(self, text, confirmed=True):
+        if not self.editor.control.isEditable():
+            raise Disabled("This combox box is not editable by text.")
+
+        self.editor.control.setEditText(text)
+        line_edit = self.editor.control.lineEdit()
+        if line_edit is not None and confirmed:
+            line_edit.editingFinished.emit()
+
+    def get_text(self):
+        return self.editor.control.currentText()
+
+
 class RadioEditor(BaseEditor):
     """ Enumeration editor, used for the "custom" style, that displays radio
         buttons.

traitsui/qt4/instance_editor.py

@@ -14,6 +14,7 @@
     the PyQt user interface toolkit..
 """
 
+import contextlib
 
 from pyface.qt import QtCore, QtGui
 
@@ -32,6 +33,9 @@
 from .constants import DropColor
 from .helper import position_window
 
+from traitsui.testing.api import BaseSimulator, simulate
+from traitsui.testing.simulation import DEFAULT_REGISTRY
+
 
 OrientationMap = {
     "default": None,
@@ -396,6 +400,17 @@ def _view_changed(self, view):
         self.resynch_editor()
 
 
+@simulate(CustomEditor, registry=DEFAULT_REGISTRY)
+class CustomInstanceEditorSimulator(BaseSimulator):
+    """ A simulator for custom instance editor: it delegates commands and
+    queries to the internal UI panel.
+    """
+
+    @contextlib.contextmanager
+    def get_ui(self):
+        yield self.editor._ui
+
+
 class SimpleEditor(CustomEditor):
     """ Simple style of editor for instances, which displays a button. Clicking
     the button displays a dialog box in which the instance can be edited.
@@ -463,3 +478,18 @@ def _parent_closed(self):
                 self._dialog_ui.control.close()
             self._dialog_ui.dispose()
             self._dialog_ui = None
+
+
+@simulate(SimpleEditor, registry=DEFAULT_REGISTRY)
+class SimpleInstanceEditorSimulator(BaseSimulator):
+    """ A simulator for simple instance editor. It launches the dialog and
+    delegates commands and queries to the dialog UI.
+    """
+
+    @contextlib.contextmanager
+    def get_ui(self):
+        self.editor._button.click()
+        try:
+            yield self.editor._dialog_ui
+        finally:
+            self.editor._dialog_ui.dispose()

traitsui/qt4/text_editor.py

@@ -29,6 +29,8 @@
 
 from .constants import OKColor
 
+from traitsui.testing.api import BaseSimulator, Disabled, simulate
+from traitsui.testing.simulation import DEFAULT_REGISTRY
 
 
 class SimpleEditor(Editor):
@@ -182,6 +184,29 @@ class CustomEditor(SimpleEditor):
     base_style = QtGui.QTextEdit
 
 
+@simulate(CustomEditor, registry=DEFAULT_REGISTRY)
+@simulate(SimpleEditor, registry=DEFAULT_REGISTRY)
+class TextEditorSimulator(BaseSimulator):
+    """ A simulator for testing GUI components with the simple and custom
+    styled TextEditor.
+
+    See ``traitsui.testing.api``.
+    """
+
+    def set_text(self, text, confirmed=True):
+        if not self.editor.control.isEnabled():
+            raise Disabled("Text field is disabled.")
+
+        self.editor.control.setText(text)
+
+        factory = self.editor.factory
+        if factory.auto_set and not factory.is_grid_cell and confirmed:
+            self.editor.control.textEdited.emit(text)
+
+    def get_text(self):
+        return self.editor.control.text()
+
+
 class ReadonlyEditor(BaseReadonlyEditor):
     """ Read-only style of text editor, which displays a read-only text field.
     """

traitsui/testing/api.py

@@ -0,0 +1,8 @@
+from traitsui.testing.ui_tester import UITester   # noqa: F401
+from traitsui.testing.exceptions import Disabled  # noqa: F401
+from traitsui.testing.simulation import (
+    BaseSimulator,
+    DEFAULT_REGISTRY,
+    simulate,
+    SimulatorRegistry,
+)

traitsui/testing/exceptions.py

@@ -0,0 +1,10 @@
+
+class SimulationError(Exception):
+    """ Raised when simulating user interactions on GUI."""
+    pass
+
+
+class Disabled(SimulationError):
+    """ Raised when a simulation fails because the widget is disabled.
+    """
+    pass