Ui tester api updates4 - Implement locating textbox in RangeEditor and performing KeySequence

traitsui/qt4/range_editor.py

@@ -177,7 +177,8 @@ def update_object_on_scroll(self, pos):
     def update_object_on_enter(self):
         """ Handles the user pressing the Enter key in the text field.
         """
-        # it is possible we get the event after the control has gone away
+        # It is possible the event is processed after the control is removed
+        # from the editor
         if self.control is None:
             return
 
@@ -449,6 +450,10 @@ def update_object_on_scroll(self, pos):
     def update_object_on_enter(self):
         """ Handles the user pressing the Enter key in the text field.
         """
+        # It is possible the event is processed after the control is removed
+        # from the editor
+        if self.control is None:
+            return
         try:
             self.value = eval(str(self.control.text.text()).strip())
         except TraitError as excp:

traitsui/testing/tester/locator.py

@@ -17,6 +17,8 @@
 applied.
 """
 
+import enum
+
 
 class NestedUI:
     """ A locator for locating a nested ``traitsui.ui.UI`` object assuming
@@ -35,3 +37,15 @@ class TargetByName:
     """
     def __init__(self, name):
         self.name = name
+
+
+class WidgetType(enum.Enum):
+    """ A locator for locating nested widgets within a UI. Many editors will
+    contain many sub-widgets (e.g. a textbox, slider, tabs, buttons, etc.).
+
+    For example when working with a range editor, one could call
+    ``tester.find_by_name(ui, "ranged_number").locate(locator.WidgetType.textbox)``
+    """
+
+    # A textbox within a UI
+    textbox = "textbox"

traitsui/testing/tester/qt4/common_ui_targets.py

@@ -0,0 +1,65 @@
+#  Copyright (c) 2005-2020, Enthought, Inc.
+#  All rights reserved.
+#
+#  This software is provided without warranty under the terms of the BSD
+#  license included in LICENSE.txt and may be redistributed only
+#  under the conditions described in the aforementioned license.  The license
+#  is also available online at http://www.enthought.com/licenses/BSD.txt
+#
+#  Thanks for using Enthought open source!
+#
+
+""" This module contains targets for UIWrapper so that the logic related to
+them can be reused. All handlers and solvers for these objects are
+registered to the default registry via the register class methods. To use the
+logic in these objects, one simply needs to register a solver with their
+target_class of choice to one of these as the locator_class. For an example,
+see the implementation of range_editor.
+"""
+
+from traitsui.testing.tester import command, query
+from traitsui.testing.tester.qt4 import helpers
+
+
+class LocatedTextbox:
+    """ Wrapper class for a located Textbox in Qt.
+
+    Parameters
+    ----------
+    textbox : Instance of QtGui.QLineEdit
+    """
+
+    def __init__(self, textbox):
+        self.textbox = textbox
+
+    @classmethod
+    def register(cls, registry):
+        """ Class method to register interactions on a LocatedTextbox for the
+        given registry.
+
+        If there are any conflicts, an error will occur.
+
+        Parameters
+        ----------
+        registry : TargetRegistry
+            The registry being registered to.
+        """
+        handlers = [
+            (command.KeySequence,
+                (lambda wrapper, interaction: helpers.key_sequence_qwidget(
+                    wrapper.target.textbox, interaction, wrapper.delay))),
+            (command.KeyClick,
+                (lambda wrapper, interaction: helpers.key_click_qwidget(
+                    wrapper.target.textbox, interaction, wrapper.delay))),
+            (command.MouseClick,
+                (lambda wrapper, _: helpers.mouse_click_qwidget(
+                    wrapper.target.textbox, wrapper.delay))),
+            (query.DisplayedText,
+                lambda wrapper, _: wrapper.target.textbox.displayText()),
+        ]
+        for interaction_class, handler in handlers:
+            registry.register_handler(
+                target_class=cls,
+                interaction_class=interaction_class,
+                handler=handler,
+            )

traitsui/testing/tester/qt4/default_registry.py

@@ -10,8 +10,10 @@
 #
 
 from traitsui.testing.tester.registry import TargetRegistry
+from traitsui.testing.tester.qt4 import common_ui_targets
 from traitsui.testing.tester.qt4.implementation import (
     button_editor,
+    range_editor,
     text_editor,
 )
 
@@ -27,10 +29,15 @@ def get_default_registry():
     """
     registry = TargetRegistry()
 
+    common_ui_targets.LocatedTextbox.register(registry)
+
     # ButtonEditor
     button_editor.register(registry)
 
     # TextEditor
     text_editor.register(registry)
 
+    # RangeEditor
+    range_editor.register(registry)
+
     return registry

traitsui/testing/tester/qt4/implementation/range_editor.py

@@ -0,0 +1,96 @@
+#  Copyright (c) 2005-2020, Enthought, Inc.
+#  All rights reserved.
+#
+#  This software is provided without warranty under the terms of the BSD
+#  license included in LICENSE.txt and may be redistributed only
+#  under the conditions described in the aforementioned license.  The license
+#  is also available online at http://www.enthought.com/licenses/BSD.txt
+#
+#  Thanks for using Enthought open source!
+#
+
+from traitsui.qt4.range_editor import (
+    LargeRangeSliderEditor,
+    LogRangeSliderEditor,
+    RangeTextEditor,
+    SimpleSliderEditor,
+)
+
+from traitsui.testing.tester import locator
+from traitsui.testing.tester.qt4.common_ui_targets import LocatedTextbox
+
+
+def resolve_location_slider(wrapper, location):
+    """ Solver from a UIWrapper wrapped Range Editor to a LocatedTextbox
+    containing the textbox of interest
+
+    If there are any conflicts, an error will occur.
+
+    Parameters
+    ----------
+    wrapper : UIWrapper
+        Wrapper containing the Range Editor target.
+    location : locator.WidgetType
+        The location we are looking to resolve.
+    """
+    if location == locator.WidgetType.textbox:
+        return LocatedTextbox(textbox=wrapper.target.control.text)
+    if location in [locator.WidgetType.slider]:
+        raise NotImplementedError(
+            f"Logic for interacting with the {location}"
+            " has not been implemented."
+        )
+    raise ValueError(
+        f"Unable to resolve {location} on {wrapper.target}."
+        " Currently supported: {locator.WidgetType.textbox}"
+    )
+
+
+def resolve_location_range_text(wrapper, location):
+    """ Solver from a UIWrapper wrapped RangeTextEditor to a LocatedTextbox
+    containing the textbox of interest
+
+    If there are any conflicts, an error will occur.
+
+    Parameters
+    ----------
+    wrapper : UIWrapper
+        Wrapper containing the RangeTextEditor target.
+    location : locator.WidgetType
+        The location we are looking to resolve.
+    """
+
+    if location == locator.WidgetType.textbox:
+        return LocatedTextbox(textbox=wrapper.target.control)
+    raise ValueError(
+        f"Unable to resolve {location} on {wrapper.target}."
+        " Currently supported: {locator.WidgetType.textbox}"
+    )
+
+
+def register(registry):
+    """ Register interactions for the given registry.
+
+    If there are any conflicts, an error will occur.
+
+    Parameters
+    ----------
+    registry : TargetRegistry
+        The registry being registered to.
+    """
+
+    targets = [SimpleSliderEditor,
+               LogRangeSliderEditor,
+               LargeRangeSliderEditor]
+    for target_class in targets:
+        registry.register_solver(
+            target_class=target_class,
+            locator_class=locator.WidgetType,
+            solver=resolve_location_slider,
+        )
+
+    registry.register_solver(
+        target_class=RangeTextEditor,
+        locator_class=locator.WidgetType,
+        solver=resolve_location_range_text,
+    )

traitsui/testing/tester/wx/common_ui_targets.py

@@ -0,0 +1,65 @@
+#  Copyright (c) 2005-2020, Enthought, Inc.
+#  All rights reserved.
+#
+#  This software is provided without warranty under the terms of the BSD
+#  license included in LICENSE.txt and may be redistributed only
+#  under the conditions described in the aforementioned license.  The license
+#  is also available online at http://www.enthought.com/licenses/BSD.txt
+#
+#  Thanks for using Enthought open source!
+#
+
+""" This module contains targets for UIWrapper so that the logic related to
+them can be reused. All handlers and solvers for these objects are
+registered to the default registry via the register class methods. To use the
+logic in these objects, one simply needs to register a solver with their
+target_class of choice to one of these as the locator_class. For an example,
+see the implementation of range_editor.
+"""
+
+from traitsui.testing.tester import command, query
+from traitsui.testing.tester.wx import helpers
+
+
+class LocatedTextbox:
+    """ Wrapper class for a located Textbox in Wx.
+
+    Parameters
+    ----------
+    textbox : Instance of wx.TextCtrl
+    """
+
+    def __init__(self, textbox):
+        self.textbox = textbox
+
+    @classmethod
+    def register(cls, registry):
+        """ Class method to register interactions on a LocatedTextbox for the
+        given registry.
+
+        If there are any conflicts, an error will occur.
+
+        Parameters
+        ----------
+        registry : TargetRegistry
+            The registry being registered to.
+        """
+        handlers = [
+            (command.KeySequence,
+                (lambda wrapper, interaction: helpers.key_sequence_text_ctrl(
+                    wrapper.target.textbox, interaction, wrapper.delay))),
+            (command.KeyClick,
+                (lambda wrapper, interaction: helpers.key_click_text_ctrl(
+                    wrapper.target.textbox, interaction, wrapper.delay))),
+            (command.MouseClick,
+                (lambda wrapper, _: helpers.mouse_click_object(
+                    wrapper.target.textbox, wrapper.delay))),
+            (query.DisplayedText,
+                lambda wrapper, _: wrapper.target.textbox.GetValue()),
+        ]
+        for interaction_class, handler in handlers:
+            registry.register_handler(
+                target_class=cls,
+                interaction_class=interaction_class,
+                handler=handler,
+            )

traitsui/testing/tester/wx/default_registry.py

@@ -10,8 +10,10 @@
 #
 
 from traitsui.testing.tester.registry import TargetRegistry
+from traitsui.testing.tester.wx import common_ui_targets
 from traitsui.testing.tester.wx.implementation import (
     button_editor,
+    range_editor,
     text_editor,
 )
 
@@ -27,10 +29,15 @@ def get_default_registry():
     """
     registry = TargetRegistry()
 
+    common_ui_targets.LocatedTextbox.register(registry)
+
     # ButtonEditor
     button_editor.register(registry)
 
     # TextEditor
     text_editor.register(registry)
 
+    # RangeEditor
+    range_editor.register(registry)
+
     return registry

traitsui/testing/tester/wx/helpers.py

@@ -43,7 +43,7 @@ def key_click(widget, key, delay=0):
         else:
             wx.MilliSleep(delay)
             key_event = wx.KeyEvent(wx.wxEVT_CHAR)
-            key_event.SetUnicodeKey(KEY)
+            key_event.SetKeyCode(KEY)
             widget.EmulateKeyPress(key_event)
     else:
         wx.MilliSleep(delay)
@@ -110,7 +110,14 @@ def key_click_text_ctrl(control, interaction, delay):
         raise Disabled("{!r} is disabled.".format(control))
     if not control.HasFocus():
         control.SetFocus()
-    key_click(control, interaction.key, delay)
+    # EmulateKeyPress in key_click seems to not be handling "Enter"
+    # correctly.
+    if interaction.key == "Enter":
+        wx.MilliSleep(delay)
+        event = wx.CommandEvent(wx.EVT_TEXT_ENTER.typeId, control.GetId())
+        control.ProcessEvent(event)
+    else:
+        key_click(control, interaction.key, delay)
 
 
 def key_sequence_text_ctrl(control, interaction, delay):