vdespa/newman

镜像概述

本镜像基于官方Newman镜像扩展构建。Newman是Postman的命令行运行工具，用于自动化执行Postman测试集合（Collection），实现API测试的自动化。本镜像在官方Newman基础上，预先集成了最常用的报告生成器（Reporters），避免用户手动安装报告器依赖，简化从测试执行到报告生成的完整流程，提升API测试报告的可获取性和可读性。

核心功能与特性

• 基于官方Newman：继承官方Newman的全部功能，支持运行Postman测试集合、环境变量文件、全局变量文件等核心能力。
• 集成常用报告器：内置最常用的测试报告生成器（如HTML、JSON、JUnit等），无需额外安装即可直接使用，覆盖大多数报告格式需求。
• 即开即用：无需手动配置报告器依赖，拉取镜像后可直接运行测试并生成报告，降低使用门槛。

适用场景

• CI/CD流程集成：在持续集成/持续部署（CI/CD） pipeline中嵌入API测试步骤，自动生成并输出测试报告，辅助判断构建是否通过。
• 本地API测试：开发或测试人员在本地环境快速运行Postman测试集合，通过集成的报告器生成直观的测试结果（如HTML报告），便捷查看测试详情。
• 团队协作：统一测试报告格式，确保团队成员使用相同的报告生成标准，提升测试结果的一致性和可沟通性。

使用方法

基本使用（docker run 示例）

通过挂载本地目录（包含Postman测试集合文件）到容器内，执行测试并生成报告。基本命令格式如下：

bash
docker run --rm -v $(pwd):/etc/newman [镜像名称] run [测试集合文件] -r [报告器类型1],[报告器类型2]

参数说明：

• --rm：容器运行结束后自动删除，避免残留容器文件。
• -v $(pwd):/etc/newman：将当前本地目录挂载到容器内的/etc/newman目录，用于读取测试集合文件并将生成的报告输出到本地。
• [镜像名称]：替换为实际使用的镜像名称（如构建后的自定义镜像名）。
• run [测试集合文件]：Newman核心命令，指定要运行的Postman测试集合文件（需位于挂载目录下，如my-collection.json）。
• -r [报告器类型]：指定使用的报告器，多个报告器用逗号分隔（如html,json,junit）。

示例：运行测试并生成HTML和JUnit报告

假设本地当前目录下存在Postman测试集合文件api-tests.postman_collection.json，执行以下命令运行测试并生成HTML（直观展示）和JUnit（CI/CD常用）格式报告：

bash
docker run --rm -v $(pwd):/etc/newman my-newman-reporter-image run api-tests.postman_collection.json -r html,junit

执行完成后，测试报告将生成在本地当前目录下，包括：

• newman-report.html（HTML格式报告，可直接在浏览器打开）
• newman-report.xml（JUnit格式报告，适合CI/CD工具解析）

结合环境变量文件使用

若测试需依赖Postman环境变量文件（如environment.json），可通过-e参数指定：

bash
docker run --rm -v $(pwd):/etc/newman my-newman-reporter-image run api-tests.postman_collection.json -e environment.json -r html

注意事项

• 文件路径：确保挂载的本地目录中包含Postman测试集合文件、环境变量文件等必要资源，且路径在命令中正确引用。
• 报告输出：生成的报告默认保存在容器内的/etc/newman目录（即本地挂载目录），无需额外配置输出路径。
• 报告器支持：本镜像集成的常用报告器包括但不限于html（HTML格式报告）、json（JSON格式报告）、junit（JUnit XML格式报告）、cli（命令行输出），可根据需求组合使用。