测试插件
测试插件评估模板表达式并返回 True 或 False。使用测试插件,您可以创建条件语句来实现任务、块、剧本、剧本集和角色的逻辑。Ansible 使用Jinja 附带的标准测试,并添加一些专门的测试插件。你可以创建自定义 Ansible 测试插件.
启用测试插件
您可以通过将自定义测试插件放入test_plugins
目录(与您的剧本相邻,位于角色内部),或将其放入ansible.cfg中配置的测试插件目录源之一来添加自定义测试插件。
使用测试插件
您可以在 Ansible 中使用模板的任何地方使用测试:在剧本中、在变量文件中或在template模块的 Jinja2 模板中。有关使用测试插件的更多信息,请参阅测试.
测试始终返回True
或False
,它们始终是布尔值,如果您需要其他返回类型,您应该查看过滤器。
您可以通过在模板中使用is
语句来识别测试插件,它们也可以用作select
过滤器系列的一部分。
vars:
is_ready: '{{ task_result is success }}'
tasks:
- name: conditionals are always in 'template' context
action: dostuff
when: task_result is failed
测试始终具有_input
,这通常是is
左侧的内容。测试还可以接受额外的参数,就像您对大多数编程函数所做的那样。这些参数可以是positional
(按顺序传递)或named
(作为键值对传递)。当传递两种类型时,位置参数应放在前面。
tasks:
- name: pass a positional parameter to match test
action: dostuff
when: myurl is match("https://example.com/users/.*/resources")
- name: pass named parameter to truthy test
action: dostuff
when: myvariable is truthy(convert_bool=True)
- name: pass both types to 'version' test
action: dostuff
when: sample_semver_var is version('2.0.0-rc.1+build.123', 'lt', version_type='semver')
使用测试插件和列表
如上所述,使用测试的一种方法是使用select
过滤器系列(select
、reject
、selectattr
、rejectattr
)。
# give me only defined variables from a list of variables, using 'defined' test
good_vars: "{{ all_vars|select('defined') }}"
# this uses the 'equalto' test to filter out non 'fixed' type of addresses from a list
only_fixed_addresses: "{{ all_addresses|selectattr('type', 'equalto', 'fixed') }}"
# this does the opposite of the previous one
only_fixed_addresses: "{{ all_addresses|rejectattr('type', 'equalto', 'fixed') }}"
插件列表
您可以使用ansible-doc -t test -l
来查看可用插件列表。使用ansible-doc -t test <plugin name>
来查看特定插件的文档和示例。