appium: key (#367)

Author: eagleoflqj

appium/conftest.py

@@ -8,10 +8,10 @@
 from typing import Generator
 
 import pytest
-from appium import webdriver
 from appium.options.mac import Mac2Options
 from appium.webdriver.webdriver import WebDriver
 
+from appium import webdriver
 
 APPIUM_SERVER = "http://127.0.0.1:4723"
 BUNDLE_ID = "org.fcitx.FcitxTestApp"

appium/test_boolean.py

@@ -1,6 +1,6 @@
 from appium.webdriver.webdriver import WebDriver
 from util.boolean import get_switch_state
-from util.button import get_undo_redo, is_enabled
+from util.button import get_undo_redo
 from util.config import read_global_config
 from util.message import (
     BUTTON_SHOULD_BE_DISABLED,
@@ -26,18 +26,18 @@ def read_config_value() -> str:
     is_on = get_switch_state(switch)
     switch.click()
     assert get_switch_state(switch) != is_on, UI_NOT_UPDATED
-    assert is_enabled(undo) is True, BUTTON_SHOULD_BE_ENABLED
-    assert is_enabled(redo) is False, BUTTON_SHOULD_BE_DISABLED
+    assert undo.is_enabled() is True, BUTTON_SHOULD_BE_ENABLED
+    assert redo.is_enabled() is False, BUTTON_SHOULD_BE_DISABLED
     assert read_config_value() == str(not is_on), CHANGE_NOT_SAVED
 
     undo.click()
     assert get_switch_state(switch) == is_on, UI_NOT_UPDATED
-    assert is_enabled(undo) is False, BUTTON_SHOULD_BE_DISABLED
-    assert is_enabled(redo) is True, BUTTON_SHOULD_BE_ENABLED
+    assert undo.is_enabled() is False, BUTTON_SHOULD_BE_DISABLED
+    assert redo.is_enabled() is True, BUTTON_SHOULD_BE_ENABLED
     assert read_config_value() == str(is_on), CHANGE_NOT_SAVED
 
     redo.click()
     assert get_switch_state(switch) != is_on, UI_NOT_UPDATED
-    assert is_enabled(undo) is True, BUTTON_SHOULD_BE_ENABLED
-    assert is_enabled(redo) is False, BUTTON_SHOULD_BE_DISABLED
+    assert undo.is_enabled() is True, BUTTON_SHOULD_BE_ENABLED
+    assert redo.is_enabled() is False, BUTTON_SHOULD_BE_DISABLED
     assert read_config_value() == str(not is_on), CHANGE_NOT_SAVED

appium/test_color.py

@@ -1,8 +1,7 @@
 from appium.webdriver.webdriver import WebDriver
-
-from util.config import read_theme_config
-from util.button import get_undo_redo, is_enabled
+from util.button import get_undo_redo
 from util.color import get_color_value, set_color_value
+from util.config import read_theme_config
 from util.message import (
     BUTTON_SHOULD_BE_DISABLED,
     BUTTON_SHOULD_BE_ENABLED,
@@ -11,7 +10,6 @@
 )
 from util.window import find_element_by_id, open_theme_config
 
-
 LIGHT_SECTION = "LightMode"
 COLOR_ID = "HighlightColor"
 
@@ -31,10 +29,10 @@ def read_config_value() -> str:
 
     set_color_value(field, new_value)
     assert get_color_value(field) == new_value, UI_NOT_UPDATED
-    assert is_enabled(undo) is True, BUTTON_SHOULD_BE_ENABLED
+    assert undo.is_enabled() is True, BUTTON_SHOULD_BE_ENABLED
     assert read_config_value() == new_value, CHANGE_NOT_SAVED
 
     undo.click()
     assert get_color_value(field) == initial_value, UI_NOT_UPDATED
-    assert is_enabled(undo) is False, BUTTON_SHOULD_BE_DISABLED
+    assert undo.is_enabled() is False, BUTTON_SHOULD_BE_DISABLED
     assert read_config_value() == initial_value, CHANGE_NOT_SAVED

appium/test_enum.py

@@ -1,6 +1,6 @@
 import pytest
 from appium.webdriver.webdriver import WebDriver
-from util.button import get_undo_redo, is_enabled
+from util.button import get_undo_redo
 from util.config import read_config
 from util.enum import get_enum_value, select_enum_option
 from util.message import (
@@ -50,24 +50,24 @@ def read_config_value() -> str:
 
     assert get_enum_value(picker) == target_value, UI_NOT_UPDATED
     assert read_config_value() == target_config_value, CHANGE_NOT_SAVED
-    assert is_enabled(undo) is True, BUTTON_SHOULD_BE_ENABLED
-    assert is_enabled(redo) is False, BUTTON_SHOULD_BE_DISABLED
+    assert undo.is_enabled() is True, BUTTON_SHOULD_BE_ENABLED
+    assert redo.is_enabled() is False, BUTTON_SHOULD_BE_DISABLED
 
     undo.click()
     assert get_enum_value(picker) == initial_value, UI_NOT_UPDATED
     assert read_config_value() == initial_config_value, CHANGE_NOT_SAVED
-    assert is_enabled(undo) is False, BUTTON_SHOULD_BE_DISABLED
-    assert is_enabled(redo) is True, BUTTON_SHOULD_BE_ENABLED
+    assert undo.is_enabled() is False, BUTTON_SHOULD_BE_DISABLED
+    assert redo.is_enabled() is True, BUTTON_SHOULD_BE_ENABLED
 
     # Re-select current value
     select_enum_option(picker, initial_value)
     assert get_enum_value(picker) == initial_value, UI_WRONGLY_UPDATED
     assert read_config_value() == initial_config_value, CHANGE_WRONGLY_SAVED
-    assert is_enabled(undo) is False, BUTTON_SHOULD_BE_DISABLED
-    assert is_enabled(redo) is True, BUTTON_SHOULD_BE_ENABLED
+    assert undo.is_enabled() is False, BUTTON_SHOULD_BE_DISABLED
+    assert redo.is_enabled() is True, BUTTON_SHOULD_BE_ENABLED
 
     redo.click()
     assert get_enum_value(picker) == target_value, UI_NOT_UPDATED
     assert read_config_value() == target_config_value, CHANGE_NOT_SAVED
-    assert is_enabled(undo) is True, BUTTON_SHOULD_BE_ENABLED
-    assert is_enabled(redo) is False, BUTTON_SHOULD_BE_DISABLED
+    assert undo.is_enabled() is True, BUTTON_SHOULD_BE_ENABLED
+    assert redo.is_enabled() is False, BUTTON_SHOULD_BE_DISABLED

appium/test_integer.py

@@ -1,5 +1,5 @@
 from appium.webdriver.webdriver import WebDriver
-from util.button import get_undo_redo, is_enabled
+from util.button import get_undo_redo
 from util.config import read_global_config
 from util.integer import (
     click_stepper_decrement,
@@ -36,24 +36,24 @@ def read_config_value() -> str:
 
     new_value = get_integer_value(field)
     assert new_value == initial_value + 1, UI_NOT_UPDATED
-    assert is_enabled(undo) is True, BUTTON_SHOULD_BE_ENABLED
-    assert is_enabled(redo) is False, BUTTON_SHOULD_BE_DISABLED
+    assert undo.is_enabled() is True, BUTTON_SHOULD_BE_ENABLED
+    assert redo.is_enabled() is False, BUTTON_SHOULD_BE_DISABLED
 
     assert read_config_value() == str(new_value), CHANGE_NOT_SAVED
 
     undo.click()
     undo_value = get_integer_value(field)
     assert undo_value == initial_value, UI_NOT_UPDATED
-    assert is_enabled(undo) is False, BUTTON_SHOULD_BE_DISABLED
-    assert is_enabled(redo) is True, BUTTON_SHOULD_BE_ENABLED
+    assert undo.is_enabled() is False, BUTTON_SHOULD_BE_DISABLED
+    assert redo.is_enabled() is True, BUTTON_SHOULD_BE_ENABLED
 
     assert read_config_value() == str(initial_value), CHANGE_NOT_SAVED
 
     redo.click()
     redo_value = get_integer_value(field)
     assert redo_value == initial_value + 1, UI_NOT_UPDATED
-    assert is_enabled(undo) is True, BUTTON_SHOULD_BE_ENABLED
-    assert is_enabled(redo) is False, BUTTON_SHOULD_BE_DISABLED
+    assert undo.is_enabled() is True, BUTTON_SHOULD_BE_ENABLED
+    assert redo.is_enabled() is False, BUTTON_SHOULD_BE_DISABLED
     assert read_config_value() == str(redo_value), CHANGE_NOT_SAVED
 
     click_stepper_decrement(driver, stepper)

appium/test_key.py

@@ -0,0 +1,57 @@
+from appium.webdriver.webdriver import WebDriver
+from selenium.webdriver.common.keys import Keys
+from util.button import get_undo_redo
+from util.config import read_global_config
+from util.key import get_label, press
+from util.message import (
+    BUTTON_SHOULD_BE_DISABLED,
+    BUTTON_SHOULD_BE_ENABLED,
+    CHANGE_NOT_SAVED,
+    UI_NOT_UPDATED,
+)
+from util.window import find_element_by_id, find_elements_by_id, open_global_config
+
+KEY_ID = "TriggerKeys"
+INDEX = 0
+# XXX: [Keys.CONTROL, Keys.RIGHT_SHIFT] is recognized as Ctrl+LSHIFT.
+KEYS = [Keys.CONTROL, Keys.SHIFT, "A"]
+KEYS_LABEL = "⌃⇧A"
+KEYS_VALUE = "Control+Shift+A"
+
+
+def test_record_shortcut(driver: WebDriver, app: str):
+    open_global_config(driver)
+
+    def read_config_value() -> str:
+        cfg = read_global_config(app)
+        return cfg[f"Hotkey/{KEY_ID}"][str(INDEX)]
+
+    button = find_elements_by_id(driver, KEY_ID)[INDEX]
+    initial_label = get_label(button)
+    undo, _ = get_undo_redo(driver)
+
+    def update():
+        button.click()
+        press(driver, KEYS)
+        assert (
+            find_element_by_id(driver, f"{KEY_ID}_key").get_attribute("value")
+            == KEYS_LABEL
+        ), UI_NOT_UPDATED
+
+    update()
+    find_element_by_id(driver, f"{KEY_ID}_cancel").click()
+    assert get_label(button) == initial_label
+    assert undo.is_enabled() is False, BUTTON_SHOULD_BE_DISABLED
+
+    update()
+    find_element_by_id(driver, f"{KEY_ID}_ok").click()
+    button = find_elements_by_id(driver, KEY_ID)[0]
+    assert get_label(button) == KEYS_LABEL
+    assert undo.is_enabled() is True, BUTTON_SHOULD_BE_ENABLED
+    assert read_config_value() == KEYS_VALUE, CHANGE_NOT_SAVED
+
+    undo.click()
+    button = find_elements_by_id(driver, KEY_ID)[0]
+    assert get_label(button) == initial_label
+    assert undo.is_enabled() is False, BUTTON_SHOULD_BE_DISABLED
+    assert read_config_value() != KEYS_VALUE, CHANGE_NOT_SAVED

appium/test_string.py

@@ -1,5 +1,6 @@
 from appium.webdriver.webdriver import WebDriver
-from util.button import get_undo_redo, is_enabled
+from selenium.webdriver.common.keys import Keys
+from util.button import get_undo_redo
 from util.config import read_theme_config
 from util.key import press
 from util.message import (
@@ -34,36 +35,36 @@ def update():
 
     update()
     undo, _ = get_undo_redo(driver)
-    assert is_enabled(undo) is False, BUTTON_SHOULD_BE_DISABLED
+    assert undo.is_enabled() is False, BUTTON_SHOULD_BE_DISABLED
 
-    press(driver, "\n")
+    press(driver, [Keys.ENTER])
     assert get_string_value(field) == new_value, UI_NOT_UPDATED
-    assert is_enabled(undo) is True, BUTTON_SHOULD_BE_ENABLED
+    assert undo.is_enabled() is True, BUTTON_SHOULD_BE_ENABLED
     assert read_config_value() == new_value, CHANGE_NOT_SAVED
 
     undo.click()
-    assert is_enabled(undo) is False, BUTTON_SHOULD_BE_DISABLED
+    assert undo.is_enabled() is False, BUTTON_SHOULD_BE_DISABLED
     assert get_string_value(field) == initial_value, UI_NOT_UPDATED
     assert read_config_value() == initial_value, CHANGE_NOT_SAVED
 
     update()
-    press(driver, "\t")
+    press(driver, [Keys.TAB])
     assert get_string_value(field) == new_value, UI_NOT_UPDATED
-    assert is_enabled(undo) is True, BUTTON_SHOULD_BE_ENABLED
+    assert undo.is_enabled() is True, BUTTON_SHOULD_BE_ENABLED
     assert read_config_value() == new_value, CHANGE_NOT_SAVED
 
     undo.click()
-    assert is_enabled(undo) is False, BUTTON_SHOULD_BE_DISABLED
+    assert undo.is_enabled() is False, BUTTON_SHOULD_BE_DISABLED
     assert get_string_value(field) == initial_value, UI_NOT_UPDATED
     assert read_config_value() == initial_value, CHANGE_NOT_SAVED
 
     update()
     find_element_by_id(driver, "checkmark").click()
     assert get_string_value(field) == new_value, UI_NOT_UPDATED
-    assert is_enabled(undo) is True, BUTTON_SHOULD_BE_ENABLED
+    assert undo.is_enabled() is True, BUTTON_SHOULD_BE_ENABLED
     assert read_config_value() == new_value, CHANGE_NOT_SAVED
 
     reset_option(driver, STRING_ID)
-    assert is_enabled(undo) is True, BUTTON_SHOULD_BE_ENABLED
+    assert undo.is_enabled() is True, BUTTON_SHOULD_BE_ENABLED
     assert get_string_value(field) == initial_value, UI_NOT_UPDATED
     assert read_config_value() == initial_value, CHANGE_NOT_SAVED

appium/util/button.py

@@ -7,14 +7,9 @@
 def get_undo_redo(driver: WebDriver) -> tuple[WebElement, WebElement]:
     """Get undo and redo buttons, asserting they are initially disabled."""
     undo = find_element_by_id(driver, "arrow.uturn.left")
-    assert is_enabled(undo) is False, BUTTON_SHOULD_BE_DISABLED
+    assert undo.is_enabled() is False, BUTTON_SHOULD_BE_DISABLED
 
     redo = find_element_by_id(driver, "arrow.uturn.right")
-    assert is_enabled(redo) is False, BUTTON_SHOULD_BE_DISABLED
+    assert redo.is_enabled() is False, BUTTON_SHOULD_BE_DISABLED
 
     return undo, redo
-
-
-def is_enabled(element: WebElement) -> bool:
-    """Check if an element is enabled."""
-    return element.get_attribute("enabled") == "true"

appium/util/color.py

@@ -1,5 +1,6 @@
-from selenium.webdriver.remote.webelement import WebElement
 from appium.webdriver.common.appiumby import AppiumBy
+from selenium.webdriver.common.keys import Keys
+from selenium.webdriver.remote.webelement import WebElement
 from util.key import press
 from util.window import find_element_by_id
 
@@ -31,7 +32,9 @@ def set_color_value(element: WebElement, value: str):
     # Type hex
     hex_field = find_element_by_id(driver, "hex")
     hex_field.send_keys(value)
-    press(driver, "\n")  # Without it, below may throw StaleElementReferenceException.
+    press(
+        driver, [Keys.ENTER]
+    )  # Without it, below may throw StaleElementReferenceException.
 
     # Close
     buttons = driver.find_elements(AppiumBy.CLASS_NAME, "XCUIElementTypeButton")

appium/util/key.py

@@ -1,5 +1,16 @@
 from appium.webdriver.webdriver import WebDriver
+from selenium.webdriver.common.actions.action_builder import ActionBuilder
+from selenium.webdriver.remote.webelement import WebElement
 
 
-def press(driver: WebDriver, key: str):
-    driver.execute_script("macos: keys", {"keys": [key]})
+def press(driver: WebDriver, keys: list[str]):
+    action = ActionBuilder(driver)
+    for key in keys:
+        action.key_action.key_down(key)
+    for key in reversed(keys):
+        action.key_action.key_up(key)
+    action.perform()
+
+
+def get_label(button: WebElement) -> str:
+    return button.get_attribute("label")