qamantle/trcli

qamantle/trcli 镜像文档

镜像概述和主要用途

该镜像提供容器化的Python环境，用于运行Gurock Software GmbH官方提供的TRCLI工具，实现将JUnit.xml格式的测试结果上传至Testrail服务器。

• https://github.com/gurock/trcli
• 官方文档参考

核心功能和特性

• 基于官方TRCLI工具，确保与Testrail服务器的兼容性
• 支持两种配置方式：环境变量配置和配置文件配置
• 支持本地JUnit.xml测试结果文件挂载，方便结果上传
• 容器化部署，简化Python环境依赖管理

使用场景和适用范围

适用于需要将JUnit格式测试结果自动上传至Testrail服务器的场景，如：

• CI/CD流水线中集成测试结果报告上传
• 自动化测试流程中测试结果的集中管理
• 团队协作中测试结果的实时同步

使用方法和配置说明

方式一：使用环境变量配置

命令格式

bash
docker run -e USER_EMAIL="{USER_EMAIL}" \
           -e URL="{TESTRAIL_SERVER_URL}" \ 
           -e USER_PASSWORD="{USER_API_KEY}" \ 
           -e PROJECT="{TARGET_PROJECT}" \ 
           -e RUN_TITLE="{TEST_RUN_TITLE}" \
           -e RUN_DESC="{TEST_RUN_DESCRIPTION}" \
           --mount src="$(pwd)/{path_to_results_xml_file}",target=/workspace/results.xml,type=bind \ 
           qamantle/trcli:1.0

参数说明

• TESTRAIL_SERVER_URL: Testrail服务器URL，格式为"[***]"
• USER_EMAIL: 用于发布结果的用户***
• USER_PASSWORD: 用于认证的API密钥（注：此处参数名虽为USER_PASSWORD，实际使用API密钥）
• TARGET_PROJECT: 目标项目名称，结果将发布至该项目
• TEST_RUN_TITLE: 测试运行的标题
• TEST_RUN_DESC: 测试运行的描述
• path_to_results_xml_file: JUnit.xml结果文件的本地路径（相对于当前工作目录）

示例

bash
docker run -e USER_EMAIL="test@qamantle.com" \
           -e URL="https://dummy.testrail.io/" \ 
           -e USER_PASSWORD="lkjhfdsgljksdhflgjkh" \ 
           -e PROJECT="My Dummy Project" \ 
           -e RUN_TITLE="Build No. 512" \
           -e RUN_DESC="My Test Run Description" \
           --mount src="$(pwd)/reports/output.xml",target=/workspace/results.xml,type=bind \ 
           qamantle/trcli:1.0

方式二：使用配置文件配置

命令格式

bash
docker run -e CONFIG=true \
           --mount src="$(pwd)/{path_to_configuration_file}",target=/workspace/config.yml,type=bind \ 
           --mount src="$(pwd)/{path_to_results_xml_file}",target=/workspace/results.xml,type=bind \ 
           qamantle/trcli:1.0

参数说明

• path_to_configuration_file: 配置文件（configuration.yml）的本地路径（相对于当前工作目录）
• path_to_results_xml_file: JUnit.xml结果文件的本地路径（相对于当前工作目录）

示例

bash
docker run -e CONFIG=true \
           --mount src="$(pwd)/config.yml",target=/workspace/config.yml,type=bind \ 
           --mount src="$(pwd)/reports/results.xml",target=/workspace/results.xml,type=bind \ 
           qamantle/trcli:1.0

注意事项

• 该镜像仅打包运行TRCLI所需的Python环境，工具本身功能与官方TRCLI完全一致，无任何修改。
• 配置文件的具体格式和参数请参考官方文档。