envsubst命令在Bash脚本中出现异常行为的问题排查

问题场景 #

为统一检查命令返回值编写了check_command_return_code函数，该函数在多数命令中正常工作，但配合envsubst做文件环境变量替换时出现异常：生成的目标文件中混入了函数的成功提示信息。

相关代码 #

1. 返回值检查函数：

check_command_return_code(){
  "$@"
  if [ "$?" -ne 0 ]; then
    echo "[ERROR] Error with command $@"
    exit 1
  fi
  echo "[SUCCESS] Command $@ has successfully run"
}

2. 文件环境变量替换函数：

substitute_env_variables_into_file(){
  echo "Create new file named $2 from $1 by substituting environment variables within it"
  check_command_return_code envsubst < $1 > $2
}

3. 调用方式：

substitute_env_variables_into_file "./ingress-values.yaml" "./ingress-values-subst.yaml"

期望与实际结果差异 #

• 期望：目标文件仅包含替换后的YAML内容
• 实际：目标文件末尾混入了[SUCCESS] Command envsubst has successfully run提示

问题原因 #

1. 重定向不属于命令参数：< $1 > $2是Shell层面的输入输出重定向操作，不会作为参数传递给check_command_return_code函数，函数内部的$@仅包含envsubst，这是正常行为，并非参数未传递。
2. 标准输出被统一重定向：check_command_return_code envsubst < $1 > $2中，重定向作用于整个函数调用命令，函数内echo输出的成功信息会和envsubst的输出一起被写入目标文件。

解决方案 #

将函数中的提示信息输出到标准错误(stderr)，避免被重定向到目标文件。修改后的函数如下：

check_command_return_code(){
  "$@"
  # 保存命令返回值，避免后续命令覆盖$?
  local exit_code=$?
  if [ "$exit_code" -ne 0 ]; then
    # 错误信息输出到stderr
    echo "[ERROR] Error with command $@" >&2
    exit 1
  fi
  # 成功信息输出到stderr
  echo "[SUCCESS] Command $@ has successfully run" >&2
}

修改后，envsubst的输出会正常写入目标文件，而函数的提示信息会打印到终端（或脚本的错误输出流），不会混入目标文件。

内容的提问来源于stack exchange，提问作者J-Are