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

traitsui/qt4/range_editor.py

@@ -449,6 +449,9 @@ 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
+        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,10 @@ class TargetByName:
     """
     def __init__(self, name):
         self.name = name
+
+
+class WidgetType(enum.Enum):
+    """ An Enum of widget types.
+    """
+
+    textbox = "textbox"

traitsui/testing/tester/qt4/default_registry.py

@@ -12,6 +12,7 @@
 from traitsui.testing.tester.registry import TargetRegistry
 from traitsui.testing.tester.qt4.implementation import (
     button_editor,
+    range_editor,
     text_editor,
 )
 
@@ -33,4 +34,7 @@ def get_default_registry():
     # TextEditor
     text_editor.register(registry)
 
+    # RangeEditor
+    range_editor.register(registry)
+
     return registry

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

@@ -0,0 +1,57 @@
+#  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,
+    SimpleSpinEditor,
+)
+
+from traitsui.testing.tester import locator
+from traitsui.testing.tester.qt4.located_object_handlers import LocatedTextbox
+
+
+class RangeEditorTextbox(LocatedTextbox):
+    pass
+
+
+def resolve_location_simple_slider(wrapper, location):
+    if location == locator.WidgetType.textbox:
+        return RangeEditorTextbox(textbox=wrapper.target.control.text)
+
+    raise NotImplementedError()
+
+def resolve_location_range_text(wrapper, location):
+    if location == locator.WidgetType.textbox:
+        return RangeEditorTextbox(textbox=wrapper.target.control)
+
+    raise NotImplementedError()
+
+def register(registry):
+
+    targets = [SimpleSliderEditor,
+               LogRangeSliderEditor,
+               LargeRangeSliderEditor]
+    for target_class in targets:
+        registry.register_solver(
+            target_class=target_class,
+            locator_class=locator.WidgetType,
+            solver=resolve_location_simple_slider,
+        )
+
+    registry.register_solver(
+        target_class=RangeTextEditor,
+        locator_class=locator.WidgetType,
+        solver=resolve_location_range_text,
+    )
+    RangeEditorTextbox.register(registry)

traitsui/testing/tester/qt4/located_object_handlers.py

@@ -0,0 +1,35 @@
+#  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.testing.tester import command, locator, query
+from traitsui.testing.tester.qt4 import helpers
+
+class LocatedTextbox:
+    def __init__(self, textbox):
+        self.textbox = textbox
+
+    @classmethod
+    def register(cls, registry):
+        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/wx/default_registry.py

@@ -12,6 +12,7 @@
 from traitsui.testing.tester.registry import TargetRegistry
 from traitsui.testing.tester.wx.implementation import (
     button_editor,
+    range_editor,
     text_editor,
 )
 
@@ -33,4 +34,7 @@ def get_default_registry():
     # TextEditor
     text_editor.register(registry)
 
+    # RangeEditor
+    range_editor.register(registry)
+
     return registry

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

@@ -0,0 +1,54 @@
+#  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.wx.range_editor import (
+    LargeRangeSliderEditor,
+    LogRangeSliderEditor,
+    RangeTextEditor,
+    SimpleSliderEditor,
+    SimpleSpinEditor,
+)
+
+from traitsui.testing.tester import locator
+from traitsui.testing.tester.wx.located_object_handlers import LocatedTextbox
+
+class RangeEditorTextbox(LocatedTextbox):
+    pass
+
+def resolve_location_simple_slider(wrapper, location):
+    if location == locator.WidgetType.textbox:
+        return RangeEditorTextbox(textbox=wrapper.target.control.text)
+
+    raise NotImplementedError()
+
+def resolve_location_range_text(wrapper, location):
+    if location == locator.WidgetType.textbox:
+        return RangeEditorTextbox(textbox=wrapper.target.control)
+
+    raise NotImplementedError()
+
+
+def register(registry):
+
+    targets = [SimpleSliderEditor,
+               LogRangeSliderEditor,
+               LargeRangeSliderEditor]
+    for target_class in targets:
+        registry.register_solver(
+            target_class=target_class,
+            locator_class=locator.WidgetType,
+            solver=resolve_location_simple_slider,
+        )
+    registry.register_solver(
+            target_class=RangeTextEditor,
+            locator_class=locator.WidgetType,
+            solver=resolve_location_simple_slider,
+        )
+    RangeEditorTextbox.register(registry)

traitsui/testing/tester/wx/located_object_handlers.py

@@ -0,0 +1,35 @@
+#  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.testing.tester import command, locator, query
+from traitsui.testing.tester.wx import helpers
+
+class LocatedTextbox:
+    def __init__(self, textbox):
+        self.textbox = textbox
+
+    @classmethod
+    def register(cls, registry):
+        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/tests/editors/test_range_editor.py

@@ -1,7 +1,9 @@
 import unittest
 
-from traits.api import HasTraits, Int
-from traitsui.api import RangeEditor, UItem, View
+from traits.api import HasTraits, Int, Range
+from traitsui.api import Item, RangeEditor, UItem, View
+from traitsui.testing.tester import command, locator, query
+from traitsui.testing.tester.ui_tester import UITester
 from traitsui.tests._tools import (
     create_ui,
     requires_toolkit,
@@ -14,6 +16,8 @@ class RangeModel(HasTraits):
 
     value = Int()
 
+class RangeTrait(HasTraits):
+    value = Range(1, 12)
 
 @requires_toolkit([ToolkitName.qt, ToolkitName.wx])
 class TestRangeEditor(unittest.TestCase):
@@ -33,8 +37,8 @@ def check_range_enum_editor_format_func(self, style):
             )
         )
 
-        with reraise_exceptions(),\
-                create_ui(obj, dict(view=view)) as ui:
+        tester = UITester()
+        with tester.create_ui(obj, dict(view=view)) as ui:
             editor = ui.get_editors("value")[0]
 
             # No formatting - simple strings
@@ -49,3 +53,53 @@ def test_simple_editor_format_func(self):
 
     def test_custom_editor_format_func(self):
         self.check_range_enum_editor_format_func("custom")
+
+    @requires_toolkit([ToolkitName.qt])
+    def check_set_with_text(self, mode):
+        model = RangeModel()
+        view = View(Item("value", editor=RangeEditor(low=1, high=12, mode=mode)), buttons=["OK"])
+        tester = UITester()
+        with tester.create_ui(model, dict(view=view)) as ui:
+            number_field = tester.find_by_name(ui, "value")
+            text = number_field.locate(locator.WidgetType.textbox)
+            text.perform(command.KeySequence("\b\b\b\b\b4"))
+            text.perform(command.KeyClick("Enter"))
+            self.assertEqual(model.value, 4)
+
+    def test_simple_slider_editor_set_with_text(self):
+        return self.check_set_with_text(mode='slider')
+
+    def test_large_range_slider_editor_set_with_text(self):
+        return self.check_set_with_text(mode='xslider')
+
+    def test_log_range_slider_editor_set_with_text(self):
+        return self.check_set_with_text(mode='logslider')
+
+    def test_range_text_editor_set_with_text(self):
+        return self.check_set_with_text(mode='text')
+
+
+    # "Enter" is not currently working to set the value on wx.
+    @requires_toolkit([ToolkitName.wx])
+    def check_set_with_text_wx(self, mode):
+        model = RangeModel()
+        view = View(Item("value", editor=RangeEditor(low=1, high=12, mode=mode)), buttons=["OK"])
+        tester = UITester()
+        with tester.create_ui(model, dict(view=view)) as ui:
+            number_field = tester.find_by_name(ui, "value")
+            text = number_field.locate(locator.WidgetType.textbox)
+            text.perform(command.KeySequence("\b\b\b\b\b4"))
+            tester.find_by_name(ui, "OK").perform(command.MouseClick)
+            self.assertEqual(model.value, 4)
+
+    """def test_simple_slider_editor_set_with_text_wx(self):
+        return self.check_set_with_text_wx(mode='slider')
+
+    def test_large_range_slider_editor_set_with_text(self):
+        return self.check_set_with_text(mode='xslider')
+
+    def test_log_range_slider_editor_set_with_text(self):
+        return self.check_set_with_text(mode='logslider')
+
+    def test_range_text_editor_set_with_text(self):
+        return self.check_set_with_text(mode='text')"""

traitsui/tests/editors/test_range_editor_text.py

@@ -26,6 +26,8 @@
 from traitsui.view import View
 from traitsui.editors.range_editor import RangeEditor
 
+from traitsui.testing.tester import command, locator, query
+from traitsui.testing.tester.ui_tester import UITester
 from traitsui.tests._tools import (
     create_ui,
     press_ok_button,
@@ -68,7 +70,18 @@ def test_wx_text_editing(self):
         # (tests a bug where this fails with an AttributeError)
 
         num = NumberWithRangeEditor()
-        with reraise_exceptions(), create_ui(num) as ui:
+        tester = UITester()
+        with tester.create_ui(num) as ui:
+            # the following is equivalent to setting the text in the text
+            # control, then pressing OK
+            text = tester.find_by_name(ui, "number").locate(locator.WidgetType.textbox)
+            text.perform(command.KeyClick("1"))
+            text.perform(command.KeyClick("Enter"))
+
+        # the number traits should be between 3 and 8
+        self.assertTrue(3 <= num.number <= 8)
+
+        """ with reraise_exceptions(), create_ui(num) as ui:
 
             # the following is equivalent to setting the text in the text
             # control, then pressing OK
@@ -77,7 +90,7 @@ def test_wx_text_editing(self):
             textctrl.SetValue("1")
 
         # the number traits should be between 3 and 8
-        self.assertTrue(3 <= num.number <= 8)
+        self.assertTrue(3 <= num.number <= 8) """
 
     @requires_toolkit([ToolkitName.qt])
     def test_avoid_slider_feedback(self):
@@ -86,7 +99,8 @@ def test_avoid_slider_feedback(self):
         from pyface import qt
 
         num = FloatWithRangeEditor()
-        with reraise_exceptions(), create_ui(num) as ui:
+        tester = UITester()
+        with tester.create_ui(num) as ui:
 
             # the following is equivalent to setting the text in the text
             # control, then pressing OK