如何避免Jenkins向Ansible的JSON参数中插入单引号？

问题描述 #

我在Jenkins流水线中运行Ansible脚本，通过ANSIBLE_ARG参数传递-v、-b或-e等Ansible参数，但传递带空格的JSON字符串给-e时，Ansible无法处理。

流水线代码如下：

pipeline {
  
  agent any
  parameters {
    string(name: 'ANSIBLE_ARG', defaultValue='', description='argument to pass to ansible')
  }
  stages {
    stage('reproduce ansible error') {
      steps {
        sh '''
echo "${ANSIBLE_ARG}"
ansible -i localhost, -c local ${ANSIBLE_ARG} all -m debug -a "var=key"
        '''
    }
  }
}

当我将ANSIBLE_ARG设为-e {"key":"some value with spaces"}时，Ansible报错无法识别参数"with spaces"，回显的命令显示Jenkins自动在JSON中间插入了单引号：

ansible -i localhost, -c local -e '{"key":"some' value with 'spaces"}' all -m debug -a "var=key"

请问如何避免Jenkins在JSON中间插入单引号？

解决方案 #

方法1：转义JSON中的双引号并包裹外层双引号 #

设置ANSIBLE_ARG参数时，用双引号包裹整个JSON字符串，并转义内部的双引号，确保shell将其识别为单个完整参数：

-e "{\"key\":\"some value with spaces\"}"

方法2：使用shell数组解析参数（更可靠） #

修改流水线的sh步骤，用shell数组处理参数传递，避免字符串拼接导致的拆分问题：

sh '''
args=()
if [ -n "${ANSIBLE_ARG}" ]; then
  read -ra args <<< "$ANSIBLE_ARG"
fi
ansible -i localhost, -c local "${args[@]}" all -m debug -a "var=key"
'''

read -ra会按照shell的规则正确拆分参数，"${args[@]}"展开时会保留每个参数的完整性，包括带空格的JSON。

方法3：通过临时文件传递JSON #

如果JSON内容复杂，可将JSON写入临时文件，用Ansible的-e @filename方式加载：

sh '''
# 剥离-e前缀并写入临时文件
echo '${ANSIBLE_ARG#-e }' > /tmp/extra_vars.json
ansible -i localhost, -c local -e @/tmp/extra_vars.json all -m debug -a "var=key"
# 清理临时文件
rm /tmp/extra_vars.json
'''

这种方式要求ANSIBLE_ARG仅包含-e加JSON的内容，若有其他参数需调整处理逻辑。

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