测试插件

测试插件评估模板表达式并返回 True 或 False。 使用测试插件,您可以创建 条件 来实现您的任务、块、剧本、playbook 和角色的逻辑。 Ansible 使用作为 Jinja 一部分提供的 标准测试,并添加了一些专门的测试插件。 您可以创建自定义 Ansible 测试插件

启用测试插件

您可以通过将自定义测试插件放入与您的剧本相邻的 test_plugins 目录、角色内部,或将其放入 ansible.cfg 中配置的测试插件目录源之一中来添加自定义测试插件。

使用测试插件

您可以在 Ansible 中可以使用模板的任何地方使用测试:在剧本中、变量文件中或 template 模块的 Jinja2 模板中。 有关使用测试插件的更多信息,请参阅测试

测试总是返回 TrueFalse,它们始终是布尔值,如果您需要不同的返回类型,则应该查看过滤器。

您可以通过在模板中使用 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 左侧的内容。测试还可以像大多数编程函数一样采用其他参数。这些参数可以是 位置 的(按顺序传递)或 命名 的(作为键=值对传递)。当传递两种类型时,位置参数应该放在前面。

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 <插件名称> 查看特定于插件的文档和示例。

另请参阅

Ansible Playbook

Playbook 简介

测试

使用测试

条件

使用条件语句

Filter 插件

Filter 插件

测试

使用测试

Lookup 插件

Lookup 插件

交流

有疑问?需要帮助?想分享您的想法?请访问 Ansible 交流指南