feat: 基于 UI 自动化最佳实践的测试框架骨架搭建
- tests/config: 环境配置 (.yaml) + 配置加载器 - tests/utils: 日志工具 + 测试数据生成器 - tests/web: Playwright conftest + Page Object 基类 + 登录页 + 导航栏组件 + 登录用例(6条) - tests/app: Appium conftest + Page Object 基类 + 司机端首页 + 登录用例(3条) - pytest.ini: markers(p0/p1/p2/smoke/web/app) + 运行配置 - 所有用例按最佳实践采用 Page Object 模式 + data-testid 优先定位 + 失败自动截图
This commit is contained in:
xst
@@ -0,0 +1,109 @@
|
||||
"""
|
||||
Web 端根级 fixture：浏览器实例 + 失败自动截图。
|
||||
|
||||
提供:
|
||||
browser_name — 参数化 fixture，每个浏览器执行一轮
|
||||
page — Playwright Page 对象（每个用例独立）
|
||||
login — 可复用的登录 helper
|
||||
|
||||
Usage:
|
||||
def test_something(page, browser_name):
|
||||
page.goto("/admin")
|
||||
...
|
||||
|
||||
def test_admin_flow(page, login):
|
||||
login("super_admin") # 以管理员身份登录
|
||||
...
|
||||
"""
|
||||
|
||||
from datetime import datetime
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
from playwright.sync_api import sync_playwright
|
||||
|
||||
# 截图根目录
|
||||
SCREENSHOTS_DIR = Path("output/screenshots")
|
||||
|
||||
|
||||
@pytest.fixture(scope="session")
|
||||
def web_config(config):
|
||||
"""session 级：Web 配置段。"""
|
||||
return config["web"]
|
||||
|
||||
|
||||
@pytest.fixture(params=["chromium", "firefox"])
|
||||
def browser_name(request):
|
||||
"""每个浏览器执行一次同一套用例。"""
|
||||
return request.param
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def page(web_config, browser_name, request):
|
||||
"""每个用例独立的 Playwright Page，失败自动截图。"""
|
||||
viewport = web_config.get("viewport", {"width": 1920, "height": 1080})
|
||||
timeout = web_config.get("timeout_seconds", 120) * 1000
|
||||
screenshot_on_failure = web_config.get("screenshot_on_failure", True)
|
||||
|
||||
with sync_playwright() as p:
|
||||
browser_launcher = getattr(p, browser_name)
|
||||
browser = browser_launcher.launch(headless=True)
|
||||
context = browser.new_context(
|
||||
viewport={"width": viewport["width"], "height": viewport["height"]},
|
||||
locale="zh-CN",
|
||||
)
|
||||
page = context.new_page()
|
||||
page.set_default_timeout(timeout)
|
||||
|
||||
yield page
|
||||
|
||||
# ── 失败自动截图 ──
|
||||
if screenshot_on_failure and hasattr(request.node, "rep_call") and request.node.rep_call.failed:
|
||||
scenario_dir = SCREENSHOTS_DIR / request.node.name
|
||||
scenario_dir.mkdir(parents=True, exist_ok=True)
|
||||
ts = datetime.now().strftime("%Y%m%d_%H%M%S")
|
||||
path = str(scenario_dir / f"FAIL_{browser_name}_{ts}.png")
|
||||
page.screenshot(path=path, full_page=True)
|
||||
|
||||
context.close()
|
||||
browser.close()
|
||||
|
||||
|
||||
@pytest.fixture
|
||||
def login(page, web_config, config):
|
||||
"""返回一个登录 helper 函数，按角色名自动填入账号并等待登录完成。
|
||||
|
||||
Usage:
|
||||
def test_admin(page, login):
|
||||
login("super_admin")
|
||||
page.getByTestId("nav-dashboard").click()
|
||||
"""
|
||||
|
||||
def _login(role: str = "super_admin") -> None:
|
||||
account = config["accounts"].get(role)
|
||||
if not account:
|
||||
raise ValueError(f"未知角色 '{role}'，可用: {list(config['accounts'].keys())}")
|
||||
|
||||
base_url = web_config["base_url"]
|
||||
# 如果已经打开某个页面且未过期，直接返回
|
||||
if page.url and not page.url.startswith("about:") and "/login" not in page.url:
|
||||
return
|
||||
|
||||
page.goto(f"{base_url}/login")
|
||||
page.getByPlaceholder("请输入用户名").fill(account["phone"])
|
||||
page.getByPlaceholder("请输入密码").fill(account["password"])
|
||||
page.getByRole("button", name="登录").click()
|
||||
|
||||
# 等待登录成功跳转（10 秒超时）
|
||||
page.wait_for_url(f"{base_url}/**", timeout=10_000)
|
||||
|
||||
return _login
|
||||
|
||||
|
||||
# ── pytest 报告 hook：记录每个用例的失败状态 ──
|
||||
@pytest.hookimpl(tryfirst=True, hookwrapper=True)
|
||||
def pytest_runtest_makereport(item, call):
|
||||
"""在每个用例执行后记录结果，供 fixture 中的失败截图逻辑使用。"""
|
||||
outcome = yield
|
||||
rep = outcome.get_result()
|
||||
setattr(item, f"rep_{rep.when}", rep)
|
||||
@@ -0,0 +1,76 @@
|
||||
"""Page Object 基类 — 封装所有页面共享的通用操作。
|
||||
|
||||
每个具体页面应继承 BasePage，在 __init__ 中声明所有定位器。
|
||||
|
||||
Usage:
|
||||
class LoginPage(BasePage):
|
||||
def __init__(self, page):
|
||||
super().__init__(page)
|
||||
self.phone_input = page.getByPlaceholder("请输入用户名")
|
||||
self.login_btn = page.getByRole("button", name="登录")
|
||||
"""
|
||||
|
||||
from datetime import datetime
|
||||
from pathlib import Path
|
||||
from typing import Optional
|
||||
|
||||
from playwright.sync_api import Page, Locator, expect
|
||||
|
||||
SCREENSHOTS_DIR = Path("output/screenshots")
|
||||
|
||||
|
||||
class BasePage:
|
||||
"""Page Object 基类。"""
|
||||
|
||||
def __init__(self, page: Page, timeout_ms: int = 30_000):
|
||||
self.page = page
|
||||
self.timeout = timeout_ms
|
||||
|
||||
# ── 通用等待 ──
|
||||
|
||||
def wait_visible(self, locator: Locator, timeout_ms: Optional[int] = None) -> None:
|
||||
"""等待元素可见。"""
|
||||
expect(locator).to_be_visible(timeout=timeout_ms or self.timeout)
|
||||
|
||||
def wait_hidden(self, locator: Locator, timeout_ms: Optional[int] = None) -> None:
|
||||
"""等待元素消失（如 Loading 遮罩）。"""
|
||||
expect(locator).to_be_hidden(timeout=timeout_ms or self.timeout)
|
||||
|
||||
def wait_for_text(self, text: str, timeout_ms: Optional[int] = None) -> None:
|
||||
"""等待页面上出现指定文本。"""
|
||||
expect(self.page.getByText(text)).to_be_visible(timeout=timeout_ms or self.timeout)
|
||||
|
||||
# ── 通用操作 ──
|
||||
|
||||
def fill_field(self, locator: Locator, value: str) -> None:
|
||||
"""安全填写输入框（先等待可见，再清空后填写）。"""
|
||||
self.wait_visible(locator)
|
||||
locator.clear()
|
||||
locator.fill(value)
|
||||
|
||||
def click_when_ready(self, locator: Locator) -> None:
|
||||
"""安全点击（等待可见 + 可操作）。"""
|
||||
self.wait_visible(locator)
|
||||
locator.click()
|
||||
|
||||
def get_text(self, locator: Locator) -> str:
|
||||
"""获取元素的 inner text。"""
|
||||
self.wait_visible(locator)
|
||||
return locator.inner_text()
|
||||
|
||||
# ── 截图 ──
|
||||
|
||||
def screenshot(self, name: str, full_page: bool = False) -> str:
|
||||
"""关键节点截图，返回文件路径。"""
|
||||
scenario_dir = SCREENSHOTS_DIR / self.__class__.__name__
|
||||
scenario_dir.mkdir(parents=True, exist_ok=True)
|
||||
ts = datetime.now().strftime("%Y%m%d_%H%M%S")
|
||||
path = str(scenario_dir / f"{name}_{ts}.png")
|
||||
self.page.screenshot(path=path, full_page=full_page)
|
||||
return path
|
||||
|
||||
# ── 导航 ──
|
||||
|
||||
def navigate(self, url: str) -> None:
|
||||
"""导航到指定 URL 并等待页面加载完成。"""
|
||||
self.page.goto(url, wait_until="domcontentloaded")
|
||||
@@ -0,0 +1,53 @@
|
||||
"""导航栏公共组件。
|
||||
|
||||
跨页面复用的顶部/侧边导航操作。
|
||||
|
||||
Usage:
|
||||
from tests.web.pages.components.navbar import NavBar
|
||||
|
||||
navbar = NavBar(page)
|
||||
navbar.go_to("运输管理")
|
||||
"""
|
||||
|
||||
from playwright.sync_api import Page, expect
|
||||
|
||||
from tests.web.pages.base_page import BasePage
|
||||
|
||||
|
||||
class NavBar(BasePage):
|
||||
"""侧边导航栏组件。"""
|
||||
|
||||
def __init__(self, page: Page):
|
||||
super().__init__(page)
|
||||
# ⚠️ 以下定位器需要根据实际 DOM 调整
|
||||
self.sidebar = page.locator(".ant-layout-sider")
|
||||
self.logout_btn = page.getByText("退出登录")
|
||||
|
||||
def go_to(self, menu_name: str) -> None:
|
||||
"""点击侧边栏菜单项展开/跳转。
|
||||
|
||||
Args:
|
||||
menu_name: 菜单名称文本（如 "运输管理"、"基础信息"）
|
||||
"""
|
||||
menu_item = self.page.getByText(menu_name).first
|
||||
self.click_when_ready(menu_item)
|
||||
|
||||
def go_to_submenu(self, parent_menu: str, sub_menu: str) -> None:
|
||||
"""点击父级菜单后，点击子菜单项。
|
||||
|
||||
Args:
|
||||
parent_menu: 父级菜单文本（如 "整车运输"）
|
||||
sub_menu: 子菜单文本（如 "运单管理"）
|
||||
"""
|
||||
self.go_to(parent_menu)
|
||||
sub_item = self.page.getByText(sub_menu).first
|
||||
self.click_when_ready(sub_item)
|
||||
|
||||
def logout(self) -> None:
|
||||
"""退出登录。"""
|
||||
self.click_when_ready(self.logout_btn)
|
||||
expect(self.page).to_have_url("**/login**", timeout=10_000)
|
||||
|
||||
def is_expanded(self) -> bool:
|
||||
"""检查侧边栏是否展开。"""
|
||||
return self.sidebar.is_visible()
|
||||
@@ -0,0 +1,52 @@
|
||||
"""登录页面 — Page Object。
|
||||
|
||||
Usage:
|
||||
from tests.web.pages.login_page import LoginPage
|
||||
|
||||
login_page = LoginPage(page)
|
||||
login_page.login(phone="super_admin", password="951260684NiAn..")
|
||||
"""
|
||||
|
||||
from playwright.sync_api import Page, expect
|
||||
|
||||
from tests.web.pages.base_page import BasePage
|
||||
|
||||
|
||||
class LoginPage(BasePage):
|
||||
"""运八管理端登录页。"""
|
||||
|
||||
def __init__(self, page: Page):
|
||||
super().__init__(page)
|
||||
# ── 定位器声明 ──
|
||||
self.username_input = page.getByPlaceholder("请输入用户名")
|
||||
self.password_input = page.getByPlaceholder("请输入密码")
|
||||
self.login_btn = page.getByRole("button", name="登录")
|
||||
self.error_tip = page.locator(".ant-form-item-explain-error")
|
||||
|
||||
def login(self, phone: str, password: str, expect_success: bool = True) -> None:
|
||||
"""执行登录流程。
|
||||
|
||||
Args:
|
||||
phone: 用户名/手机号
|
||||
password: 密码
|
||||
expect_success: True=预期成功跳转，False=预期留在登录页并有错误提示
|
||||
"""
|
||||
self.fill_field(self.username_input, phone)
|
||||
self.fill_field(self.password_input, password)
|
||||
self.click_when_ready(self.login_btn)
|
||||
|
||||
if expect_success:
|
||||
# 等待登录成功后页面跳转
|
||||
self.page.wait_for_url("**/admin/**", timeout=10_000)
|
||||
else:
|
||||
# 预期登录失败，停留在当前页
|
||||
expect(self.page).to_have_url("**/login**", timeout=5_000)
|
||||
|
||||
def get_error_message(self) -> str:
|
||||
"""获取登录失败时的错误提示文本。"""
|
||||
self.wait_visible(self.error_tip)
|
||||
return self.error_tip.inner_text()
|
||||
|
||||
def is_on_login_page(self) -> bool:
|
||||
"""检查是否仍在登录页。"""
|
||||
return "/login" in self.page.url
|
||||
@@ -0,0 +1,101 @@
|
||||
"""登录功能测试用例。
|
||||
|
||||
覆盖正常登录、异常登录、表单校验等场景。
|
||||
按 ui_automation_best_practices.md §6.3 的范本结构编写。
|
||||
|
||||
标记:
|
||||
pytest -m web # 仅执行 Web 用例
|
||||
pytest -m p0 # 仅执行 P0 冒烟
|
||||
pytest -m smoke # 仅执行冒烟
|
||||
"""
|
||||
|
||||
import pytest
|
||||
from playwright.sync_api import Page
|
||||
|
||||
from tests.web.pages.login_page import LoginPage
|
||||
|
||||
pytestmark = [pytest.mark.web]
|
||||
|
||||
|
||||
# ═══════════════════════════════════════════════════════════════════
|
||||
# P0 — 冒烟测试
|
||||
# ═══════════════════════════════════════════════════════════════════
|
||||
|
||||
class TestLoginSuccess:
|
||||
"""正常登录流程。"""
|
||||
|
||||
@pytest.mark.p0
|
||||
@pytest.mark.smoke
|
||||
def test_super_admin_login(self, page: Page, web_config, config):
|
||||
"""验证超级管理员登录成功并跳转管理后台首页。"""
|
||||
account = config["accounts"]["super_admin"]
|
||||
login_page = LoginPage(page)
|
||||
page.goto(web_config["base_url"])
|
||||
login_page.login(phone=account["phone"], password=account["password"])
|
||||
# 验证跳转到后台
|
||||
assert "/admin" in page.url, f"登录后应跳转到后台，实际 URL: {page.url}"
|
||||
|
||||
@pytest.mark.p0
|
||||
@pytest.mark.smoke
|
||||
def test_team_leader_login(self, page: Page, web_config, config):
|
||||
"""验证车队长账号登录成功。"""
|
||||
account = config["accounts"]["team_leader"]
|
||||
login_page = LoginPage(page)
|
||||
page.goto(web_config["base_url"])
|
||||
login_page.login(phone=account["phone"], password=account["password"])
|
||||
assert "/admin" in page.url
|
||||
|
||||
|
||||
# ═══════════════════════════════════════════════════════════════════
|
||||
# P1 — 异常与校验
|
||||
# ═══════════════════════════════════════════════════════════════════
|
||||
|
||||
class TestLoginValidation:
|
||||
"""登录表单校验。"""
|
||||
|
||||
@pytest.mark.p1
|
||||
@pytest.mark.parametrize("phone,password,expected_text", [
|
||||
pytest.param("", "Test123456", "请输入用户名", id="empty_username"),
|
||||
pytest.param("super_admin", "", "请输入密码", id="empty_password"),
|
||||
pytest.param("super_admin", "wrong_password", "密码错误", id="wrong_password"),
|
||||
pytest.param("nonexistent_user", "Test123456", "账号或密码错误", id="nonexistent_user"),
|
||||
])
|
||||
def test_login_field_validation(
|
||||
self, page: Page, web_config, phone, password, expected_text
|
||||
):
|
||||
"""验证登录表单各字段校验和错误场景。"""
|
||||
login_page = LoginPage(page)
|
||||
page.goto(web_config["base_url"])
|
||||
|
||||
login_page.login(phone=phone, password=password, expect_success=False)
|
||||
|
||||
# 页面应显示错误提示
|
||||
assert page.getByText(expected_text).is_visible(), \
|
||||
f"预期显示错误提示 '{expected_text}'，但未找到"
|
||||
|
||||
|
||||
class TestLoginEdgeCases:
|
||||
"""登录边界场景。"""
|
||||
|
||||
@pytest.mark.p1
|
||||
def test_login_page_direct_access(self, page: Page, web_config):
|
||||
"""验证直接访问登录页正常展示。"""
|
||||
page.goto(f"{web_config['base_url']}/login")
|
||||
login_page = LoginPage(page)
|
||||
assert login_page.is_on_login_page()
|
||||
|
||||
@pytest.mark.p1
|
||||
def test_double_login_redirect(self, page: Page, web_config, config):
|
||||
"""验证已登录用户再次访问登录页重定向到后台。"""
|
||||
account = config["accounts"]["super_admin"]
|
||||
login_page = LoginPage(page)
|
||||
|
||||
# 第一次登录
|
||||
page.goto(web_config["base_url"])
|
||||
login_page.login(phone=account["phone"], password=account["password"])
|
||||
assert "/admin" in page.url
|
||||
|
||||
# 已登录状态再次访问登录页
|
||||
page.goto(f"{web_config['base_url']}/login")
|
||||
# 应自动重定向到后台
|
||||
assert "/admin" in page.url
|
||||
Reference in New Issue
Block a user