devhelmkit 0.1.0__py3-none-any.whl

devhelmkit/harmony/webview/chromedriver_manager.py

@@ -0,0 +1,251 @@
+# !/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""chromedriver 进程管理：启动、停止、版本匹配。
+
+chromedriver 是 selenium webdriver 与 webview 之间的桥梁。
+本模块负责：
+  1. 按平台选择正确的二进制文件名（chromedriver.exe / chromedriver / chromedriver.mac）
+  2. 按设备 webview 版本匹配 chromedriver 版本
+  3. 启动 chromedriver 进程并监听指定端口
+  4. 版本不匹配时停止旧进程并重启
+  5. 资源释放时停止 chromedriver 进程
+
+chromedriver 二进制需用户自行下载放置于 search_path 目录下：
+    search_path/
+    ├── chromedriver_114/
+    │   ├── chromedriver.exe      # Windows
+    │   ├── chromedriver          # Linux
+    │   └── chromedriver.mac      # macOS
+    └── chromedriver_132/
+        ├── chromedriver.exe
+        ├── chromedriver
+        └── chromedriver.mac
+"""
+import json
+import os
+import platform
+import stat
+import subprocess
+import time
+import urllib.request
+from typing import Optional
+
+from devhelmkit.exceptions import DevhelmError
+from devhelmkit.utils import logger
+
+# chromedriver 默认监听端口
+DEFAULT_CHROMEDRIVER_PORT = 9515
+
+# chromedriver 日志级别环境变量名
+CHROME_DRIVER_LOG_LEVEL_ENV = "CHROME_DRIVER_LOG_LEVEL"
+
+# 进程状态检查重试次数
+KILL_RETRY = 3
+
+# kill 后等待时间（秒）
+KILL_WAIT = 1.0
+
+
+class ChromedriverManager:
+    """chromedriver 进程生命周期管理。"""
+
+    def __init__(self, search_path: str = "",
+                 exe_path: str = "",
+                 port: int = DEFAULT_CHROMEDRIVER_PORT):
+        """
+        Args:
+            search_path: chromedriver 存放目录（多版本目录结构）
+            exe_path: 直接指定 chromedriver 可执行文件路径（优先于 search_path）
+            port: chromedriver 监听端口
+        """
+        self._search_path = search_path
+        self._exe_path = exe_path
+        self._port = port
+        self._process: Optional[subprocess.Popen] = None
+        self._log_path = ""
+
+    @property
+    def host(self) -> str:
+        """chromedriver 访问地址。"""
+        return "http://localhost:%d" % self._port
+
+    @property
+    def port(self) -> int:
+        return self._port
+
+    def set_exe_path(self, path: str) -> None:
+        """直接指定 chromedriver 可执行文件路径。"""
+        self._exe_path = path
+
+    def set_search_path(self, path: str) -> None:
+        """设置 chromedriver 存放目录。"""
+        self._search_path = path
+
+    def start(self, webview_version: int) -> None:
+        """启动与 webview 版本匹配的 chromedriver。
+
+        若已有 chromedriver 运行且版本匹配则复用；
+        版本不匹配则停止旧进程后重启。
+
+        Args:
+            webview_version: 设备端 webview 内核版本号（如 114）
+
+        Raises:
+            DevhelmError: chromedriver 未找到或启动失败
+        """
+        chrome_path = self._resolve_path(webview_version)
+        if self._is_running():
+            current_version = self._get_version()
+            if current_version < webview_version:
+                logger.info(
+                    "chromedriver 版本 %d 低于 webview 版本 %d，重启",
+                    current_version, webview_version
+                )
+                self.stop()
+                time.sleep(KILL_WAIT)
+                self._start_process(chrome_path)
+            else:
+                logger.debug("chromedriver 已运行，版本 %d，复用", current_version)
+        else:
+            self._start_process(chrome_path)
+
+    def stop(self) -> None:
+        """停止 chromedriver 进程。"""
+        if self._process is not None:
+            try:
+                self._process.terminate()
+                self._process.wait(timeout=5)
+            except subprocess.TimeoutExpired:
+                self._process.kill()
+                self._process.wait(timeout=3)
+            except Exception as e:
+                logger.warn("停止 chromedriver 进程异常: %s", e)
+            finally:
+                self._process = None
+            return
+
+        # 进程非本实例启动（残留），按名称 kill
+        proc_name = self._get_process_name()
+        for _ in range(KILL_RETRY):
+            self._kill_by_name(proc_name)
+            time.sleep(KILL_WAIT)
+            if not self._is_running_by_name(proc_name):
+                return
+        logger.warn("未能停止 chromedriver 进程")
+
+    def _resolve_path(self, version: int) -> str:
+        """解析 chromedriver 可执行文件路径。
+
+        优先级：exe_path > search_path/chromedriver_{version}/{name} > 内置
+        """
+        proc_name = self._get_process_name()
+        if self._exe_path:
+            path = self._exe_path
+        elif self._search_path:
+            path = os.path.join(
+                self._search_path, "chromedriver_%d" % version, proc_name
+            )
+        else:
+            raise DevhelmError(
+                "未配置 chromedriver 路径，请通过 set_exe_path 或 set_search_path 设置"
+            )
+
+        if not os.path.isfile(path):
+            raise DevhelmError("chromedriver 不存在: %s" % path)
+        return path
+
+    def _start_process(self, chrome_path: str) -> None:
+        """启动 chromedriver 子进程。"""
+        if not _is_windows():
+            os.chmod(chrome_path, stat.S_IRWXU)
+
+        log_path = os.path.join(
+            _get_temp_dir(), "chromedriver.log"
+        )
+        log_level = os.getenv(CHROME_DRIVER_LOG_LEVEL_ENV, "info")
+        cmd = [
+            chrome_path,
+            "--log-level=%s" % log_level,
+            "--log-path=%s" % log_path,
+            "--port=%d" % self._port,
+        ]
+        self._log_path = log_path
+        logger.info("启动 chromedriver: %s", " ".join(cmd))
+        self._process = subprocess.Popen(cmd)
+
+    def _is_running(self) -> bool:
+        """检查 chromedriver 是否在运行（通过 HTTP /status）。"""
+        try:
+            urllib.request.urlopen(
+                self.host + "/status", timeout=2
+            ).read()
+            return True
+        except Exception:
+            return False
+
+    def _is_running_by_name(self, name: str) -> bool:
+        """通过进程名检查是否运行。"""
+        if _is_windows():
+            try:
+                result = subprocess.run(
+                    ["tasklist"],
+                    capture_output=True, text=True, timeout=10
+                )
+                return name in result.stdout
+            except Exception:
+                return False
+        else:
+            try:
+                result = subprocess.run(
+                    ["pgrep", "-f", name],
+                    capture_output=True, text=True, timeout=10
+                )
+                return bool(result.stdout.strip())
+            except Exception:
+                return False
+
+    def _kill_by_name(self, name: str) -> None:
+        """按进程名 kill。"""
+        if _is_windows():
+            subprocess.run(["taskkill", "/F", "/IM", name],
+                          capture_output=True, timeout=10)
+        else:
+            subprocess.run(["pkill", "-f", name],
+                          capture_output=True, timeout=10)
+
+    def _get_version(self) -> int:
+        """查询运行中 chromedriver 的版本号。"""
+        for _ in range(3):
+            try:
+                resp = urllib.request.urlopen(
+                    self.host + "/status", timeout=5
+                ).read().decode("utf-8", errors="ignore")
+                match = __import__("re").search(r'"version":"(\d+)\.', resp)
+                if match:
+                    return int(match.group(1))
+            except Exception as e:
+                logger.debug("查询 chromedriver 版本失败: %s", e)
+        return 0
+
+    @staticmethod
+    def _get_process_name() -> str:
+        """获取当前平台的 chromedriver 进程名。"""
+        if _is_windows():
+            return "chromedriver.exe"
+        elif _is_mac():
+            return "chromedriver.mac"
+        else:
+            return "chromedriver"
+
+
+def _is_windows() -> bool:
+    return platform.system() == "Windows"
+
+
+def _is_mac() -> bool:
+    return platform.system() == "Darwin"
+
+
+def _get_temp_dir() -> str:
+    """获取系统临时目录。"""
+    return os.environ.get("TEMP") or os.environ.get("TMP") or "/tmp"

devhelmkit/harmony/webview/devtools_finder.py

@@ -0,0 +1,131 @@
+# !/usr/bin/env python
+# -*- coding: utf-8 -*-
+"""devtools 端口探测：定位设备端 webview 调试端口。
+
+HarmonyOS webview 调试端口有两种形态：
+  1. domain socket：webview_devtools_remote_{pid}（系统 web 内核，默认）
+  2. tcp 端口：9222 等（自定义 web 内核，需应用主动开启）
+
+探测流程：
+  1. 读取 /proc/net/unix 判断是否使用 domain socket
+  2. 通过 ps -ef | grep {bundle_name} 获取应用 PID
+  3. 在 /proc/net/unix 中匹配包含该 PID 的 devtools socket 名
+"""
+import re
+import time
+from typing import List, Optional
+
+from devhelmkit.harmony.device.hdc import HdcDevice
+from devhelmkit.utils import logger
+
+# domain socket 名称前缀
+DOMAIN_SOCKET_PREFIX = "webview_devtools_remote_"
+
+# 默认探测超时（秒）
+DEFAULT_STARTUP_TIMEOUT = 8
+
+# 轮询间隔（秒）
+POLL_INTERVAL = 0.8
+
+
+class DevtoolsFinder:
+    """设备端 webview devtools 端口探测。"""
+
+    def __init__(self, device: HdcDevice):
+        self._device = device
+
+    def is_using_domain_socket(self, timeout: float = DEFAULT_STARTUP_TIMEOUT) -> bool:
+        """检查设备是否使用 domain socket 形式的 devtools。
+
+        Args:
+            timeout: 探测超时（秒），轮询直到发现或超时
+
+        Returns:
+            True 表示使用 domain socket，False 表示需用 tcp 端口
+        """
+        deadline = time.time() + timeout
+        while time.time() < deadline:
+            result = self._device.shell(
+                "cat /proc/net/unix | grep %s" % DOMAIN_SOCKET_PREFIX
+            )
+            if DOMAIN_SOCKET_PREFIX in result:
+                return True
+            time.sleep(POLL_INTERVAL)
+        return False
+
+    def find_devtools_socket(self, bundle_name: str,
+                             timeout: float = DEFAULT_STARTUP_TIMEOUT) -> Optional[str]:
+        """查找指定应用的 devtools domain socket 名称。
+
+        通过应用 PID 与 /proc/net/unix 中的 devtools socket 匹配。
+
+        Args:
+            bundle_name: 应用包名
+            timeout: 探测超时（秒）
+
+        Returns:
+            socket 名称（如 webview_devtools_remote_12345），未找到返回 None
+        """
+        deadline = time.time() + timeout
+        while time.time() < deadline:
+            devtools_sockets = self._get_devtools_sockets()
+            if not devtools_sockets:
+                time.sleep(POLL_INTERVAL)
+                continue
+
+            process_pids = self._get_bundle_pids(bundle_name)
+            if not process_pids:
+                time.sleep(POLL_INTERVAL)
+                continue
+
+            # 匹配 PID 与 socket 名称
+            for socket_name in devtools_sockets:
+                for pid in process_pids:
+                    if pid in socket_name:
+                        logger.debug(
+                            "找到 devtools socket: %s (pid=%s, bundle=%s)",
+                            socket_name, pid, bundle_name
+                        )
+                        return socket_name
+            time.sleep(POLL_INTERVAL)
+        return None
+
+    def check_tcp_port(self, port: int) -> bool:
+        """检查设备端 tcp devtools 端口是否开放。
+
+        Args:
+            port: 设备端 tcp 端口号
+
+        Returns:
+            True 表示端口已开放
+        """
+        result = self._device.shell("netstat -tlnp | grep :%d" % port)
+        return str(port) in result
+
+    def _get_devtools_sockets(self) -> List[str]:
+        """读取 /proc/net/unix 中所有 devtools socket 名称。"""
+        result = self._device.shell("cat /proc/net/unix | grep devtools")
+        sockets = []
+        for line in result.split("\n"):
+            items = line.split()
+            if not items:
+                continue
+            # 最后一列为 socket 名称，去掉前导 @
+            name = items[-1].strip("@")
+            if name:
+                sockets.append(name)
+        return sockets
+
+    def _get_bundle_pids(self, bundle_name: str) -> List[str]:
+        """获取指定包名应用的所有进程 PID。"""
+        result = self._device.shell("ps -ef | grep %s" % bundle_name)
+        pids = []
+        for line in result.split("\n"):
+            items = line.split()
+            if len(items) < 8:
+                continue
+            pid = items[1]
+            actual_name = items[7]
+            if bundle_name in actual_name:
+                pids.append(pid)
+        return pids