File indexing completed on 2024-05-12 05:36:59

 #!/usr/bin/env python3
 
 # SPDX-FileCopyrightText: 2022 Harald Sitter <sitter@kde.org>
 # SPDX-FileCopyrightText: 2023 Fushan Wen <qydwhotmail@gmail.com>
 # SPDX-License-Identifier: MIT
 
 import os
 import shutil
 import time
 import unittest
 from typing import Final
 
 import gi
 from appium import webdriver
 from appium.options.common.base import AppiumOptions
 from appium.webdriver.common.appiumby import AppiumBy
 from selenium.common.exceptions import NoSuchElementException
 from selenium.webdriver.common.action_chains import ActionChains
 from selenium.webdriver.common.keys import Keys
 from selenium.webdriver.support.ui import WebDriverWait
 
 gi.require_version('Gdk', '3.0')
 from gi.repository import GLib
 
 WIDGET_ID: Final = "org.kde.plasma.clipboard"
 
 
 class ClipboardTest(unittest.TestCase):
     """
     Tests for the clipboard widget
     """
 
     driver: webdriver.Remote
 
     @classmethod
     def setUpClass(cls) -> None:
         """
         Opens the widget and initialize the webdriver
         """
         # Create history file to suppress warnings
         data_dir: str = GLib.get_user_data_dir()
         klipper_folder: Final = os.path.join(data_dir, "klipper")
         klipper_data_file: Final = os.path.join(klipper_folder, "history2.lst")
         if os.path.exists(klipper_data_file):
             shutil.move(klipper_data_file, f"{klipper_data_file}.bak")
             cls.addClassCleanup(lambda: shutil.move(f"{klipper_data_file}.bak", klipper_data_file))
         elif os.path.exists(klipper_folder):
             cls.addClassCleanup(lambda: os.remove(klipper_data_file))
         else:
             os.mkdir(klipper_folder)
             cls.addClassCleanup(lambda: shutil.rmtree(klipper_folder))
 
         shutil.copy("../klipper/autotests/data/onetextentry.lst", klipper_data_file)
 
         options = AppiumOptions()
         options.set_capability("app", f"plasmawindowed -p org.kde.plasma.nano {WIDGET_ID}")
         options.set_capability("environ", {
             "QT_FATAL_WARNINGS": "1",
             "QT_LOGGING_RULES": "qt.accessibility.atspi.warning=false;kf.plasma.core.warning=false;kf.windowsystem.warning=false;kf.kirigami.platform.warning=false;org.kde.klipper.debug=true",
         })
         options.set_capability("timeouts", {'implicit': 10000})
         cls.driver = webdriver.Remote(command_executor='http://127.0.0.1:4723', options=options)
 
     def tearDown(self) -> None:
         """
         Take screenshot when the current test fails
         """
         if not self._outcome.result.wasSuccessful():
             self.driver.get_screenshot_as_file(f"failed_test_shot_{WIDGET_ID}_#{self.id()}.png")
 
     @classmethod
     def tearDownClass(cls) -> None:
         """
         Make sure to terminate the driver again, lest it dangles.
         """
         cls.driver.quit()
 
     def test_0_open(self) -> None:
         """
         Tests the widget can be opened
         """
         self.driver.find_element(AppiumBy.NAME, "Fushan Wen")
         self.driver.find_element(AppiumBy.NAME, "clipboard")
 
     def test_1_barcode_1_open_barcode_page(self) -> None:
         """
         Tests the barcode page can be opened
         """
         actions = ActionChains(self.driver)
         actions.send_keys(Keys.DOWN).perform()
         # Wait until the first item is selected
         try:
             self.driver.find_element(AppiumBy.NAME, "Show QR code")
         except NoSuchElementException:
             actions.send_keys(Keys.DOWN).perform()  # Try pressing down key again
             self.driver.find_element(AppiumBy.NAME, "Show QR code")
 
         actions.send_keys(Keys.RIGHT).perform()
         time.sleep(1)
         actions.send_keys(Keys.RIGHT).perform()
         time.sleep(1)
         actions.send_keys(Keys.SPACE).perform()
         self.driver.find_element(AppiumBy.NAME, "QR Code")
         self.driver.find_element(AppiumBy.NAME, "Return to Clipboard")
         self.driver.find_element(AppiumBy.NAME, "Change the QR code type")
 
     def test_1_barcode_2_change_barcode_type(self) -> None:
         """
         Opens the barcode type menu and changes the current barcode type
         """
         self.driver.find_element(AppiumBy.NAME, "Change the QR code type").click()
         menu_item = self.driver.find_element(AppiumBy.NAME, "Aztec")
         # Switch to Aztec
         actions = ActionChains(self.driver)
         for _ in range(3):
             actions.send_keys(Keys.DOWN).perform()
             time.sleep(1)
         actions.send_keys(Keys.SPACE).perform()
         WebDriverWait(self.driver, 5).until_not(lambda _: menu_item.is_displayed())
         self.driver.find_element(AppiumBy.NAME, "Aztec")  # This is from barcodeItem
 
     def test_1_barcode_3_go_back_to_list_from_barcode_page(self) -> None:
         """
         Go back to the list from the barcode page
         """
         button_item = self.driver.find_element(AppiumBy.NAME, "Return to Clipboard")
         self.assertTrue(button_item.is_displayed())
         button_item.click()
         self.driver.find_element(AppiumBy.NAME, "Fushan Wen")
         self.assertFalse(button_item.is_displayed())
 
     def test_2_list_1_bug475696(self) -> None:
         """
         Pressing Return on an item should trigger the copy action
         @see https://bugs.kde.org/show_bug.cgi?id=475696
         """
         ActionChains(self.driver).send_keys(Keys.TAB).send_keys(Keys.DOWN).perform()
         self.driver.find_element(AppiumBy.NAME, "Show QR code")
         ActionChains(self.driver).send_keys(Keys.RETURN).perform()
         self.assertEqual(self.driver.get_clipboard_text(), "clipboard")
         ActionChains(self.driver).send_keys(Keys.ENTER).perform()
         self.assertEqual(self.driver.get_clipboard_text(), "Fushan Wen")
         ActionChains(self.driver).send_keys(Keys.SPACE).perform()
         self.assertEqual(self.driver.get_clipboard_text(), "clipboard")
 
     def test_2_list_2_delete(self) -> None:
         """
         Deletes the top item and tests if the current clipboard changes
         @see https://bugs.kde.org/show_bug.cgi?id=475696
         """
         # Now "clipboard" is the first item
         ActionChains(self.driver).send_keys(Keys.UP).perform()
         self.driver.find_element(AppiumBy.NAME, "Remove from history").click()
         # The first item becomes the current clipboard item
         self.assertEqual(self.driver.get_clipboard_text(), "Fushan Wen")
 
 
 if __name__ == '__main__':
     unittest.main()