Pelco KBD300A 模拟器:13.项目pytest自动化测试方案规划

Pelco KBD300A 模拟器项目pytest自动化测试方案规划

本规划基于最新上传的代码版本（已优化），针对项目的核心功能、逻辑、架构和模块实现情况，制定全面的测试方案。测试方案旨在验证代码的正确性、鲁棒性、性能和覆盖率，确保模拟器在模拟Pelco-D/P协议、宏执行、模板渲染、串口通信、UI交互等方面的可靠性。规划排除已有的测试文件（假设tests目录存在），聚焦于方案设计、测试类型、覆盖范围、工具使用和执行步骤。

测试方案遵循以下原则：

• 全面覆盖：从单元到端到端，覆盖正常/异常场景、边界case。
• 自动化优先：使用pytest自动化执行，手动测试仅用于UI视觉验证。
• 覆盖率目标：至少80%行覆盖率，分支覆盖率70%+（使用pytest-cov）。
• 环境独立：测试在隔离环境中运行（e.g., virtualenv），模拟Windows 7/Python 3.7，但实际使用Python 3.12（从工具查询确认pytest 8.4.1）。
• CI/CD集成：设计支持GitHub Actions等，自动运行测试。
• 风险导向：优先测试高风险模块（如协议解析、宏引擎、串口线程）。

1. 测试范围和覆盖

1.1 测试类型分类

• 单元测试 (Unit Tests)：测试单个函数/类/方法，隔离依赖（使用mock/pytest-mock）。
  • 示例：测试core/protocol/pelco_protocol.py的build_pelco_d()函数，输入参数 → 预期字节输出。
  • 覆盖：函数逻辑、异常处理、边界值（e.g., speed=0/63/超出范围）。
• 集成测试 (Integration Tests)：测试模块间交互，不涉及UI。
  • 示例：core/serial/manager.py + core/protocol/base.py，模拟串口写/读，验证帧构建/解析。
  • 覆盖：数据流（e.g., 键盘输入 → 协议帧 → 串口发送）。
• UI测试 (UI Tests)：使用pytest-qt模拟Qt事件，测试交互。
  • 示例：ui/keyboard/joystick.py，模拟鼠标拖拽 → 验证pan_tilt_changed信号。
  • 覆盖：信号发射、UI状态变化（e.g., LCD显示模式切换）。
• 端到端测试 (End-to-End Tests)：模拟完整流程，包括UI + 核心 + 模拟设备。
  • 示例：键盘按下PRESET → 发送预置位命令 → 虚拟设备更新状态 → 日志记录。
  • 覆盖：用户场景（如运行宏、触发报警）。
• 性能测试 (Performance Tests)：使用cProfile（已集成在engine.py），测试宏执行时间、日志缓冲。
  • 示例：大循环宏执行，验证不超过阈值。
• 手动测试 (Manual Tests)：视觉/交互验证（e.g., 主题切换、QSS渲染），不自动化。
  • 示例：打开UI，检查摇杆动画、指示灯闪烁。

1.2 模块覆盖规划

基于项目分析，按模块优先级（高风险先）规划测试点：

• core/alarm/rules.py(高)：
  • 单元：load/save规则，验证JSON解析/写入；execute_alarm_action()匹配规则/执行动作。
  • 集成：与宏引擎结合，测试触发run_macro。
  • case：无效规则、禁用规则、异常动作。
• core/macro/(高)：
  • 单元：parser.py解析脚本（正常/语法错误）；standard.py验证命令（范围/类型）；engine.py解释AST（loop/if变量）。
  • 集成：api.py统一入口，测试get_parser() → parse → execute。
  • case：嵌套循环、变量赋值、性能估算准确性。
• core/protocol/(高)：
  • 单元：build/parse函数（D/P），校验和计算；自动检测（detect_protocol）。
  • 集成：与serial结合，端到端帧处理。
  • case：无效帧、边界速度、报警帧。
• core/serial/(高)：
  • 单元：worker.py读取/解析；manager.py写方法。
  • 集成：线程安全（多线程写/读）；Auto协议切换。
  • case：串口错误（无端口）、缓冲溢出。
• core/simulator/virtual_device.py(中)：
  • 单元：process_command()更新状态；get_status_dict()。
  • 集成：与protocol结合，模拟响应。
  • case：连续命令、报警模拟。
• core/template/(中)：
  • 单元：renderer.py替换占位符（类型转换）；library.py load/save。
  • 集成：runner.py异步执行；params.py输入验证。
  • case：缺少参数、非法类型。
• core/utils/(中)：
  • 单元：log_emitter.py缓冲/发射；bytes_to_hex。
  • 集成：多源日志（serial/macro），批量优化。
  • case：高频日志、flush()。
• ui/keyboard/(高)：
  • UI：lcd.py显示动画/模式；joystick.py拖拽事件；indicator_manager.py状态切换/闪烁。
  • 集成：panel.py按钮信号 → 主窗口处理。
  • case：缩放、主题应用。
• ui/right_panel/(高)：
  • UI：macro_editor.py高亮/补全/运行；template_library_panel.py编辑/渲染；log_panel.py过滤/导出。
  • 集成：panel.py信号转发（e.g., run_macro）。
  • case：表格动态行、搜索。
• ui/main_window.py & app.py(高)：
  • 端到端：完整启动/关闭；配置加载；信号链（键盘 → 串口 → 日志）。
  • case：异常启动、主题切换。

1.3 测试case设计原则

• 正常case：预期输入 → 预期输出。
• 异常case：无效输入（e.g., None、超出范围） → 优雅处理/日志。
• 边界case：最小/最大值（e.g., speed= -100/100）。
• 并发case：多线程（e.g., 同时写/读串口）。
• 数据驱动：使用@pytest.mark.parametrize（e.g., 多协议测试）。
• Mock依赖：mock serial、QTimer、信号（pytest-mock、pytest-qt）。

2. 测试工具和配置

• 框架：pytest 8.4.1（从工具确认）。
• 插件：
  • pytest-qt：UI事件模拟（e.g., qtbot.mousePress()）。
  • pytest-cov：覆盖率（–cov=core --cov=ui）。
  • pytest-mock：mock对象（e.g., mocker.patch(‘serial.Serial’)）。
• 环境：
  • Python 3.12（兼容3.7代码）。
  • QT_QPA_PLATFORM=offscreen（无头UI测试）。
  • 变量：KBD300A_TEST_MODE=1（启用测试模式，如虚拟串口）。
• 配置：使用pytest.ini（已存在），添加markers（e.g., ui: UI测试）。
• 报告：–cov-report=html，生成htmlcov/目录；–junitxml=report.xml（CI）。

3. 执行步骤

3.1 准备阶段

1. 安装依赖：

   • 创建虚拟环境：python -m venv venv；激活：venv\Scripts\activate（Windows）。
   • 安装：pip install -r requirements.txt（包括pytest、pytest-qt、pytest-cov）。

2. 目录结构：

   • tests/：根测试目录。
     • unit/：单元测试子目录。
     • integration/：集成。
     • ui/：UI。
     • e2e/：端到端。
   • conftest.py：全局fixture（e.g., mock_serial = pytest.fixture()）。

3. 编写/更新测试：

   • 根据1.2规划，创建test_xxx.py（e.g., test_protocol.py）。

   • 示例fixture：

     @pytest.fixturedefmock_serial(mocker):returnmocker.patch('serial.Serial',autospec=True)

   • 示例测试：

     deftest_build_pelco_d():assertbuild_pelco_d(1,0,2,0,0)==b'\xFF\x01\x00\x02\x00\x00\x03'# 预期字节

4. 模拟数据：

   • 使用bytes()创建测试帧。
   • JSON fixtures加载配置/模板。

3.2 执行阶段

1. 运行单元/集成测试：
   • 命令：pytest tests/unit tests/integration --cov=core --cov-branch --cov-report=term-missing。
   • 预期：快速运行（<1min），覆盖率报告。
2. 运行UI测试：
   • 环境：set QT_QPA_PLATFORM=offscreen（Windows）。
   • 命令：pytest tests/ui -v（verbose）。
   • 使用qtbot fixture模拟事件（e.g., qtbot.mouseMove(joystick, pos)）。
3. 运行端到端测试：
   • 命令：pytest tests/e2e --cov=ui --cov-append（追加覆盖率）。
   • 包括虚拟设备初始化。
4. 性能测试：
   • 集成在单元中：assert execution_time < 1.0。
5. 全套运行：
   • 命令：pytest --cov --cov-report=html --cov-fail-under=80。
   • 如果失败，重跑：pytest --lf（last failed）。
6. 手动测试：
   • 运行app.py，交互验证（e.g., 拖摇杆观察LCD/日志）。
   • 记录：使用Excel表格，列出场景/预期/实际。

3.3 分析和迭代阶段

1. 查看报告：

   • 打开htmlcov/index.html，检查未覆盖行。
   • JUnit XML：集成CI。

2. 调试：

   • –pdb：失败时进入调试。
   • 日志：检查test输出。

3. 迭代：

   • 覆盖率低 → 添加case。
   • 失败 → 修复bug，重跑。
   • 目标：100%通过，覆盖率达标。

4. CI集成：

   • .github/workflows/test.yml：

     name:Testson:[push]jobs:test:runs-on:windows-lateststeps:-uses:actions/checkout@v2-name:Set up Pythonuses:actions/setup-python@v2with:{python-version:'3.12'}-run:pip install-r requirements.txt-run:pytest--cov--cov-report=xml-uses:codecov/codecov-action@v1

4. 时间和资源估算

• 时间：编写测试1-2周（1人，覆盖80%）；执行/迭代1周。
• 资源：Windows机（模拟7环境）；CI免费（GitHub）。
• 风险：UI测试不稳定（Qt timing） → 使用qtbot.wait()。
• 成功指标：0失败，覆盖率>80%，无重大bug。
  上一篇总目录下一篇