Jenkinsfile运行测试步骤获取远程命令返回值的最佳方案

首先明确你现有方案的核心坑点：你的apitester工具执行成功时返回退出码1，属于非0值，Jenkins的shell/SSH步骤默认会把所有非0退出码判定为执行失败，直接中断流水线，无法直接通过步骤返回值做后续判断，必须通过「远端脚本标准化输出+流水线端解析输出」的方式实现，具体步骤如下：

1. 优化目标服务器上的执行脚本 #

原脚本存在$?容易被覆盖、输出不规范难以解析的问题，调整为如下版本，既保留完整测试日志方便排查，又输出固定格式的状态码供流水线捕获：

#!/bin/bash
# 执行接口测试，所有测试日志正常输出到标准输出，会同步展示在Jenkins控制台
docker run --net=host -v "$(pwd)":/apiconf docker.registry.com:5000/apitester:1.0.0 apitester -credentials /apiconf/credentials.txt -scenario /apiconf/api.yml -strict-mode
# 第一时间保存测试命令的退出码，避免后续命令修改$?导致状态失真
TEST_EXIT_CODE=$?
# 最后一行输出固定前缀的状态码，作为流水线解析的标记，不要在这之后加其他输出
echo "APITEST_FINAL_CODE:${TEST_EXIT_CODE}"

注意：脚本不要加set -e配置，否则docker run返回非0时会直接中断脚本，无法走到输出状态码的步骤。

2. Jenkins流水线中捕获状态并注入环境变量 #

推荐使用官方SSH Pipeline Steps插件实现远端命令执行，凭证管理更安全，输出捕获更稳定，核心逻辑如下：

• 部署Swarm服务前，提前把当前运行的旧版本镜像标签存为环境变量，供后续回滚使用
• 执行SSH命令时开启returnStdout参数，把远端所有输出拉取到Jenkins端
• 从输出中匹配固定前缀的状态码行，解析后转为布尔值存入全局环境变量
• 根据环境变量值走通知/回滚分支

完整Jenkinsfile参考片段：

pipeline {
    agent any
    environment {
        // 提前定义变量存储旧版本镜像、测试结果
        OLD_SERVICE_IMAGE = ""
        API_TEST_PASS = ""
    }
    stages {
        stage('Swarm服务部署') {
            steps {
                script {
                    // 部署前先记录当前运行的旧版本镜像，避免后续回滚无据可依
                    OLD_SERVICE_IMAGE = sh(
                        script: "docker service inspect your-api-svc --format '{{.Spec.TaskTemplate.ContainerSpec.Image}}'",
                        returnStdout: true
                    ).trim()
                    // 执行服务更新，部署新构建的镜像
                    sh "docker service update --image docker.registry.com:5000/your-api-svc:${BUILD_NUMBER} your-api-svc"
                    // 等待服务副本启动完成，根据实际情况调整等待时间
                    sh "docker service wait your-api-svc 120"
                }
            }
        }
        stage('接口自动化测试') {
            steps {
                script {
                    // SSH到目标服务器执行测试脚本，捕获全量输出
                    def remoteExecResult = sshCommand(
                        remote: [
                            name: "api-target-host",
                            host: "目标服务器IP",
                            user: "SSH登录用户",
                            // 推荐通过credentialsId绑定Jenkins中存储的SSH密钥，不要硬编码密钥路径
                            credentialsId: "your-ssh-credential-id"
                        ],
                        command: "/data/scripts/run_apitester.sh",
                        // 关键配置：返回命令全量输出，同时禁止步骤因非0退出码中断
                        returnStdout: true,
                        failOnError: false
                    )
                    // 解析匹配固定前缀的状态码行，不会被前面的测试日志干扰
                    def codeLine = remoteExecResult.readLines().findLast { it.startsWith("APITEST_FINAL_CODE:") }
                    def testExitCode = (codeLine =~ /APITEST_FINAL_CODE:(\d+)/)[0][1] as Integer
                    // 按照你的规则：退出码为1代表测试通过，存入全局环境变量
                    env.API_TEST_PASS = (testExitCode == 1).toString()
                    echo "接口测试执行完成，退出码：${testExitCode}，测试通过状态：${env.API_TEST_PASS}"
                }
            }
        }
        stage('部署结果处理') {
            steps {
                script {
                    if (env.API_TEST_PASS == "true") {
                        // 测试通过，发送Slack成功通知
                        slackSend(
                            channel: "#deploy-notice",
                            message: "✅ API服务部署成功，版本号：${BUILD_NUMBER}，接口全量测试通过"
                        )
                    } else {
                        // 测试不通过，回滚到旧版本，发送失败通知
                        echo "接口测试校验失败，开始回滚服务到旧版本：${OLD_SERVICE_IMAGE}"
                        sh "docker service update --image ${OLD_SERVICE_IMAGE} your-api-svc"
                        slackSend(
                            channel: "#deploy-notice",
                            color: "danger",
                            message: "❌ API服务部署失败，版本号：${BUILD_NUMBER}，接口测试异常，已自动回滚到旧版本"
                        )
                    }
                }
            }
        }
    }
}

3. 关键避坑点 #

• 不要直接依赖SSH命令的退出码判断结果：因为你定义的成功状态是退出码1，属于Jenkins默认判定的「命令失败」范畴，直接用会导致流水线提前中断，走不到后续判断逻辑
• 远端脚本中必须第一时间保存$?值：如果在docker run和输出状态码之间插入任何其他命令（比如sleep、echo日志），$?会被覆盖为上一条命令的退出码，导致状态判断完全错误
• 不要直接取输出最后一行做解析：apitester运行时可能输出多行日志，甚至因为docker日志缓冲问题出现顺序错乱，用固定前缀匹配对应状态行的方式容错率最高
• 旧版本镜像一定要在部署前提前存储：如果新镜像部署后服务启动异常，部署后再查询旧镜像信息可能失败，提前存到环境变量是最稳妥的方案

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