From e81888a5e12c1866f0ad0b431b84e51ed2adc4d9 Mon Sep 17 00:00:00 2001
From: Joshua Fehler <jsfehler@gmail.com>
Date: Tue, 11 Jun 2024 11:20:50 -0400
Subject: [PATCH] Add keyboard class and Element.press()

---
 splinter/driver/__init__.py           | 17 ++++++++++
 splinter/driver/webdriver/__init__.py | 30 +++++++++++++++++
 splinter/driver/webdriver/keyboard.py | 47 +++++++++++++++++++++++++++
 tests/base.py                         |  3 +-
 tests/element.py                      | 23 +++++++++++++
 tests/form_elements.py                | 21 +-----------
 tests/keyboard.py                     | 13 ++++++++
 tests/skip_if.py                      | 31 ++++++++++++++++++
 8 files changed, 164 insertions(+), 21 deletions(-)
 create mode 100644 splinter/driver/webdriver/keyboard.py
 create mode 100644 tests/keyboard.py
 create mode 100644 tests/skip_if.py

diff --git a/splinter/driver/__init__.py b/splinter/driver/__init__.py
index a57ea263f..e9714ca23 100644
--- a/splinter/driver/__init__.py
+++ b/splinter/driver/__init__.py
@@ -871,6 +871,23 @@ def type(self, value: str, slowly: bool = False) -> str:  # NOQA: A003
         """
         raise NotImplementedError
 
+    def press(self, key: str, delay: int = 0) -> None:
+        """Focus the element and press the specified key pattern.
+
+        Key names are case sensitive.
+
+        Arguments:
+            key_name: Name of the key to press.
+            delay: Time, in seconds, to wait between key down and key up.
+
+        Example:
+
+            >>> browser.find_by_css('.my_element').press('ENTER')
+            >>> browser.find_by_css('.my_element').press('SHIFT+awesome')
+
+        """
+        raise NotImplementedError
+
     def select(self, value: str, slowly: bool = False) -> None:
         """
         Select an ``<option>`` element in the element using the ``value`` of the ``<option>``.
diff --git a/splinter/driver/webdriver/__init__.py b/splinter/driver/webdriver/__init__.py
index cd8049f9c..0e4f386ed 100644
--- a/splinter/driver/webdriver/__init__.py
+++ b/splinter/driver/webdriver/__init__.py
@@ -18,6 +18,7 @@
 from selenium.webdriver.common.action_chains import ActionChains
 from selenium.webdriver.common.alert import Alert
 from selenium.webdriver.common.by import By
+from selenium.webdriver.common.keys import Keys
 from selenium.webdriver.support import expected_conditions as EC  # NOQA: N812
 from selenium.webdriver.support.ui import WebDriverWait
 
@@ -25,6 +26,7 @@
 from splinter.driver import ElementAPI
 from splinter.driver.find_links import FindLinks
 from splinter.driver.webdriver.cookie_manager import CookieManager
+from splinter.driver.webdriver.keyboard import Keyboard
 from splinter.driver.xpath_utils import _concat_xpath_from_str
 from splinter.element_list import ElementList
 from splinter.exceptions import ElementDoesNotExist
@@ -265,6 +267,8 @@ class BaseWebDriver(DriverAPI):
     def __init__(self, driver=None, wait_time=2):
         self.wait_time = wait_time
 
+        self.keyboard = Keyboard(self)
+
         self.links = FindLinks(self)
 
         self.driver = driver
@@ -792,6 +796,32 @@ def type(self, value, slowly=False):  # NOQA: A003
         self._element.send_keys(value)
         return value
 
+    def press(self, key: str, delay: int = 0) -> None:
+        key_pattern = key.split("+")
+
+        chain = ActionChains(self.driver)
+
+        for item in key_pattern:
+            # If in selenium keys, use it, if not, assume literal.
+            key_value = getattr(Keys, item)
+
+            if key_value:
+                chain = chain.key_down(key_value, self._element)
+            else:
+                chain = chain.send_keys(key, self._element)
+
+        if delay:
+            chain = chain.pause(delay)
+
+        for item in key_pattern:
+            # If in selenium keys, use it, if not, assume literal.
+            key_value = getattr(Keys, item)
+
+            if key_value:
+                chain = chain.key_up(key_value, self._element)
+
+        chain.perform()
+
     def click(self):
         """Click an element.
 
diff --git a/splinter/driver/webdriver/keyboard.py b/splinter/driver/webdriver/keyboard.py
new file mode 100644
index 000000000..fcaecd797
--- /dev/null
+++ b/splinter/driver/webdriver/keyboard.py
@@ -0,0 +1,47 @@
+from selenium.webdriver.common.action_chains import ActionChains
+from selenium.webdriver.common.keys import Keys
+
+
+class Keyboard:
+    def __init__(self, driver) -> None:
+        self.driver = driver
+
+    def down(self, key: str) -> None:
+        key_value = getattr(Keys, key)
+
+        chain = ActionChains(self.driver)
+        chain.key_down(key_value)
+        chain.perform()
+
+    def up(self, key: str) -> None:
+        key_value = getattr(Keys, key)
+
+        chain = ActionChains(self.driver)
+        chain.key_up(key_value)
+        chain.perform()
+
+    def press(self, key: str, delay: int = 0) -> None:
+        key_pattern = key.split("+")
+
+        chain = ActionChains(self.driver)
+
+        for item in key_pattern:
+            # If in selenium keys, use it, if not, assume literal.
+            key_value = getattr(Keys, item)
+
+            if key_value:
+                chain = chain.key_down(key_value)  # , self._element)
+            else:
+                chain = chain.send_keys(key)  # , self._element)
+
+        if delay:
+            chain = chain.pause(delay)
+
+        for item in key_pattern:
+            # If in selenium keys, use it, if not, assume literal.
+            key_value = getattr(Keys, item)
+
+            if key_value:
+                chain = chain.key_up(key_value)  # , self._element)
+
+        chain.perform()
diff --git a/tests/base.py b/tests/base.py
index dc43689bb..ad509bfe1 100644
--- a/tests/base.py
+++ b/tests/base.py
@@ -24,7 +24,7 @@
 from .is_text_present import IsTextPresentTest
 from .type import SlowlyTypeTest
 from .get_browser import get_browser
-
+from .keyboard import KeyboardTest
 
 supported_browsers = [
     "chrome",
@@ -138,6 +138,7 @@ class WebDriverTests(
     BaseBrowserTests,
     ElementDoestNotExistTest,
     IsElementPresentTest,
+    KeyboardTest,
 ):
     def test_status_code(self):
         with pytest.raises(NotImplementedError):
diff --git a/tests/element.py b/tests/element.py
index 978c8087f..ea45a9c53 100644
--- a/tests/element.py
+++ b/tests/element.py
@@ -1,6 +1,7 @@
 # Copyright 2012 splinter authors. All rights reserved.
 # Use of this source code is governed by a BSD-style
 # license that can be found in the LICENSE file.
+from .skip_if import skip_if_zope, skip_if_django, skip_if_flask
 
 
 class ElementTest:
@@ -29,3 +30,25 @@ def test_element_html(self):
         assert (
             self.browser.find_by_id("html-property").html == 'inner <div class="inner-html">inner text</div> html test'
         )
+
+    @skip_if_zope
+    @skip_if_django
+    @skip_if_flask
+    def test_element_press_tab(self):
+        elem = self.browser.find_by_css("[name='q']")
+        next_elem = self.browser.find_by_css("[name='input1']").first
+
+        assert not next_elem.is_selected()
+
+        elem.press("TAB")
+
+        assert next_elem.is_selected()
+
+    @skip_if_zope
+    @skip_if_django
+    @skip_if_flask
+    def test_element_press_combo(self):
+        elem = self.browser.find_by_css("[name='q']")
+        elem.press("SHIFT+a+b+c+BACKSPACE")
+
+        assert elem.text == "AB"
diff --git a/tests/form_elements.py b/tests/form_elements.py
index bbdb08be2..7e25ecf64 100644
--- a/tests/form_elements.py
+++ b/tests/form_elements.py
@@ -7,26 +7,7 @@
 import pytest
 
 from splinter.exceptions import ElementDoesNotExist
-
-
-def skip_if_zope(f):
-    def wrapper(self, *args, **kwargs):
-        if self.__class__.__name__ == "TestZopeTestBrowserDriver":
-            return pytest.skip("skipping this test for zope testbrowser")
-        else:
-            f(self, *args, **kwargs)
-
-    return wrapper
-
-
-def skip_if_django(f):
-    def wrapper(self, *args, **kwargs):
-        if self.__class__.__name__ == "TestDjangoClientDriver":
-            return pytest.skip("skipping this test for django")
-        else:
-            f(self, *args, **kwargs)
-
-    return wrapper
+from .skip_if import skip_if_zope, skip_if_django
 
 
 class FormElementsTest:
diff --git a/tests/keyboard.py b/tests/keyboard.py
new file mode 100644
index 000000000..e84e4b93d
--- /dev/null
+++ b/tests/keyboard.py
@@ -0,0 +1,13 @@
+from splinter.driver.webdriver import Keyboard
+
+
+class KeyboardTest:
+    def test_keyboard_down(self):
+        keyboard = Keyboard(self.browser)
+
+        keyboard.down("SHIFT")
+
+        elem = self.browser.find_by_css("[name='q']")
+        elem.fill("hello")
+
+        assert elem.text == "HELLO"
diff --git a/tests/skip_if.py b/tests/skip_if.py
new file mode 100644
index 000000000..3875515bf
--- /dev/null
+++ b/tests/skip_if.py
@@ -0,0 +1,31 @@
+import pytest
+
+
+def skip_if_zope(f):
+    def wrapper(self, *args, **kwargs):
+        if self.__class__.__name__ == "TestZopeTestBrowserDriver":
+            return pytest.skip("skipping this test for zope testbrowser")
+        else:
+            f(self, *args, **kwargs)
+
+    return wrapper
+
+
+def skip_if_django(f):
+    def wrapper(self, *args, **kwargs):
+        if self.__class__.__name__ == "TestDjangoClientDriver":
+            return pytest.skip("skipping this test for django")
+        else:
+            f(self, *args, **kwargs)
+
+    return wrapper
+
+
+def skip_if_flask(f):
+    def wrapper(self, *args, **kwargs):
+        if self.__class__.__name__ == "TestFlaskClientDriver":
+            return pytest.skip("skipping this test for flask")
+        else:
+            f(self, *args, **kwargs)
+
+    return wrapper