""" 认证和浏览器相关 Fixture 模块(重构版) 提供 Playwright 浏览器自动化所需的认证状态管理和 Fixture。 使用 pytest fixture 生命周期管理替代全局变量,确保测试隔离性。 改进: - 移除全局变量,使用 fixture 生命周期管理 - 并行测试安全,无竞态条件 - 资源自动清理 """ from __future__ import annotations import os import sys import json from pathlib import Path sys.path.insert(0, os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) import pytest import httpx from playwright.sync_api import Page, BrowserContext, Browser, Playwright, sync_playwright from config.settings import config from tests.utils import APIClient from tests.logger import get_logger # 测试日志器 _test_logger = get_logger("TEST") # --------------------------------------------------------------------------- # 公共工具函数 # --------------------------------------------------------------------------- def _get_worker_index() -> int: """获取当前 xdist worker 的索引号(gw0→0, gw1→1, 非 xdist→0) 用于多 worker 并行测试时,每个 worker 获取独立索引, 配合测试数据隔离机制避免数据竞态。 Returns: int: worker 索引号,非 xdist 模式返回 0 """ worker_id = os.environ.get("PYTEST_XDIST_WORKER", "") if worker_id.startswith("gw"): try: return int(worker_id[2:]) except ValueError: pass return 0 # --------------------------------------------------------------------------- # 认证相关常量 # --------------------------------------------------------------------------- AUTH_STATE_FILE = Path(__file__).parent.parent / ".auth" / "state.json" _cached_auth_state = None _proxy_server = ( os.environ.get("all_proxy") or os.environ.get("HTTP_PROXY") or os.environ.get("http_proxy") or "" ) PROXY = {"server": _proxy_server} if _proxy_server else None # 使用配置管理中的 URL APP_URL = f"{config.BASE_URL}/d-cloud/workbench/list" SSO_WITH_REDIRECT = f"{config.SSO_URL}/?redirectUrl={APP_URL}" # SSO 登录超时与重试配置 _SSO_PAGE_TIMEOUT = 45000 # SSO 页面级超时(毫秒) _SSO_REDIRECT_RETRIES = 30 # 等 SSO 跳转到目标页面最大重试次数 _SSO_REDIRECT_INTERVAL = 500 # 每次重试间隔(毫秒) _SSO_TOKEN_RETRIES = 10 # 等 token 写入 localStorage 最大重试次数 _SSO_TOKEN_INTERVAL = 1000 # 每次 token 重试间隔(毫秒) _SSO_TYPE_DELAY = 30 # 模拟打字延迟(毫秒/字符) _SSO_INITIAL_WAIT = 1000 # 页面加载后初始等待(毫秒) def _read_auth_state() -> dict | None: """读取认证状态文件,返回解析后的 dict(带缓存)""" global _cached_auth_state if _cached_auth_state is not None: return _cached_auth_state if not AUTH_STATE_FILE.exists(): return None with open(AUTH_STATE_FILE) as f: _cached_auth_state = json.load(f) return _cached_auth_state def _invalidate_auth_cache(): """清除认证状态缓存(登录后调用)""" global _cached_auth_state _cached_auth_state = None def _auth_state_has_token() -> bool: """检查认证状态文件是否包含有效的 token 通过读取 .auth/state.json 文件,检查 localStorage 中是否存在 token。 Returns: bool: token 存在返回 True,否则返回 False """ state = _read_auth_state() if state is None: return False return any( any(item.get("name") == "token" for item in o.get("localStorage", [])) for o in state.get("origins", []) ) def _auth_state_is_valid() -> bool: """检查认证状态中的 token 是否仍被平台接受。""" token = _get_token_from_auth_state() if not token: return False try: response = httpx.get( f"{config.BASE_URL}/api/dcloudUserApi/user/userAndOrg", headers={"Authorization": token, "Accept": "application/json"}, timeout=10.0, proxy=_proxy_server or None, ) if response.status_code != 200: return False payload = response.json() message = str(payload.get("message", "")).lower() if payload.get("status") == 10002 or "token invalid" in message: return False return payload.get("success") is not False except Exception: return False def _get_token_from_auth_state() -> str | None: """从认证状态文件中提取 token 读取 .auth/state.json,遍历 origins 和 localStorage 获取 token 值。 Returns: str or None: token 值,不存在则返回 None """ state = _read_auth_state() if state is None: return None for origin in state.get("origins", []): for item in origin.get("localStorage", []): if item.get("name") == "token": return item.get("value") return None def get_or_create_auth_state(playwright: Playwright | None = None) -> None: """获取或创建认证状态 如果认证状态文件不存在或不包含有效 token,则启动浏览器执行 SSO 登录流程, 登录完成后保存认证状态到 .auth/state.json。 登录流程: 1. 启动 Chromium 浏览器(无头模式) 2. 跳转到 SSO 登录页面 3. 输入用户名和密码,点击登录 4. 等待跳转至目标页面并获取 token 5. 保存认证状态到文件 """ AUTH_STATE_FILE.parent.mkdir(exist_ok=True) def _login_with_playwright(p: Playwright) -> None: browser = p.chromium.launch(headless=True, slow_mo=0) context_opts = { "viewport": { "width": config.VIEWPORT_WIDTH, "height": config.VIEWPORT_HEIGHT, }, "locale": "zh-CN", } if PROXY: context_opts["proxy"] = PROXY context = browser.new_context(**context_opts) page = context.new_page() page.set_default_timeout(_SSO_PAGE_TIMEOUT) page.goto( SSO_WITH_REDIRECT, wait_until="domcontentloaded", timeout=_SSO_PAGE_TIMEOUT ) page.wait_for_timeout(_SSO_INITIAL_WAIT) account_input = page.locator('[placeholder="请输入账号"]') password_input = page.locator('[placeholder="请输入密码"]') account_input.click() account_input.type(config.TEST_USERNAME, delay=_SSO_TYPE_DELAY) password_input.click() password_input.type(config.TEST_PASSWORD, delay=_SSO_TYPE_DELAY) page.get_by_role("button", name="立即登录").click() for _ in range(_SSO_REDIRECT_RETRIES): page.wait_for_timeout(_SSO_REDIRECT_INTERVAL) if "cloud-fat.d-robotics.cc" in page.url: break for _ in range(_SSO_TOKEN_RETRIES): page.wait_for_timeout(_SSO_TOKEN_INTERVAL) try: token = page.evaluate('() => localStorage.getItem("token")') if token: break except Exception: continue context.storage_state(path=str(AUTH_STATE_FILE)) _invalidate_auth_cache() context.close() browser.close() if playwright is not None: _login_with_playwright(playwright) return with sync_playwright() as p: _login_with_playwright(p) # --------------------------------------------------------------------------- # Playwright Fixtures(重构版 - 无全局状态) # --------------------------------------------------------------------------- @pytest.fixture(scope="session") def playwright_instance(): """Playwright 实例 Fixture(Session 级别) 在测试会话开始时创建 Playwright 实例,会话结束后自动清理。 使用 yield 确保资源正确释放,无全局状态污染。 Yields: Playwright: Playwright 实例 """ p = sync_playwright().start() yield p p.stop() @pytest.fixture(scope="session") def browser(playwright_instance: Playwright) -> Browser: """浏览器实例 Fixture(Session 级别) 在测试会话期间维护单一浏览器实例,复用认证状态。 首次调用时检查认证状态,如不存在则自动创建。 Args: playwright_instance: Playwright 实例 Yields: Browser: 浏览器实例 """ if not _auth_state_has_token() or not _auth_state_is_valid(): get_or_create_auth_state(playwright_instance) browser = playwright_instance.chromium.launch( headless=config.HEADLESS, slow_mo=config.SLOW_MO ) yield browser browser.close() @pytest.fixture(scope="session") def browser_context(browser: Browser) -> BrowserContext: """浏览器上下文 Fixture(Session 级别) 在测试会话期间维护单一浏览器上下文,复用认证状态。 Args: browser: 浏览器实例 Yields: BrowserContext: 浏览器上下文对象 """ context_opts = { "storage_state": str(AUTH_STATE_FILE), "viewport": { "width": config.VIEWPORT_WIDTH, "height": config.VIEWPORT_HEIGHT, }, "locale": "zh-CN", } if PROXY and PROXY.get("server"): context_opts["proxy"] = PROXY context = browser.new_context(**context_opts) yield context context.close() @pytest.fixture(scope="class") def page(browser_context: BrowserContext) -> Page: """页面 Fixture(Class 级别) 为每个测试类创建独立的页面实例,测试结束后自动关闭。 Args: browser_context: 浏览器上下文 Yields: Page: 页面对象 """ page = browser_context.new_page() page.set_default_timeout(config.DEFAULT_TIMEOUT) yield page try: page.close() except Exception: pass @pytest.fixture(scope="class") def authenticated_page(page: Page) -> Page: """已认证页面 Fixture(Class 级别) 基于 page fixture 的别名,确保页面已通过认证。 主要用于语义化区分需要认证的测试场景。 Args: page: 页面对象 Yields: Page: 已认证的页面对象 """ yield page @pytest.fixture def api_client(authenticated_page: Page) -> APIClient: """API 客户端 Fixture(Function 级别) 创建 APIClient 实例并自动注入认证 token。 Token 优先级:页面 localStorage > 认证状态文件。 Args: authenticated_page: 已认证的页面对象 Returns: APIClient: 配置好认证信息的 API 客户端 """ client = APIClient.from_page(authenticated_page) if not client.headers.get("Authorization"): # 优先尝试从页面 localStorage 获取 token try: token = authenticated_page.evaluate('() => localStorage.getItem("token")') if token: client.headers["Authorization"] = token except Exception: pass # 降级方案:从认证状态文件加载 token if not client.headers.get("Authorization"): token = _get_token_from_auth_state() if token: client.headers["Authorization"] = token return client @pytest.fixture def standalone_api_client() -> APIClient: """独立 API 客户端 Fixture(Function 级别) 创建不依赖 Page 的独立 APIClient 实例。 从认证状态文件获取 token,不需要浏览器页面。 Returns: APIClient: 独立的 API 客户端 Raises: RuntimeError: 未找到有效 token """ # 提取 token if not _auth_state_is_valid(): get_or_create_auth_state() token = _get_token_from_auth_state() if not token: raise RuntimeError("No valid token found in auth state. Please run browser-based authentication first.") # 创建独立的 API 客户端 client = APIClient( base_url=config.BASE_URL, token=token, proxy_url=( os.environ.get("all_proxy") or os.environ.get("HTTP_PROXY") or os.environ.get("http_proxy") or "" ) ) return client # --------------------------------------------------------------------------- # 测试环境设置 # --------------------------------------------------------------------------- @pytest.fixture(autouse=True) def setup_screenshot_dir(): """截图和报告目录自动创建 Fixture 在每个测试运行前自动创建截图和报告目录,确保写入权限。 使用 autouse=True 确保无需显式声明即可生效。 """ os.makedirs(config.SCREENSHOT_DIR, exist_ok=True) os.makedirs(config.REPORT_DIR, exist_ok=True)