Jenkins Pipeline运行peekaboo.py报Expected a step错误及Ansible传值问题

报错根因 #

当前代码抛出Expected a step错误的核心原因是：Jenkins声明式流水线不支持在steps块内直接通过env.xxx = sh "命令"的写法接收shell执行返回值，这种内联赋值逻辑不符合流水线DSL的语法规则，会被脚本解析器判定为非法的非步骤语句。

问题修复实现 #

1. 语法修正逻辑 #

• 调用shell命令时，必须通过returnStdout: true参数开启标准输出返回能力，用自定义变量承接返回结果，不能直接内联给env变量赋值。
• 涉及JSON解析、动态环境变量赋值的逻辑，必须包裹在script块内，绕开声明式流水线的严格语法校验。
• 环境变量是固定字符串类型，无法通过Groovy动态属性挂载的方式隐式写入值，必须显式把需要的参数解析完成后，逐个赋值给对应env属性。

2. 下游Ansible环节的参数传递 #

要正确读取peekaboo.py输出的JSON结构，整体流程分为三步：

1. 调用Python脚本时收集其标准输出，去掉输出首尾的无意义换行、空白字符
2. 用Jenkins内置的readJSON步骤把输出字符串解析为可访问的键值对对象
3. 把解析得到的fernet_key、db_url、pki_password逐个写入环境变量，供后续ansiblePlaybook步骤引用

修正后的完整可运行流水线代码：

pipeline {
    parameters {
        string(defaultValue: '', description: '', name: 'pki_client_cacert_password', trim: true)
        string(defaultValue: '', description: '', name: 'db_url', trim: true)
    }
    stages {
        stage('DeployToDev') {
            steps {
                script {
                    // 调用peekaboo.py并收集标准输出
                    String rawOutput = sh(
                        script: "/var/lib/jenkins/python_jobs/peekaboo_venv/bin/python3 /var/lib/jenkins/python_jobs/peekaboo.py --db_url='${params.db_url}' --pki_password='${params.pki_client_cacert_password}'",
                        returnStdout: true
                    ).trim()

                    // 解析Python输出的JSON结构
                    Map generatedParams = readJSON(text: rawOutput)

                    // 显式赋值参数到环境变量：用户手动传入的参数优先，未传则使用脚本生成的值
                    env.fernet_key = generatedParams.fernet_key
                    env.db_url = params.db_url ?: generatedParams.db_url
                    env.pki_client_cacert_password = params.pki_client_cacert_password ?: generatedParams.pki_password

                    // 输出校验日志
                    echo "参数解析完成：db_url=${env.db_url}, fernet_key已生成, pki密码已就绪"

                    // 调用Ansible Playbook
                    ansiblePlaybook(
                        credentialsId: "${env.git_credential_id}",
                        disableHostKeyChecking: true,
                        extras: "-e \"pki_client_cacert_password=${env.pki_client_cacert_password} db_url=${env.db_url} fernet_key=${env.fernet_key} use_isrg_freetds=false\""
                    )
                }
            }
        }
    }
}

常见踩坑点 #

• 传给shell命令的参数必须加单引号包裹，避免参数中带空格、特殊字符时被shell错误拆分解析。原代码未加引号的写法在参数含特殊字符时会触发执行异常。
• 如果peekaboo.py执行时会打印额外的日志行，导致输出中混有非JSON内容，可在shell命令中增加过滤逻辑，比如python3 xxx.py 2>/dev/null | grep -E '^\{.*\}$'，保证传给readJSON的是纯合法JSON字符串，避免解析失败。
• 原代码中ansiblePlaybook步骤末尾多了一个逗号，也是潜在的语法报错点，修正时已移除。

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