pytest-dsl-ui 0.1.0__tar.gz

pytest_dsl_ui-0.1.0/PKG-INFO

@@ -0,0 +1,220 @@
+Metadata-Version: 2.4
+Name: pytest-dsl-ui
+Version: 0.1.0
+Summary: Playwright-based UI automation keywords for pytest-dsl framework
+Author: Chen Shuanglin
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/felix-1991/pytest-dsl-ui
+Project-URL: Bug Tracker, https://github.com/felix-1991/pytest-dsl-ui/issues
+Classifier: Framework :: Pytest
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: pytest-dsl>=0.7.0
+Requires-Dist: playwright>=1.40.0
+Requires-Dist: allure-pytest>=2.9.0
+Requires-Dist: Pillow>=9.0.0
+Requires-Dist: ddddocr>=1.4.11
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
+Requires-Dist: black>=22.0.0; extra == "dev"
+Requires-Dist: flake8>=5.0.0; extra == "dev"
+
+# pytest-dsl-ui
+
+🎯 **基于Playwright的UI自动化测试框架** - 为pytest-dsl提供强大的Web UI测试能力
+
+## ✨ 核心特性
+
+- 🔍 **智能定位器** - 支持20+种元素定位策略，包括复合定位器
+- ⚡ **零配置启动** - 开箱即用，无需复杂配置
+- 🌐 **多浏览器支持** - Chrome、Firefox、Safari、Edge
+- 🔧 **Playwright转换器** - 一键转换录制脚本为DSL格式
+
+## 🚀 快速开始
+
+### 安装
+```bash
+pip install pytest-dsl-ui
+playwright install  # 安装浏览器
+```
+
+### 5分钟上手示例
+```dsl
+@name: "百度搜索测试"
+
+[启动浏览器], 浏览器: "chromium"
+[打开页面], 地址: "https://www.baidu.com"
+[输入文本], 定位器: "input#kw", 文本: "pytest-dsl-ui"
+[点击元素], 定位器: "input#su"
+[断言文本存在], 文本: "pytest"
+[截图], 文件名: "search_result.png"
+[关闭浏览器]
+```
+
+运行：`pytest-dsl test.dsl`
+
+## 🎯 定位器速查表
+
+> **定位器是框架的核心**，支持简单到复杂的各种定位需求
+
+### 基础定位器
+
+| 定位器类型 | 语法格式 | 使用示例 | 说明 |
+|-----------|---------|----------|------|
+| **CSS选择器** | `selector` | `"button.submit"` | 最常用，支持所有CSS选择器 |
+| **文本定位** | `text=文本` | `"text=登录"` | 根据元素文本内容定位 |
+| **角色定位** | `role=角色` | `"role=button"` | 根据ARIA角色定位 |
+| **标签定位** | `label=标签` | `"label=用户名"` | 根据关联的label定位 |
+| **占位符定位** | `placeholder=文本` | `"placeholder=请输入"` | 根据placeholder属性定位 |
+| **测试ID定位** | `testid=ID` | `"testid=submit-btn"` | 根据test-id属性定位 |
+| **XPath定位** | `//xpath` | `"//button[@type='submit']"` | 使用XPath表达式定位 |
+
+### 精确匹配定位器
+
+| 定位器类型 | 语法格式 | 使用示例 | 说明 |
+|-----------|---------|----------|------|
+| **精确文本** | `text=文本,exact=true` | `"text=登录,exact=true"` | 精确匹配文本，不包含子串 |
+| **精确标签** | `label=标签,exact=true` | `"label=用户名,exact=true"` | 精确匹配标签文本 |
+| **角色+名称** | `role=角色:名称` | `"role=button:提交"` | 角色和名称的组合定位 |
+
+### 复合定位器 ⭐
+
+| 功能 | 语法格式 | 使用示例 | 说明 |
+|------|---------|----------|------|
+| **子元素定位** | `基础定位器&locator=子选择器` | `"role=cell:外到内&locator=label"` | 在基础元素中查找子元素 |
+| **文本过滤** | `基础定位器&has_text=文本` | `"div&has_text=重要"` | 包含特定文本的元素 |
+| **选择第一个** | `基础定位器&first=true` | `"button&first=true"` | 选择第一个匹配的元素 |
+| **选择最后一个** | `基础定位器&last=true` | `"li&last=true"` | 选择最后一个匹配的元素 |
+| **选择第N个** | `基础定位器&nth=索引` | `"option&nth=2"` | 选择第N个元素（从0开始） |
+| **组合条件** | `定位器&条件1&条件2` | `"role=cell:外到内&locator=label&first=true"` | 多个条件组合使用 |
+
+### 智能定位器
+
+| 定位器类型 | 语法格式 | 使用示例 | 说明 |
+|-----------|---------|----------|------|
+| **可点击元素** | `clickable=文本` | `"clickable=提交"` | 智能查找可点击的元素 |
+| **元素类型** | `标签名=文本` | `"span=状态"` | 根据HTML标签和文本定位 |
+| **CSS类定位** | `class=类名:文本` | `"class=btn:确认"` | 根据CSS类名和文本定位 |
+
+## 🛠️ 常用操作关键字
+
+### 浏览器控制
+```dsl
+[启动浏览器], 浏览器: "chromium", 无头模式: false
+[打开页面], 地址: "https://example.com"
+[刷新页面]
+[关闭浏览器]
+```
+
+### 元素操作
+```dsl
+[点击元素], 定位器: "button#submit"
+[双击元素], 定位器: "text=编辑"
+[输入文本], 定位器: "input[name='username']", 文本: "admin"
+[清空文本], 定位器: "textarea"
+[选择选项], 定位器: "select", 值: "选项1"
+[上传文件], 定位器: "input[type='file']", 文件路径: "test.jpg"
+```
+
+### 等待与断言
+```dsl
+[等待元素出现], 定位器: ".loading"
+[等待元素消失], 定位器: ".spinner" 
+[等待文本出现], 文本: "加载完成"
+[断言元素存在], 定位器: ".success"
+[断言文本内容], 定位器: "h1", 预期文本: "欢迎"
+[断言元素可见], 定位器: "button"
+```
+
+## 🔄 Playwright脚本转换
+
+将Playwright录制的脚本一键转换为DSL格式：
+
+```bash
+# 转换Playwright脚本
+python -m pytest_dsl_ui.utils.playwright_converter input.py -o output.dsl
+```
+
+**转换前（Playwright）：**
+```python
+page.get_by_role("cell", name="外到内").locator("label").first.click()
+page.get_by_text("专家模式", exact=True).click()
+```
+
+**转换后（DSL）：**
+```dsl
+[点击元素], 定位器: "role=cell:外到内&locator=label&first=true"
+[点击元素], 定位器: "text=专家模式,exact=true"
+```
+
+## 📝 实战示例
+
+### 登录测试
+```dsl
+@name: "用户登录测试"
+
+[启动浏览器], 浏览器: "chromium"
+[打开页面], 地址: "https://example.com/login"
+
+# 输入用户名密码
+[输入文本], 定位器: "label=用户名", 文本: "admin"
+[输入文本], 定位器: "placeholder=请输入密码", 文本: "123456"
+
+# 点击登录按钮
+[点击元素], 定位器: "role=button:登录"
+
+# 验证登录成功
+[等待文本出现], 文本: "欢迎"
+[断言元素存在], 定位器: "text=退出"
+[截图], 文件名: "login_success.png"
+
+[关闭浏览器]
+```
+
+### 表单操作
+```dsl
+@name: "复杂表单测试"
+
+[启动浏览器]
+[打开页面], 地址: "https://example.com/form"
+
+# 复合定位器示例
+[点击元素], 定位器: "role=cell:配置项&locator=button&first=true"
+[选择选项], 定位器: "label=类型&locator=select", 值: "高级"
+[输入文本], 定位器: "class=input-group:备注&locator=textarea", 文本: "测试数据"
+
+# 提交表单
+[点击元素], 定位器: "clickable=提交"
+[等待文本出现], 文本: "保存成功"
+
+[关闭浏览器]
+```
+
+## 🔧 高级配置
+
+### 设置默认超时
+```dsl
+[设置等待超时], 超时时间: 30  # 30秒
+```
+
+### 浏览器选项
+```dsl
+[启动浏览器], 浏览器: "firefox", 无头模式: true, 视口宽度: 1920, 视口高度: 1080
+```
+
+## 📚 更多资源
+
+- 📖 [完整文档](https://github.com/your-repo/pytest-dsl-ui/docs)
+- 🐛 [问题反馈](https://github.com/your-repo/pytest-dsl-ui/issues)
+- 💡 [示例集合](https://github.com/your-repo/pytest-dsl-ui/examples)
+
+---
+
+**💡 提示**：定位器是框架的核心，熟练掌握各种定位器的使用是提高测试效率的关键！

pytest_dsl_ui-0.1.0/README.md

@@ -0,0 +1,192 @@
+# pytest-dsl-ui
+
+🎯 **基于Playwright的UI自动化测试框架** - 为pytest-dsl提供强大的Web UI测试能力
+
+## ✨ 核心特性
+
+- 🔍 **智能定位器** - 支持20+种元素定位策略，包括复合定位器
+- ⚡ **零配置启动** - 开箱即用，无需复杂配置
+- 🌐 **多浏览器支持** - Chrome、Firefox、Safari、Edge
+- 🔧 **Playwright转换器** - 一键转换录制脚本为DSL格式
+
+## 🚀 快速开始
+
+### 安装
+```bash
+pip install pytest-dsl-ui
+playwright install  # 安装浏览器
+```
+
+### 5分钟上手示例
+```dsl
+@name: "百度搜索测试"
+
+[启动浏览器], 浏览器: "chromium"
+[打开页面], 地址: "https://www.baidu.com"
+[输入文本], 定位器: "input#kw", 文本: "pytest-dsl-ui"
+[点击元素], 定位器: "input#su"
+[断言文本存在], 文本: "pytest"
+[截图], 文件名: "search_result.png"
+[关闭浏览器]
+```
+
+运行：`pytest-dsl test.dsl`
+
+## 🎯 定位器速查表
+
+> **定位器是框架的核心**，支持简单到复杂的各种定位需求
+
+### 基础定位器
+
+| 定位器类型 | 语法格式 | 使用示例 | 说明 |
+|-----------|---------|----------|------|
+| **CSS选择器** | `selector` | `"button.submit"` | 最常用，支持所有CSS选择器 |
+| **文本定位** | `text=文本` | `"text=登录"` | 根据元素文本内容定位 |
+| **角色定位** | `role=角色` | `"role=button"` | 根据ARIA角色定位 |
+| **标签定位** | `label=标签` | `"label=用户名"` | 根据关联的label定位 |
+| **占位符定位** | `placeholder=文本` | `"placeholder=请输入"` | 根据placeholder属性定位 |
+| **测试ID定位** | `testid=ID` | `"testid=submit-btn"` | 根据test-id属性定位 |
+| **XPath定位** | `//xpath` | `"//button[@type='submit']"` | 使用XPath表达式定位 |
+
+### 精确匹配定位器
+
+| 定位器类型 | 语法格式 | 使用示例 | 说明 |
+|-----------|---------|----------|------|
+| **精确文本** | `text=文本,exact=true` | `"text=登录,exact=true"` | 精确匹配文本，不包含子串 |
+| **精确标签** | `label=标签,exact=true` | `"label=用户名,exact=true"` | 精确匹配标签文本 |
+| **角色+名称** | `role=角色:名称` | `"role=button:提交"` | 角色和名称的组合定位 |
+
+### 复合定位器 ⭐
+
+| 功能 | 语法格式 | 使用示例 | 说明 |
+|------|---------|----------|------|
+| **子元素定位** | `基础定位器&locator=子选择器` | `"role=cell:外到内&locator=label"` | 在基础元素中查找子元素 |
+| **文本过滤** | `基础定位器&has_text=文本` | `"div&has_text=重要"` | 包含特定文本的元素 |
+| **选择第一个** | `基础定位器&first=true` | `"button&first=true"` | 选择第一个匹配的元素 |
+| **选择最后一个** | `基础定位器&last=true` | `"li&last=true"` | 选择最后一个匹配的元素 |
+| **选择第N个** | `基础定位器&nth=索引` | `"option&nth=2"` | 选择第N个元素（从0开始） |
+| **组合条件** | `定位器&条件1&条件2` | `"role=cell:外到内&locator=label&first=true"` | 多个条件组合使用 |
+
+### 智能定位器
+
+| 定位器类型 | 语法格式 | 使用示例 | 说明 |
+|-----------|---------|----------|------|
+| **可点击元素** | `clickable=文本` | `"clickable=提交"` | 智能查找可点击的元素 |
+| **元素类型** | `标签名=文本` | `"span=状态"` | 根据HTML标签和文本定位 |
+| **CSS类定位** | `class=类名:文本` | `"class=btn:确认"` | 根据CSS类名和文本定位 |
+
+## 🛠️ 常用操作关键字
+
+### 浏览器控制
+```dsl
+[启动浏览器], 浏览器: "chromium", 无头模式: false
+[打开页面], 地址: "https://example.com"
+[刷新页面]
+[关闭浏览器]
+```
+
+### 元素操作
+```dsl
+[点击元素], 定位器: "button#submit"
+[双击元素], 定位器: "text=编辑"
+[输入文本], 定位器: "input[name='username']", 文本: "admin"
+[清空文本], 定位器: "textarea"
+[选择选项], 定位器: "select", 值: "选项1"
+[上传文件], 定位器: "input[type='file']", 文件路径: "test.jpg"
+```
+
+### 等待与断言
+```dsl
+[等待元素出现], 定位器: ".loading"
+[等待元素消失], 定位器: ".spinner" 
+[等待文本出现], 文本: "加载完成"
+[断言元素存在], 定位器: ".success"
+[断言文本内容], 定位器: "h1", 预期文本: "欢迎"
+[断言元素可见], 定位器: "button"
+```
+
+## 🔄 Playwright脚本转换
+
+将Playwright录制的脚本一键转换为DSL格式：
+
+```bash
+# 转换Playwright脚本
+python -m pytest_dsl_ui.utils.playwright_converter input.py -o output.dsl
+```
+
+**转换前（Playwright）：**
+```python
+page.get_by_role("cell", name="外到内").locator("label").first.click()
+page.get_by_text("专家模式", exact=True).click()
+```
+
+**转换后（DSL）：**
+```dsl
+[点击元素], 定位器: "role=cell:外到内&locator=label&first=true"
+[点击元素], 定位器: "text=专家模式,exact=true"
+```
+
+## 📝 实战示例
+
+### 登录测试
+```dsl
+@name: "用户登录测试"
+
+[启动浏览器], 浏览器: "chromium"
+[打开页面], 地址: "https://example.com/login"
+
+# 输入用户名密码
+[输入文本], 定位器: "label=用户名", 文本: "admin"
+[输入文本], 定位器: "placeholder=请输入密码", 文本: "123456"
+
+# 点击登录按钮
+[点击元素], 定位器: "role=button:登录"
+
+# 验证登录成功
+[等待文本出现], 文本: "欢迎"
+[断言元素存在], 定位器: "text=退出"
+[截图], 文件名: "login_success.png"
+
+[关闭浏览器]
+```
+
+### 表单操作
+```dsl
+@name: "复杂表单测试"
+
+[启动浏览器]
+[打开页面], 地址: "https://example.com/form"
+
+# 复合定位器示例
+[点击元素], 定位器: "role=cell:配置项&locator=button&first=true"
+[选择选项], 定位器: "label=类型&locator=select", 值: "高级"
+[输入文本], 定位器: "class=input-group:备注&locator=textarea", 文本: "测试数据"
+
+# 提交表单
+[点击元素], 定位器: "clickable=提交"
+[等待文本出现], 文本: "保存成功"
+
+[关闭浏览器]
+```
+
+## 🔧 高级配置
+
+### 设置默认超时
+```dsl
+[设置等待超时], 超时时间: 30  # 30秒
+```
+
+### 浏览器选项
+```dsl
+[启动浏览器], 浏览器: "firefox", 无头模式: true, 视口宽度: 1920, 视口高度: 1080
+```
+
+## 📚 更多资源
+
+- 📖 [完整文档](https://github.com/your-repo/pytest-dsl-ui/docs)
+- 🐛 [问题反馈](https://github.com/your-repo/pytest-dsl-ui/issues)
+- 💡 [示例集合](https://github.com/your-repo/pytest-dsl-ui/examples)
+
+---
+
+**💡 提示**：定位器是框架的核心，熟练掌握各种定位器的使用是提高测试效率的关键！

pytest_dsl_ui-0.1.0/pyproject.toml

@@ -0,0 +1,59 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pytest-dsl-ui"
+version = "0.1.0"
+description = "Playwright-based UI automation keywords for pytest-dsl framework"
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+authors = [
+    {name = "Chen Shuanglin"}
+]
+classifiers = [
+    "Framework :: Pytest",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "pytest-dsl>=0.7.0",
+    "playwright>=1.40.0",
+    "allure-pytest>=2.9.0",
+    "Pillow>=9.0.0",  # 用于截图处理
+    "ddddocr>=1.4.11",  # 用于验证码识别
+]
+
+# 声明entry_points，让pytest-dsl自动发现这个插件
+[project.entry-points."pytest_dsl.keywords"]
+ui_keywords = "pytest_dsl_ui"
+
+# 添加控制台脚本入口点
+[project.scripts]
+pw2dsl = "pytest_dsl_ui.utils.playwright_converter:main"
+playwright2dsl = "pytest_dsl_ui.utils.playwright_converter:main"
+
+[project.urls]
+"Homepage" = "https://github.com/felix-1991/pytest-dsl-ui"
+"Bug Tracker" = "https://github.com/felix-1991/pytest-dsl-ui/issues"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0.0",
+    "pytest-cov>=4.0.0",
+    "black>=22.0.0",
+    "flake8>=5.0.0",
+]
+
+[tool.setuptools]
+packages = {find = {where = ["."], include = ["pytest_dsl_ui*"]}}
+
+
+[[tool.uv.index]]
+name = "tuna"
+url = "https://mirrors.tuna.tsinghua.edu.cn/pypi/web/simple"

pytest_dsl_ui-0.1.0/pytest_dsl_ui/__init__.py

@@ -0,0 +1,39 @@
+"""pytest-dsl-ui: Playwright-based UI automation keywords for pytest-dsl
+
+这个包为pytest-dsl框架提供基于Playwright的UI自动化测试关键字。
+通过entry_points机制自动集成到pytest-dsl中。
+"""
+
+__version__ = "0.1.0"
+__author__ = "Chen Shuanglin"
+
+from pytest_dsl.core.keyword_manager import keyword_manager
+
+
+def register_keywords(keyword_manager_instance=None):
+    """注册所有UI关键字到关键字管理器
+    
+    这个函数会被pytest-dsl的插件发现机制自动调用。
+    
+    Args:
+        keyword_manager_instance: 关键字管理器实例，如果为None则使用全局实例
+    """
+    if keyword_manager_instance is None:
+        keyword_manager_instance = keyword_manager
+    
+    # 导入所有关键字模块，触发关键字注册
+    try:
+        from . import keywords
+        print("pytest-dsl-ui: 已成功加载UI自动化关键字")
+    except ImportError as e:
+        print(f"pytest-dsl-ui: 加载关键字时出错: {e}")
+        raise
+
+
+# 当模块被直接导入时，自动注册关键字
+# 这确保了即使没有调用register_keywords函数，关键字也会被注册
+try:
+    from . import keywords
+except ImportError:
+    # 在某些情况下（如安装时），可能无法导入依赖
+    pass

pytest_dsl_ui-0.1.0/pytest_dsl_ui/__main__.py

@@ -0,0 +1,106 @@
+#!/usr/bin/env python3
+"""
+pytest-dsl-ui 包的主入口点
+
+支持通过 python -m pytest_dsl_ui 运行
+"""
+
+import sys
+import argparse
+from pathlib import Path
+
+
+def show_help():
+    """显示帮助信息"""
+    help_text = """
+pytest-dsl-ui 工具集
+
+用法:
+    python -m pytest_dsl_ui <command> [options]
+    
+命令:
+    convert      - 转换Playwright脚本为DSL格式
+    help         - 显示帮助信息
+    
+示例:
+    # 转换Playwright脚本
+    python -m pytest_dsl_ui convert script.py output.dsl
+    
+    # 显示帮助
+    python -m pytest_dsl_ui help
+    """
+    print(help_text.strip())
+
+
+def convert_command(args):
+    """处理转换命令"""
+    if len(args) < 1:
+        print("错误: convert命令需要输入文件")
+        print("用法: python -m pytest_dsl_ui convert <input_file> [output_file]")
+        return 1
+    
+    # 导入转换器
+    try:
+        from .utils.playwright_converter import PlaywrightToDSLConverter
+    except ImportError:
+        print("错误: 无法导入playwright_converter模块")
+        return 1
+    
+    input_file = args[0]
+    output_file = args[1] if len(args) > 1 else None
+    
+    # 检查输入文件
+    input_path = Path(input_file)
+    if not input_path.exists():
+        print(f"错误: 输入文件 {input_path} 不存在")
+        return 1
+    
+    try:
+        # 读取文件
+        with open(input_path, 'r', encoding='utf-8') as f:
+            script_content = f.read()
+        
+        # 转换
+        converter = PlaywrightToDSLConverter()
+        dsl_content = converter.convert_script(script_content)
+        
+        # 输出结果
+        if output_file:
+            output_path = Path(output_file)
+            with open(output_path, 'w', encoding='utf-8') as f:
+                f.write(dsl_content)
+            print(f"转换完成! DSL文件已保存到: {output_path}")
+        else:
+            print("转换结果:")
+            print("=" * 50)
+            print(dsl_content)
+        
+        return 0
+        
+    except Exception as e:
+        print(f"错误: {e}")
+        return 1
+
+
+def main():
+    """主函数"""
+    if len(sys.argv) < 2:
+        show_help()
+        return 0
+    
+    command = sys.argv[1]
+    args = sys.argv[2:]
+    
+    if command == 'convert':
+        return convert_command(args)
+    elif command == 'help':
+        show_help()
+        return 0
+    else:
+        print(f"错误: 未知命令 '{command}'")
+        show_help()
+        return 1
+
+
+if __name__ == '__main__':
+    sys.exit(main()) 

pytest_dsl_ui-0.1.0/pytest_dsl_ui/core/__init__.py

@@ -0,0 +1 @@
+# Core modules for pytest-dsl-ui