6、postman生成测试报告
环境准备
1. 环境安装介绍
- 安装流程:生成测试报告需要先安装node.js,再通过node.js安装newman插件,最后安装newman-reporter-htmlextra扩展插件。
- 前提条件:Postman本身不能生成测试报告,必须借助newman插件实现。
2. 安装newman
1)安装node.js
- 安装方法:双击.msi安装包,勾选接受用户协议,不做任何设置,一路"下一步"即可完成安装。
- 验证方法:cmd打开命令提示符,输入命令npm -v,如能查看到npm的版本号信息则说明安装成功。
- 注意事项:安装过程中不要勾选任何额外选项,保持默认设置即可。
- 下载位置:官方下载地址为https://nodejs.org/zh-cn/download/,课程已提供安装包可跳过下载步骤。
2)安装newman
- 安装命令:npm install -g newman,必须使用"管理员"身份启动命令提示符执行。
- 安装技巧:避开网络访问高峰期(早7:30-9:30,午11:30-14:30,晚18:30-22:30)可提高成功率。
- 验证方法:安装完成后使用newman -v命令查看版本号确认安装成功。
- 异常处理:如安装失败可尝试10几次或几十次,Windows终端有缺陷,安装过程中不要用鼠标点击终端页面。
3)安装newman-reporter-htmlextra
- 安装命令:npm install -g newman-reporter-htmlextra,同样需要使用管理员权限。
- 安装特点:只要newman安装成功,此插件一定能安装成功,如失败可多尝试几次。
- 验证方法:通过后续生成测试报告的操作来验证插件是否安装成功。
3. 安装node.js总结
- 关键步骤:
- 安装node.js(双击.msi文件,一路下一步)
- 验证node.js(npm -v查看版本)
- 安装newman(npm install -g newman)
- 验证newman(newman -v查看版本)
- 安装htmlextra插件(npm install -g newman-reporter-htmlextra)
- 离线安装方案:对于1%无法在线安装的情况:
- 找到C:\Users\用户名\AppData\Roaming\npm目录
- 删除原npm目录所有内容
- 将npm.rar压缩包内容解压到该目录
用例集导入导出:
一、用例集的导出和导入
1. 导出用例集
1)导出用力集
- 操作步骤:
- 选择要导出的用例集名称
- 点击三个点选择"export"选项
- 默认选项直接点击export即可
- 文件格式:
- 自动生成.json后缀的文件
- 文件名不建议修改,保持自动命名格式
- 注意事项:
- 导出前建议先创建专用目录(如report)
- 避免将文件随意存放在桌面
2)选择导出用力集
- 版本确认:
- 弹出页面会显示Collection v2.1(推荐版本)
- 通常保持默认选项不做修改
- 导出操作:
- 直接点击页面下方的export按钮
- 系统会自动生成用例集文件
3)选择存储位置
- 目录准备:
- 建议新建专用文件夹(如report)
- 避免使用中文命名
- 存储操作:
- 选择预先准备好的目录
- 保持自动生成的文件名不变
- 点击"存储"完成导出
- 成功提示:
- 出现绿色提示表示导出成功
- 可在指定目录查看导出的.json文件
2. 导入用例集
1)删除用例集
- 删除步骤:
- 点击用例集名称旁的三个点
- 选择"delete"选项
- 确认删除操作
- 注意事项:
- 删除前确保已备份重要用例集
- 可批量删除不需要的测试集
2)导入用例集
- 导入步骤:
- 点击界面上的"import"按钮
- 选择"upload file"选项
- 浏览选择要导入的.json文件
- 注意事项:
- 导入文件必须是Postman导出的.json格式
- 可一次导入多个用例集文件
3)选择导入文件
- 文件选择:
- 浏览到之前导出的用例集文件
- 支持从任意位置选择文件
- 可同时选择多个文件批量导入
- 操作提示:
- 点击"打开"开始导入
- 系统会自动识别文件格式
4)二次确认步骤
- 重复导入处理:
- 当用例集已存在时会出现提示
- 可选择"Replace"替换原有用例集
- 或选择"Import as Copy"创建副本
- 推荐做法:
- 通常选择创建副本保留原有数据
- 副本会自动在原名称后添加"Copy"
- 完成提示:
- 导入成功后会有相应提示
- 用例集会出现在左侧导航栏
环境文件导出
1. 导出用例集
- 必要性:生成测试报告必须要有用例集文件,这是基础条件
- 导出方法:
- 在Postman中选择要导出的用例集
- 点击"Export"按钮导出为JSON格式文件
- 默认文件名格式为"xxx.postman_collection.json"
- 存储建议:强烈建议将导出的用例集文件存放在专门目录中,便于后续管理
2. 导出环境文件
1)环境文件的导出方法
- 前提条件:
- 必须性:当测试用例脚本中使用到环境变量时,必须导出环境文件
- 区别:全局变量不需要导出,只有环境变量需要导出
- 操作步骤:
- 进入Postman的"Environments"标签页
- 选中当前使用的环境(如测试环境)
- 点击右侧三个点的菜单按钮
- 选择"Export"选项导出环境文件
2)操作示例
- 文件命名:
- 默认生成"xxx.postman_environment.json"格式文件名
- 强烈建议保留默认命名,便于识别文件类型
- 存储位置:
- 强烈建议与用例集文件存放在同一目录下
- 优点:方便后续生成测试报告时命令编写,避免使用绝对路径
- 变量修改示例:
- 将全局变量改为环境变量:pm.globals.set()改为pm.environment.set()
- 变量命名建议:使用"env_"前缀(如env_city)提高可读性
3)操作示例
- 文件区分:
- 用例集文件:包含"collection"标识(如xxx.postman_collection.json)
- 环境文件:包含"environment"标识(如xxx.postman_environment.json)
- 实际应用:
- 环境变量使用前必须确保对应环境被选中(如测试环境)
- 示例:查询天气接口将城市名存入环境变量,百度搜索接口从环境变量读取城市名
- 验证方法:
- 通过Postman的眼睛图标查看当前环境变量值
- 确保变量值正确后再执行依赖该变量的请求
测试报告生成命令详解
1. 命令介绍
- 准备工作:安装node.js、安装newman插件、导出用例集文件和环境文件,这些操作都是为生成测试报告做准备。
- 生成方式:必须通过命令行生成,Postman工具本身不提供图形化生成报告的功能。
2. 命令说明
- 完整命令:
- 参数说明:
- run xxx.json:执行测试集文件(必需)
- -e source:指定环境变量文件(当脚本使用环境变量时需要)
- -d source:指定测试数据文件(当用例使用参数化时需要)
- -r htmlextra:指定生成HTML格式报告(固定写法)
- --reporter-html-export source:指定报告保存路径
- 参数取舍原则:
- 测试集文件必须指定
- 仅当脚本中使用环境变量时才需要-e参数
- 仅当用例使用参数化时才需要-d参数
- 示例:作业三(登录模块)不需要环境文件参数,但关联练习需要环境文件参数
- 注意事项:
- 命令中的htmlextra是固定写法,不能写错
- 参数之间需要用空格分隔
- 报告名称可以自定义,但扩展名需为.html
- 环境文件和用例集文件都是.json格式
- 文件示例:
- 用例集文件:postman关联练习1.collection.json
- 环境文件:environment.json
- 生成命令示例(无数据文件):
三、命令总结
- 完整命令格式:
- 参数说明:
- -e参数:指定环境变量文件,当测试不使用环境变量时可省略
- -d参数:指定测试数据文件(支持.json或.csv格式),用于参数化测试,无参数化需求时可省略
- -r参数:必须参数,指定生成报告类型为htmlextra(扩展版HTML报告)
- --reporter-htmlextra-export:必须参数,由三个单词组成,注意前面需要双横杠
- 执行要点:
- 必须保留newman run:不能省略"newman"或"run"关键字,否则命令无法执行
- 参数顺序敏感:各参数位置不可随意调换,必须保持固定格式
- 空格要求:每个参数前必须有空格分隔,如"-e"前必须有空格
四、今日总结
- 关键步骤:
- 前置准备:需先安装node.js和newman(通过npm install -g newman)
- 插件安装:必须安装HTML报告扩展插件(newman-reporter-htmlextra)
- 文件管理:建议将环境文件、用例集文件存放在同一目录下
- 注意事项:
- 报告生成失败排查:检查是否漏写"newman"关键字或参数格式错误
- 参数化测试:当使用数据文件时,必须确保文件格式正确(.json或.csv)
- 路径问题:文件路径包含空格或特殊字符时建议使用引号包裹
生成测试报告:
一、使用命令生成测试报告
1. 打开终端
- 目录操作技巧:
- 建议为用例集和数据文件创建专用目录存放
- 在目录地址栏直接输入cmd可快速在当前目录打开终端
- 路径处理要点:
- 必须确保终端在当前用例集所在目录打开
- 相对路径写法要求终端必须定位到用例集所在目录
2. 巩固命令
- 基础语法:
- 完整格式:newman run 用例集文件.json -e 环境文件.json -d 数据文件.csv -r htmlextra --reporter-htmlextra-export 报告名.html
- 参数说明:
- -e:非必须,仅当使用环境文件时需要
- -d:非必须,仅当做参数化需要数据文件时使用
- -r:必须指定为htmlextra格式
- 自动补全技巧:
- 在正确目录打开终端后,可使用tab键自动补全文件名
- 补全前提:必须确保文件存在于当前终端所在目录
- 例题:指定用例集文件和数据文件
- 典型场景:
- 当测试需要参数化数据但不需要环境变量时使用
- 示例命令:newman run 第三天作业.postman_collection.json -d login.json -r htmlextra --reporter-htmlextra-export 作业测试报告.html
- 执行验证:
- 成功执行后会生成HTML格式测试报告
- 报告默认保存在用例集相同目录下
- 可查看请求详情、响应数据和断言结果
- 例题:指定用例集文件和环境文件
- 典型场景:
- 当测试需要环境变量但不需要参数化数据时使用
- 示例命令:newman run postman关联练习1.postman_collection.json -e 测试环境.postman_environment.json -r htmlextra --reporter-htmlextra-export 关联练习报告.html
- 注意事项:
- 环境文件中需正确定义变量
- 无断言时报告仅显示请求执行情况
- 可通过迭代详情查看环境变量传递过程
- 常见问题排查:
- 插件未安装时会出现"command not found"错误
- 网络延迟可能导致报告生成缓慢
- 文件路径错误是最常见的执行失败原因
- 典型场景:
浙公网安备 33010602011771号