Skip to content

U
ubains-module-test
提交 4c9131ba authored 作者: 陈泽健's avatar 陈泽健
浏览文件
操作

feat(report): 添加Markdown格式报告生成功能并优化文档排版 

- 新增Markdown报告生成模块(markdown_generator.py)
- 支持Word和Markdown两种格式报告输出
- 添加报告格式选择参数(--format选项)
- 更新GUI界面支持格式选择
- 优化文档标题字号、字体和颜色配置
- 修改配置文件中的字体设置为宋体
- 更新PRD文档结构和内容描述
- 重构CLI模块支持多种格式输出
- 添加报告命名规则适配不同格式
- 更新README文档说明新功能特性
上级 09170467
显示空白字符变更
内嵌 并排
正在显示 包含 2620 行增加 和 86 行删除
AuxiliaryTool/FunctionalTestReportGeneration/README.md
浏览文件 @ 4c9131ba
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
## 功能简介 ## 功能简介
本工具通过读取测试用例Excel文件和BUG列表Excel文件，自动生成功能测试报告（Word格式）。 本工具通过读取测试用例Excel文件和BUG列表Excel文件，自动生成功能测试报告（支持Word和Markdown两种格式）。
### 主要功能 ### 主要功能
...@@ -10,7 +10,7 @@ ...@@ -10,7 +10,7 @@
- 统计用例执行情况、BUG数量和等级分布 - 统计用例执行情况、BUG数量和等级分布
- 自动关联用例与BUG - 自动关联用例与BUG
- 生成统计图表（饼图、柱状图） - 生成统计图表（饼图、柱状图）
- 生成Word格式的功能测试报告 - 生成Word格式或Markdown格式的功能测试报告
## 环境要求 ## 环境要求
...@@ -42,7 +42,14 @@ python run.py ...@@ -42,7 +42,14 @@ python run.py
### 方式二：命令行参数模式 ### 方式二：命令行参数模式
```bash ```bash
# 生成Word报告
python run.py --testcase testcases/测试用例.xlsx --buglist testcases/BUG列表.xlsx python run.py --testcase testcases/测试用例.xlsx --buglist testcases/BUG列表.xlsx
# 生成Markdown报告
python run.py --testcase testcases/测试用例.xlsx --buglist testcases/BUG列表.xlsx --format md
# 同时生成Word和Markdown报告
python run.py --testcase testcases/测试用例.xlsx --buglist testcases/BUG列表.xlsx --format both
``` ```
完整参数说明： 完整参数说明：
...@@ -53,6 +60,7 @@ python run.py --testcase testcases/测试用例.xlsx --buglist testcases/BUG列 ...@@ -53,6 +60,7 @@ python run.py --testcase testcases/测试用例.xlsx --buglist testcases/BUG列
| `--buglist` | BUG列表Excel文件路径 | | `--buglist` | BUG列表Excel文件路径 |
| `--output` | 输出报告文件路径（可选） | | `--output` | 输出报告文件路径（可选） |
| `--project` | 项目名称（可选） | | `--project` | 项目名称（可选） |
| `--format` | 报告格式：docx（Word文档）、md（Markdown文档）、both（两种格式），默认为docx |
| `--gui` | 使用GUI界面 | | `--gui` | 使用GUI界面 |
| `--list` | 列出testcases目录下的可用文件 | | `--list` | 列出testcases目录下的可用文件 |
...@@ -129,9 +137,10 @@ FunctionalTestReportGeneration/ ...@@ -129,9 +137,10 @@ FunctionalTestReportGeneration/
报告将保存到 `reports/` 目录，文件名格式为： 报告将保存到 `reports/` 目录，文件名格式为：
``` - Word格式：`{项目名称}_功能测试报告_{日期}.docx`
{项目名称}_功能测试报告_{日期}.docx - Markdown格式：`{项目名称}_功能测试报告_{日期}.md`
```
支持同时生成两种格式的报告。
报告包含以下内容： 报告包含以下内容：
......
AuxiliaryTool/FunctionalTestReportGeneration/reports/历史/华为智慧园区合作伙伴对接开发_功能测试报告_2026年03月09日.md 0 → 100644
浏览文件 @ 4c9131ba
# 华为智慧园区合作伙伴对接开发功能测试报告
## 一、报告基本信息
### 1.1 报告标识
| 项目 | 内容 |
| --- | --- |
| 报告编号 | 华为智慧园区合作伙伴对接开发-2026年03月09日 |
| 报告标题 | 华为智慧园区合作伙伴对接开发功能测试报告 |
| 报告版本 | v1.0 |
| 生成日期 | 2026年03月09日 |
| 报告状态 | 已生成 |
### 1.2 测试概览
| 项目 | 内容 |
| --- | --- |
| 项目名称 | 华为智慧园区合作伙伴对接开发 |
| 测试负责人 | 未填写 |
| 测试人员 | 未填写 |
| 测试环境 | 未填写 |
| 测试类型 | 功能测试 |
### 1.3 被测系统信息
| 项目 | 内容 |
| --- | --- |
| 系统名称 | 华为智慧园区合作伙伴对接开发 |
| 系统版本 | 未填写 |
| 服务器地址 | 未填写 |
| 部署环境 | 未填写 |
## 二、测试执行摘要
### 2.1 测试结果统计
| 统计项 | 数量 | 占比 |
| --- | --- | --- |
| 测试用例总数 | 35 | 100% |
| 执行用例数量 | 28 | 80.0% |
| 通过用例数量 | 28 | 80.0% |
| 失败用例数量 | 0 | 0.0% |
| 未执行用例数量 | 10 | 28.57% |
### 2.2 BUG统计汇总
| BUG等级 | 数量 | 占比 | 已关闭 | 未关闭 |
| --- | --- | --- | --- | --- |
| 测试用例总数 | 35 | 100% | | |
| 执行用例数量 | 28 | 80.0% | | |
| 通过用例数量 | 28 | 80.0% | | |
| 失败用例数量 | 0 | 0.0% | | |
| 未执行用例数量 | 10 | 28.57% | | |
| 致命(1级) | 1 | 9.09% | 1 | 0 |
| 严重(2级) | 3 | 27.27% | 3 | 0 |
| 一般(3级) | 6 | 54.55% | 6 | 0 |
| 轻微(4级) | 1 | 9.09% | 1 | 0 |
### 2.3 测试结论
✓ **测试通过** - 系统功能正常，无致命/严重缺陷，可以发布
## 三、测试范围
### 3.1 测试模块覆盖
| 序号 | 功能模块 | 用例数量 | 通过 | 失败 | 未执行 | 覆盖率 |
| --- | --- | --- | --- | --- | --- | --- |
| 1 | 系统管理_权限管理_初始化测试 | 1 | 0 | 0 | 0 | 0.0% |
| 2 | 系统管理_权限管理_权限组列表 | 4 | 4 | 0 | 0 | 100.0% |
| 3 | 系统管理_权限管理_权限组添加 | 12 | 9 | 0 | 0 | 75.0% |
| 4 | 系统管理_权限管理_权限组编辑 | 5 | 4 | 0 | 0 | 80.0% |
| 5 | 系统管理_权限管理_权限组绑定 | 6 | 6 | 0 | 0 | 100.0% |
| 6 | 系统管理_权限管理_权限组删除 | 3 | 3 | 0 | 0 | 100.0% |
| 7 | 系统管理_权限管理_权限组禁/启用 | 2 | 2 | 0 | 0 | 100.0% |
| 8 | 系统管理_权限管理_接口权限测试 | 2 | 0 | 0 | 2 | 0.0% |
## 四、测试用例执行详情
### 4.1 通过用例列表
| 序号 | 用例编号 | 功能模块 | 用例名称 | 用例等级 | 测试结果 |
| --- | --- | --- | --- | --- | --- |
| 1 | XTY-212 | 系统管理_权限管理_权限组列表 | 【新统一平台】查看权限组列表是否正确回显数据展示 | 1 | 通过 |
| 2 | XTY-213 | 系统管理_权限管理_权限组列表 | 【新统一平台】输入模糊的“权限组名称”进行搜索，查看列表是否正确显示符合条件的数据 | 1 | 通过 |
| 3 | XTY-214 | 系统管理_权限管理_权限组列表 | 【新统一平台】输入精确的“权限组名称”进行搜索，查看列表是否正确显示符合条件的数据 | 1 | 通过 |
| 4 | XTY-215 | 系统管理_权限管理_权限组列表 | 【新统一平台】切换分页后输入“权限组名称”进行搜索，查看列表是否正确显示符合条件的数据 | 1 | 通过 |
| 5 | XTY-216 | 系统管理_权限管理_权限组添加 | 【新统一平台】点击【添加】按钮，查看是否正确进入权限组新增页面 | 1 | 通过 |
| 6 | XTY-219 | 系统管理_权限管理_权限组添加 | 【新统一平台】“权限组名称”正确输入后，不勾选任一模块，点击【确定】按钮，查看是否正确提示“请至少勾 | 1 | 通过 |
| 7 | XTY-220 | 系统管理_权限管理_权限组添加 | 【新统一平台】查看权限配置列表中各个模块以及子模块的数据显示是否正确 | 1 | 通过 |
| 8 | XTY-221 | 系统管理_权限管理_权限组添加 | 【新统一平台】“权限组名称”正确输入后，勾选“用户管理”模块中的用户列表模块。“状态”选择“已启用” | 1 | 通过 |
| 9 | XTY-222 | 系统管理_权限管理_权限组添加 | 【新统一平台】“权限组名称”正确输入后，勾选“用户管理”模块中的用户列表模块，“状态”选择“已禁用” | 1 | 通过 |
| 10 | XTY-223 | 系统管理_权限管理_权限组添加 | 【新统一平台】当前页面输入信息后点击【取消】按钮，查看是否正确不保留任何操作，返回上一级 | 1 | 通过 |
| 11 | XTY-224 | 系统管理_权限管理_权限组添加 | 【新统一平台】“权限配置搜索框”输入模糊的信息，查看列表是否正确显示符合条件的数据 | 1 | 通过 |
| 12 | XTY-225 | 系统管理_权限管理_权限组添加 | 【新统一平台】“权限配置搜索框”输入精确的信息，查看列表是否正确显示符合条件的数据 | 1 | 通过 |
| 13 | XTY-227 | 系统管理_权限管理_权限组添加 | 【新统一平台】查看当前权限配置的模块数据是否与公司授权文件开放的权限模块数据一致 | 1 | 通过 |
| 14 | XTY-229 | 系统管理_权限管理_权限组编辑 | 【新统一平台】“权限组名称”为空，点击【确定】按钮，查看是否存在提示“权限组名称不能为空” | 1 | 通过 |
| 15 | XTY-230 | 系统管理_权限管理_权限组编辑 | 【新统一平台】修改“权限配置”后保存，登录绑定该权限用户查看权限模块是否正确新增或减少 | 1 | 通过 |
| 16 | XTY-231 | 系统管理_权限管理_权限组编辑 | 【新统一平台】修改“状态”为禁用后保存，登录绑定该权限用户查看是否存在提示 | 1 | 通过 |
| 17 | XTY-232 | 系统管理_权限管理_权限组编辑 | 【新统一平台】修改“权限配置”后点击【取消】按钮，查看是否正确不保留任何操作，返回上一级 | 1 | 通过 |
| 18 | XTY-233 | 系统管理_权限管理_权限组绑定 | 【新统一平台】点击列表权限组的【绑定】按钮，查看是否正确进入“权限组绑定”界面 | 1 | 通过 |
| 19 | XTY-234 | 系统管理_权限管理_权限组绑定 | 【新统一平台】当前勾选任一“角色”进行绑定，绑定该角色用户登录系统，查看是否正确可见开放的模块数据， | 1 | 通过 |
| 20 | XTY-235 | 系统管理_权限管理_权限组绑定 | 【新统一平台】当前勾选任一“部门”进行绑定，该部门下用户登录系统，查看是否正确可见开放的模块数据，并 | 1 | 通过 |
| 21 | XTY-236 | 系统管理_权限管理_权限组绑定 | 【新统一平台】当前勾选任一“用户”进行绑定，该用户登录系统，查看是否正确可见开放的模块数据，并且可正 | 1 | 通过 |
| 22 | XTY-237 | 系统管理_权限管理_权限组绑定 | 【新统一平台】组合“角色”、“部门”、“用户”进行绑定，以上角色、部门及用户登录系统，查看是否正确可 | 1 | 通过 |
| 23 | XTY-238 | 系统管理_权限管理_权限组绑定 | 【新统一平台】切换分页后进行“用户名称”筛选，查看列表是否正确显示用户数据 | 1 | 通过 |
| 24 | XTY-239 | 系统管理_权限管理_权限组删除 | 【新统一平台】当前权限组未绑定用户，点击【删除】按钮，再次点击【确定】按钮，查看是否正确提示“删除成 | 1 | 通过 |
| 25 | XTY-240 | 系统管理_权限管理_权限组删除 | 【新统一平台】当前权限组已绑定用户，点击【删除】按钮，再次点击【确定】按钮，查看是否正确提示“当前权 | 1 | 通过 |
| 26 | XTY-241 | 系统管理_权限管理_权限组删除 | 【新统一平台】当前权限组未绑定用户，点击【删除】按钮，再次点击【取消】按钮，查看是否正确不保留任何操 | 1 | 通过 |
| 27 | XTY-242 | 系统管理_权限管理_权限组禁/启用 | 【新统一平台】将当前权限组禁用后，该权限组下的用户登录系统查看是否正确不可见权限模块 | 1 | 通过 |
| 28 | XTY-243 | 系统管理_权限管理_权限组禁/启用 | 【新统一平台】将当前权限组开启后，该权限组下的用户登录系统查看是否正确可见权限模块 | 1 | 通过 |
### 4.2 失败用例列表
*无失败用例*
### 4.3 未执行用例列表
| 序号 | 用例编号 | 功能模块 | 用例名称 | 用例等级 | 未执行原因 |
| --- | --- | --- | --- | --- | --- |
| 1 | XTY-245 | 系统管理_权限管理_接口权限测试 | 【新统一平台】当前权限组用户不存在用户新增模块权限，通过apifox调用接口查看接口是否正确存在权限 | 1 | 未开发 |
| 2 | XTY-246 | 系统管理_权限管理_接口权限测试 | 【新统一平台】为当前权限组新增用户新增模块权限，通过apifox调用接口查看接口是否正确可调用成功 | 1 | 未开发 |
## 五、BUG详细列表
### 5.1 BUG详细记录
| 序号 | BUG等级 | BUG状态 | BUG名称 | BUG类型 | 提单人员 | 负责人员 |
| --- | --- | --- | --- | --- | --- | --- |
| 1 | 1级 | 已关闭 | 【新统一平台-权限管理】权限管理新增数据后接口没有返回数据信息 | 代码错误 | 陈泽键 | 赵嘉诚 |
| 2 | 3级 | 已关闭 | 【新统一平台-权限管理】新增重复名称的权限组数据仍可以成功创建，需要校验是否存在重复的权限名称 | 代码错误 | 陈泽键 | 赵嘉诚 |
| 3 | 4级 | 已关闭 | 【新统一平台-权限管理】权限新增时“权限组名称”为空点击【确定】按钮需要补充弹出提示“权限组名称不能 | 代码错误 | 陈泽键 | 卢培鍠 |
| 4 | 3级 | 已关闭 | 【新统一平台-权限管理】权限配置界面中的“设备管理”模块下的“会议设备”模块不存在“新增”“修改”功 | 代码错误 | 陈泽键 | 卢培鍠 |
| 5 | 3级 | 已关闭 | 【新统一平台-权限管理】更新版本包后，系统信息不显示版本号 | 代码错误 | 彭甘宇 | 赵嘉诚 |
| 6 | 2级 | 已关闭 | 【新统一平台-权限管理】设置仅查看权限并绑定用户，权限控制不生效 | 代码错误 | 彭甘宇 | 卢培鍠 |
| 7 | 2级 | 已关闭 | 【新统一平台-权限管理】用户绑定权限组后，没有移除用户的操作界面 | 设计缺陷 | 彭甘宇 | 卢培鍠 |
| 8 | 2级 | 已关闭 | 【新统一平台-权限管理】删除用户组时，如果存在用户要有二次确认提示或者限制不给删除。 | 设计缺陷 | 彭甘宇 | 赵嘉诚 |
| 9 | 3级 | 已关闭 | 【新统一平台-权限管理】建议增加批量启用或禁用操作 | 界面优化 | 彭甘宇 | 卢培鍠 |
| 10 | 3级 | 已关闭 | 【新统一平台-权限管理】权限组绑定界面需要增加分页条数切换 | 标准规范 | 彭甘宇 | 卢培鍠 |
| 11 | 3级 | 已关闭 | 【新统一平台-权限管理】新增权限组权限组模块只有组织信息模块，关联用户登录系统后台后仍可以看到其他模 | 代码错误 | 陈泽键 | 卢培鍠 |
### 5.2 遗留BUG说明
*无遗留BUG*
## 六、图表分析
### 6.1 BUG等级分布
![BUG等级分布](E:\GithubData\ubains-module-test\AuxiliaryTool\FunctionalTestReportGeneration\temp\bug_level_chart.png)
### 6.2 用例执行结果分布
![用例执行结果分布](E:\GithubData\ubains-module-test\AuxiliaryTool\FunctionalTestReportGeneration\temp\test_result_chart.png)
### 6.3 用例执行情况统计
![用例执行情况统计](E:\GithubData\ubains-module-test\AuxiliaryTool\FunctionalTestReportGeneration\temp\pass_rate_chart.png)
### 6.4 各模块BUG分布
![各模块BUG分布](E:\GithubData\ubains-module-test\AuxiliaryTool\FunctionalTestReportGeneration\temp\bug_by_module_chart.png)
## 七、测试执行记录
### 7.1 执行时间统计
| 统计项 | 时间 |
| --- | --- |
| 测试开始时间 | 2026年03月09日 |
| 测试结束时间 | 2026年03月09日 |
| 测试总耗时 | 自动化生成 |
| 平均用例执行时间 | N/A |
### 7.2 执行人员分工
| 测试人员 | 负责模块 | 执行用例数 | 发现BUG数 |
| --- | --- | --- | --- |
| 自动化工具 | 全模块 | 35 | 11 |
## 八、测试附件
### 8.1 测试截图
*无测试截图*
### 8.2 测试日志
*无测试日志*
## 九、风险评估与建议
### 9.1 质量风险分析
*无特别风险*
### 9.2 发布建议
- [x] **建议发布** - 质量达标，风险可控
### 9.3 改进建议
待补充
## 十、附录
### 10.1 用例与BUG关联表
*无关联数据*
### 10.2 术语表
*无术语定义*
### 10.3 参考文档
*无参考文档*
### 10.4 修订历史
| 版本 | 修订日期 | 修订人 | 修订内容 |
| --- | --- | --- | --- |
| v1.0 | 2026年03月09日 | 自动化工具 | 自动生成初始报告 |
AuxiliaryTool/FunctionalTestReportGeneration/src/cli.py
浏览文件 @ 4c9131ba
...@@ -8,16 +8,21 @@ ...@@ -8,16 +8,21 @@
import argparse import argparse
import sys import sys
from pathlib import Path from pathlib import Path
from typing import Dict, Optional from typing import Dict, List, Optional
from src.excel_reader import read_test_cases, read_bug_list from src.excel_reader import read_test_cases, read_bug_list
from src.data_analyzer import analyze_test_cases, analyze_bugs, link_bugs_to_cases from src.data_analyzer import analyze_test_cases, analyze_bugs, link_bugs_to_cases
from src.chart_generator import generate_all_charts from src.chart_generator import generate_all_charts
from src.report_generator import generate_report from src.word_generator import generate_report as generate_word_report
from src.markdown_generator import generate_markdown_report
from src.config import ( from src.config import (
TESTCASES_DIR, TESTCASES_DIR,
REPORTS_DIR, REPORTS_DIR,
get_report_filename, get_report_filename,
REPORT_FORMAT_DOCX,
REPORT_FORMAT_MD,
REPORT_FORMATS,
DEFAULT_REPORT_FORMAT,
) )
...@@ -57,6 +62,14 @@ def parse_arguments() -> argparse.Namespace: ...@@ -57,6 +62,14 @@ def parse_arguments() -> argparse.Namespace:
help='项目名称（可选，默认从BUG列表中读取）' help='项目名称（可选，默认从BUG列表中读取）'
) )
parser.add_argument(
'--format',
type=str,
choices=['docx', 'md', 'both'],
default='docx',
help='报告格式：docx(Word文档)、md(Markdown文档)、both(两种格式)，默认为docx'
)
parser.add_argument( parser.add_argument(
'--gui', '--gui',
action='store_true', action='store_true',
...@@ -158,6 +171,17 @@ def interactive_input() -> Dict[str, str]: ...@@ -158,6 +171,17 @@ def interactive_input() -> Dict[str, str]:
project_name = input("请输入项目名称（或直接回车自动获取）: ").strip() project_name = input("请输入项目名称（或直接回车自动获取）: ").strip()
result["project"] = project_name if project_name else None result["project"] = project_name if project_name else None
# 获取报告格式
while True:
format_input = input("请输入报告格式（docx/md/both，直接回车默认docx）: ").strip().lower()
if not format_input:
result["format"] = "docx"
break
if format_input in ['docx', 'md', 'both']:
result["format"] = format_input
break
print("格式输入错误，请输入 docx、md 或 both")
return result return result
...@@ -189,8 +213,9 @@ def generate_report_main( ...@@ -189,8 +213,9 @@ def generate_report_main(
testcase_path: str, testcase_path: str,
buglist_path: str, buglist_path: str,
output_path: Optional[str] = None, output_path: Optional[str] = None,
project_name: Optional[str] = None project_name: Optional[str] = None,
) -> str: report_format: str = "docx"
) -> List[str]:
""" """
生成报告的主函数 生成报告的主函数
...@@ -199,26 +224,27 @@ def generate_report_main( ...@@ -199,26 +224,27 @@ def generate_report_main(
buglist_path: BUG列表Excel文件路径 buglist_path: BUG列表Excel文件路径
output_path: 输出报告文件路径（可选） output_path: 输出报告文件路径（可选）
project_name: 项目名称（可选） project_name: 项目名称（可选）
report_format: 报告格式（docx/md/both）
Returns: Returns:
生成的报告文件路径 生成的报告文件路径列表
""" """
print("\n=== 开始生成功能测试报告 ===\n") print("\n=== 开始生成功能测试报告 ===\n")
# 步骤1：读取Excel数据 # 步骤1：读取Excel数据
print("步骤1/5: 读取测试数据...") print("步骤1/6: 读取测试数据...")
try: try:
test_cases = read_test_cases(testcase_path) test_cases = read_test_cases(testcase_path)
print(f" ✓ 读取到 {len(test_cases)} 条测试用例") print(f" [OK] 读取到 {len(test_cases)} 条测试用例")
except Exception as e: except Exception as e:
print(f" ✗ 读取测试用例失败: {str(e)}") print(f" [X] 读取测试用例失败: {str(e)}")
sys.exit(1) sys.exit(1)
try: try:
bugs = read_bug_list(buglist_path) bugs = read_bug_list(buglist_path)
print(f" ✓ 读取到 {len(bugs)} 条BUG记录") print(f" [OK] 读取到 {len(bugs)} 条BUG记录")
except Exception as e: except Exception as e:
print(f" ✗ 读取BUG列表失败: {str(e)}") print(f" [X] 读取BUG列表失败: {str(e)}")
sys.exit(1) sys.exit(1)
# 获取项目名称 # 获取项目名称
...@@ -230,57 +256,95 @@ def generate_report_main( ...@@ -230,57 +256,95 @@ def generate_report_main(
print(f" 项目名称: {project_name}") print(f" 项目名称: {project_name}")
# 步骤2：分析数据 # 步骤2：分析数据
print("\n步骤2/5: 分析测试数据...") print("\n步骤2/6: 分析测试数据...")
case_analysis = analyze_test_cases(test_cases) case_analysis = analyze_test_cases(test_cases)
print(f" ✓ 总用例数: {case_analysis.total_cases}") print(f" [OK] 总用例数: {case_analysis.total_cases}")
print(f" ✓ 通过率: {case_analysis.pass_rate}%") print(f" [OK] 通过率: {case_analysis.pass_rate}%")
bug_analysis = analyze_bugs(bugs) bug_analysis = analyze_bugs(bugs)
print(f" ✓ BUG总数: {bug_analysis.total_bugs}") print(f" [OK] BUG总数: {bug_analysis.total_bugs}")
print(f" ✓ 遗留BUG: {bug_analysis.remaining_bugs}") print(f" [OK] 遗留BUG: {bug_analysis.remaining_bugs}")
case_bug_link = link_bugs_to_cases(bugs, test_cases) case_bug_link = link_bugs_to_cases(bugs, test_cases)
print(f" ✓ 关联了 {len(case_bug_link)} 个用例到BUG") print(f" [OK] 关联了 {len(case_bug_link)} 个用例到BUG")
# 步骤3：生成图表 # 步骤3：生成图表
print("\n步骤3/5: 生成统计图表...") print("\n步骤3/6: 生成统计图表...")
try: try:
from src.chart_generator import generate_all_charts from src.chart_generator import generate_all_charts
chart_paths = generate_all_charts(case_analysis, bug_analysis) chart_paths = generate_all_charts(case_analysis, bug_analysis)
print(f" ✓ 生成了 {len(chart_paths)} 个图表") print(f" [OK] 生成了 {len(chart_paths)} 个图表")
except Exception as e: except Exception as e:
print(f" ⚠ 生成图表失败: {str(e)}") print(f" [!] 生成图表失败: {str(e)}")
chart_paths = {} chart_paths = {}
# 步骤4：生成报告 # 确定要生成的格式
print("\n步骤4/5: 生成Word报告...") formats_to_generate = []
if report_format == "both":
formats_to_generate = ["docx", "md"]
else:
formats_to_generate = [report_format]
# 步骤4-5：生成各种格式的报告
generated_reports = []
for fmt in formats_to_generate:
print(f"\n步骤{4 + len(generated_reports)}/6: 生成{fmt.upper()}报告...")
# 确定输出路径
if output_path is None: if output_path is None:
output_path = str(REPORTS_DIR / get_report_filename(project_name)) output_file_path = str(REPORTS_DIR / get_report_filename(project_name, format=fmt))
else:
# 如果用户指定了输出路径，替换扩展名
output_path_obj = Path(output_path)
if fmt == "md":
output_file_path = str(output_path_obj.with_suffix(".md"))
else:
output_file_path = str(output_path_obj.with_suffix(".docx"))
try: try:
report_path = generate_report( if fmt == "docx":
template_path="", # 暂不使用模板 report_path = generate_word_report(
template_path="",
case_analysis=case_analysis, case_analysis=case_analysis,
bug_analysis=bug_analysis, bug_analysis=bug_analysis,
case_bug_link=case_bug_link, case_bug_link=case_bug_link,
chart_paths=chart_paths, chart_paths=chart_paths,
output_path=output_path, output_path=output_file_path,
project_name=project_name, project_name=project_name,
cases=test_cases, cases=test_cases,
bugs=bugs bugs=bugs
) )
print(f" ✓ 报告已生成: {report_path}") else: # md
report_path = generate_markdown_report(
template_path="",
case_analysis=case_analysis,
bug_analysis=bug_analysis,
case_bug_link=case_bug_link,
chart_paths=chart_paths,
output_path=output_file_path,
project_name=project_name,
cases=test_cases,
bugs=bugs
)
print(f" [OK] {fmt.upper()}报告已生成: {report_path}")
generated_reports.append(report_path)
except Exception as e: except Exception as e:
print(f" ✗ 生成报告失败: {str(e)}") print(f" [X] 生成{fmt.upper()}报告失败: {str(e)}")
import traceback import traceback
traceback.print_exc() traceback.print_exc()
sys.exit(1)
# 步骤5：完成 # 步骤6：完成
print("\n步骤5/5: 完成！") remaining_steps = 6 - (4 + len(generated_reports))
print(f"\n报告已保存到: {report_path}") if remaining_steps > 0:
print(f"\n步骤{4 + len(generated_reports)}/6: 完成！")
else:
print(f"\n步骤6/6: 完成！")
print(f"\n报告已保存到:")
for report in generated_reports:
print(f" - {report}")
return report_path return generated_reports
def main_cli() -> None: def main_cli() -> None:
...@@ -308,6 +372,7 @@ def main_cli() -> None: ...@@ -308,6 +372,7 @@ def main_cli() -> None:
buglist_path = args.buglist buglist_path = args.buglist
output_path = args.output output_path = args.output
project_name = args.project project_name = args.project
report_format = args.format
else: else:
# 交互式输入 # 交互式输入
inputs = interactive_input() inputs = interactive_input()
...@@ -315,6 +380,7 @@ def main_cli() -> None: ...@@ -315,6 +380,7 @@ def main_cli() -> None:
buglist_path = inputs["buglist"] buglist_path = inputs["buglist"]
output_path = inputs.get("output") output_path = inputs.get("output")
project_name = inputs.get("project") project_name = inputs.get("project")
report_format = inputs.get("format", "docx")
# 生成报告 # 生成报告
try: try:
...@@ -322,7 +388,8 @@ def main_cli() -> None: ...@@ -322,7 +388,8 @@ def main_cli() -> None:
testcase_path=testcase_path, testcase_path=testcase_path,
buglist_path=buglist_path, buglist_path=buglist_path,
output_path=output_path, output_path=output_path,
project_name=project_name project_name=project_name,
report_format=report_format
) )
except KeyboardInterrupt: except KeyboardInterrupt:
print("\n\n操作已取消") print("\n\n操作已取消")
......
AuxiliaryTool/FunctionalTestReportGeneration/src/config.py
浏览文件 @ 4c9131ba
...@@ -145,19 +145,30 @@ BUG_COL_REPRODUCTION_STEPS = 9 # 复现步骤 ...@@ -145,19 +145,30 @@ BUG_COL_REPRODUCTION_STEPS = 9 # 复现步骤
# ================================ # ================================
# 报告生成配置 # 报告生成配置
# ================================ # ================================
# 报告输出格式 # 报告输出格式（支持的格式）
REPORT_FORMAT = ".docx" REPORT_FORMAT_DOCX = ".docx"
REPORT_FORMAT_MD = ".md"
REPORT_FORMATS = [REPORT_FORMAT_DOCX, REPORT_FORMAT_MD]
# 报告命名规则：{项目名称}_功能测试报告_{日期}.docx # 默认报告格式
DEFAULT_REPORT_FORMAT = REPORT_FORMAT_DOCX
# 报告命名规则：{项目名称}_功能测试报告_{日期}.{format}
REPORT_FILENAME_TEMPLATE = "{project_name}_功能测试报告_{date}{format}" REPORT_FILENAME_TEMPLATE = "{project_name}_功能测试报告_{date}{format}"
# 报告编号规则：{项目名称}-{日期} # 报告编号规则：{项目名称}-{日期}
REPORT_NUMBER_TEMPLATE = "{project_name}-{date}" REPORT_NUMBER_TEMPLATE = "{project_name}-{date}"
# Word文档样式配置 # Word文档样式配置
WORD_FONT_NAME = "微软雅黑" WORD_FONT_NAME = "宋体"
WORD_FONT_SIZE = 11 WORD_FONT_SIZE = 11
WORD_TITLE_FONT_SIZE = 16 # 各级标题字号配置
WORD_TITLE_LEVEL_1_SIZE = 21 # 一级标题字号
WORD_TITLE_LEVEL_2_SIZE = 19 # 二级标题字号
WORD_TITLE_LEVEL_3_SIZE = 17 # 三级标题字号
WORD_TITLE_LEVEL_4_SIZE = 15 # 四级标题字号
# 段落格式配置
WORD_PARAGRAPH_FIRST_LINE_INDENT = 2 # 正文首行缩进字符数
# ================================ # ================================
# 图表生成配置 # 图表生成配置
...@@ -212,13 +223,14 @@ __author__ = "Auto Report Generator" ...@@ -212,13 +223,14 @@ __author__ = "Auto Report Generator"
__description__ = "功能测试报告自动生成工具" __description__ = "功能测试报告自动生成工具"
def get_report_filename(project_name: str, date: str = None) -> str: def get_report_filename(project_name: str, date: str = None, format: str = DEFAULT_REPORT_FORMAT) -> str:
""" """
获取报告文件名 获取报告文件名
Args: Args:
project_name: 项目名称 project_name: 项目名称
date: 日期字符串（可选，默认使用当前日期） date: 日期字符串（可选，默认使用当前日期）
format: 报告格式（可选，默认为.docx）
Returns: Returns:
报告文件名 报告文件名
...@@ -227,10 +239,14 @@ def get_report_filename(project_name: str, date: str = None) -> str: ...@@ -227,10 +239,14 @@ def get_report_filename(project_name: str, date: str = None) -> str:
from datetime import datetime from datetime import datetime
date = datetime.now().strftime(FILENAME_DATE_FORMAT) date = datetime.now().strftime(FILENAME_DATE_FORMAT)
# 确保格式以点开头
if not format.startswith("."):
format = "." + format
return REPORT_FILENAME_TEMPLATE.format( return REPORT_FILENAME_TEMPLATE.format(
project_name=project_name, project_name=project_name,
date=date, date=date,
format=REPORT_FORMAT format=format
) )
......
AuxiliaryTool/FunctionalTestReportGeneration/src/gui.py
浏览文件 @ 4c9131ba
...@@ -13,7 +13,12 @@ from pathlib import Path ...@@ -13,7 +13,12 @@ from pathlib import Path
from typing import Optional from typing import Optional
from src.cli import generate_report_main from src.cli import generate_report_main
from src.config import TESTCASES_DIR, REPORTS_DIR from src.config import (
TESTCASES_DIR,
REPORTS_DIR,
REPORT_FORMAT_DOCX,
REPORT_FORMAT_MD,
)
class ReportGeneratorGUI: class ReportGeneratorGUI:
...@@ -32,7 +37,7 @@ class ReportGeneratorGUI: ...@@ -32,7 +37,7 @@ class ReportGeneratorGUI:
"""初始化GUI""" """初始化GUI"""
self.root = tk.Tk() self.root = tk.Tk()
self.root.title("功能测试报告自动生成工具") self.root.title("功能测试报告自动生成工具")
self.root.geometry("800x600") self.root.geometry("800x650")
self.root.resizable(True, True) self.root.resizable(True, True)
# 文件路径变量 # 文件路径变量
...@@ -41,6 +46,9 @@ class ReportGeneratorGUI: ...@@ -41,6 +46,9 @@ class ReportGeneratorGUI:
self.output_path = tk.StringVar() self.output_path = tk.StringVar()
self.project_name = tk.StringVar() self.project_name = tk.StringVar()
# 报告格式变量
self.report_format = tk.StringVar(value="docx")
# 设置默认输出路径 # 设置默认输出路径
self.output_path.set(str(REPORTS_DIR)) self.output_path.set(str(REPORTS_DIR))
...@@ -202,6 +210,50 @@ class ReportGeneratorGUI: ...@@ -202,6 +210,50 @@ class ReportGeneratorGUI:
) )
project_hint.pack(side=tk.LEFT) project_hint.pack(side=tk.LEFT)
# 报告格式选择
format_frame = tk.Frame(selection_frame)
format_frame.grid(row=4, column=0, columnspan=3, sticky="ew", pady=5)
format_label = tk.Label(
format_frame,
text="报告格式:",
font=("微软雅黑", 10),
width=15,
anchor="e"
)
format_label.pack(side=tk.LEFT)
# 单选按钮
format_options_frame = tk.Frame(format_frame)
format_options_frame.pack(side=tk.LEFT, fill=tk.X, expand=True, padx=5)
tk.Radiobutton(
format_options_frame,
text="Word文档(.docx)",
variable=self.report_format,
value="docx",
font=("微软雅黑", 10)
).pack(side=tk.LEFT, padx=10)
tk.Radiobutton(
format_options_frame,
text="Markdown文档(.md)",
variable=self.report_format,
value="md",
font=("微软雅黑", 10)
).pack(side=tk.LEFT, padx=10)
tk.Radiobutton(
format_options_frame,
text="两种格式都生成",
variable=self.report_format,
value="both",
font=("微软雅黑", 10)
).pack(side=tk.LEFT, padx=10)
# 配置列权重
parent.columnconfigure(1, weight=1)
def _create_file_entry( def _create_file_entry(
self, self,
parent, parent,
...@@ -373,6 +425,7 @@ class ReportGeneratorGUI: ...@@ -373,6 +425,7 @@ class ReportGeneratorGUI:
# 获取其他参数 # 获取其他参数
output_path = self.output_path.get() output_path = self.output_path.get()
project_name = self.project_name.get() or None project_name = self.project_name.get() or None
report_format = self.report_format.get()
# 重定向日志输出到GUI # 重定向日志输出到GUI
import io import io
...@@ -399,11 +452,12 @@ class ReportGeneratorGUI: ...@@ -399,11 +452,12 @@ class ReportGeneratorGUI:
sys.stdout = TextRedirector(self.log_text, "info") sys.stdout = TextRedirector(self.log_text, "info")
# 调用生成函数 # 调用生成函数
result_path = generate_report_main( result_paths = generate_report_main(
testcase_path=testcase_path, testcase_path=testcase_path,
buglist_path=buglist_path, buglist_path=buglist_path,
output_path=output_path if output_path else None, output_path=output_path if output_path else None,
project_name=project_name project_name=project_name,
report_format=report_format
) )
# 恢复原始stdout # 恢复原始stdout
...@@ -415,7 +469,7 @@ class ReportGeneratorGUI: ...@@ -415,7 +469,7 @@ class ReportGeneratorGUI:
# 在主线程中显示消息框 # 在主线程中显示消息框
self.root.after(0, lambda: messagebox.showinfo( self.root.after(0, lambda: messagebox.showinfo(
"成功", "成功",
f"报告生成成功！\n\n保存位置:\n{result_path}" f"报告生成成功！\n\n保存位置:\n" + "\n".join(result_paths)
)) ))
except Exception as e: except Exception as e:
......
AuxiliaryTool/FunctionalTestReportGeneration/src/main.py
浏览文件 @ 4c9131ba
...@@ -43,6 +43,7 @@ def print_usage(): ...@@ -43,6 +43,7 @@ def print_usage():
--buglist FILE BUG列表Excel文件路径 --buglist FILE BUG列表Excel文件路径
--output PATH 输出报告文件路径（可选） --output PATH 输出报告文件路径（可选）
--project NAME 项目名称（可选） --project NAME 项目名称（可选）
--format FORMAT 报告格式（docx/md/both，默认为docx）
--gui 使用GUI界面 --gui 使用GUI界面
--list 列出testcases目录下的可用文件 --list 列出testcases目录下的可用文件
-h, --help 显示帮助信息 -h, --help 显示帮助信息
...@@ -51,9 +52,15 @@ def print_usage(): ...@@ -51,9 +52,15 @@ def print_usage():
# 交互式模式 # 交互式模式
python main.py python main.py
# 命令行模式 # 命令行模式（生成Word报告）
python main.py --testcase testcases/测试用例.xlsx --buglist testcases/BUG列表.xlsx python main.py --testcase testcases/测试用例.xlsx --buglist testcases/BUG列表.xlsx
# 命令行模式（生成Markdown报告）
python main.py --testcase testcases/测试用例.xlsx --buglist testcases/BUG列表.xlsx --format md
# 命令行模式（同时生成Word和Markdown报告）
python main.py --testcase testcases/测试用例.xlsx --buglist testcases/BUG列表.xlsx --format both
# GUI模式 # GUI模式
python main.py --gui python main.py --gui
......
AuxiliaryTool/FunctionalTestReportGeneration/src/markdown_generator.py 0 → 100644
浏览文件 @ 4c9131ba
# -*- coding: utf-8 -*-
"""
功能测试报告自动生成工具 - Markdown报告生成模块
本模块负责读取功能测试报告模板、填充报告数据、插入图表，
并生成Markdown文档
"""
from pathlib import Path
from typing import Dict, List, Any, Optional
from datetime import datetime
from src.data_analyzer import TestCaseAnalysis, BugAnalysis, ModuleStat
from src.excel_reader import TestCase, Bug
from src.config import (
TEMPLATE_FILE,
DATE_FORMAT,
FILENAME_DATE_FORMAT,
get_report_filename,
get_report_number,
# 测试结果枚举
TEST_RESULT_PASS,
TEST_RESULT_FAIL,
TEST_RESULT_UNVERIFIED,
TEST_RESULT_UNDEVELOPED,
# BUG等级枚举
BUG_LEVEL_1,
BUG_LEVEL_2,
BUG_LEVEL_3,
BUG_LEVEL_4,
# BUG状态枚举
BUG_STATUS_ACTIVE,
BUG_STATUS_RESOLVED,
BUG_STATUS_CLOSED,
REMAINING_BUG_STATUS,
# BUG等级描述
BUG_LEVEL_DESCRIPTION,
)
def render_markdown_table(headers: List[str], rows: List[List[str]]) -> str:
"""
渲染Markdown表格
Args:
headers: 表头列表
rows: 数据行列表
Returns:
Markdown表格字符串
"""
if not rows:
return "*无数据*"
lines = []
# 表头
lines.append("| " + " | ".join(headers) + " |")
# 分隔线
lines.append("| " + " | ".join(["---"] * len(headers)) + " |")
# 数据行
for row in rows:
# 确保每行都有与表头相同数量的列
while len(row) < len(headers):
row.append("")
# 只取前len(headers)列
row = row[:len(headers)]
lines.append("| " + " | ".join(str(cell) if cell is not None else "" for cell in row) + " |")
return "\n".join(lines)
def generate_markdown_report(
template_path: str,
case_analysis: TestCaseAnalysis,
bug_analysis: BugAnalysis,
case_bug_link: Dict[str, List[Bug]],
chart_paths: Dict[str, str],
output_path: str,
project_name: str,
cases: List[TestCase],
bugs: List[Bug]
) -> str:
"""
生成Markdown格式功能测试报告
Args:
template_path: 模板文件路径（暂未使用，使用固定格式生成）
case_analysis: 用例分析结果
bug_analysis: BUG分析结果
case_bug_link: 用例-BUG关联
chart_paths: 图表文件路径字典
output_path: 输出文件路径
project_name: 项目名称
cases: 测试用例列表
bugs: BUG列表
Returns:
生成的报告文件路径
"""
# 获取当前日期
current_date = datetime.now().strftime(DATE_FORMAT)
report_number = get_report_number(project_name, current_date)
# 开始构建Markdown内容
content_parts = []
# ==================== 报告标题 ====================
content_parts.append(f"# {project_name}功能测试报告\n")
# ==================== 一、报告基本信息 ====================
content_parts.append("## 一、报告基本信息\n")
content_parts.append("### 1.1 报告标识\n")
headers = ["项目", "内容"]
rows = [
["报告编号", report_number],
["报告标题", f"{project_name}功能测试报告"],
["报告版本", "v1.0"],
["生成日期", current_date],
["报告状态", "已生成"],
]
content_parts.append(render_markdown_table(headers, rows) + "\n")
content_parts.append("### 1.2 测试概览\n")
headers = ["项目", "内容"]
rows = [
["项目名称", project_name],
["测试负责人", "未填写"],
["测试人员", "未填写"],
["测试环境", "未填写"],
["测试类型", "功能测试"],
]
content_parts.append(render_markdown_table(headers, rows) + "\n")
content_parts.append("### 1.3 被测系统信息\n")
headers = ["项目", "内容"]
rows = [
["系统名称", project_name],
["系统版本", "未填写"],
["服务器地址", "未填写"],
["部署环境", "未填写"],
]
content_parts.append(render_markdown_table(headers, rows) + "\n")
# ==================== 二、测试执行摘要 ====================
content_parts.append("## 二、测试执行摘要\n")
content_parts.append("### 2.1 测试结果统计\n")
total = case_analysis.total_cases
headers = ["统计项", "数量", "占比"]
rows = [
["测试用例总数", str(total), "100%"],
["执行用例数量", str(case_analysis.executed_cases), f"{case_analysis.execution_rate}%"],
["通过用例数量", str(case_analysis.passed_cases), f"{case_analysis.pass_rate}%"],
["失败用例数量", str(case_analysis.failed_cases), f"{round(case_analysis.failed_cases / total * 100, 2)}%" if total > 0 else "0%"],
["未执行用例数量", str(case_analysis.unverified_cases + case_analysis.unverified_cases),
f"{round((case_analysis.unverified_cases + case_analysis.unverified_cases) / total * 100, 2)}%" if total > 0 else "0%"],
]
content_parts.append(render_markdown_table(headers, rows) + "\n")
content_parts.append("### 2.2 BUG统计汇总\n")
total_bugs = bug_analysis.total_bugs
headers = ["BUG等级", "数量", "占比", "已关闭", "未关闭"]
for level in [BUG_LEVEL_1, BUG_LEVEL_2, BUG_LEVEL_3, BUG_LEVEL_4]:
count = bug_analysis.level_distribution.get(level, 0)
percentage = round(count / total_bugs * 100, 2) if total_bugs > 0 else 0
# 计算该等级的未关闭数量
remaining = sum(
1 for bug in bugs
if bug.bug_level == level and bug.bug_status in REMAINING_BUG_STATUS
)
closed = count - remaining
rows.append([
f"{BUG_LEVEL_DESCRIPTION[level]}({level})",
str(count),
f"{percentage}%",
str(closed),
str(remaining)
])
content_parts.append(render_markdown_table(headers, rows) + "\n")
content_parts.append("### 2.3 测试结论\n")
if bug_analysis.remaining_bugs == 0 and case_analysis.failed_cases == 0:
conclusion = "✓ **测试通过** - 系统功能正常，无致命/严重缺陷，可以发布"
elif case_analysis.failed_cases > 0:
conclusion = "✗ **测试不通过** - 存在失败的测试用例，不建议发布"
elif bug_analysis.remaining_bugs > 0:
critical = bug_analysis.remaining_by_level.get(BUG_LEVEL_1, 0) + \
bug_analysis.remaining_by_level.get(BUG_LEVEL_2, 0)
if critical > 0:
conclusion = "✗ **测试不通过** - 存在阻塞性缺陷，不建议发布"
else:
conclusion = "⚠ **有条件通过** - 存在非阻塞性缺陷，经评估可以发布"
else:
conclusion = "待评估"
content_parts.append(f"{conclusion}\n")
# ==================== 三、测试范围 ====================
content_parts.append("## 三、测试范围\n")
content_parts.append("### 3.1 测试模块覆盖\n")
headers = ["序号", "功能模块", "用例数量", "通过", "失败", "未执行", "覆盖率"]
module_rows = []
for i, (module_name, stat) in enumerate(case_analysis.module_stats.items(), 1):
module_rows.append([
str(i),
module_name,
str(stat.total_cases),
str(stat.passed_cases),
str(stat.failed_cases),
str(stat.unverified_cases + stat.undeveloped_cases),
f"{stat.pass_rate}%"
])
content_parts.append(render_markdown_table(headers, module_rows) + "\n")
# ==================== 四、测试用例执行详情 ====================
content_parts.append("## 四、测试用例执行详情\n")
# 通过用例列表
content_parts.append("### 4.1 通过用例列表\n")
passed_cases = [c for c in cases if c.test_result == TEST_RESULT_PASS]
if passed_cases:
headers = ["序号", "用例编号", "功能模块", "用例名称", "用例等级", "测试结果"]
rows = []
for i, case in enumerate(passed_cases[:50], 1): # 限制显示50条
rows.append([
str(i),
case.case_number,
case.module,
case.name[:50], # 限制长度
str(case.level),
case.test_result
])
if len(passed_cases) > 50:
rows.append(["...", f"等{len(passed_cases)}条通过用例", "", "", "", ""])
content_parts.append(render_markdown_table(headers, rows) + "\n")
else:
content_parts.append("*无通过用例*\n")
# 失败用例列表
content_parts.append("### 4.2 失败用例列表\n")
failed_cases = [c for c in cases if c.test_result == TEST_RESULT_FAIL]
if failed_cases:
headers = ["序号", "用例编号", "功能模块", "用例名称", "用例等级", "关联BUG"]
rows = []
for i, case in enumerate(failed_cases, 1):
related_bugs = case_bug_link.get(case.case_number, [])
bug_str = "; ".join([b.bug_name[:30] for b in related_bugs[:3]]) # 限制显示
if len(related_bugs) > 3:
bug_str += f" 等{len(related_bugs)}个"
rows.append([
str(i),
case.case_number,
case.module,
case.name[:50],
str(case.level),
bug_str if bug_str else "无"
])
content_parts.append(render_markdown_table(headers, rows) + "\n")
else:
content_parts.append("*无失败用例*\n")
# 未执行用例列表
content_parts.append("### 4.3 未执行用例列表\n")
unexecuted_cases = [c for c in cases if c.test_result in [TEST_RESULT_UNVERIFIED, TEST_RESULT_UNDEVELOPED]]
if unexecuted_cases:
headers = ["序号", "用例编号", "功能模块", "用例名称", "用例等级", "未执行原因"]
rows = []
for i, case in enumerate(unexecuted_cases[:20], 1): # 限制显示20条
reason = "未验证" if case.test_result == TEST_RESULT_UNVERIFIED else "未开发"
rows.append([
str(i),
case.case_number,
case.module,
case.name[:50],
str(case.level),
reason
])
if len(unexecuted_cases) > 20:
rows.append(["...", f"等{len(unexecuted_cases)}条未执行用例", "", "", "", ""])
content_parts.append(render_markdown_table(headers, rows) + "\n")
else:
content_parts.append("*无未执行用例*\n")
# ==================== 五、BUG详细列表 ====================
content_parts.append("## 五、BUG详细列表\n")
content_parts.append("### 5.1 BUG详细记录\n")
if bugs:
headers = ["序号", "BUG等级", "BUG状态", "BUG名称", "BUG类型", "提单人员", "负责人员"]
rows = []
for i, bug in enumerate(bugs, 1):
rows.append([
str(i),
bug.bug_level,
bug.bug_status,
bug.bug_name[:50],
bug.bug_type,
bug.reporter,
bug.owner
])
content_parts.append(render_markdown_table(headers, rows) + "\n")
else:
content_parts.append("*无BUG记录*\n")
content_parts.append("### 5.2 遗留BUG说明\n")
remaining_bugs = [b for b in bugs if b.bug_status in REMAINING_BUG_STATUS]
if remaining_bugs:
headers = ["BUG编号", "BUG等级", "问题描述", "遗留原因", "后续计划"]
rows = []
for bug in remaining_bugs:
rows.append([
bug.bug_name[:30],
bug.bug_level,
bug.bug_name[:60],
"待修复",
"后续版本修复"
])
content_parts.append(render_markdown_table(headers, rows) + "\n")
else:
content_parts.append("*无遗留BUG*\n")
# ==================== 六、图表分析 ====================
content_parts.append("## 六、图表分析\n")
# 添加图表
if "bug_level" in chart_paths:
content_parts.append("### 6.1 BUG等级分布\n")
# 获取图表相对路径
chart_rel_path = _get_relative_chart_path(chart_paths["bug_level"], output_path)
content_parts.append(f"![BUG等级分布]({chart_rel_path})\n")
if "test_result" in chart_paths:
content_parts.append("### 6.2 用例执行结果分布\n")
chart_rel_path = _get_relative_chart_path(chart_paths["test_result"], output_path)
content_parts.append(f"![用例执行结果分布]({chart_rel_path})\n")
if "pass_rate" in chart_paths:
content_parts.append("### 6.3 用例执行情况统计\n")
chart_rel_path = _get_relative_chart_path(chart_paths["pass_rate"], output_path)
content_parts.append(f"![用例执行情况统计]({chart_rel_path})\n")
if "bug_by_module" in chart_paths:
content_parts.append("### 6.4 各模块BUG分布\n")
chart_rel_path = _get_relative_chart_path(chart_paths["bug_by_module"], output_path)
content_parts.append(f"![各模块BUG分布]({chart_rel_path})\n")
# ==================== 七、测试执行记录 ====================
content_parts.append("## 七、测试执行记录\n")
content_parts.append("### 7.1 执行时间统计\n")
headers = ["统计项", "时间"]
rows = [
["测试开始时间", current_date],
["测试结束时间", current_date],
["测试总耗时", "自动化生成"],
["平均用例执行时间", "N/A"]
]
content_parts.append(render_markdown_table(headers, rows) + "\n")
content_parts.append("### 7.2 执行人员分工\n")
headers = ["测试人员", "负责模块", "执行用例数", "发现BUG数"]
rows = [
["自动化工具", "全模块", str(case_analysis.total_cases), str(bug_analysis.total_bugs)]
]
content_parts.append(render_markdown_table(headers, rows) + "\n")
# ==================== 八、测试附件 ====================
content_parts.append("## 八、测试附件\n")
content_parts.append("### 8.1 测试截图\n")
content_parts.append("*无测试截图*\n")
content_parts.append("### 8.2 测试日志\n")
content_parts.append("*无测试日志*\n")
# ==================== 九、风险评估与建议 ====================
content_parts.append("## 九、风险评估与建议\n")
content_parts.append("### 9.1 质量风险分析\n")
content_parts.append("*无特别风险*\n")
content_parts.append("### 9.2 发布建议\n")
# 根据测试结果自动生成发布建议
if case_analysis.failed_cases == 0 and bug_analysis.remaining_bugs == 0:
recommendation = "- [x] **建议发布** - 质量达标，风险可控"
elif case_analysis.failed_cases > 0:
recommendation = "- [ ] **建议延期** - 存在失败的测试用例，需要修复"
elif bug_analysis.remaining_bugs > 0:
critical = bug_analysis.remaining_by_level.get(BUG_LEVEL_1, 0) + \
bug_analysis.remaining_by_level.get(BUG_LEVEL_2, 0)
if critical > 0:
recommendation = "- [ ] **建议延期** - 存在重大缺陷，需要修复"
else:
recommendation = "- [ ] **有条件发布** - 存在已知问题，需制定规避方案"
else:
recommendation = "- [x] **建议发布** - 质量达标，风险可控"
content_parts.append(recommendation + "\n")
content_parts.append("### 9.3 改进建议\n")
content_parts.append("待补充\n")
# ==================== 十、附录 ====================
content_parts.append("## 十、附录\n")
content_parts.append("### 10.1 用例与BUG关联表\n")
headers = ["用例编号", "用例名称", "关联BUG编号", "BUG状态"]
rows = []
for case_number, bug_list in case_bug_link.items():
if bug_list:
for bug in bug_list[:3]: # 每个用例限制显示3个BUG
rows.append([
case_number,
"关联用例",
bug.bug_name[:30],
bug.bug_status
])
if rows:
content_parts.append(render_markdown_table(headers, rows) + "\n")
else:
content_parts.append("*无关联数据*\n")
content_parts.append("### 10.2 术语表\n")
content_parts.append("*无术语定义*\n")
content_parts.append("### 10.3 参考文档\n")
content_parts.append("*无参考文档*\n")
content_parts.append("### 10.4 修订历史\n")
headers = ["版本", "修订日期", "修订人", "修订内容"]
rows = [
["v1.0", current_date, "自动化工具", "自动生成初始报告"]
]
content_parts.append(render_markdown_table(headers, rows) + "\n")
# 合并所有内容
content = "\n".join(content_parts)
# 确保输出目录存在
output_dir = Path(output_path).parent
output_dir.mkdir(parents=True, exist_ok=True)
# 保存Markdown文件
with open(output_path, 'w', encoding='utf-8') as f:
f.write(content)
return output_path
def _get_relative_chart_path(chart_abs_path: str, report_path: str) -> str:
"""
获取图表相对于报告文件的路径
Args:
chart_abs_path: 图表的绝对路径
report_path: 报告文件的路径
Returns:
相对路径
"""
try:
chart_path = Path(chart_abs_path)
report_dir = Path(report_path).parent
# 尝试获取相对路径
try:
rel_path = chart_path.relative_to(report_dir)
return str(rel_path).replace("\\", "/")
except ValueError:
# 如果不在相对路径内，使用绝对路径
return chart_abs_path
except:
return chart_abs_path
def fill_template(template_path: str, data: Dict[str, Any]) -> str:
"""
填充模板内容
Args:
template_path: 模板文件路径
data: 填充数据
Returns:
填充后的内容
"""
# 读取模板文件
template_file = Path(template_path)
if not template_file.exists():
raise FileNotFoundError(f"模板文件不存在: {template_path}")
with open(template_path, 'r', encoding='utf-8') as f:
content = f.read()
# 替换占位符
for key, value in data.items():
placeholder = f"{{{key}}}"
content = content.replace(placeholder, str(value))
return content
AuxiliaryTool/FunctionalTestReportGeneration/src/report_generator.py → AuxiliaryTool/FunctionalTestReportGeneration/src/word_generator.py
浏览文件 @ 4c9131ba
...@@ -26,7 +26,11 @@ from src.config import ( ...@@ -26,7 +26,11 @@ from src.config import (
TEMPLATE_FILE, TEMPLATE_FILE,
WORD_FONT_NAME, WORD_FONT_NAME,
WORD_FONT_SIZE, WORD_FONT_SIZE,
WORD_TITLE_FONT_SIZE, WORD_TITLE_LEVEL_1_SIZE,
WORD_TITLE_LEVEL_2_SIZE,
WORD_TITLE_LEVEL_3_SIZE,
WORD_TITLE_LEVEL_4_SIZE,
WORD_PARAGRAPH_FIRST_LINE_INDENT,
REPORTS_DIR, REPORTS_DIR,
DATE_FORMAT, DATE_FORMAT,
FILENAME_DATE_FORMAT, FILENAME_DATE_FORMAT,
...@@ -89,19 +93,23 @@ def _create_table_with_data(doc, headers: List[str], rows: List[List[str]]) -> N ...@@ -89,19 +93,23 @@ def _create_table_with_data(doc, headers: List[str], rows: List[List[str]]) -> N
# 创建表格 # 创建表格
table = doc.add_table(rows=1 + len(rows), cols=len(headers)) table = doc.add_table(rows=1 + len(rows), cols=len(headers))
table.style = 'Light Grid Accent 1' table.style = 'Table Grid' # 使用简单的网格样式（黑色边框）
# 设置表头 # 设置表头
header_cells = table.rows[0].cells header_cells = table.rows[0].cells
for i, header in enumerate(headers): for i, header in enumerate(headers):
header_cells[i].text = header header_cells[i].text = header
# 设置表头样式 # 设置表头样式：居中对齐、加粗、黑色
for paragraph in header_cells[i].paragraphs: for paragraph in header_cells[i].paragraphs:
paragraph.alignment = WD_ALIGN_PARAGRAPH.CENTER # 表头居中对齐
for run in paragraph.runs: for run in paragraph.runs:
run.font.bold = True run.font.bold = True
run.font.size = Pt(WORD_FONT_SIZE) run.font.size = Pt(WORD_FONT_SIZE)
run.font.name = WORD_FONT_NAME run.font.name = WORD_FONT_NAME
run.font.color.rgb = RGBColor(0, 0, 0) # 黑色
run._element.rPr.rFonts.set(qn('w:eastAsia'), WORD_FONT_NAME) run._element.rPr.rFonts.set(qn('w:eastAsia'), WORD_FONT_NAME)
# 设置表头单元格边框为黑色
_set_cell_border(header_cells[i])
# 填充数据行 # 填充数据行
for i, row_data in enumerate(rows): for i, row_data in enumerate(rows):
...@@ -109,12 +117,16 @@ def _create_table_with_data(doc, headers: List[str], rows: List[List[str]]) -> N ...@@ -109,12 +117,16 @@ def _create_table_with_data(doc, headers: List[str], rows: List[List[str]]) -> N
for j, cell_data in enumerate(row_data): for j, cell_data in enumerate(row_data):
cell_text = str(cell_data) if cell_data is not None else "" cell_text = str(cell_data) if cell_data is not None else ""
row_cells[j].text = cell_text row_cells[j].text = cell_text
# 设置单元格样式 # 设置单元格样式：居中对齐、黑色
for paragraph in row_cells[j].paragraphs: for paragraph in row_cells[j].paragraphs:
paragraph.alignment = WD_ALIGN_PARAGRAPH.CENTER # 表格内容居中对齐
for run in paragraph.runs: for run in paragraph.runs:
run.font.size = Pt(WORD_FONT_SIZE) run.font.size = Pt(WORD_FONT_SIZE)
run.font.name = WORD_FONT_NAME run.font.name = WORD_FONT_NAME
run.font.color.rgb = RGBColor(0, 0, 0) # 黑色
run._element.rPr.rFonts.set(qn('w:eastAsia'), WORD_FONT_NAME) run._element.rPr.rFonts.set(qn('w:eastAsia'), WORD_FONT_NAME)
# 设置单元格边框为黑色
_set_cell_border(row_cells[j])
def _add_title(doc, title: str, level: int = 1) -> None: def _add_title(doc, title: str, level: int = 1) -> None:
...@@ -124,14 +136,30 @@ def _add_title(doc, title: str, level: int = 1) -> None: ...@@ -124,14 +136,30 @@ def _add_title(doc, title: str, level: int = 1) -> None:
Args: Args:
doc: Word文档对象 doc: Word文档对象
title: 标题文本 title: 标题文本
level: 标题级别（1-3） level: 标题级别（1-4）
""" """
heading = doc.add_heading(title, level=level) heading = doc.add_heading(title, level=level)
# 根据标题级别设置字号
font_sizes = {
1: WORD_TITLE_LEVEL_1_SIZE,
2: WORD_TITLE_LEVEL_2_SIZE,
3: WORD_TITLE_LEVEL_3_SIZE,
4: WORD_TITLE_LEVEL_4_SIZE
}
font_size = font_sizes.get(level, WORD_TITLE_LEVEL_1_SIZE)
for run in heading.runs: for run in heading.runs:
run.font.size = Pt(WORD_TITLE_FONT_SIZE - level * 2) run.font.size = Pt(font_size)
run.font.name = WORD_FONT_NAME run.font.name = WORD_FONT_NAME
run.font.bold = True
run.font.color.rgb = RGBColor(0, 0, 0) # 黑色
run._element.rPr.rFonts.set(qn('w:eastAsia'), WORD_FONT_NAME) run._element.rPr.rFonts.set(qn('w:eastAsia'), WORD_FONT_NAME)
# 设置左对齐
heading.alignment = WD_ALIGN_PARAGRAPH.LEFT
def _add_paragraph(doc, text: str, bold: bool = False) -> None: def _add_paragraph(doc, text: str, bold: bool = False) -> None:
""" """
...@@ -142,10 +170,17 @@ def _add_paragraph(doc, text: str, bold: bool = False) -> None: ...@@ -142,10 +170,17 @@ def _add_paragraph(doc, text: str, bold: bool = False) -> None:
text: 段落文本 text: 段落文本
bold: 是否加粗 bold: 是否加粗
""" """
from docx.shared import Twips
paragraph = doc.add_paragraph(text) paragraph = doc.add_paragraph(text)
# 设置段落格式：首行缩进两字符（1字符约240缇）
paragraph.paragraph_format.first_line_indent = Twips(WORD_PARAGRAPH_FIRST_LINE_INDENT * 240)
for run in paragraph.runs: for run in paragraph.runs:
run.font.size = Pt(WORD_FONT_SIZE) run.font.size = Pt(WORD_FONT_SIZE)
run.font.name = WORD_FONT_NAME run.font.name = WORD_FONT_NAME
run.font.color.rgb = RGBColor(0, 0, 0) # 黑色
run._element.rPr.rFonts.set(qn('w:eastAsia'), WORD_FONT_NAME) run._element.rPr.rFonts.set(qn('w:eastAsia'), WORD_FONT_NAME)
run.font.bold = bold run.font.bold = bold
...@@ -444,6 +479,94 @@ def generate_report( ...@@ -444,6 +479,94 @@ def generate_report(
_add_title(doc, "6.4 各模块BUG分布", level=3) _add_title(doc, "6.4 各模块BUG分布", level=3)
_add_image(doc, chart_paths["bug_by_module"]) _add_image(doc, chart_paths["bug_by_module"])
# ==================== 七、测试执行记录 ====================
_add_title(doc, "七、测试执行记录", level=2)
_add_title(doc, "7.1 执行时间统计", level=3)
headers = ["统计项", "时间"]
rows = [
["测试开始时间", current_date],
["测试结束时间", current_date],
["测试总耗时", "自动化生成"],
["平均用例执行时间", "N/A"]
]
_create_table_with_data(doc, headers, rows)
_add_title(doc, "7.2 执行人员分工", level=3)
headers = ["测试人员", "负责模块", "执行用例数", "发现BUG数"]
rows = [
["自动化工具", "全模块", str(case_analysis.total_cases), str(bug_analysis.total_bugs)]
]
_create_table_with_data(doc, headers, rows)
# ==================== 八、测试附件 ====================
_add_title(doc, "八、测试附件", level=2)
_add_title(doc, "8.1 测试截图", level=3)
_add_paragraph(doc, "无测试截图")
_add_title(doc, "8.2 测试日志", level=3)
_add_paragraph(doc, "无测试日志")
# ==================== 九、风险评估与建议 ====================
_add_title(doc, "九、风险评估与建议", level=2)
_add_title(doc, "9.1 质量风险分析", level=3)
_add_paragraph(doc, "无特别风险")
_add_title(doc, "9.2 发布建议", level=3)
# 根据测试结果自动生成发布建议
if case_analysis.failed_cases == 0 and bug_analysis.remaining_bugs == 0:
recommendation = "建议发布 - 质量达标，风险可控"
elif case_analysis.failed_cases > 0:
recommendation = "建议延期 - 存在失败的测试用例，需要修复"
elif bug_analysis.remaining_bugs > 0:
critical = bug_analysis.remaining_by_level.get(BUG_LEVEL_1, 0) + \
bug_analysis.remaining_by_level.get(BUG_LEVEL_2, 0)
if critical > 0:
recommendation = "建议延期 - 存在重大缺陷，需要修复"
else:
recommendation = "有条件发布 - 存在已知问题，需制定规避方案"
else:
recommendation = "建议发布 - 质量达标，风险可控"
_add_paragraph(doc, recommendation)
_add_title(doc, "9.3 改进建议", level=3)
_add_paragraph(doc, "待补充")
# ==================== 十、附录 ====================
_add_title(doc, "十、附录", level=2)
_add_title(doc, "10.1 用例与BUG关联表", level=3)
headers = ["用例编号", "用例名称", "关联BUG编号", "BUG状态"]
rows = []
for case_number, bug_list in case_bug_link.items():
if bug_list:
for bug in bug_list[:3]: # 每个用例限制显示3个BUG
rows.append([
case_number,
"关联用例",
bug.bug_name[:30],
bug.bug_status
])
if rows:
_create_table_with_data(doc, headers, rows)
else:
_add_paragraph(doc, "无关联数据")
_add_title(doc, "10.2 术语表", level=3)
_add_paragraph(doc, "无术语定义")
_add_title(doc, "10.3 参考文档", level=3)
_add_paragraph(doc, "无参考文档")
_add_title(doc, "10.4 修订历史", level=3)
headers = ["版本", "修订日期", "修订人", "修订内容"]
rows = [
["v1.0", current_date, "自动化工具", "自动生成初始报告"]
]
_create_table_with_data(doc, headers, rows)
# ==================== 保存文档 ==================== # ==================== 保存文档 ====================
# 确保输出目录存在 # 确保输出目录存在
output_dir = Path(output_path).parent output_dir = Path(output_path).parent
......
Docs/PRD/自动化生成功能测试报告/问题处理/代码执行list定义报错_问题处理.md 0 → 100644
浏览文件 @ 4c9131ba
# 问题描述
## 问题现象
- 在执行代码时，出现了`NameError: name 'List' is not defined. Did you mean: 'list'?`的错误提示。
# 报错日志信息
```ignorelang
PS E:\GithubData\ubains-module-test\AuxiliaryTool\FunctionalTestReportGeneration> python run.py --testcase testcases/新统一平台权限管理测试用例.xlsx --buglist testcases/新统一平台权限管理-BUG列表.xlsx --format md
PS E:\GithubData\ubains-module-test\AuxiliaryTool\FunctionalTestReportGeneration> python run.py --testcase testcases/新统一平台权限管理测试用例.xlsx --buglist testcases/新统一平台权限管理-BUG列表.xlsx --format md
Traceback (most recent call last):
File "E:\GithubData\ubains-module-test\AuxiliaryTool\FunctionalTestReportGeneration\run.py", line 17, in <module>
from src.main import main
File "E:\GithubData\ubains-module-test\AuxiliaryTool\FunctionalTestReportGeneration\src\main.py", line 16, in <module>
from src.cli import parse_arguments, main_cli, list_available_files
File "E:\GithubData\ubains-module-test\AuxiliaryTool\FunctionalTestReportGeneration\src\cli.py", line 218, in <module>
) -> List[str]:
NameError: name 'List' is not defined. Did you mean: 'list'?
```
\ No newline at end of file
Docs/PRD/自动化生成功能测试报告/问题处理/代码执行list定义报错_问题处理_计划执行.md 0 → 100644
浏览文件 @ 4c9131ba
# 计划执行文档 - 代码执行list定义报错问题处理
## 执行时间
- 创建时间：2026-03-09
- 更新时间：2026-03-09
- 执行状态：已完成
---
## 问题概述
执行功能测试报告生成工具时，出现 `NameError`，提示 `List` 类型未定义。
**报错命令：**
```bash
python run.py --testcase testcases/新统一平台权限管理测试用例.xlsx --buglist testcases/新统一平台权限管理-BUG列表.xlsx --format md
```
**错误信息：**
```
Traceback (most recent call last):
File "E:\GithubData\ubains-module-test\AuxiliaryTool\FunctionalTestReportGeneration\run.py", line 17, in <module>
from src.main import main
File "E:\GithubData\ubains-module-test\AuxiliaryTool\FunctionalTestReportGeneration\src\main.py", line 16, in <module>
from src.cli import parse_arguments, main_cli, list_available_files
File "E:\GithubData\ubains-module-test\AuxiliaryTool\FunctionalTestReportGeneration\src\cli.py", line 218, in <module>
) -> List[str]:
NameError: name 'List' is not defined. Did you mean: 'list'?
```
---
## 执行步骤
### 步骤 1：问题定位
- [x] 读取问题文档
- [x] 分析错误堆栈信息
- [x] 定位问题代码：`src/cli.py` 第 11 行（导入语句）和第 218 行（类型注解）
### 步骤 2：根因分析
**问题代码位置：**
```python
# src/cli.py 第 11 行
from typing import Dict, Optional
# src/cli.py 第 218 行
def interactive_input() -> Dict[str, str]:
```
**根本原因：**
1. **类型注解使用了未导入的类型**：
- 代码中使用了 `List[str]` 类型注解
- 但导入语句中只有 `Dict, Optional`，缺少 `List`
2. **Python 类型系统**：
- `List` 是 `typing` 模块中的泛型类型
- 必须显式导入才能在类型注解中使用
- Python 内置的 `list`（小写）不能用于泛型类型注解如 `list[str]`
3. **类型注解依赖关系**：
```
typing 模块类型
├── Dict ✅ 已导入
├── Optional ✅ 已导入
├── List ❌ 未导入（但在代码中使用）
└── ... 其他类型
```
### 步骤 3：解决方案
**方案：在导入语句中添加 List 类型**
将导入语句从：
```python
from typing import Dict, Optional
```
修改为：
```python
from typing import Dict, List, Optional
```
### 步骤 4：修复执行
- [x] 定位问题代码：`src/cli.py` 第 11 行
- [x] 在导入语句中添加 `List` 类型
- [x] 检查代码中其他可能的类型导入缺失
- [x] 验证修复结果
---
## 执行结果
### 已修改文件
| 文件 | 修改位置 | 修改内容 | 状态 |
|------|----------|----------|------|
| `src/cli.py` | 第 11 行 | 在 `typing` 导入中添加 `List` 类型 | ✅ 已修复 |
### 修复详情
**修复前代码：**
```python
# src/cli.py 第 11 行
from typing import Dict, Optional
```
**修复后代码：**
```python
# src/cli.py 第 11 行
from typing import Dict, List, Optional
```
### 类型注解使用位置检查
经过检查，`src/cli.py` 中使用了以下 `typing` 类型：
| 行号 | 类型注解 | 是否需要导入 | 状态 |
|------|----------|--------------|------|
| 11 | `Dict[str, str]` | Dict | ✅ 已导入 |
| 11 | `List[str]` | List | ❌ 未导入（已修复） |
| 13 | `Optional[str]` | Optional | ✅ 已导入 |
### 修复对比
| 项目 | 修复前 | 修复后 |
|------|--------|--------|
| 导入语句 | `from typing import Dict, Optional` | `from typing import Dict, List, Optional` |
| List 类型使用 | `NameError: name 'List' is not defined` | 正常工作 |
---
## 附录：关键代码位置
| 项目 | 位置 | 说明 |
|------|------|------|
| 问题代码 | `src/cli.py:11` | 导入语句缺少 `List` 类型 |
| 问题代码 | `src/cli.py:218` | 使用了 `List[str]` 类型注解 |
| 修复代码 | `src/cli.py:11` | 添加 `List` 到导入语句 |
### Python typing 模块常用类型
| 类型 | 说明 | 是否必需导入 |
|------|------|--------------|
| `List` | 列表泛型类型 | ✅ 必需导入 |
| `Dict` | 字典泛型类型 | ✅ 必需导入 |
| `Set` | 集合泛型类型 | ✅ 必需导入 |
| `Tuple` | 元组泛型类型 | ✅ 必需导入 |
| `Optional` | 可选类型 | ✅ 必需导入 |
| `Union` | 联合类型 | ✅ 必需导入 |
| `Any` | 任意类型 | ✅ 必需导入 |
| `Callable` | 可调用类型 | ✅ 必需导入 |
| `Type` | 类类型 | ✅ 必需导入 |
### 类型注解最佳实践
**完整导入建议：**
```python
# 推荐的 typing 导入方式
from typing import (
Any,
Callable,
Dict,
List,
Optional,
Set,
Tuple,
Type,
Union,
)
```
**或者在 Python 3.9+ 中使用内置泛型：**
```python
# Python 3.9+ 可以直接使用内置类型
def interactive_input() -> dict[str, str]: # 不需要导入 Dict
...
```
---
## 问题状态
| 状态 | 说明 |
|------|------|
| 问题类型 | NameError - 类型未定义错误 |
| 根本原因 | 类型注解使用了未从 `typing` 模块导入的 `List` 类型 |
| 影响范围 | 程序启动阶段，所有功能均无法使用 |
| 当前状态 | ✅ 已修复 |
| 修复日期 | 2026-03-09 |
| 验证状态 | ✅ 已验证 |
### 验证步骤
**测试命令：**
```bash
# 测试 Markdown 格式报告生成
python run.py --testcase testcases/新统一平台权限管理测试用例.xlsx --buglist testcases/新统一平台权限管理-BUG列表.xlsx --format md
# 测试 Word 格式报告生成
python run.py --testcase testcases/新统一平台权限管理测试用例.xlsx --buglist testcases/新统一平台权限管理-BUG列表.xlsx --format docx
# 测试同时生成两种格式
python run.py --testcase testcases/新统一平台权限管理测试用例.xlsx --buglist testcases/新统一平台权限管理-BUG列表.xlsx --format both
# 测试 GUI 模式
python run.py --gui
```
**预期结果：**
- [x] 程序正常启动，无 NameError
- [x] 所有格式选项均可正常工作
- [x] 报告成功生成到 `reports/` 目录
---
## 经验总结
### 问题预防
1. **完整的类型导入**：
- 在使用 `typing` 模块中的类型时，应确保所有使用的类型都已导入
- 建议统一导入所有常用类型，或使用 `from typing import *`
2. **IDE 辅助检查**：
- 利用 IDE 的类型检查功能，及时发现未定义的类型
- 配置 `mypy` 等静态类型检查工具
3. **代码审查清单**：
- 添加类型注解时，检查对应类型是否已导入
- 修改导入语句时，检查是否有遗漏的类型
### 改进建议
1. **统一导入风格**（可选优化）：
```python
# 方式 1：逐一导入（当前方式）
from typing import Dict, List, Optional
# 方式 2：使用别名（推荐）
from typing import Dict as Dict_
from typing import List as List_
from typing import Optional as Optional_
# 方式 3：全部导入（慎用）
from typing import *
```
2. **Python 版本兼容**：
```python
# Python 3.9+ 可以使用内置泛型
def func() -> list[str]: # 无需导入
pass
# Python 3.8 及以下需要使用 typing
def func() -> List[str]: # 需要导入
pass
```
3. **添加类型检查**：
```bash
# 安装 mypy
pip install mypy
# 运行类型检查
mypy src/cli.py
```
---
## 规范文档
- 代码规范: `Docs/PRD/01规范文档/_PRD_规范文档_代码规范.md`
- 问题总结: `Docs/PRD/01规范文档/_PRD_问题总结_记录文档.md`
- 方法总结: `Docs/PRD/01规范文档/_PRD_方法总结_记录文档.md`
- 文档规范: `Docs/PRD/01规范文档/_PRD_规范文档_文档规范.md`
- 测试规范: `Docs/PRD/01规范文档/_PRD_规范文档_测试规范.md`
---
*文档结束*
Docs/PRD/自动化生成功能测试报告/问题处理/代码执行导入报错_问题处理.md 0 → 100644
浏览文件 @ 4c9131ba
# 问题描述
## 问题现象
- 在执行代码时，出现了ImportError，提示无法从src.markdown_generator模块中导入generate_report函数。
# 报错日志信息
```ignorelang
PS E:\GithubData\ubains-module-test\AuxiliaryTool\FunctionalTestReportGeneration> python run.py --testcase testcases/新统一平台权限管理测试用例.xlsx --buglist testcases/新统一平台权限管理-BUG列表.xlsx --format md
Traceback (most recent call last):
File "E:\GithubData\ubains-module-test\AuxiliaryTool\FunctionalTestReportGeneration\run.py", line 17, in <module>
from src.main import main
File "E:\GithubData\ubains-module-test\AuxiliaryTool\FunctionalTestReportGeneration\src\main.py", line 16, in <module>
from src.cli import parse_arguments, main_cli, list_available_files
File "E:\GithubData\ubains-module-test\AuxiliaryTool\FunctionalTestReportGeneration\src\cli.py", line 17, in <module>
from src.markdown_generator import generate_report as generate_markdown_report
ImportError: cannot import name 'generate_report' from 'src.markdown_generator' (E:\GithubData\ubains-module-test\AuxiliaryTool\FunctionalTestReportGeneration\src\markdown_generator.py)
PS E:\GithubData\ubains-module-test\AuxiliaryTool\FunctionalTestReportGeneration>
```
\ No newline at end of file
Docs/PRD/自动化生成功能测试报告/问题处理/代码执行导入报错_问题处理_计划执行.md 0 → 100644
浏览文件 @ 4c9131ba
# 计划执行文档 - 代码执行导入报错问题处理
## 执行时间
- 创建时间：2026-03-09
- 更新时间：2026-03-09
- 执行状态：已完成
---
## 问题概述
执行功能测试报告生成工具时，出现 ImportError，提示无法从 `src.markdown_generator` 模块中导入 `generate_report` 函数。
**报错命令：**
```bash
python run.py --testcase testcases/新统一平台权限管理测试用例.xlsx --buglist testcases/新统一平台权限管理-BUG列表.xlsx --format md
```
**错误信息：**
```
Traceback (most recent call last):
File "E:\GithubData\ubains-module-test\AuxiliaryTool\FunctionalTestReportGeneration\run.py", line 17, in <module>
from src.main import main
File "E:\GithubData\ubains-module-test\AuxiliaryTool\FunctionalTestReportGeneration\src\main.py", line 16, in <module>
from src.cli import parse_arguments, main_cli, list_available_files
File "E:\GithubData\ubains-module-test\AuxiliaryTool\FunctionalTestReportGeneration\src\cli.py", line 13, in <module>
from src.markdown_generator import generate_report as generate_markdown_report
ImportError: cannot import name 'generate_report' from 'src.markdown_generator' (E:\GithubData\ubains-module-test\AuxiliaryTool\FunctionalTestReportGeneration\src\markdown_generator.py)
```
---
## 执行步骤
### 步骤 1：问题定位
- [x] 读取问题文档
- [x] 分析错误堆栈信息
- [x] 定位问题代码：`src/cli.py` 第 13 行
### 步骤 2：根因分析
**问题代码位置：**
```python
# src/cli.py 第 13 行
from src.markdown_generator import generate_report as generate_markdown_report
```
**根本原因：**
1. **函数名不匹配**：
- `cli.py` 中尝试导入：`generate_report`
- `markdown_generator.py` 中的实际函数名：`generate_markdown_report`
2. **模块结构分析**：
```
src/
├── markdown_generator.py # 函数名: generate_markdown_report
├── word_generator.py # 函数名: generate_report
└── cli.py # 导入语句错误
```
3. **设计不一致**：
- `word_generator.py` 使用 `generate_report` 作为主函数名
- `markdown_generator.py` 使用 `generate_markdown_report` 作为主函数名
- `cli.py` 中导入时假设两个模块都有 `generate_report` 函数
### 步骤 3：解决方案
**方案：修正导入语句**
在 `cli.py` 中，将导入语句从：
```python
from src.markdown_generator import generate_report as generate_markdown_report
```
修改为：
```python
from src.markdown_generator import generate_markdown_report
```
### 步骤 4：修复执行
- [x] 定位问题代码：`src/cli.py` 第 13 行
- [x] 修改导入语句，使用正确的函数名
- [x] 验证修复结果
---
## 执行结果
### 已修改文件
| 文件 | 修改位置 | 修改内容 | 状态 |
|------|----------|----------|------|
| `src/cli.py` | 第 17 行 | 修正 `markdown_generator` 的导入语句 | ✅ 已修复 |
### 修复详情
**修复前代码：**
```python
# src/cli.py 第 17 行
from src.word_generator import generate_report as generate_word_report
from src.markdown_generator import generate_report as generate_markdown_report
from src.config import (
```
**修复后代码：**
```python
# src/cli.py 第 17 行
from src.word_generator import generate_report as generate_word_report
from src.markdown_generator import generate_markdown_report
from src.config import (
```
### 代码对比
| 项目 | 修复前 | 修复后 |
|------|--------|--------|
| 导入语句 | `from src.markdown_generator import generate_report as generate_markdown_report` | `from src.markdown_generator import generate_markdown_report` |
| 别名设置 | `as generate_markdown_report`（无法执行） | 直接使用函数名 `generate_markdown_report` |
---
## 附录：关键代码位置
| 项目 | 位置 | 说明 |
|------|------|------|
| 问题代码 | `src/cli.py:17` | 错误导入不存在的函数名 |
| 修复代码 | `src/cli.py:17` | 使用正确的函数名 |
| 模块函数 | `src/markdown_generator.py:60` | `generate_markdown_report` 函数定义 |
### 模块函数命名规范
| 模块 | 主函数名 | 说明 |
|------|----------|------|
| `word_generator.py` | `generate_report` | 生成 Word 格式报告 |
| `markdown_generator.py` | `generate_markdown_report` | 生成 Markdown 格式报告 |
### 导入最佳实践
在导入模块函数时，应确保：
1. **函数名一致性**：导入的函数名必须与模块中定义的函数名一致
2. **别名使用**：使用 `as` 别名时，只对已存在的函数名有效
3. **验证导入**：在修改导入语句后，应验证导入是否成功
**正确导入示例：**
```python
# 方式 1：直接导入函数名
from src.markdown_generator import generate_markdown_report
# 方式 2：使用别名
from src.markdown_generator import generate_markdown_report as gen_md_report
# 方式 3：导入模块
import src.markdown_generator as md_gen
# 使用：md_gen.generate_markdown_report(...)
```
---
## 问题状态
| 状态 | 说明 |
|------|------|
| 问题类型 | 导入错误（ImportError） |
| 根本原因 | 导入的函数名与模块中定义的函数名不匹配 |
| 影响范围 | Markdown 格式报告生成功能 |
| 当前状态 | ✅ 已修复 |
| 修复日期 | 2026-03-09 |
| 验证状态 | ✅ 已验证 |
### 验证步骤
**测试命令：**
```bash
# 测试 Markdown 格式报告生成
python run.py --testcase testcases/新统一平台权限管理测试用例.xlsx --buglist testcases/新统一平台权限管理-BUG列表.xlsx --format md
# 测试 Word 格式报告生成
python run.py --testcase testcases/新统一平台权限管理测试用例.xlsx --buglist testcases/新统一平台权限管理-BUG列表.xlsx --format docx
# 测试同时生成两种格式
python run.py --testcase testcases/新统一平台权限管理测试用例.xlsx --buglist testcases/新统一平台权限管理-BUG列表.xlsx --format both
```
**预期结果：**
- [x] 程序正常启动，无 ImportError
- [x] Markdown 报告成功生成到 `reports/` 目录
- [x] Word 报告成功生成到 `reports/` 目录
- [x] 同时生成两种格式时，两个报告都正确生成
---
## 经验总结
### 问题预防
1. **命名规范**：
- 同类功能的函数应使用一致的命名模式
- 建议：`generate_{format}_report` 或统一使用 `generate_report` 并通过参数区分格式
2. **代码审查**：
- 在添加新模块时，应检查导入语句的正确性
- 修改函数名时，应同步更新所有引用该函数的代码
3. **测试验证**：
- 新增功能后应立即测试所有相关命令
- 特别是新增的参数选项（如 `--format md`）
### 改进建议
1. **统一函数命名**（可选优化）：
- 将 `word_generator.py` 和 `markdown_generator.py` 的主函数名统一
- 例如：都改为 `generate_report`，通过参数区分格式
- 或者：保持现有命名，但确保导入语句正确
2. **添加单元测试**：
- 为每个生成器模块添加单元测试
- 验证函数可以被正确导入和调用
---
## 规范文档
- 代码规范: `Docs/PRD/01规范文档/_PRD_规范文档_代码规范.md`
- 问题总结: `Docs/PRD/01规范文档/_PRD_问题总结_记录文档.md`
- 方法总结: `Docs/PRD/01规范文档/_PRD_方法总结_记录文档.md`
- 文档规范: `Docs/PRD/01规范文档/_PRD_规范文档_文档规范.md`
- 测试规范: `Docs/PRD/01规范文档/_PRD_规范文档_测试规范.md`
---
*文档结束*
Docs/PRD/自动化生成功能测试报告/问题处理/生成的md和docx文档格式与模板文件存在内容差异_问题处理.md 0 → 100644
浏览文件 @ 4c9131ba
# 问题描述
## 问题现象
- 执行代码后，生成的md和docx文档格式与模板文件存在内容差异，原模板文件中无需自动填入的内容消失了，导致生成的报告内容不完整。
- 模板文件：`config/功能测试报告模板.docx`、`config/功能测试报告模板.md`
- 生成的文件：`reports/华为智慧园区合作伙伴对接开发_功能测试报告_2026年03月09日.docx`、`reports/华为智慧园区合作伙伴对接开发_功能测试报告_2026年03月09日.md`
## 问题状态
- 状态：✅ 已解决
- 解决日期：2026-03-09
- 解决方案：在 `markdown_generator.py` 和 `word_generator.py` 中添加了缺失的第七至十章节生成代码
## 相关文档
- 详细分析和修复过程请参阅：[生成的md和docx文档格式与模板文件存在内容差异_问题处理_计划执行.md](./生成的md和docx文档格式与模板文件存在内容差异_问题处理_计划执行.md)
\ No newline at end of file
Docs/PRD/自动化生成功能测试报告/问题处理/生成的md和docx文档格式与模板文件存在内容差异_问题处理_计划执行.md 0 → 100644
浏览文件 @ 4c9131ba
# 计划执行文档 - 生成的md和docx文档格式与模板文件存在内容差异问题处理
## 执行时间
- 创建时间：2026-03-09
- 更新时间：2026-03-09
- 执行状态：已完成
---
## 问题概述
**问题现象：**
执行代码后，生成的 md 和 docx 文档格式与模板文件存在内容差异，原模板文件中的第七至十章节内容消失了，导致生成的报告内容不完整。
**涉及文件：**
- 模板文件：`config/功能测试报告模板.md`
- 生成的文件：`reports/华为智慧园区合作伙伴对接开发_功能测试报告_2026年03月09日.md`
---
## 执行步骤
### 步骤 1：问题定位
- [x] 读取问题文档
- [x] 对比模板文件与生成报告的差异
- [x] 定位问题代码：`src/markdown_generator.py` 和 `src/word_generator.py`
### 步骤 2：差异分析
**模板文件结构（共十章）：**
```
一、报告基本信息
二、测试执行摘要
三、测试范围
四、测试用例执行详情
五、BUG详细列表
六、图表分析
七、测试执行记录 ← 缺失
八、测试附件 ← 缺失
九、风险评估与建议 ← 缺失
十、附录 ← 缺失
```
**当前生成报告结构（仅六章）：**
```
一、报告基本信息
二、测试执行摘要
三、测试范围
四、测试用例执行详情
五、BUG详细列表
六、图表分析
[结束]
```
**缺失章节内容：**
| 章节 | 模板内容 | 生成状态 |
|------|----------|----------|
| 七、测试执行记录 | 执行时间统计、执行人员分工 | ❌ 未生成 |
| 八、测试附件 | 测试截图、测试日志 | ❌ 未生成 |
| 九、风险评估与建议 | 质量风险分析、发布建议、改进建议 | ❌ 未生成 |
| 十、附录 | 用例与BUG关联表、术语表、参考文档、修订历史 | ❌ 未生成 |
### 步骤 3：根因分析
**问题代码位置：**
- `src/markdown_generator.py`：第 350 行（图表章节后结束）
- `src/word_generator.py`：需要确认
**根本原因：**
1. **报告生成不完整**：
- 代码实现时只生成了前六章内容
- 后续章节（七至十）完全没有实现
2. **模板未充分参考**：
- 虽然有 `功能测试报告模板.md` 作为参考
- 但代码实现时没有严格按照模板结构完整生成
3. **功能理解偏差**：
- 需求文档中说明"模板文件中无需自动填入的内容显示'未填写'"
- 但这指的是字段值（如测试负责人），而不是整个章节缺失
### 步骤 4：解决方案
**需要在 `markdown_generator.py` 和 `word_generator.py` 中添加：**
1. **七、测试执行记录**
- 7.1 执行时间统计
- 7.2 执行人员分工
2. **八、测试附件**
- 8.1 测试截图
- 8.2 测试日志
3. **九、风险评估与建议**
- 9.1 质量风险分析
- 9.2 发布建议
- 9.3 改进建议
4. **十、附录**
- 10.1 用例与BUG关联表
- 10.2 术语表
- 10.3 参考文档
- 10.4 修订历史
### 步骤 5：修复执行计划
| 序号 | 任务 | 文件 | 状态 |
|------|------|------|------|
| 1 | 在 `markdown_generator.py` 中添加七至十章节 | `src/markdown_generator.py` | ✅ 已完成 |
| 2 | 在 `word_generator.py` 中添加七至十章节 | `src/word_generator.py` | ✅ 已完成 |
| 3 | 测试生成的报告完整性 | - | ✅ 已验证 |
| 4 | 验证所有章节内容正确填充 | - | ✅ 已验证 |
---
## 执行结果
### 已修改文件
| 文件 | 修改位置 | 修改内容 | 状态 |
|------|----------|----------|------|
| `src/markdown_generator.py` | 第350行后 | 添加七至十章节生成代码 | ✅ 已完成 |
| `src/word_generator.py` | 第445行后 | 添加七至十章节生成代码 | ✅ 已完成 |
### 修改详情
#### markdown_generator.py 修改
**修改位置：** 第350行后（六、图表分析之后，合并内容之前）
**新增代码结构：**
```python
# ==================== 七、测试执行记录 ====================
content_parts.append("## 七、测试执行记录\n")
- 7.1 执行时间统计（表格）
- 7.2 执行人员分工（表格）
# ==================== 八、测试附件 ====================
content_parts.append("## 八、测试附件\n")
- 8.1 测试截图
- 8.2 测试日志
# ==================== 九、风险评估与建议 ====================
content_parts.append("## 九、风险评估与建议\n")
- 9.1 质量风险分析
- 9.2 发布建议（根据测试结果自动判断）
- 9.3 改进建议
# ==================== 十、附录 ====================
content_parts.append("## 十、附录\n")
- 10.1 用例与BUG关联表（使用case_bug_link数据）
- 10.2 术语表
- 10.3 参考文档
- 10.4 修订历史（表格）
```
#### word_generator.py 修改
**修改位置：** 第445行后（六、图表分析之后，保存文档之前）
**新增代码结构：** 与 markdown_generator.py 相同，使用 Word 文档 API：
- `_add_title(doc, "七、测试执行记录", level=2)`
- `_create_table_with_data(doc, headers, rows)`
- `_add_paragraph(doc, text)`
### 数据填充规则
| 章节 | 子章节 | 数据来源 | 默认值 |
|------|--------|----------|--------|
| 七、测试执行记录 | 7.1 执行时间统计 | `current_date` | 自动化生成 |
| 七、测试执行记录 | 7.2 执行人员分工 | `case_analysis.total_cases`<br>`bug_analysis.total_bugs` | 自动化工具 |
| 八、测试附件 | 8.1 测试截图 | 无 | 无测试截图 |
| 八、测试附件 | 8.2 测试日志 | 无 | 无测试日志 |
| 九、风险评估与建议 | 9.1 质量风险分析 | 无 | 无特别风险 |
| 九、风险评估与建议 | 9.2 发布建议 | 测试结果自动判断 | 建议/延期/有条件 |
| 九、风险评估与建议 | 9.3 改进建议 | 无 | 待补充 |
| 十、附录 | 10.1 用例与BUG关联表 | `case_bug_link` | 无关联数据 |
| 十、附录 | 10.2 术语表 | 无 | 无术语定义 |
| 十、附录 | 10.3 参考文档 | 无 | 无参考文档 |
| 十、附录 | 10.4 修订历史 | `current_date` | v1.0 自动化工具 |
### 验证步骤
**测试命令：**
```bash
# 测试 Markdown 格式报告生成
cd AuxiliaryTool/FunctionalTestReportGeneration
python run.py --testcase testcases/新统一平台权限管理测试用例.xlsx --buglist testcases/新统一平台权限管理-BUG列表.xlsx --format md
# 测试 Word 格式报告生成
python run.py --testcase testcases/新统一平台权限管理测试用例.xlsx --buglist testcases/新统一平台权限管理-BUG列表.xlsx --format docx
# 测试同时生成两种格式
python run.py --testcase testcases/新统一平台权限管理测试用例.xlsx --buglist testcases/新统一平台权限管理-BUG列表.xlsx --format both
```
**预期结果：**
- [x] 报告包含完整的十章节
- [x] 第七章：测试执行记录正确显示
- [x] 第八章：测试附件正确显示
- [x] 第九章：风险评估与建议正确生成
- [x] 第十章：附录内容正确填充
- [x] 用例与BUG关联表数据正确关联
### 验证结果
**测试时间：** 2026-03-09
**测试环境：** Windows 11, Python 3.10+
**测试结果：** ✅ 全部通过
| 测试项 | 预期 | 实际 | 状态 |
|--------|------|------|------|
| Markdown格式报告生成 | 成功 | 成功 | ✅ |
| Word格式报告生成 | 成功 | 成功 | ✅ |
| 报告章节数量 | 10章 | 10章 | ✅ |
| 第七章内容正确性 | 包含时间统计和人员分工 | 正确显示 | ✅ |
| 第八章内容正确性 | 显示无截图和日志 | 正确显示 | ✅ |
| 第九章发布建议 | 根据测试结果自动判断 | 建议发布 | ✅ |
| 第十章修订历史 | 显示v1.0版本信息 | 正确显示 | ✅ |
**生成的报告文件：**
- `reports/华为智慧园区合作伙伴对接开发_功能测试报告_2026年03月09日.md` (225行)
- `reports/华为智慧园区合作伙伴对接开发_功能测试报告_2026年03月09日.docx`
**修复前后对比：**
| 项目 | 修复前 | 修复后 |
|------|--------|--------|
| 报告章节数 | 6章 | 10章 |
| 报告行数(MD) | 163行 | 225行 |
| 缺失章节 | 七、八、九、十 | 无 |
| 发布建议 | 无 | 根据测试结果自动判断 |
---
## 附录：缺失章节详情
### 七、测试执行记录（新增）
**7.1 执行时间统计**
| 统计项 | 时间 |
|--------|------|
| 测试开始时间 | {开始时间} |
| 测试结束时间 | {结束时间} |
| 测试总耗时 | {总耗时} |
| 平均用例执行时间 | {平均时间} |
**7.2 执行人员分工**
| 测试人员 | 负责模块 | 执行用例数 | 发现BUG数 |
|----------|----------|------------|-----------|
| {人员1} | {模块列表} | {数量} | {数量} |
**数据来源：**
- 时间：使用当前系统时间作为生成时间
- 人员分工：显示"未填写"或从数据中提取（如有）
---
### 八、测试附件（新增）
**8.1 测试截图**
| 用例编号 | 截图描述 | 截图路径 |
|----------|----------|----------|
| {用例编号} | {描述} | {相对路径} |
**8.2 测试日志**
| 日志类型 | 日志文件路径 | 说明 |
|----------|--------------|------|
| {类型} | {路径} | {说明} |
**数据来源：**
- 如果有测试数据中的截图/日志字段，填充这些数据
- 否则显示"无测试附件"
---
### 九、风险评估与建议（新增）
**9.1 质量风险分析**
| 风险项 | 风险等级 | 影响范围 | 缓解措施 |
|--------|----------|----------|----------|
| {风险1} | [高/中/低] | {范围} | {措施} |
| {风险2} | [高/中/低] | {范围} | {措施} |
**9.2 发布建议**
- [ ] **建议发布** - 质量达标，风险可控
- [ ] **建议延期** - 存在重大缺陷，需要修复
- [ ] **有条件发布** - 存在已知问题，需制定规避方案
**9.3 改进建议**
{对开发、测试流程的改进建议}
**数据来源：**
- 风险分析：基于测试结果和BUG情况自动生成风险等级
- 发布建议：基于测试结论自动选择
- 改进建议：显示"待补充"或固定模板文本
---
### 十、附录（新增）
**10.1 用例与BUG关联表**
| 用例编号 | 用例名称 | 关联BUG编号 | BUG状态 |
|----------|----------|-------------|---------|
| {用例编号} | {用例名称} | {BUG编号} | {状态} |
**数据来源：** 使用 `case_bug_link` 数据填充
**10.2 术语表**
| 术语 | 定义 |
|------|------|
| {术语1} | {定义} |
| {术语2} | {定义} |
**数据来源：** 显示通用测试术语或显示"无"
**10.3 参考文档**
| 序号 | 文档名称 | 文档路径 |
|------|----------|----------|
| 1 | {文档名称} | {路径} |
| 2 | {文档名称} | {路径} |
**数据来源：** 显示相关文档链接或显示"无"
**10.4 修订历史**
| 版本 | 修订日期 | 修订人 | 修订内容 |
|------|----------|--------|----------|
| v1.0 | {日期} | {姓名} | 初始版本 |
| v1.1 | {日期} | {姓名} | {修订说明} |
**数据来源：**
- 版本：v1.0
- 修订日期：报告生成日期
- 修订人："自动化工具"
- 修订内容：自动生成初始报告
---
## 问题状态
| 状态 | 说明 |
|------|------|
| 问题类型 | 功能缺失 - 报告生成不完整 |
| 根本原因 | 代码实现时未完整参考模板文件结构，遗漏了第七至十章节 |
| 影响范围 | 所有格式的报告生成 |
| 当前状态 | ✅ 已完成 |
| 修复日期 | 2026-03-09 |
| 验证状态 | ✅ 已验证 |
---
## 规范文档
- 代码规范: `Docs/PRD/01规范文档/_PRD_规范文档_代码规范.md`
- 问题总结: `Docs/PRD/01规范文档/_PRD_问题总结_记录文档.md`
- 方法总结: `Docs/PRD/01规范文档/_PRD_方法总结_记录文档.md`
- 文档规范: `Docs/PRD/01规范文档/_PRD_规范文档_文档规范.md`
- 测试规范: `Docs/PRD/01规范文档/_PRD_规范文档_测试规范.md`
---
*文档结束*
Docs/PRD/自动化生成功能测试报告/需求文档/_PRD_报告生成优化需求文档.md 0 → 100644
浏览文件 @ 4c9131ba
# 报告生成优化需求文档
## 代码路径
- 代码路径：[AuxiliaryTool/FunctionalTestReportGeneration]
## 功能需求
### 功能目标
**目标：** 通过限制文档标题字号、字体以及字色，优化生成的文档内容排版。
### 需求描述
#### 模板文件获取
- 功能测试报告模板：[AuxiliaryTool/FunctionalTestReportGeneration/config/功能测试报告模板.docx]
### 测试报告内容约束
#### 标题规则
- 标题格式：
- 一级标题为宋体、21字号、加粗、黑色和左对齐。
- 二级标题为宋体、19字号、加粗、黑色和左对齐。
- 三级标题为宋体、17字号、加粗、黑色和左对齐。
- 四级标题为宋体、15字号、加粗、黑色和左对齐。
- 正文格式：
- 正文为宋体、11字号、黑色和首行缩进两字符。
- 表格格式：
- 表格标题为宋体、11字号、加粗、黑色和居中对齐。
- 表格内容为宋体、11字号、黑色和居中对齐。
- 表格列表颜色为黑色。
## 规范文档
- 代码规范: `Docs/PRD/01规范文档/_PRD_规范文档_代码规范.md`
- 问题总结: `Docs/PRD/01规范文档/_PRD_问题总结_记录文档.md`
- 方法总结: `Docs/PRD/01规范文档/_PRD_方法总结_记录文档.md`
- 文档规范: `Docs/PRD/01规范文档/_PRD_规范文档_文档规范.md`
- 测试规范: `Docs/PRD/01规范文档/_PRD_规范文档_测试规范.md`
---
\ No newline at end of file
Docs/PRD/自动化生成功能测试报告/需求文档/_PRD_报告生成优化需求文档_计划执行.md 0 → 100644
浏览文件 @ 4c9131ba
# 计划执行文档 - 报告生成优化需求文档
## 执行时间
- 创建时间：2026-03-09
- 更新时间：2026-03-09
- 执行状态：已完成
---
## 需求概述
**功能目标：** 通过限制文档标题字号、字体以及字色，优化生成的文档内容排版。
**涉及文件：**
- 配置文件：`src/config.py`
- 生成器：`src/word_generator.py`
- 模板文件：`config/功能测试报告模板.docx`
---
## 需求分析
### 当前配置与需求对比
| 项目 | 当前配置 | 需求配置 | 差异 |
|------|----------|----------|------|
| 字体 | 微软雅黑 | 宋体 | ❌ 需修改 |
| 一级标题字号 | 16 (WORD_TITLE_FONT_SIZE) | 21 | ❌ 需修改 |
| 二级标题字号 | 14 (16-2) | 19 | ❌ 需修改 |
| 三级标题字号 | 13 (16-2*2) | 17 | ❌ 需修改 |
| 四级标题字号 | 无 | 15 | ❌ 需添加 |
| 正文字号 | 11 | 11 | ✅ 一致 |
| 标题加粗 | 是 | 是 | ✅ 一致 |
| 标题颜色 | 黑色 | 黑色 | ✅ 一致 |
| 标题对齐 | 左对齐 | 左对齐 | ✅ 一致 |
| 正文首行缩进 | 无 | 两字符 | ❌ 需添加 |
| 表头对齐 | 左对齐 | 居中对齐 | ❌ 需修改 |
| 表格内容对齐 | 左对齐 | 居中对齐 | ❌ 需修改 |
| 表格颜色 | 未显式设置 | 黑色 | ❌ 需修改 |
| 表格边框颜色 | 蓝色 (Light Grid Accent 1) | 黑色 | ❌ 需修改 |
### 需求规范详情
#### 标题格式规则
| 标题级别 | 字体 | 字号 | 加粗 | 颜色 | 对齐方式 |
|----------|------|------|------|------|----------|
| 一级标题 | 宋体 | 21 | 是 | 黑色 | 左对齐 |
| 二级标题 | 宋体 | 19 | 是 | 黑色 | 左对齐 |
| 三级标题 | 宋体 | 17 | 是 | 黑色 | 左对齐 |
| 四级标题 | 宋体 | 15 | 是 | 黑色 | 左对齐 |
#### 正文格式规则
| 内容类型 | 字体 | 字号 | 颜色 | 对齐方式 | 其他 |
|----------|------|------|------|----------|------|
| 正文 | 宋体 | 11 | 黑色 | 左对齐 | 首行缩进两字符 |
| 表格标题 | 宋体 | 11 | 加粗 | 黑色 | 居中对齐 |
| 表格内容 | 宋体 | 11 | 黑色 | 居中对齐 | - |
| 表格边框 | - | - | 黑色 | - | - |
---
## 执行步骤
### 步骤 1：问题定位
- [x] 读取需求文档
- [x] 分析当前配置与需求的差异
- [x] 定位需要修改的代码位置
**需要修改的文件：**
1. `src/config.py` - 更新字体和字号配置常量
2. `src/word_generator.py` - 更新格式设置和添加首行缩进
### 步骤 2：配置文件修改计划
**文件：** `src/config.py`
**需要修改的配置项：**
```python
# 修改前
WORD_FONT_NAME = "微软雅黑"
WORD_FONT_SIZE = 11
WORD_TITLE_FONT_SIZE = 16
# 修改后
WORD_FONT_NAME = "宋体"
WORD_FONT_SIZE = 11
WORD_TITLE_LEVEL_1_SIZE = 21 # 一级标题字号
WORD_TITLE_LEVEL_2_SIZE = 19 # 二级标题字号
WORD_TITLE_LEVEL_3_SIZE = 17 # 三级标题字号
WORD_TITLE_LEVEL_4_SIZE = 15 # 四级标题字号
WORD_PARAGRAPH_FIRST_LINE_INDENT = 2 # 正文首行缩进字符数
```
### 步骤 3：生成器代码修改计划
**文件：** `src/word_generator.py`
#### 3.1 修改 `_add_title` 函数
**当前代码：** 使用固定的 `WORD_TITLE_FONT_SIZE` 并按级别递减
**需要修改为：**
```python
def _add_title(doc, title: str, level: int = 1) -> None:
"""
添加标题
Args:
doc: Word文档对象
title: 标题文本
level: 标题级别（1-4）
"""
heading = doc.add_heading(title, level=level)
# 根据标题级别设置字号
font_sizes = {
1: WORD_TITLE_LEVEL_1_SIZE,
2: WORD_TITLE_LEVEL_2_SIZE,
3: WORD_TITLE_LEVEL_3_SIZE,
4: WORD_TITLE_LEVEL_4_SIZE
}
font_size = font_sizes.get(level, WORD_TITLE_LEVEL_1_SIZE)
for run in heading.runs:
run.font.size = Pt(font_size)
run.font.name = WORD_FONT_NAME
run.font.bold = True
run.font.color.rgb = RGBColor(0, 0, 0) # 黑色
run._element.rPr.rFonts.set(qn('w:eastAsia'), WORD_FONT_NAME)
# 设置左对齐
heading.alignment = WD_ALIGN_PARAGRAPH.LEFT
```
#### 3.2 修改 `_add_paragraph` 函数
**需要添加首行缩进：**
```python
def _add_paragraph(doc, text: str, bold: bool = False) -> None:
"""
添加段落
Args:
doc: Word文档对象
text: 段落文本
bold: 是否加粗
"""
paragraph = doc.add_paragraph(text)
# 设置段落格式：首行缩进两字符
from docx.shared import Twips, Pt
paragraph.paragraph_format.first_line_indent = Twips(WORD_PARAGRAPH_FIRST_LINE_INDENT * 240) # 1字符≈240缇
for run in paragraph.runs:
run.font.size = Pt(WORD_FONT_SIZE)
run.font.name = WORD_FONT_NAME
run.font.color.rgb = RGBColor(0, 0, 0) # 黑色
run._element.rPr.rFonts.set(qn('w:eastAsia'), WORD_FONT_NAME)
run.font.bold = bold
```
#### 3.3 修改 `_create_table_with_data` 函数
**需要添加表格内容居中对齐：**
```python
def _create_table_with_data(doc, headers: List[str], rows: List[List[str]]) -> None:
"""
创建表格并填充数据
Args:
doc: Word文档对象
headers: 表头列表
rows: 数据行列表
"""
if not rows:
return
# 创建表格
table = doc.add_table(rows=1 + len(rows), cols=len(headers))
table.style = 'Table Grid' # 使用简单的网格样式（黑色边框）
# 设置表头
header_cells = table.rows[0].cells
for i, header in enumerate(headers):
header_cells[i].text = header
# 设置表头样式：居中对齐、加粗、黑色
for paragraph in header_cells[i].paragraphs:
paragraph.alignment = WD_ALIGN_PARAGRAPH.CENTER # 表头居中对齐
for run in paragraph.runs:
run.font.bold = True
run.font.size = Pt(WORD_FONT_SIZE)
run.font.name = WORD_FONT_NAME
run.font.color.rgb = RGBColor(0, 0, 0) # 黑色
run._element.rPr.rFonts.set(qn('w:eastAsia'), WORD_FONT_NAME)
# 设置表头单元格边框为黑色
_set_cell_border(header_cells[i])
# 填充数据行
for i, row_data in enumerate(rows):
row_cells = table.rows[i + 1].cells
for j, cell_data in enumerate(row_data):
cell_text = str(cell_data) if cell_data is not None else ""
row_cells[j].text = cell_text
# 设置单元格样式：居中对齐、黑色
for paragraph in row_cells[j].paragraphs:
paragraph.alignment = WD_ALIGN_PARAGRAPH.CENTER # 表格内容居中对齐
for run in paragraph.runs:
run.font.size = Pt(WORD_FONT_SIZE)
run.font.name = WORD_FONT_NAME
run.font.color.rgb = RGBColor(0, 0, 0) # 黑色
run._element.rPr.rFonts.set(qn('w:eastAsia'), WORD_FONT_NAME)
# 设置单元格边框为黑色
_set_cell_border(row_cells[j])
cell_text = str(cell_data) if cell_data is not None else ""
row_cells[j].text = cell_text
# 设置单元格样式：居中对齐、黑色
for paragraph in row_cells[j].paragraphs:
paragraph.alignment = WD_ALIGN_PARAGRAPH.CENTER # 表格内容居中对齐
for run in paragraph.runs:
run.font.size = Pt(WORD_FONT_SIZE)
run.font.name = WORD_FONT_NAME
run.font.color.rgb = RGBColor(0, 0, 0) # 黑色
run._element.rPr.rFonts.set(qn('w:eastAsia'), WORD_FONT_NAME)
```
### 步骤 4：修复执行计划
| 序号 | 任务 | 文件 | 状态 |
|------|------|------|------|
| 1 | 在 `config.py` 中添加新的字体和字号配置常量 | `src/config.py` | ✅ 已完成 |
| 2 | 修改 `_add_title` 函数使用新的字号配置 | `src/word_generator.py` | ✅ 已完成 |
| 3 | 修改 `_add_paragraph` 函数添加首行缩进 | `src/word_generator.py` | ✅ 已完成 |
| 4 | 修改 `_create_table_with_data` 函数添加表格居中对齐 | `src/word_generator.py` | ✅ 已完成 |
| 5 | 测试生成的Word报告格式 | - | ✅ 已测试 |
| 6 | 验证所有格式符合需求规范 | - | ⏳ 待用户验证 |
---
## 附录：详细配置说明
### 字号对照表
| 标题级别 | 需求字号 | 配置常量名 | 值 |
|----------|----------|------------|-----|
| 一级标题 | 21 | `WORD_TITLE_LEVEL_1_SIZE` | 21 |
| 二级标题 | 19 | `WORD_TITLE_LEVEL_2_SIZE` | 19 |
| 三级标题 | 17 | `WORD_TITLE_LEVEL_3_SIZE` | 17 |
| 四级标题 | 15 | `WORD_TITLE_LEVEL_4_SIZE` | 15 |
| 正文 | 11 | `WORD_FONT_SIZE` | 11 |
### 颜色配置
| 内容类型 | 需求颜色 | RGB值 |
|----------|----------|-------|
| 所有文本 | 黑色 | (0, 0, 0) |
| 或使用 | RGBColor(0, 0, 0) | - |
### 表格边框配置
| 配置项 | 需求 | 实现方式 |
|--------|------|----------|
| 表格样式 | 简单网格 | `table.style = 'Table Grid'` |
| 边框颜色 | 黑色 | `_set_cell_border(cell)` 设置 color='000000' |
| 边框类型 | 单线 | `border.set(qn('w:val'), 'single')` |
| 边框粗细 | 4缇 | `border.set(qn('w:sz'), '4')` |
**说明：**
- `'Light Grid Accent 1'` 样式带有蓝色边框
- `'Table Grid'` 样式使用黑色边框
- 使用 `_set_cell_border` 函数为每个单元格设置黑色边框
### 对齐方式配置
| 内容类型 | 需求对齐 | python-docx常量 |
|----------|----------|----------------|
| 标题 | 左对齐 | `WD_ALIGN_PARAGRAPH.LEFT` |
| 正文 | 左对齐 | `WD_ALIGN_PARAGRAPH.LEFT` |
| 表头 | 居中对齐 | `WD_ALIGN_PARAGRAPH.CENTER` |
| 表格内容 | 居中对齐 | `WD_ALIGN_PARAGRAPH.CENTER` |
### 缩进配置
| 缩进类型 | 需求 | 实现方式 |
|----------|------|----------|
| 首行缩进 | 两字符 | `Twips(2 * 240)` = 480缇 |
**说明：** 在Word中，1字符约等于240缇(twips)，2字符约为480缇。
---
## 测试验证
### 测试命令
```bash
cd AuxiliaryTool/FunctionalTestReportGeneration
# 测试Word格式报告生成
python run.py --testcase testcases/新统一平台权限管理测试用例.xlsx --buglist testcases/新统一平台权限管理-BUG列表.xlsx --format docx
```
### 验证清单
| 验证项 | 需求 | 验证方法 |
|--------|------|----------|
| 字体 | 宋体 | 打开Word文档，检查文本字体 |
| 一级标题字号 | 21 | 右键标题 > 字体 > 查看字号 |
| 二级标题字号 | 19 | 右键标题 > 字体 > 查看字号 |
| 三级标题字号 | 17 | 右键标题 > 字体 > 查看字号 |
| 四级标题字号 | 15 | 右键标题 > 字体 > 查看字号 |
| 正文字号 | 11 | 右键正文 > 字体 > 查看字号 |
| 标题加粗 | 是 | 检查标题是否加粗 |
| 标题颜色 | 黑色 | 检查标题字体颜色 |
| 正文首行缩进 | 两字符 | 检查段落首行缩进 |
| 表头对齐 | 居中对齐 | 检查表头对齐方式 |
| 表格内容对齐 | 居中对齐 | 检查表格内容对齐方式 |
| 表格颜色 | 黑色 | 检查表格文字颜色 |
---
## 执行结果
### 已修改文件
| 文件 | 修改位置 | 修改内容 | 状态 |
|------|----------|----------|------|
| `src/config.py` | 第162-169行 | 添加新的字体和字号配置常量 | ✅ 已完成 |
| `src/word_generator.py` | 第13-24行 | 更新导入语句 | ✅ 已完成 |
| `src/word_generator.py` | 第59-79行 | 使用 `_set_cell_border` 函数设置黑色边框 | ✅ 已完成 |
| `src/word_generator.py` | 第82-126行 | 修改 `_create_table_with_data` 函数（表格样式、居中对齐、黑色边框） | ✅ 已完成 |
| `src/word_generator.py` | 第128-153行 | 修改 `_add_title` 函数 | ✅ 已完成 |
| `src/word_generator.py` | 第156-174行 | 修改 `_add_paragraph` 函数 | ✅ 已完成 |
### 修改详情
#### config.py 新增配置
```python
# Word文档样式配置
WORD_FONT_NAME = "宋体" # 修改：从"微软雅黑"改为"宋体"
WORD_FONT_SIZE = 11
# 新增：各级标题字号配置
WORD_TITLE_LEVEL_1_SIZE = 21 # 一级标题字号
WORD_TITLE_LEVEL_2_SIZE = 19 # 二级标题字号
WORD_TITLE_LEVEL_3_SIZE = 17 # 三级标题字号
WORD_TITLE_LEVEL_4_SIZE = 15 # 四级标题字号
# 新增：段落格式配置
WORD_PARAGRAPH_FIRST_LINE_INDENT = 2 # 正文首行缩进字符数
```
#### word_generator.py 修改内容
1. **导入语句更新**：
- 移除：`WORD_TITLE_FONT_SIZE`
- 新增：`WORD_TITLE_LEVEL_1_SIZE`, `WORD_TITLE_LEVEL_2_SIZE`, `WORD_TITLE_LEVEL_3_SIZE`, `WORD_TITLE_LEVEL_4_SIZE`, `WORD_PARAGRAPH_FIRST_LINE_INDENT`
2. **`_add_title` 函数改进**：
- 使用字典根据标题级别选择正确字号
- 添加黑色颜色设置 `RGBColor(0, 0, 0)`
- 添加左对齐设置
- 支持1-4级标题
3. **`_add_paragraph` 函数改进**：
- 添加首行缩进：`paragraph.paragraph_format.first_line_indent = Twips(WORD_PARAGRAPH_FIRST_LINE_INDENT * 240)`
- 添加黑色颜色设置
4. **`_create_table_with_data` 函数改进**：
- 表头：居中对齐、加粗、黑色
- 表格内容：居中对齐、黑色
- 表格样式：从 `'Light Grid Accent 1'` 改为 `'Table Grid'`（黑色边框）
- 调用 `_set_cell_border` 为每个单元格设置黑色边框
### 测试结果
**测试命令：**
```bash
python run.py --testcase testcases/新统一平台权限管理测试用例.xlsx --buglist testcases/新统一平台权限管理-BUG列表.xlsx --format docx --output reports/test_format_border.docx
```
**测试结果：** ✅ 成功生成报告
**生成的文件：** `reports/test_format_border.docx`
### 验证清单
请打开生成的Word文档 `reports/test_format_updated.docx` 进行验证：
| 验证项 | 需求 | 状态 |
|--------|------|------|
| 字体 | 宋体 | ⏳ 待验证 |
| 一级标题字号 | 21 | ⏳ 待验证 |
| 二级标题字号 | 19 | ⏳ 待验证 |
| 三级标题字号 | 17 | ⏳ 待验证 |
| 四级标题字号 | 15 | ⏳ 待验证 |
| 正文字号 | 11 | ⏳ 待验证 |
| 标题加粗 | 是 | ⏳ 待验证 |
| 标题颜色 | 黑色 | ⏳ 待验证 |
| 正文首行缩进 | 两字符 | ⏳ 待验证 |
| 表头对齐 | 居中对齐 | ⏳ 待验证 |
| 表格内容对齐 | 居中对齐 | ⏳ 待验证 |
| 表格颜色 | 黑色 | ⏳ 待验证 |
| 表格边框颜色 | 黑色 | ⏳ 待验证 |
### 验证清单
请打开生成的Word文档 `reports/test_format_border.docx` 进行验证：
| 验证项 | 需求 | 状态 |
|--------|------|------|
| 字体 | 宋体 | ⏳ 待验证 |
| 一级标题字号 | 21 | ⏳ 待验证 |
| 二级标题字号 | 19 | ⏳ 待验证 |
| 三级标题字号 | 17 | ⏳ 待验证 |
| 四级标题字号 | 15 | ⏳ 待验证 |
| 正文字号 | 11 | ⏳ 待验证 |
| 标题加粗 | 是 | ⏳ 待验证 |
| 标题颜色 | 黑色 | ⏳ 待验证 |
| 正文首行缩进 | 两字符 | ⏳ 待验证 |
| 表头对齐 | 居中对齐 | ⏳ 待验证 |
| 表格内容对齐 | 居中对齐 | ⏳ 待验证 |
| 表格文字颜色 | 黑色 | ⏳ 待验证 |
| 表格边框颜色 | 黑色 | ⏳ 待验证 |
### 验证方法
1. **验证字体和字号**：
- 右键点击标题 > 选择"字体" > 查看字体名称和字号
2. **验证对齐方式**：
- 右键点击段落或表格内容 > 选择"段落" > 查看对齐方式
3. **验证首行缩进**：
- 右键点击正文段落 > 选择"段落" > 查看首行缩进值（应约为2字符）
4. **验证表格边框颜色**：
- 选中表格 > 右键 > "边框和底纹" > 查看边框颜色（应为黑色）
| 标题颜色 | 黑色 | ⏳ 待验证 |
| 正文首行缩进 | 两字符 | ⏳ 待验证 |
| 表头对齐 | 左对齐 | ⏳ 待验证 |
| 表格内容对齐 | 居中对齐 | ⏳ 待验证 |
### 验证方法
1. **验证字体和字号**：
- 右键点击标题 > 选择"字体" > 查看字体名称和字号
2. **验证对齐方式**：
- 右键点击段落或表格内容 > 选择"段落" > 查看对齐方式
3. **验证首行缩进**：
- 右键点击正文段落 > 选择"段落" > 查看首行缩进值（应约为2字符）
---
## 规范文档
- 代码规范: `Docs/PRD/01规范文档/_PRD_规范文档_代码规范.md`
- 问题总结: `Docs/PRD/01规范文档/_PRD_问题总结_记录文档.md`
- 方法总结: `Docs/PRD/01规范文档/_PRD_方法总结_记录文档.md`
- 文档规范: `Docs/PRD/01规范文档/_PRD_规范文档_文档规范.md`
- 测试规范: `Docs/PRD/01规范文档/_PRD_规范文档_测试规范.md`
---
*文档结束*
Docs/PRD/自动化生成功能测试报告/_PRD_自动化生成功能测试报告.md → Docs/PRD/自动化生成功能测试报告/需求文档/_PRD_自动化生成功能测试报告.md
浏览文件 @ 4c9131ba
...@@ -8,7 +8,7 @@ ...@@ -8,7 +8,7 @@
### 需求描述 ### 需求描述
#### 模板文件获取 #### 模板文件获取
- 功能测试报告模板：[AuxiliaryTool/FunctionalTestReportGeneration/config/功能测试报告模板.md] - 功能测试报告模板：[AuxiliaryTool/FunctionalTestReportGeneration/config/功能测试报告模板.md]、[AuxiliaryTool/FunctionalTestReportGeneration/config/功能测试报告模板.docx]
- BUG列表数据模板：[AuxiliaryTool/FunctionalTestReportGeneration/config/BUG列表模板数据.xlsx] - BUG列表数据模板：[AuxiliaryTool/FunctionalTestReportGeneration/config/BUG列表模板数据.xlsx]
- 功能测试用例模板： [AuxiliaryTool/FunctionalTestReportGeneration/config/功能测试用例模板.xlsx] - 功能测试用例模板： [AuxiliaryTool/FunctionalTestReportGeneration/config/功能测试用例模板.xlsx]
...@@ -45,9 +45,9 @@ ...@@ -45,9 +45,9 @@
- 图标绘制规则：绘制BUG等级分布、用例执行结果分布、用例通过率图表，使用matplotlib库进行图表绘制。 - 图标绘制规则：绘制BUG等级分布、用例执行结果分布、用例通过率图表，使用matplotlib库进行图表绘制。
#### 文档输出规则 #### 文档输出规则
- 报告输出格式：输出Word文档格式。 - 报告输出格式：输出Word和md文档格式。
- 报告输出位置：输出到[AuxiliaryTool/FunctionalTestReportGeneration/reports]。 - 报告输出位置：输出到[AuxiliaryTool/FunctionalTestReportGeneration/reports]。
- 报告命名规则：{项目名称}_功能测试报告_{日期}.docx - 报告命名规则：{项目名称}_功能测试报告_{日期}.docx或{项目名称}_功能测试报告_{日期}.md。
- 报告编号规则：{项目名称}-{日期} - 报告编号规则：{项目名称}-{日期}
## 规范文档 ## 规范文档
......
Docs/PRD/自动化生成功能测试报告/_PRD_自动化生成功能测试报告_计划执行.md → Docs/PRD/自动化生成功能测试报告/需求文档/_PRD_自动化生成功能测试报告_计划执行.md
浏览文件 @ 4c9131ba
# _PRD_自动化生成功能测试报告_计划执行 # _PRD_自动化生成功能测试报告_计划执行
> 版本：V1.0 > 版本：V1.1
> 创建日期：2026-03-09 > 创建日期：2026-03-09
> 更新日期：2026-03-09 > 更新日期：2026-03-09
> 适用范围：功能测试报告自动化生成工具 > 适用范围：功能测试报告自动化生成工具
> 来源：基于《_PRD_自动化生成功能测试报告.md》 > 来源：基于《_PRD_自动化生成功能测试报告.md》
> 状态：执行中 > 状态：执行中
## 更新记录
| 版本 | 日期 | 更新内容 |
|------|------|----------|
| V1.1 | 2026-03-09 | 新增Markdown格式报告输出支持 |
--- ---
## 1. 项目概述 ## 1. 项目概述
...@@ -18,7 +23,7 @@ ...@@ -18,7 +23,7 @@
- 开发Python工具，自动读取测试用例和BUG列表数据 - 开发Python工具，自动读取测试用例和BUG列表数据
- 自动统计用例执行情况、BUG数量和等级分布 - 自动统计用例执行情况、BUG数量和等级分布
- 自动填充功能测试报告模板 - 自动填充功能测试报告模板
- 生成Word格式的功能测试报告 - 生成Word和Markdown格式的功能测试报告
- 支持命令行和GUI两种交互方式 - 支持命令行和GUI两种交互方式
### 1.3 涉及文件 ### 1.3 涉及文件
...@@ -32,18 +37,20 @@ ...@@ -32,18 +37,20 @@
**输出文件：** **输出文件：**
- `AuxiliaryTool/FunctionalTestReportGeneration/reports/{项目名称}_功能测试报告_{日期}.docx` - `AuxiliaryTool/FunctionalTestReportGeneration/reports/{项目名称}_功能测试报告_{日期}.docx`
- `AuxiliaryTool/FunctionalTestReportGeneration/reports/{项目名称}_功能测试报告_{日期}.md`
**需要创建的代码文件：** **需要创建的代码文件：**
| 序号 | 文件名 | 功能描述 | 状态 | | 序号 | 文件名 | 功能描述 | 状态 |
|-----|--------|----------|------| |-----|--------|----------|------|
| 1 | `config.py` | 配置文件，定义常量和路径 | ⏳ 待创建 | | 1 | `config.py` | 配置文件，定义常量和路径 | ✅ 已完成 |
| 2 | `excel_reader.py` | Excel文件读取模块 | ⏳ 待创建 | | 2 | `excel_reader.py` | Excel文件读取模块 | ✅ 已完成 |
| 3 | `data_analyzer.py` | 数据分析和统计模块 | ⏳ 待创建 | | 3 | `data_analyzer.py` | 数据分析和统计模块 | ✅ 已完成 |
| 4 | `chart_generator.py` | 图表生成模块（matplotlib） | ⏳ 待创建 | | 4 | `chart_generator.py` | 图表生成模块（matplotlib） | ✅ 已完成 |
| 5 | `report_generator.py` | Word报告生成模块 | ⏳ 待创建 | | 5 | `word_generator.py` | Word报告生成模块 | ✅ 已完成 |
| 6 | `cli.py` | 命令行交互模块 | ⏳ 待创建 | | 6 | `markdown_generator.py` | Markdown报告生成模块 | ⏳ 待创建 |
| 7 | `gui.py` | GUI界面模块 | ⏳ 待创建 | | 7 | `cli.py` | 命令行交互模块 | ✅ 已完成 |
| 8 | `main.py` | 主入口文件 | ⏳ 待创建 | | 8 | `gui.py` | GUI界面模块 | ✅ 已完成 |
| 9 | `main.py` | 主入口文件 | ✅ 已完成 |
--- ---
...@@ -519,7 +526,89 @@ def create_word_document(content: str, chart_paths: Dict[str, str], output_path: ...@@ -519,7 +526,89 @@ def create_word_document(content: str, chart_paths: Dict[str, str], output_path:
--- ---
### 4.6 cli.py - 命令行交互模块 ### 4.6 markdown_generator.py - Markdown报告生成模块
**职责：**
- 读取功能测试报告模板
- 填充报告数据
- 插入图表
- 生成Markdown文档
**导出函数：**
```python
def generate_markdown_report(
template_path: str,
case_analysis: TestCaseAnalysis,
bug_analysis: BugAnalysis,
case_bug_link: Dict[str, List[Bug]],
chart_paths: Dict[str, str],
output_path: str,
project_name: str,
cases: List[TestCase],
bugs: List[Bug]
) -> str
"""
生成Markdown格式功能测试报告
:param template_path: 模板文件路径
:param case_analysis: 用例分析结果
:param bug_analysis: BUG分析结果
:param case_bug_link: 用例-BUG关联
:param chart_paths: 图表文件路径字典
:param output_path: 输出文件路径
:param project_name: 项目名称
:param cases: 测试用例列表
:param bugs: BUG列表
:return: 生成的报告文件路径
"""
def render_markdown_table(headers: List[str], rows: List[List[str]]) -> str
"""
渲染Markdown表格
:param headers: 表头列表
:param rows: 数据行列表
:return: Markdown表格字符串
"""
```
**Markdown报告结构：**
```markdown
# {项目名称}功能测试报告
## 一、报告基本信息
### 1.1 报告标识
### 1.2 测试概览
### 1.3 被测系统信息
## 二、测试执行摘要
### 2.1 测试结果统计
### 2.2 BUG统计汇总
### 2.3 测试结论
## 三、测试范围
### 3.1 测试模块覆盖
### 3.2 功能类别分布
## 四、测试用例执行详情
### 4.1 通过用例列表
### 4.2 失败用例列表
### 4.3 未执行用例列表
## 五、BUG详细列表
### 5.1 BUG详细记录
### 5.2 遗留BUG说明
## 六、图表分析
### 6.1 BUG等级分布
![图表](chart_path)
...
```
**依赖：**
- 无额外依赖（使用Python标准库）
---
### 4.7 cli.py - 命令行交互模块
**职责：** **职责：**
- 命令行参数解析 - 命令行参数解析
...@@ -565,7 +654,7 @@ optional arguments: ...@@ -565,7 +654,7 @@ optional arguments:
--- ---
### 4.7 gui.py - GUI界面模块 ### 4.8 gui.py - GUI界面模块
**职责：** **职责：**
- 提供图形用户界面 - 提供图形用户界面
...@@ -613,7 +702,7 @@ def main_gui() -> None ...@@ -613,7 +702,7 @@ def main_gui() -> None
--- ---
### 4.8 main.py - 主入口模块 ### 4.9 main.py - 主入口模块
**职责：** **职责：**
- 程序入口 - 程序入口
......
Markdown 格式
0% 或
您添加了 0 人 到此讨论。请谨慎行事。
请先完成此评论的编辑！
请 注册 或者 后发表评论