kdtest-pw 2.0.0__tar.gz

kdtest_pw-2.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 KDTest Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

kdtest_pw-2.0.0/MANIFEST.in

@@ -0,0 +1,17 @@
+# 包含配置文件
+include kdtest_pw/data/static/*.json
+include kdtest_pw/data/static/*.yaml
+include kdtest_pw/data/static/*.xlsx
+
+# 包含插件配置
+include kdtest_pw/plugins/element_plus_plugin/*.ini
+include kdtest_pw/plugins/element_plus_plugin/elementData/*.yaml
+
+# 包含文档
+include README.md
+include LICENSE
+
+# 排除缓存
+global-exclude __pycache__
+global-exclude *.py[cod]
+global-exclude .git*

kdtest_pw-2.0.0/PKG-INFO

@@ -0,0 +1,169 @@
+Metadata-Version: 2.4
+Name: kdtest-pw
+Version: 2.0.0
+Summary: KDTest Playwright Edition - 关键字驱动测试框架，专为 Element Plus/Vue3 优化
+Home-page: https://github.com/kdtest/kdtest-pw
+Author: KDTest Team
+Author-email: KDTest Team <kdtest@example.com>
+License: MIT
+Project-URL: Homepage, https://github.com/kdtest/kdtest-pw
+Project-URL: Documentation, https://github.com/kdtest/kdtest-pw#readme
+Project-URL: Repository, https://github.com/kdtest/kdtest-pw
+Keywords: testing,automation,playwright,keyword-driven,element-plus,vue3
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+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: Topic :: Software Development :: Testing
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: playwright>=1.40.0
+Requires-Dist: openpyxl>=3.1.0
+Requires-Dist: PyYAML>=6.0
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-playwright>=0.4.0; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# KDTest-Playwright
+
+基于 Playwright 的关键字驱动测试框架，专为 Element Plus/Vue3 优化。
+
+## 安装
+
+```bash
+# 从 PyPI 安装
+pip install kdtest-pw
+
+# 安装 Playwright 浏览器
+playwright install chromium
+```
+
+## 快速开始
+
+### 1. 创建配置文件 `parameters.json`
+
+```json
+{
+    "testCaseFile": [
+        {
+            "caseFilePath": "testCases.xlsx",
+            "caseItem": ["Sheet1"]
+        }
+    ],
+    "browser": "chromium",
+    "url": "http://localhost:8080",
+    "headless": false,
+    "timeout": 30000
+}
+```
+
+### 2. 创建 Excel 测试用例
+
+| 用例ID | 用例名称 | 描述 | 关键字 | 定位信息 | 操作值 |
+|--------|----------|------|--------|----------|--------|
+| TC001 | 登录测试 | | | | |
+| | | 打开网站 | driver_get | | http://localhost |
+| | | 输入用户名 | input_text | xpath | //input[@placeholder='账号'] | admin |
+| | | 点击登录 | click_btn | css | .el-button--primary | |
+
+### 3. 运行测试
+
+```bash
+# 命令行运行
+kdtest-pw -c parameters.json
+
+# 或在 Python 中使用
+from kdtest_pw.cli import KDTestRunner
+
+runner = KDTestRunner("parameters.json")
+runner.setup()
+runner.run()
+runner.teardown()
+```
+
+## 核心关键字
+
+### 浏览器操作
+- `driver_get` - 导航到 URL
+- `driver_back` - 后退
+- `driver_refresh` - 刷新
+- `driver_close` - 关闭页面
+
+### 输入操作
+- `input_text` - 输入文本（清除后输入）
+- `input_append` - 追加输入
+- `input_clear` - 清除输入
+
+### 点击操作
+- `click_btn` - 点击元素
+- `double_click` - 双击
+- `right_click` - 右键点击
+- `hover` - 鼠标悬停
+
+### 断言
+- `text_assert` - 文本断言
+- `title_assert` - 标题断言
+- `element_visible_assert` - 可见性断言
+- `element_count_assert` - 数量断言
+
+### Element Plus 组件
+- `el_select` - 下拉选择
+- `el_datepicker` - 日期选择
+- `el_dialog_confirm` - 对话框确认
+- `el_table_click_row` - 表格行点击
+- `el_tree_click_node` - 树节点点击
+- `el_cascader` - 级联选择
+- `el_upload` - 文件上传
+- `el_form_input` - 表单输入
+
+### 菜单导航
+- `menu_load_data` - 加载菜单配置
+- `menu_navigate` - 导航到菜单
+- `menu_switch_iframe` - 切换 iframe
+- `menu_exit_iframe` - 退出 iframe
+
+## 变量和内置函数
+
+### 变量引用
+```
+${varName}           # 从缓存获取
+${self.param}        # 自定义参数
+${env.NAME}          # 环境变量
+```
+
+### 内置函数
+```
+@today()             # 今天日期
+@now()               # 当前时间
+@random(1,100)       # 随机数
+@random_phone()      # 随机手机号
+@uuid()              # UUID
+```
+
+## 与 kdtest (Selenium) 的区别
+
+| 特性 | kdtest (Selenium) | kdtest-pw (Playwright) |
+|------|-------------------|------------------------|
+| 浏览器驱动 | 需要下载 WebDriver | 内置浏览器 |
+| 等待机制 | 显式/隐式等待 | 自动等待 |
+| Element Plus | 需要额外处理 | 原生支持 |
+| 多标签页 | 需要切换句柄 | 原生支持 |
+| 录制回放 | 无 | 支持 Trace |
+| 视频录制 | 无 | 原生支持 |
+
+## License
+
+MIT

kdtest_pw-2.0.0/README.md

@@ -0,0 +1,130 @@
+# KDTest-Playwright
+
+基于 Playwright 的关键字驱动测试框架，专为 Element Plus/Vue3 优化。
+
+## 安装
+
+```bash
+# 从 PyPI 安装
+pip install kdtest-pw
+
+# 安装 Playwright 浏览器
+playwright install chromium
+```
+
+## 快速开始
+
+### 1. 创建配置文件 `parameters.json`
+
+```json
+{
+    "testCaseFile": [
+        {
+            "caseFilePath": "testCases.xlsx",
+            "caseItem": ["Sheet1"]
+        }
+    ],
+    "browser": "chromium",
+    "url": "http://localhost:8080",
+    "headless": false,
+    "timeout": 30000
+}
+```
+
+### 2. 创建 Excel 测试用例
+
+| 用例ID | 用例名称 | 描述 | 关键字 | 定位信息 | 操作值 |
+|--------|----------|------|--------|----------|--------|
+| TC001 | 登录测试 | | | | |
+| | | 打开网站 | driver_get | | http://localhost |
+| | | 输入用户名 | input_text | xpath | //input[@placeholder='账号'] | admin |
+| | | 点击登录 | click_btn | css | .el-button--primary | |
+
+### 3. 运行测试
+
+```bash
+# 命令行运行
+kdtest-pw -c parameters.json
+
+# 或在 Python 中使用
+from kdtest_pw.cli import KDTestRunner
+
+runner = KDTestRunner("parameters.json")
+runner.setup()
+runner.run()
+runner.teardown()
+```
+
+## 核心关键字
+
+### 浏览器操作
+- `driver_get` - 导航到 URL
+- `driver_back` - 后退
+- `driver_refresh` - 刷新
+- `driver_close` - 关闭页面
+
+### 输入操作
+- `input_text` - 输入文本（清除后输入）
+- `input_append` - 追加输入
+- `input_clear` - 清除输入
+
+### 点击操作
+- `click_btn` - 点击元素
+- `double_click` - 双击
+- `right_click` - 右键点击
+- `hover` - 鼠标悬停
+
+### 断言
+- `text_assert` - 文本断言
+- `title_assert` - 标题断言
+- `element_visible_assert` - 可见性断言
+- `element_count_assert` - 数量断言
+
+### Element Plus 组件
+- `el_select` - 下拉选择
+- `el_datepicker` - 日期选择
+- `el_dialog_confirm` - 对话框确认
+- `el_table_click_row` - 表格行点击
+- `el_tree_click_node` - 树节点点击
+- `el_cascader` - 级联选择
+- `el_upload` - 文件上传
+- `el_form_input` - 表单输入
+
+### 菜单导航
+- `menu_load_data` - 加载菜单配置
+- `menu_navigate` - 导航到菜单
+- `menu_switch_iframe` - 切换 iframe
+- `menu_exit_iframe` - 退出 iframe
+
+## 变量和内置函数
+
+### 变量引用
+```
+${varName}           # 从缓存获取
+${self.param}        # 自定义参数
+${env.NAME}          # 环境变量
+```
+
+### 内置函数
+```
+@today()             # 今天日期
+@now()               # 当前时间
+@random(1,100)       # 随机数
+@random_phone()      # 随机手机号
+@uuid()              # UUID
+```
+
+## 与 kdtest (Selenium) 的区别
+
+| 特性 | kdtest (Selenium) | kdtest-pw (Playwright) |
+|------|-------------------|------------------------|
+| 浏览器驱动 | 需要下载 WebDriver | 内置浏览器 |
+| 等待机制 | 显式/隐式等待 | 自动等待 |
+| Element Plus | 需要额外处理 | 原生支持 |
+| 多标签页 | 需要切换句柄 | 原生支持 |
+| 录制回放 | 无 | 支持 Trace |
+| 视频录制 | 无 | 原生支持 |
+
+## License
+
+MIT

kdtest_pw-2.0.0/kdtest_pw/__init__.py

@@ -0,0 +1,50 @@
+"""KDTest-Playwright 关键字驱动测试框架
+
+基于 Playwright 的关键字驱动测试框架，专为 Element Plus/Vue3 优化。
+"""
+
+from .product import __version__, __author__, __description__
+from .reference import (
+    GSTORE,
+    GSDSTORE,
+    MODULEDATA,
+    PRIVATEDATA,
+    CASESDATA,
+    INFO,
+    get_global,
+    set_global,
+    get_element_value,
+    set_element_value,
+    clear_element_values,
+)
+from .common import (
+    DEFAULT_CONFIG,
+    BROWSER_TYPES,
+    LOCATOR_TYPES,
+    KEY_MAP,
+)
+
+__all__ = [
+    # 版本信息
+    '__version__',
+    '__author__',
+    '__description__',
+    # 全局存储
+    'GSTORE',
+    'GSDSTORE',
+    'MODULEDATA',
+    'PRIVATEDATA',
+    'CASESDATA',
+    # 工具函数
+    'INFO',
+    'get_global',
+    'set_global',
+    'get_element_value',
+    'set_element_value',
+    'clear_element_values',
+    # 常量
+    'DEFAULT_CONFIG',
+    'BROWSER_TYPES',
+    'LOCATOR_TYPES',
+    'KEY_MAP',
+]

kdtest_pw-2.0.0/kdtest_pw/action/__init__.py

@@ -0,0 +1,7 @@
+"""动作模块 - 关键字实现"""
+
+from .base_keyword import BaseKeyword
+from .page_action import KeyWordTest
+from .key_retrieval import KeyRetrieval
+
+__all__ = ['BaseKeyword', 'KeyWordTest', 'KeyRetrieval']

kdtest_pw-2.0.0/kdtest_pw/action/base_keyword.py

@@ -0,0 +1,292 @@
+"""基础关键字类 - 元素定位和通用操作"""
+
+from playwright.sync_api import Page, Locator, FrameLocator
+from typing import Optional, Union, Literal, List
+
+from ..common import LOCATOR_TYPES
+from ..reference import INFO
+
+LocatorType = Literal[
+    'id', 'name', 'class_name', 'class', 'css', 'xpath',
+    'text', 'role', 'data_testid', 'placeholder', 'link_text', 'partial_link_text'
+]
+
+
+class BaseKeyword:
+    """基础关键字类
+
+    提供元素定位和通用操作方法，是所有关键字类的基类。
+    """
+
+    def __init__(self, page: Page):
+        """初始化基础关键字
+
+        Args:
+            page: Playwright Page 实例
+        """
+        self.page = page
+        self._current_frame: Optional[FrameLocator] = None
+        self._frame_stack: List[FrameLocator] = []
+
+    def locator(
+        self,
+        targeting: LocatorType,
+        element: str,
+        index: Optional[Union[int, str]] = None,
+        parent: Optional[Locator] = None
+    ) -> Locator:
+        """统一元素定位方法
+
+        Args:
+            targeting: 定位类型 (id, name, class_name, css, xpath, text, role, data_testid, placeholder)
+            element: 定位表达式
+            index: 索引 (数字、'first'、'last')，None 表示不使用索引
+            parent: 父元素定位器，用于链式定位
+
+        Returns:
+            Locator: Playwright Locator 实例
+        """
+        # 确定基础定位上下文
+        base = parent or self._current_frame or self.page
+
+        # 标准化定位类型
+        targeting = LOCATOR_TYPES.get(targeting, targeting)
+
+        # 根据定位类型创建 Locator
+        locator_map = {
+            'id': lambda: base.locator(f'#{element}'),
+            'name': lambda: base.locator(f'[name="{element}"]'),
+            'class_name': lambda: base.locator(f'.{element}'),
+            'css': lambda: base.locator(element),
+            'xpath': lambda: base.locator(f'xpath={element}'),
+            'text': lambda: base.get_by_text(element, exact=False),
+            'role': lambda: base.get_by_role(element),
+            'data_testid': lambda: base.get_by_test_id(element),
+            'placeholder': lambda: base.get_by_placeholder(element),
+        }
+
+        loc = locator_map.get(targeting, lambda: base.locator(element))()
+
+        # 处理索引
+        if index is not None:
+            if index == 'first' or index == 0:
+                loc = loc.first
+            elif index == 'last' or index == -1:
+                loc = loc.last
+            elif isinstance(index, int):
+                loc = loc.nth(index)
+            elif isinstance(index, str) and index.isdigit():
+                loc = loc.nth(int(index))
+
+        return loc
+
+    def locator_by_expression(self, expression: str, index: Optional[Union[int, str]] = None) -> Locator:
+        """通过表达式定位元素
+
+        支持格式：
+        - "xpath=//div" 或 "xpath://div"
+        - "css=.class" 或 "css:.class"
+        - "text=文本"
+        - "id=elementId"
+        - 纯 CSS 选择器
+
+        Args:
+            expression: 定位表达式
+            index: 索引
+
+        Returns:
+            Locator: Playwright Locator 实例
+        """
+        base = self._current_frame or self.page
+
+        # 解析表达式
+        if '=' in expression:
+            parts = expression.split('=', 1)
+            prefix = parts[0].lower().rstrip(':')
+            value = parts[1]
+
+            if prefix == 'xpath':
+                loc = base.locator(f'xpath={value}')
+            elif prefix == 'css':
+                loc = base.locator(value)
+            elif prefix == 'text':
+                loc = base.get_by_text(value)
+            elif prefix == 'id':
+                loc = base.locator(f'#{value}')
+            elif prefix == 'name':
+                loc = base.locator(f'[name="{value}"]')
+            elif prefix == 'class':
+                loc = base.locator(f'.{value}')
+            else:
+                loc = base.locator(expression)
+        else:
+            # 纯 CSS 选择器
+            loc = base.locator(expression)
+
+        # 处理索引
+        if index is not None:
+            if index == 'first' or index == 0:
+                loc = loc.first
+            elif index == 'last' or index == -1:
+                loc = loc.last
+            elif isinstance(index, int):
+                loc = loc.nth(index)
+
+        return loc
+
+    def switch_frame(self, targeting: str, element: str) -> None:
+        """切换到 iframe
+
+        Args:
+            targeting: 定位类型
+            element: 定位表达式
+        """
+        if targeting == 'xpath':
+            frame_locator = self.page.frame_locator(f'xpath={element}')
+        elif targeting in ('css', 'selector'):
+            frame_locator = self.page.frame_locator(element)
+        elif targeting == 'name':
+            frame_locator = self.page.frame_locator(f'[name="{element}"]')
+        elif targeting == 'id':
+            frame_locator = self.page.frame_locator(f'#{element}')
+        else:
+            frame_locator = self.page.frame_locator(element)
+
+        self._frame_stack.append(self._current_frame)
+        self._current_frame = frame_locator
+        INFO(f"切换到 iframe: {element}")
+
+    def switch_frame_parent(self) -> None:
+        """切换到父级 frame"""
+        if self._frame_stack:
+            self._current_frame = self._frame_stack.pop()
+        else:
+            self._current_frame = None
+        INFO("切换到父级 frame")
+
+    def frame_default(self) -> None:
+        """返回主文档"""
+        self._current_frame = None
+        self._frame_stack.clear()
+        INFO("切换到主文档")
+
+    def wait_for_loading(self, timeout: int = 30000) -> None:
+        """等待页面加载完成
+
+        Args:
+            timeout: 超时时间 (毫秒)
+        """
+        self.page.wait_for_load_state('networkidle', timeout=timeout)
+
+    def wait_for_dom_ready(self, timeout: int = 30000) -> None:
+        """等待 DOM 加载完成
+
+        Args:
+            timeout: 超时时间 (毫秒)
+        """
+        self.page.wait_for_load_state('domcontentloaded', timeout=timeout)
+
+    def wait_for_element_plus_loading(self, timeout: int = 30000) -> None:
+        """等待 Element Plus 的 v-loading 消失
+
+        Args:
+            timeout: 超时时间 (毫秒)
+        """
+        loading = self.page.locator('.el-loading-mask')
+        try:
+            if loading.count() > 0:
+                loading.first.wait_for(state='hidden', timeout=timeout)
+        except Exception:
+            pass  # loading 可能已经消失
+
+    def wait_for_element(
+        self,
+        targeting: str,
+        element: str,
+        state: str = 'visible',
+        timeout: int = 30000
+    ) -> None:
+        """等待元素状态
+
+        Args:
+            targeting: 定位类型
+            element: 定位表达式
+            state: 等待状态 (visible, hidden, attached, detached)
+            timeout: 超时时间 (毫秒)
+        """
+        loc = self.locator(targeting, element)
+        loc.wait_for(state=state, timeout=timeout)
+
+    def is_element_visible(self, targeting: str, element: str, index: Optional[int] = None) -> bool:
+        """检查元素是否可见
+
+        Args:
+            targeting: 定位类型
+            element: 定位表达式
+            index: 索引
+
+        Returns:
+            bool: 元素是否可见
+        """
+        loc = self.locator(targeting, element, index)
+        return loc.is_visible()
+
+    def is_element_enabled(self, targeting: str, element: str, index: Optional[int] = None) -> bool:
+        """检查元素是否可用
+
+        Args:
+            targeting: 定位类型
+            element: 定位表达式
+            index: 索引
+
+        Returns:
+            bool: 元素是否可用
+        """
+        loc = self.locator(targeting, element, index)
+        return loc.is_enabled()
+
+    def get_element_count(self, targeting: str, element: str) -> int:
+        """获取元素数量
+
+        Args:
+            targeting: 定位类型
+            element: 定位表达式
+
+        Returns:
+            int: 元素数量
+        """
+        loc = self.locator(targeting, element)
+        return loc.count()
+
+    def execute_script(self, script: str, *args) -> any:
+        """执行 JavaScript
+
+        Args:
+            script: JavaScript 代码
+            *args: 脚本参数
+
+        Returns:
+            脚本执行结果
+        """
+        return self.page.evaluate(script, args if args else None)
+
+    def execute_script_on_element(
+        self,
+        targeting: str,
+        element: str,
+        script: str,
+        index: Optional[int] = None
+    ) -> any:
+        """在元素上执行 JavaScript
+
+        Args:
+            targeting: 定位类型
+            element: 定位表达式
+            script: JavaScript 代码 (使用 el 引用元素)
+            index: 索引
+
+        Returns:
+            脚本执行结果
+        """
+        loc = self.locator(targeting, element, index)
+        return loc.evaluate(script)