PR合并后基于Jenkins实现后端服务自动化测试与发布方案咨询

一、前置准备 #

• Jenkins节点配置Docker环境（支持Docker命令执行，或采用Docker-in-Docker模式）
• 配置Git仓库（GitHub/GitLab等）的Webhook，PR合并后触发Jenkins Pipeline
• 准备API测试框架：可选用Newman（Postman集合）、RestAssured+JUnit，或自定义Python/Shell测试脚本
• 协调上下游项目提供测试环境接口，或准备其可运行的Docker镜像（用于本地依赖模拟）
• Jenkins中配置私有镜像仓库凭证、目标环境部署凭证

二、核心流程设计 #

• PR合并完成 → 触发Jenkins Pipeline
• 拉取最新代码 → 构建REST API的Docker镜像
• 启动API测试容器及上下游依赖服务（测试环境或本地容器）
• 执行全量API测试（含上下游关联场景）
• 测试通过 → 推送镜像到私有仓库 → 部署到目标环境
• 清理测试阶段产生的容器、镜像资源

三、Jenkins Pipeline具体实现 #

1. 触发配置 #

在Git仓库中设置Webhook，触发事件选择「PR合并完成」，指向Jenkins的job/${JOB_NAME}/build地址；同时在Jenkins任务中配置分支为main/master，仅接受合并后的代码触发。

2. Pipeline代码示例 #

pipeline {
    agent any
    environment {
        DOCKER_IMAGE = "my-rest-api:${BUILD_NUMBER}"
        REGISTRY = "internal-registry.com"
        UPSTREAM_TEST_URL = "http://test-upstream:8080"
        DOWNSTREAM_TEST_URL = "http://test-downstream:9090"
    }
    stages {
        stage('拉取合并后代码') {
            steps {
                git url: 'git@your-repo.git', branch: 'main'
            }
        }

        stage('构建Docker镜像') {
            steps {
                script {
                    docker.build("${REGISTRY}/${DOCKER_IMAGE}", "-f Dockerfile .")
                }
            }
        }

        stage('启动测试环境依赖') {
            steps {
                script {
                    // 创建测试专用网络
                    sh 'docker network create test-net || true'
                    // 启动上游服务容器（若需本地模拟）
                    sh 'docker run -d --name test-upstream --network test-net upstream-service:test'
                    // 启动下游服务容器（若需本地模拟）
                    sh 'docker run -d --name test-downstream --network test-net downstream-service:test'
                    // 等待依赖服务就绪
                    sh 'sleep 15'
                    // 验证依赖服务状态
                    sh 'curl -f ${UPSTREAM_TEST_URL}/health && curl -f ${DOWNSTREAM_TEST_URL}/health'
                }
            }
        }

        stage('启动API测试容器') {
            steps {
                script {
                    def apiContainer = docker.run("${REGISTRY}/${DOCKER_IMAGE}", 
                        "-d --name test-api --network test-net -p 8080:8080 " +
                        "-e UPSTREAM_URL=${UPSTREAM_TEST_URL} " +
                        "-e DOWNSTREAM_URL=${DOWNSTREAM_TEST_URL}")
                    // 等待API服务就绪
                    sh 'sleep 10'
                    sh 'curl -f http://localhost:8080/actuator/health'
                }
            }
        }

        stage('执行API测试') {
            steps {
                script {
                    // 用Newman执行Postman测试集合（含上下游关联用例）
                    sh 'newman run api-test-collection.json ' +
                       "--env-var api_url=http://localhost:8080 " +
                       "--env-var upstream_url=${UPSTREAM_TEST_URL} " +
                       "--reporters junit,cli"
                    // 若用JUnit+RestAssured，执行单元测试命令
                    // sh './gradlew test --info'
                }
            }
            post {
                always {
                    junit '**/TEST-*.xml' // 展示测试报告
                }
            }
        }

        stage('推送镜像到私有仓库') {
            when {
                expression { currentBuild.result == 'SUCCESS' }
            }
            steps {
                script {
                    docker.withRegistry("https://${REGISTRY}", "registry-cred") {
                        docker.image("${REGISTRY}/${DOCKER_IMAGE}").push()
                        docker.image("${REGISTRY}/${DOCKER_IMAGE}").push('latest')
                    }
                }
            }
        }

        stage('部署到预发布环境') {
            when {
                expression { currentBuild.result == 'SUCCESS' }
            }
            steps {
                script {
                    // 用Docker Compose部署
                    sh 'docker-compose -f pre-deploy.yml pull && docker-compose -f pre-deploy.yml up -d'
                    // 或用K8s部署
                    // sh 'kubectl set image deployment/my-rest-api my-rest-api=${REGISTRY}/${DOCKER_IMAGE}'
                }
            }
        }

        stage('清理测试资源') {
            steps {
                script {
                    sh 'docker stop test-api test-upstream test-downstream || true'
                    sh 'docker rm test-api test-upstream test-downstream || true'
                    sh 'docker network rm test-net || true'
                    // 可选：清理本地镜像
                    // sh 'docker rmi ${REGISTRY}/${DOCKER_IMAGE} || true'
                }
            }
        }
    }
    post {
        failure {
            sh 'echo "测试/发布失败，通知开发团队"'
            // 可扩展邮件/企业微信通知
        }
    }
}

四、上下游关联项目测试要点 #

• 依赖环境适配：优先使用稳定的测试环境上下游服务，若需本地模拟，需确保上下游镜像为测试专用版本（不含生产数据）
• 测试用例覆盖：编写依赖上下游的场景用例，比如：
  • 调用本API前，先调用上游服务生成测试数据，验证本API的返回结果
  • 调用本API后，检查下游服务是否同步接收并处理数据
• 动态参数传递：通过Jenkins环境变量传递上下游服务地址，避免测试用例硬编码
• 依赖健康检查：在启动测试容器后，先验证上下游服务的健康状态，再执行API测试

五、关键注意事项 #

• 确保Jenkins节点有Docker操作权限，可将Jenkins用户加入docker组
• 测试阶段与生产环境完全隔离，避免测试流量影响线上服务
• 添加超时机制：比如在服务启动、测试执行步骤中设置timeout(time: 5, unit: 'MINUTES')，防止Pipeline挂起
• 敏感信息（如仓库密码、API密钥）通过Jenkins凭证管理存储，避免明文暴露

内容的提问来源于stack exchange，提问作者miniQ