applib-ui 0.0.1__py3-none-any.whl

applib_ui/core/android/recorder.py

@@ -0,0 +1,171 @@
+"""
+基于本机 scrcpy 命令行的安卓录屏。
+"""
+import os
+import shutil
+import signal
+import subprocess
+import tempfile
+import time
+
+import allure
+
+from applib_ui.utils.log import logger
+
+
+def _find_scrcpy():
+    path = shutil.which("scrcpy")
+    if path:
+        return path
+    for candidate in ("/opt/homebrew/bin/scrcpy", "/usr/local/bin/scrcpy"):
+        if os.path.isfile(candidate):
+            return candidate
+    return None
+
+
+class ScrcpyRecorder:
+    #: 启动失败后重启 scrcpy 的重试次数（adb 抖动、设备被占用等偶发问题）
+    START_RETRY = 2
+
+    def __init__(self, serial: str):
+        self.serial = serial
+        self.file_path = None
+        self.proc = None
+        self._log_file = None
+
+    def start(self, file_path: str, timeout: float = 10) -> bool:
+        """
+        启动录屏：等录屏文件真正开始写数据才算成功，失败会重启 scrcpy 重试
+        @param file_path: 输出文件
+        @param timeout: 单次等待"文件开始写入"的上限
+        @return: 是否成功启动；最终失败只记日志不抛异常（录屏是辅助能力，不该让功能用例失败）
+        """
+        scrcpy_bin = _find_scrcpy()
+        if not scrcpy_bin:
+            raise FileNotFoundError(
+                "未找到 scrcpy，请先执行: brew install scrcpy"
+            )
+
+        self.file_path = file_path
+        base_cmd = [
+            scrcpy_bin,
+            "-s", self.serial,
+            "--record", file_path,
+            "--no-playback",
+            "--no-audio",
+        ]
+        last_error = ""
+        for attempt in range(1, self.START_RETRY + 1):
+            logger.info(f"开始录屏({attempt}/{self.START_RETRY}): {file_path}")
+            # 每次重试前清掉上一次的残留文件，否则"文件非空"的判断会被旧文件骗过去
+            if os.path.exists(file_path):
+                os.remove(file_path)
+            try:
+                self._launch(base_cmd, timeout)
+                logger.info(f"录屏已开始: {file_path}")
+                return True
+            except RuntimeError as e:
+                last_error = str(e)
+                logger.warning(f"第 {attempt}/{self.START_RETRY} 次启动录屏失败：{last_error}")
+                # 清掉半死的进程，避免多个 scrcpy 抢同一个设备
+                self._terminate(timeout=5)
+                if attempt < self.START_RETRY:
+                    time.sleep(0.5)
+
+        logger.error(f"scrcpy 录屏没起来，本次不会生成录屏文件：{last_error}")
+        return False
+
+    def _launch(self, base_cmd, timeout: float):
+        """起 scrcpy 并等它真的开始写文件（含 --no-window 不被支持时的回退）"""
+        self.proc = self._popen(base_cmd + ["--no-window"])
+        time.sleep(0.3)
+        if self.proc.poll() is not None:
+            log = self._read_log()
+            if "unknown" in log.lower() or "unrecognized" in log.lower():
+                logger.warning("当前 scrcpy 不支持 --no-window，回退后再启动")
+                self.proc = self._popen(base_cmd)
+            else:
+                raise RuntimeError(f"scrcpy 启动失败: {log}")
+
+        deadline = time.time() + timeout
+        while time.time() < deadline:
+            if self.proc.poll() is not None:
+                raise RuntimeError(f"scrcpy 启动失败: {self._read_log()}")
+            if os.path.exists(self.file_path) and os.path.getsize(self.file_path) > 0:
+                return
+            time.sleep(0.2)
+        raise RuntimeError(f"等待录屏文件写入超时({timeout}s)")
+
+    def _popen(self, cmd):
+        self._close_log()
+        self._log_file = tempfile.TemporaryFile()
+        return subprocess.Popen(
+            cmd,
+            stdin=subprocess.DEVNULL,
+            stdout=self._log_file,
+            stderr=subprocess.STDOUT,
+            start_new_session=True,
+        )
+
+    def _read_log(self):
+        if self._log_file is None:
+            return ""
+        self._log_file.seek(0)
+        return self._log_file.read().decode("utf-8", errors="ignore").strip()
+
+    def _close_log(self):
+        if self._log_file is not None:
+            self._log_file.close()
+            self._log_file = None
+
+    def _signal_group(self, sig):
+        if self.proc is None:
+            return
+        try:
+            os.killpg(self.proc.pid, sig)
+        except ProcessLookupError:
+            pass
+
+    def _terminate(self, timeout: float = 15):
+        """SIGINT → SIGTERM → SIGKILL，逐级结束 scrcpy 进程组"""
+        if self.proc is None or self.proc.poll() is not None:
+            return
+        self._signal_group(signal.SIGINT)
+        try:
+            self.proc.wait(timeout=timeout)
+            return
+        except subprocess.TimeoutExpired:
+            logger.warning("scrcpy SIGINT 未退出，尝试 SIGTERM")
+        self._signal_group(signal.SIGTERM)
+        try:
+            self.proc.wait(timeout=5)
+            return
+        except subprocess.TimeoutExpired:
+            logger.error("scrcpy 停止超时，强制结束进程")
+        self._signal_group(signal.SIGKILL)
+        try:
+            self.proc.wait(timeout=5)
+        except subprocess.TimeoutExpired:
+            pass
+
+    def stop(self):
+        self._terminate(timeout=15)
+        if self.proc is not None and self.proc.poll() not in (0, None, -signal.SIGINT, -signal.SIGTERM):
+            logger.error(f"scrcpy 退出异常(returncode={self.proc.returncode}): {self._read_log()}")
+        # 关掉日志前留一份，便于定位"为什么没录上"
+        scrcpy_log = self._read_log()
+        self.proc = None
+        self._close_log()
+
+        if self.file_path and os.path.exists(self.file_path) and os.path.getsize(self.file_path) > 0:
+            logger.info(f"录屏保存至: {self.file_path}")
+            logger.info("录屏上传allure报告")
+            allure.attach.file(
+                self.file_path,
+                attachment_type=allure.attachment_type.MP4,
+                name=self.file_path,
+            )
+            return self.file_path
+
+        logger.error("录屏文件为空或不存在" + (f"；scrcpy 日志: {scrcpy_log[-300:]}" if scrcpy_log else ""))
+        return None

applib_ui/core/android/remote_adb.py

@@ -0,0 +1,69 @@
+import requests
+
+from applib_ui.utils.common import get_free_port
+
+
+class RemoteAdbInit:
+    """
+    远端adb连接初始化
+    """
+
+    def __init__(self, serial: str, sonic_host: str, sonic_user: str, sonic_pwd: str):
+        self.serial = serial
+        self.host = sonic_host
+        # 登录获取登录态请求头
+        print('sonic登录，获取token')
+        body = {"userName": sonic_user, "password": sonic_pwd}
+        res = requests.post(self.host + '/server/api/controller/users/login', json=body)
+        print(res.text)
+        token = res.json()['data']
+        self.headers = {
+            'sonictoken': token
+        }
+
+    def occupy_device(self):
+        print('占用设备')
+        try:
+            body = {
+                "udId": self.serial,
+                "sasRemotePort": get_free_port(),
+            }
+            res = requests.post(self.host + '/server/api/controller/devices/occupy', json=body, headers=self.headers)
+            print(res.text)
+            res_json = res.json()
+            data = res_json['data']
+            print(data)
+            # uia2 = data['uia2']
+            sas = data['sas']
+            adb_server = sas.split()[-1]
+            return adb_server
+        except Exception as e:
+            print(f'设备占用失败: \n + {str(e)}')
+
+    def release_device(self):
+        print('释放设备')
+        try:
+            query = {'udId': self.serial}
+            res = requests.get(self.host + '/server/api/controller/devices/release', params=query, headers=self.headers)
+            print(res.json())
+        except Exception as e:
+            print(f'设备释放失败：\n + {str(e)}')
+
+    def delete_offline_device(self):
+        print('删除离线设备')
+        try:
+            # 查询离线设备
+            res = requests.get(f'{self.host}/server/api/controller/devices/list?page=1&pageSize=12&status%5B%5D=DISCONNECTED', headers=self.headers)
+            print(res.text)
+            res_json = res.json()
+            device_list = res_json['data']['content']
+            # 删除离线设备
+            for device in device_list:
+                device_id = device['id']
+                res = requests.delete(f'{self.host}/server/api/controller/devices?id={device_id}', headers=self.headers)
+                print(res.text)
+        except Exception as e:
+            print(f"删除设备失败: {str(e)}")
+
+
+

applib_ui/core/android/remote_driver.py

@@ -0,0 +1,176 @@
+import allure
+import time
+import uiautomator2 as u2
+
+from adbutils import adb
+from .remote_adb import RemoteAdbInit
+from applib_ui.utils.log import logger
+from applib_ui.utils.common import general_file_path
+
+
+class RemoteDriver:
+    """
+    https://github.com/openatx/adbutils
+    """
+
+    def __init__(
+            self,
+            serial: str,
+            sonic_host: str,
+            sonic_user: str,
+            sonic_pwd: str,
+            package: str = None
+    ):
+        """
+        @param serial: 通过adb devices或者关于手机-序列号获取
+        @param package: 通过adb shell pm list packages获取
+        """
+        logger.info(f'初始化远端设备连接: {serial}')
+        self.serial = serial
+        print('获取adb连接ip:port')
+        self.remote_adb = RemoteAdbInit(serial, sonic_host, sonic_user, sonic_pwd)
+        self.adb_server = self.remote_adb.occupy_device()
+        print(self.adb_server)
+        self.package = package
+        print('连接远端adb服务')
+        count = 15
+        while count > 0:
+            output = adb.connect(self.adb_server)
+            print(output)
+            if 'connected' in output:
+                logger.info('adb服务已就绪')
+                break
+            else:
+                logger.info('adb服务未就绪，1s后重试！')
+                time.sleep(1)
+        else:
+            # 释放设备
+            self.remote_adb.release_device()
+            raise KeyError('adb服务连接超时！')
+
+        device = adb.device(self.adb_server)
+        self.d = u2.connect(device)
+
+    def close(self):
+        print('释放远端设备连接')
+        # 释放设备
+        self.remote_adb.release_device()
+        # 断开adb连接
+        output = adb.disconnect(self.adb_server)
+        print(output)
+        # 等待3s
+        time.sleep(3)
+        # 删除设备
+        self.remote_adb.delete_offline_device()
+
+    def uninstall_app(self, package: str = None):
+        """
+        卸载应用
+        @return:
+        """
+        if self.package is None:
+            if package is None:
+                raise KeyError('package不能为空')
+            else:
+                self.d.app_uninstall(package)
+        else:
+            self.d.app_uninstall(self.package)
+
+    def install_app(self, apk_url: str, package: str = None):
+        """
+        安装应用
+        @return:
+        """
+        if self.package is None:
+            if package is None:
+                raise KeyError('package不能为空')
+            else:
+                self.d.app_install(package)
+        else:
+            self.d.app_install(self.package)
+        self.d.app_install(apk_url)
+
+    def start_app(self, package: str = None):
+        """
+        启动应用
+        @return:
+        """
+        if self.package is None:
+            if package is None:
+                raise KeyError('package不能为空')
+            else:
+                self.d.app_start(package)
+        else:
+            self.d.app_start(self.package)
+
+    def stop_app(self, package: str = None):
+        """
+        停止应用
+        @return:
+        """
+        if self.package is None:
+            if package is None:
+                raise KeyError('package不能为空')
+            else:
+                self.d.app_stop(package)
+        else:
+            self.d.app_stop(self.package)
+
+    def shot(self, file_name=None):
+        """
+        截图
+        @param file_name:
+        @return:
+        """
+        file_path = general_file_path(file_name, self.serial)
+        logger.info(f"截图保存至: {file_path}")
+        self.d.screenshot(file_path)
+
+        logger.info("截图上传allure报告")
+        allure.attach.file(
+            file_path,
+            attachment_type=allure.attachment_type.PNG,
+            name=f"{file_path}",
+        )
+        return file_path
+
+    def click(self, x, y):
+        """
+        点击坐标
+        @param x:
+        @param y:
+        @return:
+        """
+        self.d.click(x, y)
+
+    def input(self, *args, **kwargs):
+        """
+        输入
+        @param args:
+        @param kwargs:
+        @return:
+        """
+        self.d.send_keys(*args, **kwargs)
+
+    def shell(self, *args, **kwargs):
+        """
+        执行adb shell
+        @param args:
+        @param kwargs:
+        @return:
+        """
+        self.d.shell(*args, **kwargs)
+
+    def unlock(self):
+        """
+        解锁设备
+        @return:
+        """
+        self.shell("input keyevent WAKEUP")
+        self.d.swipe(0.1, 0.9, 0.9, 0.1)
+
+
+
+
+
+

applib_ui/core/img/__init__.py

@@ -0,0 +1,4 @@
+from .element import ImgElem
+
+
+__all__ = ["ImgElem"]

applib_ui/core/img/driver.py

@@ -0,0 +1,43 @@
+# 'pip install opencv-python==4.6.0.66'
+import os
+import cv2
+import numpy as np
+
+
+class ImageDiscern:
+    def __init__(self, target_image, source_image, grade=0.8, gauss_num=111) -> None:
+        """__init__ [处理图片识别]
+        Args:
+            target_image (str): 被识别的目标图片
+            grade (float, optional): 分数. Defaults to 0.8.
+            gauss_num (int, optional): 过滤值. Defaults to 111.
+        """
+        self.source_image = source_image
+        self.target_image = target_image
+        if not os.path.exists(self.source_image):
+            raise FileNotFoundError(f"文件: {self.source_image} 不存在")
+        if not os.path.exists(self.target_image):
+            raise FileNotFoundError(f"文件: {self.target_image} 不存在")
+
+        self.grade = grade
+        self.gauss_num = gauss_num
+
+    # 降噪处理（高斯滤波）
+    def __coordinate(self, image):
+        return cv2.GaussianBlur(image, (self.gauss_num, self.gauss_num), 0)
+
+    # 获取坐标图片坐标
+    def get_coordinate(self):
+        # 这里不用imread，解决中文目录无法读取的问题
+        screen = cv2.imdecode(np.fromfile(self.source_image, dtype=np.uint8), 1)
+        target = cv2.imdecode(np.fromfile(self.target_image, dtype=np.uint8), 1)
+        result = cv2.matchTemplate(self.__coordinate(screen),
+                                   self.__coordinate(target),
+                                   cv2.TM_CCOEFF_NORMED)
+        min, max, min_loc, max_loc = cv2.minMaxLoc(result)
+        if max <= self.grade:
+            return None
+        else:
+            x = max_loc[0] + int(target.shape[1] / 2)
+            y = max_loc[1] + int(target.shape[0] / 2)
+            return (x, y)

applib_ui/core/img/element.py

@@ -0,0 +1,73 @@
+# 'pip install opencv-python==4.6.0.66'
+import time
+
+from .driver import ImageDiscern
+from applib_ui.utils.log import logger
+
+
+class ImgElem(object):
+    """图像识别定位"""
+
+    def __init__(self, driver=None, file: str = None):
+        """
+
+        @param driver: 设备驱动
+        @param file: 图片文件路径
+        """
+        self.driver = driver
+        self.target_image = file
+        # if hasattr(self.driver, 'scale') is True:
+        #     self.scale = self.driver.scale
+        # else:
+        #     self.scale = None
+
+    def __get__(self, instance, owner):
+        if instance is None:
+            return None
+
+        self.driver = instance.driver
+        return self
+
+    def wait(self, timeout=1):
+        logger.info(f'图像识别判断: {self.target_image} 是否存在')
+        time.sleep(timeout)
+        source_image = self.driver.shot("图像识别中")
+        res = ImageDiscern(self.target_image, source_image).get_coordinate()
+        logger.debug(res)
+        # logger.error(self.scale)
+        # logger.error(self.driver.d.scale)
+        # logger.error(self.driver.d.screen_info())
+        if isinstance(res, tuple):
+            x, y = res[0], res[1]
+            try:
+                scale = self.driver.d.scale
+            except:
+                scale = None
+            if scale is not None:
+                """iphone的scale是3"""
+                x, y = int(x / scale), int(y / scale)
+            return x, y
+        else:
+            return False
+
+    def click_exists(self, timeout=3):
+        logger.info(f'图像如果存在则点击: {self.target_image}')
+        res = self.wait(timeout=timeout)
+        if res is not False:
+            self.driver.click(*res)
+            # logger.info(f"点击({res})")
+        else:
+            logger.info("图像不存在，不进行点击")
+
+    def click(self, retry=3, timeout=3):
+        logger.info(f'图像识别点击: {self.target_image}')
+        for i in range(retry):
+            logger.info(f'第{i + 1}次查找:')
+            res = self.wait(timeout=timeout)
+            if res is not False:
+                self.driver.click(*res)
+                logger.info(f"点击{res}")
+                break
+        else:
+            self.driver.shot(f'图像识别定位失败')
+            raise Exception('未识别到图片，无法进行点击')

applib_ui/core/ios/__init__.py

@@ -0,0 +1,16 @@
+"""ios 平台接口，按需加载驱动依赖。"""
+
+from importlib import import_module
+
+__all__ = ['Elem', 'Page', 'Driver', 'RemoteDriver', 'TestCase']
+
+_MODULES = {'Elem': 'elem', 'Page': 'page', 'Driver': 'driver',
+            'RemoteDriver': 'remote_driver', 'TestCase': 'case'}
+
+
+def __getattr__(name):
+    if name not in _MODULES:
+        raise AttributeError(f'module {__name__!r} has no attribute {name!r}')
+    value = getattr(import_module(f'.{_MODULES[name]}', __name__), name)
+    globals()[name] = value
+    return value

applib_ui/core/ios/case.py

@@ -0,0 +1,8 @@
+from ...case import TestCase as BaseTestCase
+
+
+class TestCase(BaseTestCase):
+    """iOS pytest 测试基类。"""
+
+    _platform = 'ios'
+