tidutools1.1工具操作说明

工具说明

• tidutools可提取MeterSphere(以下简称为Ms)中的用例信息与Jira中的缺陷信息，并根据Word模板生成对应的测试报告文档主体部分，包括以下几个部分
  • 用例统计列表
  • 用例详情列表（多表）
  • 已关闭缺陷列表
  • 延期缺陷列表
  • 缺陷统计表（模块+优先级）

文件说明

• tidutools-1.0-SNAPSHOT-jar-with-dependencies.jar => 程序包
• template目录 => word表格模板，每种表格一个单独的模板文件。
• jdk-17.0.6_windows-x64_bin.msi => Jdk17安装包(win)
• params.json => 配置文件，用于设置一些自定义的参数

执行环境需求

• 安装jdk17 如配置了path可以直接执行java命令，没配置path需要到java17的安装目录中执行java命令 jdk17(win_x64)下载地址

执行命令

java -jar tidutools-1.0-SNAPSHOT-jar-with-dependencies

参数文件params.json说明

• 文件实例

{
    "project": "2",
    "msVersion": "8.3.x",
    "jiraVersion": "ai_v1.3.0",
    "priority": "P3",
    "reportType": "bug",
    "jqlClosed": "",
    "jqlDelayed": "",
    "template_caseStat": "template/表格模板-用例统计表.docx",
    "template_caseInfo": "template/表格模板-用例详情表.docx",
    "template_bugClosed": "template/表格模板-已关闭缺陷表.docx",
    "template_bugDelayed": "template/表格模板-延期缺陷表.docx",
    "template_bugStat1": "template/表格模板-缺陷(模块&优先级)统计表.docx"
}

• 参数说明

• project :项目名称,以Ms中的信息为准。输入数字或全名均可。
  (1-容器云项目;2-AI项目;3-云管项目;4-运维管理平台;5-IAM项目;6-大数据项目)
• msVersion : MS中的所属模块,包括版本号和模块名，此项为模糊匹配。例如:/v1.7.x/数据探查
• jiraVersion : jira中的版本号，此项为精确匹配
• prioirty : MS中的用例优先级 P0->P3,向下包含
• reportType : 选项为case(只用例)、bug(只缺陷)、all(所有)

case 包括 用例统计表与用例详情表
bug 包括 已关闭缺陷列表、延期缺陷列表、缺陷(模块&优先级)统计表
all 则会生成以上所有的表格

• jqlClosed : 自定义查询jql,这里不为空则会以这个jql的查询结果生成【已关闭缺陷列表】

由于不同产品线统计缺陷的方式不同，所以这里放开了自定义查询的功能，例如
issuetype = bug AND project = STE and status = Closed and fixVersion = 1.0.0
issuetype = bug AND project = DG and status = Closed and affectedVersion = 1.0.0

• jqlDelayed : 自定义查询jql,这里不为空则会以这个jql的查询结果生成【延期缺陷列表】
• template_caseStat : 用例统计表模板路径
• template_caseInfo : 用例详情表模板路径
• template_bugClosed : 已关闭缺陷列表模板路径
• template_bugDelayed :延期缺陷列表模板路径
• template_bugStat1 :缺陷(模块&优先级)统计表模板路径

操作实例

# dos
 java -jar tidutools-1.1-SNAPSHOT-jar-with-dependencies.jar
2023-08-21 17:20:21 146 [main] [MeterSphere.MsCaseAnalysis2] [INFO] - 共查找到 83 条用例记录，项目 => 运维管理平台  版本=>2.1.0
2023-08-21 17:20:21 152 [main] [MeterSphere.JiraBugAnalysis] [INFO] - 下面开始获取Jira中的缺陷信息...
2023-08-21 17:20:21 749 [main] [MeterSphere.JiraBugAnalysis] [INFO] - 共查找到 2 条已关闭缺陷记录，项目 => 运维管理平台  版本=>2.1.0
2023-08-21 17:20:23 220 [main] [MeterSphere.MsCase2Word] [INFO] - MeterSphere_运维管理平台_2.1.0_测试报告.docx 文档生成成功！

注意事项（粗体为必须遵守）

1. Ms中的项目版本号需要与jira中一致，或者Jira为Ms的子集。如 Jira中 1.0.0 Ms中 v1.0.0

2. Ms中的目录层级建议 2=<x<=5，其中第一层是系统默认的目录，第二层用于标识版本，第三层标识组件或模块，再往下标识子模块或业务
   

3. 用例步骤描述中不要写数字序号，工具生成文档时会根据步骤编号自动添加序号。否则会在文档中重复展示序号，引起阅读障碍。
   

4. 上传的图片附件需要以 数字+、 开头，用于匹配对应的步骤编号。比如 【1、截图01.jpg】 对应第一步的截图，图片的文件名在文档中则会作为该图片的描述信息展示。
   

1.0 => 1.1功能更新列表

• 增加延期缺陷列表
• 增加缺陷(模块&优先级)统计表
• 输入参数由命令行参数改为配置文件，增加新的参数种类
• 表格模板由一个大模板文件改为每个表格对应一个独立的模板文件
• 优化优先级的兼容性处理逻辑，缺陷中有P开头的标签则取其为优先级，没有P开头或没有标签的缺陷，则取系统内置的优先级字段，并改成P+数字形式的优先级展示方式。 具体映射关系为

Map.of("Highest", "P1", "High", "P2", "Medium", "P3", "Low", "P4", "Lowest", "P4");

待改进

1. 现在只支持导出功能测试用例，以后可根据实际需求添加非功能用例
2. 附件图片现在只支持一个步骤对应一张截图，以后需要改进为一步骤对多截图