AppAutoTest/core/driver.py

#!/usr/bin/env python
# coding=utf-8

"""
@author: CNWei,ChenWei
@Software: PyCharm
@contact: t6g888@163.com
@file: driver
@date: 2026/1/16 10:49
@desc: Appium 核心驱动封装，提供统一的 API 用于 Appium 会话管理和元素操作。
"""
import logging
import secrets  # 原生库，用于生成安全的随机数
from typing import Optional, Type, TypeVar, Union, Callable, Any
from time import sleep

from appium import webdriver
from appium.options.android import UiAutomator2Options
from appium.options.ios import XCUITestOptions
from appium.options.common.base import AppiumOptions
from appium.webdriver.webdriver import ExtensionBase
from appium.webdriver.webelement import WebElement
from appium.webdriver.client_config import AppiumClientConfig

from selenium.common import TimeoutException, StaleElementReferenceException, NoSuchElementException
from selenium.webdriver.support.ui import WebDriverWait
from selenium.webdriver.support import expected_conditions as EC
from selenium.webdriver.common.action_chains import ActionChains
from selenium.webdriver.common.actions import interaction
from selenium.webdriver.common.actions.action_builder import ActionBuilder
from selenium.webdriver.common.actions.pointer_input import PointerInput

from utils.finder import by_converter
from utils.decorators import resolve_wait_method
from core.modules import AppPlatform
from core.settings import IMPLICIT_WAIT_TIMEOUT, EXPLICIT_WAIT_TIMEOUT, APPIUM_HOST, APPIUM_PORT, SCREENSHOT_DIR

logger = logging.getLogger(__name__)

T = TypeVar("T")


class CoreDriver:
    def __init__(self, driver: Optional[webdriver.Remote] = None):
        """
        初始化 CoreDriver 实例。
        从 settings.py 加载默认的 Appium 服务器主机和端口。
        """
        self.driver = driver
        self._current_implicit_timeout = IMPLICIT_WAIT_TIMEOUT
        self._host = APPIUM_HOST
        self._port = APPIUM_PORT

    @property
    def server_url(self) -> str:
        """
        动态构造 URL，确保 server_config 修改后立即生效。
        """
        return f"http://{self._host}:{self._port}"

    def server_config(self, host: str = APPIUM_HOST, port: int = APPIUM_PORT) -> 'CoreDriver':
        """
        配置服务器信息。支持链式调用。
        :param host: ip
        :param port: 端口
        :return: 返回 CoreDriver 实例自身，支持链式调用。
        """
        self._host = host
        self._port = port
        logger.info(f"Appium Server 指向 -> {self._host}:{self._port}")
        return self

    @staticmethod
    def _make_options(platform: str | AppPlatform, caps: dict) -> AppiumOptions:
        """
        根据平台生成对应的 Options
        :param platform: 目标平台 ('android' 或 'ios')，支持 AppPlatform 枚举或字符串。
        :param caps: Appium capabilities 字典。
        :return: AppiumOptions
        """
        match platform:
            case AppPlatform.ANDROID.value:
                logger.info(f"正在初始化 Android 会话...")
                return UiAutomator2Options().load_capabilities(caps)

            case AppPlatform.IOS.value:
                logger.info(f"正在初始化 iOS 会话...")
                return XCUITestOptions().load_capabilities(caps)

            case _:
                # 优化：不再默认返回 Android，而是显式报错 (Fail Fast)
                msg = f"不支持的平台类型: [{platform}]。当前仅支持: [android, ios]"
                logger.error(msg)
                raise ValueError(msg)

    def connect(self, platform: str | AppPlatform, caps: dict,
                extensions: list[Type[ExtensionBase]] | None = None,
                client_config: AppiumClientConfig | None = None) -> 'CoreDriver':
        """
        连接到 Appium 服务器并创建一个新的会话。

        :param platform: 目标平台 ('android' 或 'ios')，支持 AppPlatform 枚举或字符串。
        :param caps: Appium capabilities 字典。
        :param extensions: Appium 驱动扩展列表。
        :param client_config: Appium 客户端配置。
        :return: 返回 CoreDriver 实例自身，支持链式调用。
        :raises ValueError: 如果平台不受支持。
        :raises ConnectionError: 如果无法连接到 Appium 服务。
        """
        # 1. 统一格式化平台名称
        platform_name = platform.value if isinstance(platform, AppPlatform) else platform.lower().strip()

        # 2. 预校验：如果已经有 driver 正在运行，先清理（防止 Session 冲突）
        if self.driver:
            logger.warning("发现旧的 Driver 实例尚未关闭，正在强制重置...")
            self.quit()

        # 3. 匹配平台并加载 Options
        options: AppiumOptions = self._make_options(platform_name, caps)

        try:

            # 4. 创建连接
            self.driver = webdriver.Remote(
                command_executor=self.server_url,
                options=options,
                extensions=extensions,
                client_config=client_config
            )

            logger.info(f"已成功连接到 {platform_name.upper()} 设备 (SessionID: {self.driver.session_id})")
            return self

        except Exception as e:
            logger.error(f"驱动连接失败！底层错误信息: {e}")
            # 确保失败后清理现场
            self.driver = None
            raise ConnectionError(f"无法连接到 Appium 服务，请检查端口 {self._port} 或设备状态。") from e

    # --- 核心操作 ---
    def find_element(self, by: str, value: str, timeout: Optional[float] = None) -> WebElement:
        """
        内部通用查找（显式等待）
        :param by: 定位策略
        :param value: 定位值
        :param timeout: 等待超时时间 (秒)。如果为 None, 则使用全局默认超时.
        :return: WebElement.
        """
        by = by_converter(by)
        mark = (by, value)
        method = EC.presence_of_element_located(mark)
        return self.explicit_wait(method, timeout)

    def find_elements(self, by: str, value: str, timeout: Optional[float] = None) -> list[WebElement]:
        """
        内部通用查找（显式等待）
        :param by: 定位策略
        :param value: 定位值
        :param timeout: 等待超时时间 (秒)。如果为 None, 则使用全局默认超时.
        :return: list[WebElement].
        """
        by = by_converter(by)
        mark = (by, value)
        method = EC.presence_of_all_elements_located(mark)
        return self.explicit_wait(method, timeout)

    def delay(self, timeout: int | float) -> 'CoreDriver':
        """
        强制等待（线程阻塞）。

        应谨慎使用，主要用于等待非 UI 元素的异步操作或调试。
        :param timeout: 等待时间（秒）。
        :return: self
        """
        sleep(timeout)
        return self

    def implicit_wait(self, timeout: float = IMPLICIT_WAIT_TIMEOUT) -> None:
        """
        设置全局隐式等待时间。
        在每次 find_element 时生效，直到元素出现或超时。
        :param timeout: 超时时间
        :return:
        """
        self.driver.implicitly_wait(timeout)
        self._current_implicit_timeout = timeout  # 记录等待时间

    @resolve_wait_method
    def explicit_wait(self, method: Union[Callable[[webdriver.Remote], T], str], timeout: Optional[float] = None) -> \
            Union[T, WebElement]:
        """
        执行显式等待，直到满足某个条件或超时。

        使用示例:
        1. 使用原生 Selenium EC:
           driver.explicit_wait(EC.presence_of_element_located((By.ID, "el_id")))

        2. 使用自定义字符串别名 (支持参数传递):
           # 检查 Toast 消息
           driver.explicit_wait("toast_visible:登录成功")
           # 检查元素属性 (格式: key:by,value,attr,expect)
           driver.explicit_wait("attr_contains:id,btn_submit,checked,true")
           # 检查元素数量
           driver.explicit_wait("count_at_least:xpath,//android.widget.TextView,3")

        :param method: EC等待条件(Callable) 或 自定义等待条件的名称(str)
        :param timeout: 超时时间 (秒)。如果为 None, 则使用全局默认超时.
        :return: 等待条件的执行结果 (通常是 WebElement 或 bool)
        """
        wait_timeout = timeout if timeout is not None else EXPLICIT_WAIT_TIMEOUT

        try:
            # 获取函数名称用于日志，兼容 lambda 和普通函数
            func_name = getattr(method, '__name__', repr(method))
            logger.info(f"执行显式等待: {func_name}, 超时: {wait_timeout}s")
            return WebDriverWait(self.driver, wait_timeout).until(method)
        except TimeoutException:
            logger.error(f"等待超时: {wait_timeout}s 内未满足条件 {method}")
            raise
        except TypeError as te:
            logger.error(f"显示等待异常: {te}")
            # self.driver.quit()
            raise te

    def page_load_timeout(self, timeout: Optional[float] = None) -> None:
        """
        设置页面加载超时时间。
        :param timeout: 超时时间 (秒)。如果为 None, 则使用全局默认超时.
        """
        wait_timeout = timeout if timeout is not None else EXPLICIT_WAIT_TIMEOUT
        self.driver.set_page_load_timeout(wait_timeout)

    def click(self, by: str, value: str, timeout: Optional[float] = None) -> 'CoreDriver':
        """
        查找元素并执行点击操作。
        内置显式等待，确保元素可点击。
        :param by: 定位策略。
        :param value: 定位值。
        :param timeout: 等待超时时间。
        :return: self
        """
        by = by_converter(by)
        mark = (by, value)
        logger.info(f"点击: {mark}")
        method = EC.element_to_be_clickable(mark)
        self.explicit_wait(method, timeout).click()
        return self

    def clear(self, by: str, value: str, timeout: Optional[float] = None) -> 'CoreDriver':
        """
        查找元素并清空其内容。
        内置显式等待，确保元素可见。
        :param by: 定位策略。
        :param value: 定位值。
        :param timeout: 等待超时时间。
        :return: self
        """
        by = by_converter(by)
        mark = (by, value)
        logger.info(f"清空输入框: {mark}")
        method = EC.visibility_of_element_located(mark)
        self.explicit_wait(method, timeout).clear()
        return self

    def input(self, by: str, value: str, text: str, sensitive: bool = False,
              timeout: Optional[float] = None) -> 'CoreDriver':
        """
        查找元素并输入文本。
        内置显式等待，确保元素可见。
        :param by: 定位策略。
        :param value: 定位值。
        :param text: 要输入的文本。
        :param sensitive: 是否为敏感信息（如密码），如果是，日志中将掩码显示。
        :param timeout: 等待超时时间。
        :return: self
        """
        by = by_converter(by)
        mark = (by, value)
        display_text = "******" if sensitive else text
        logger.info(f"输入文本到 {mark}: '{display_text}'")
        method = EC.visibility_of_element_located(mark)
        self.explicit_wait(method, timeout).send_keys(text)
        return self

    def is_visible(self, by: str, value: str) -> bool | None:
        """
        判断元素是否可见
        :param by: 定位策略。
        :param value: 定位值。
        :return: bool
        """
        # 禁用隐式等待
        original_timeout = self._current_implicit_timeout
        try:
            self.implicit_wait(0)

            by = by_converter(by)
            elements = self.driver.find_elements(by, value)

            if elements:
                return elements[0].is_displayed()
            # 2. 元素存在于 DOM 中，还需要判断它在 UI 上是否真正可见（宽/高 > 0 且未隐藏）
            return False
        except (StaleElementReferenceException, NoSuchElementException):
            # 这些属于预料中的“不可见”情况
            return False
        except Exception as e:
            _ = e
            return False
        finally:
            # 恢复原来的隐式等待时间
            self.implicit_wait(original_timeout)

    def wait_until_visible(self, by: str, value: str, timeout: Optional[float] = None) -> bool:
        """
        等待元素出现
        :param by: 定位策略。
        :param value: 定位值。
        :param timeout: 等待超时时间。
        :return: bool
        """
        try:
            by = by_converter(by)
            mark = (by, value)
            method = EC.visibility_of_element_located(mark)
            self.explicit_wait(method, timeout)
            return True
        except TimeoutException:
            return False

    def wait_until_not_visible(self, by: str, value: str, timeout: Optional[float] = None) -> bool:
        """
        等待元素消失
        :param by: 定位策略。
        :param value: 定位值。
        :param timeout: 等待超时时间。
        :return: bool
        """
        try:
            by = by_converter(by)
            mark = (by, value)
            method = EC.invisibility_of_element_located(mark)
            self.explicit_wait(method, timeout)
            return True
        except TimeoutException:
            return False

    def get_text(self, by: str, value: str, timeout: Optional[float] = None) -> str:
        """
        获取元素文本
        :param by: 定位策略。
        :param value: 定位值。
        :param timeout: 等待超时时间。
        :return:获取到的文本
        """
        by = by_converter(by)
        mark = (by, value)
        method = EC.visibility_of_element_located(mark)

        text = self.explicit_wait(method, timeout).text
        logger.info(f"获取到的文本: {text}")
        return text

    def get_attribute(self, by: str, value: str, name: str, timeout: Optional[float] = None) -> str:
        """
        获取元素属性
        :param by: 定位策略。
        :param value: 定位值。
        :param timeout: 等待超时时间。
        :param name: 属性名称 (如 'checked', 'enabled', 'resource-id')
        """
        by = by_converter(by)
        mark = (by, value)
        method = EC.presence_of_element_located(mark)
        element = self.explicit_wait(method, timeout)
        attr_value = element.get_attribute(name)
        logger.info(f"获取属性 {name} of {mark}: {attr_value}")
        return attr_value

    def clear_popups(self, black_list: list = None, max_rounds: int = 5) -> bool:
        """
        显式清理弹窗函数。
        说明：
        1. 快速扫描：使用 is_visible (不等待) 确认弹窗是否存在。
        2. 动作处理：发现后点击，并触发 wait_until_not_visible (异步等待消失)。
        3. 自适应退出：当整轮扫描无障碍物时，立即返回，不浪费时间。
        4. 异常存证：若点击失败或发生错误，自动截图。
        :param black_list: 允许传入当前页面特有的弹窗定位 [(by, value), ...]（如某个活动的特殊广告）
        :param max_rounds: 最大扫描轮数
        :return: active: bool(清理过一个弹窗都将返回 True)
        """
        if not black_list:
            logger.warning("未提供黑名单列表，跳过清理动作。")
            return False

        list_len = len(black_list)
        active = False

        logger.info(f"开始执行显式弹窗清理，待检查项: {list_len} 个")
        for round_idx in range(max_rounds):
            skip_count = 0
            for by, value in black_list:

                if not self.is_visible(by, value):
                    skip_count += 1
                    continue

                logger.info(f"当前权重{skip_count},第 {round_idx + 1} 轮：待清理弹窗 -> {value}")
                try:
                    elements = self.find_elements(by, value, timeout=0.5)  # 使用极短超时
                    if not elements:
                        skip_count += 1
                    else:
                        elements[0].click()
                        active = True

                        # 消失得快返回得就快，最多等 1.5s
                        if self.wait_until_not_visible(by, value, timeout=1.5):
                            logger.info(f"弹窗已成功消失")
                        else:
                            logger.warning(f"弹窗点击后仍存在")

                except Exception as e:
                    safe_val = secrets.token_hex(8)
                    file_name = f"popup_fail_{round_idx}_{safe_val}.png"

                    logger.error(f"清理弹窗尝试点击时失败[{safe_val}:{value}]: {e}")
                    self.full_screen_screenshot(file_name)
                    raise e
            if skip_count == list_len:
                break
        return active

    def back(self) -> 'CoreDriver':
        """
        模拟设备返回键操作。
        :return: self
        """
        self.driver.back()
        return self

    @property
    def session_id(self) -> Any | None:
        """获取当前 Appium 会话的 Session ID。"""
        return self.driver.session_id

    # --- 移动端特有：方向滑动 ---
    def swipe_by_coordinates(self, start_x: int, start_y: int, end_x: int, end_y: int,
                             duration: int = 1000) -> 'CoreDriver':
        """
        基于绝对坐标的滑动 (W3C Actions 底层实现)
        :param start_x: 起点 X
        :param start_y: 起点 Y
        :param end_x: 终点 X
        :param end_y: 终点 Y
        :param duration: 滑动持续时间 (ms)
        :return: self
        """
        actions = ActionChains(self.driver)
        # 覆盖默认的鼠标输入为触摸输入
        actions.w3c_actions = ActionBuilder(self.driver, mouse=PointerInput(interaction.POINTER_TOUCH, "touch"))

        actions.w3c_actions.pointer_action.move_to_location(start_x, start_y)
        actions.w3c_actions.pointer_action.pointer_down()
        actions.w3c_actions.pointer_action.pause(duration / 1000)
        actions.w3c_actions.pointer_action.move_to_location(end_x, end_y)
        actions.w3c_actions.pointer_action.release()
        actions.perform()
        return self

    def swipe(self, direction: str = "up", duration: int = 1000) -> 'CoreDriver':
        """
        封装方向滑动
        :param direction: 滑动方向 up/down/left/right (指手指滑动的方向)
        :param duration: 滑动持续时间 (ms)
        :return: self
        """
        # 每次获取屏幕尺寸以适应旋转
        size = self.driver.get_window_size()
        w, h = size['width'], size['height']

        # 定义滑动坐标 (中心区域，避开边缘，防止误触系统操作)
        coords = {
            "up": (w * 0.5, h * 0.8, w * 0.5, h * 0.2),
            "down": (w * 0.5, h * 0.2, w * 0.5, h * 0.8),
            "left": (w * 0.9, h * 0.5, w * 0.1, h * 0.5),
            "right": (w * 0.1, h * 0.5, w * 0.9, h * 0.5)
        }
        start_x, start_y, end_x, end_y = coords.get(direction.lower(), coords["up"])
        logger.info(f"执行滑动: {direction} ({start_x}, {start_y}) -> ({end_x}, {end_y})")

        return self.swipe_by_coordinates(start_x, start_y, end_x, end_y, duration)

    def long_press(self, element: Optional[WebElement] = None, x: Optional[int] = None, y: Optional[int] = None,
                   duration: int = 2000) -> 'CoreDriver':
        """
        长按封装：支持传入元素或坐标。
        如果传入 element，则计算其中心点坐标进行长按。
        如果传入 x, y，则直接在坐标处长按。

        :param element: 目标元素 (WebElement)，可选。
        :param x: 绝对坐标 X，可选。
        :param y: 绝对坐标 Y，可选。
        :param duration: 长按持续时间 (ms)，默认 2000ms。
        :return: self
        :raises ValueError: 如果既未传入 element 也未传入坐标 (x, y)。
        """
        if element:
            rect = element.rect
            x = rect['x'] + rect['width'] // 2
            y = rect['y'] + rect['height'] // 2

        if x is None or y is None:
            raise ValueError("Long press requires an element or (x, y) coordinates.")

        # 复用 swipe_by_coordinates，当起点和终点一致时，即为长按效果。
        # 逻辑：Move -> Down -> Pause -> Move(原地) -> Release
        return self.swipe_by_coordinates(x, y, x, y, duration)

    def drag_and_drop(self, source_el: WebElement, target_el: WebElement, duration: int = 1000) -> 'CoreDriver':
        """
        将 source_el 拖拽到 target_el。
        计算两个元素的中心点，执行从源元素中心到目标元素中心的拖拽操作。

        :param source_el: 源元素 (WebElement)。
        :param target_el: 目标元素 (WebElement)。
        :param duration: 拖拽过程持续时间 (ms)，默认 1000ms。
        :return: self
        """
        s_rect = source_el.rect
        t_rect = target_el.rect

        sx, sy = s_rect['x'] + s_rect['width'] // 2, s_rect['y'] + s_rect['height'] // 2
        tx, ty = t_rect['x'] + t_rect['width'] // 2, t_rect['y'] + t_rect['height'] // 2

        logger.info(f"执行拖拽: ({sx}, {sy}) -> ({tx}, {ty})")
        return self.swipe_by_coordinates(sx, sy, tx, ty, duration)

    def smart_scroll(self, element: WebElement, direction: str = "down") -> 'CoreDriver':
        """
        智能滚动：自动识别平台并调用最稳定的原生滚动脚本
        :param element: 需要滚动的容器元素 (如 ScrollView, RecyclerView, TableView)
        :param direction: 滚动方向 'up', 'down', 'left', 'right'
        :return: self
        """
        platform = self.driver.capabilities.get('platformName', '').lower()
        match platform:
            case AppPlatform.ANDROID.value:
                # Android UiAutomator2 专用滚动手势
                self.driver.execute_script('mobile: scrollGesture', {
                    'elementId': element.id,
                    'direction': direction,
                    'percent': 1.0
                })
            case AppPlatform.IOS.value:
                # iOS XCUITest 专用滚动 (默认为 iOS 处理)
                self.driver.execute_script("mobile: scroll", {
                    "elementId": element.id,
                    "direction": direction
                })

        return self

    def swipe_by_percent(self, start_xp: float, start_yp: float, end_xp: float, end_yp: float,
                         duration: int = 1000) -> 'CoreDriver':
        """
        按屏幕比例滑动。
        坐标值为屏幕宽高的百分比 (0.0 - 1.0)。

        :param start_xp: 起点 X 比例 (如 0.5)。
        :param start_yp: 起点 Y 比例 (如 0.8)。
        :param end_xp: 终点 X 比例 (如 0.5)。
        :param end_yp: 终点 Y 比例 (如 0.2)。
        :param duration: 滑动持续时间 (ms)，默认 1000ms。
        :return: self
        """
        size = self.driver.get_window_size()
        w, h = size['width'], size['height']

        return self.swipe_by_coordinates(
            int(w * start_xp),
            int(h * start_yp),
            int(w * end_xp),
            int(h * end_yp),
            duration
        )

    # --- 上下文切换 (Context Switch) ---
    def switch_to_context(self, context_name: str) -> 'CoreDriver':
        """
        切换到指定的上下文 (Context)。
        :param context_name: 上下文名称 (如 'NATIVE_APP', 'WEBVIEW_com.example.app')
        :return: self
        """
        logger.info(f"尝试切换到上下文: {context_name}")
        try:
            self.driver.switch_to.context(context_name)
            logger.info(f"成功切换到上下文: {context_name}")
        except Exception as e:
            logger.error(f"切换上下文失败: {e}")
            available_contexts = self.driver.contexts
            logger.info(f"当前可用上下文: {available_contexts}")
            raise e
        return self

    def switch_to_webview(self) -> 'CoreDriver':
        """
        自动切换到第一个可用的 WebView 上下文。
        :return: self
        """
        logger.info("尝试自动切换到 WebView 上下文...")
        contexts = self.driver.contexts
        for context in contexts:
            if 'WEBVIEW' in context:
                return self.switch_to_context(context)

        logger.warning("未找到 WebView 上下文，保持在当前上下文。")
        return self

    def switch_to_native(self) -> 'CoreDriver':
        """
        切换回原生应用上下文 (NATIVE_APP)。
        :return: self
        """
        return self.switch_to_context('NATIVE_APP')
    def full_screen_screenshot(self, name: str | None = None) -> str:
        """
        截取当前完整屏幕内容 (自愈逻辑、异常报错首选)
        :param name: 图片文件名
        :return: 截图保存的路径
        """
        file_name = f"{name or secrets.token_hex(8)}.png"
        path = (SCREENSHOT_DIR / file_name).as_posix()

        try:
            # 核心：save_screenshot 是底层原生方法，不依赖任何元素定位
            self.driver.save_screenshot(path)
            logger.info(f"全屏截图已保存: {path}")
            return path
        except Exception as e:
            logger.error(f"全屏截图失败: {e}")
            return ""

    def element_screenshot(self, by: str, value: str, name: str | None = None) -> str:
        """
        截取特定元素的图像 (业务校验、UI对比首选)
        :param by: 定位策略
        :param value: 定位值
        :param name: 图片文件名
        :return: 截图保存的路径
        """
        file_name = f"{name or secrets.token_hex(8)}.png"
        path = (SCREENSHOT_DIR / file_name).as_posix()

        try:
            by = by_converter(by)
            # 核心：直接调用底层 find_element，
            self.driver.find_element(by, value).screenshot(path)
            logger.info(f"元素截图已保存: {path}")
            return path
        except Exception as e:
            logger.error(f"元素截图失败: {e}")
            return ""

    @property
    def is_alive(self) -> bool:
        """判断当前驱动会话是否仍然存活。"""
        return self.driver is not None and self.driver.session_id is not None

    def quit(self):
        """安全关闭 Appium 驱动并断开连接。"""
        if self.driver:
            try:
                # 获取 session_id 用于日志追踪
                sid = self.session_id
                self.driver.quit()
                logger.info(f"已安全断开连接 (Session: {sid})")
            except Exception as e:
                logger.warning(f"断开连接时发生异常 (可能服务已预先关闭): {e}")
            finally:
                self.driver = None
        else:
            logger.debug("没有正在运行的 Driver 实例需要关闭。")