为何lookup('vars', item)失败时自定义错误消息未显示？

问题根源 #

原剧本里用lookup('vars', item)检查变量是否存在时，只要变量未定义，lookup插件就会直接抛出AnsibleUndefinedVariable异常，导致任务提前终止，根本走不到fail模块的自定义错误消息逻辑。

修复方案 #

以下两种方法都能避免lookup触发异常，让自定义错误消息正常输出：

方案一：使用vars.get()方法 #

vars.get()在变量不存在时会返回指定的默认值（这里用undefined），不会抛出异常，保证when条件能正常判断：

vars:
  required_vars:
    - 'varname1'
    - 'varname2'

tasks:
  - name: Check for required variables
    fail:
      msg: "variable '{{ item }}' is not defined"
    when: vars.get(item, undefined) is undefined
    loop: "{{ required_vars }}"

方案二：检查变量名是否在vars字典中 #

直接判断变量名是否存在于vars的键集合里，逻辑更直观：

vars:
  required_vars:
    - 'varname1'
    - 'varname2'

tasks:
  - name: Check for required variables
    fail:
      msg: "variable '{{ item }}' is not defined"
    when: item not in vars
    loop: "{{ required_vars }}"

测试验证 #

当test-vars.yml只定义varname1时，执行命令：

ansible-playbook -K --extra-vars '@test-vars.yml' test.yml

剧本会输出自定义错误消息：variable 'varname2' is not defined，符合预期。

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