Spec-Zone.ru › Ansible 2.9

Тесты

  • Синтаксис тестов
  • Тестирование строк
  • Сравнение версий
  • Тесты теории множеств
  • Проверка наличия значения в списке
  • Тестирование путей
  • Результаты задач

Тесты в Jinja — способ оценки выражений шаблона и возвращения True или False. Jinja поставляется со многими такими тестами. См. встроенные тесты в официальной документации по шаблонам Jinja.

Основное различие между тестами и фильтрами заключается в том, что тесты Jinja используются для сравнений, а фильтры — для обработки данных, и они имеют различные применения в Jinja. Тесты также могут использоваться в фильтрах для обработки списков, таких как map() и select() для выбора элементов в списке.

Как и все шаблоны, тесты всегда выполняются на контроллере Ansible, а не на целевом узле задачи, так как они тестируют локальные данные.

Помимо этих тестов Jinja2, Ansible предоставляет еще несколько, и пользователи могут легко создавать свои собственные.

Синтаксис тестов

Синтаксис тестов отличается от синтаксиса фильтров (variable | filter). Раньше Ansible регистрировал тесты как тесты Jinja и фильтры Jinja, что позволяло ссылаться на них с помощью синтаксиса фильтров.

Начиная с Ansible 2.5, использование теста Jinja как фильтра будет генерировать предупреждение.

Синтаксис использования теста Jinja следующий:

variable is test_name

Например:

result is failed

Тестирование строк

Для сопоставления строк с подстрокой или регулярным выражением используйте фильтры «match», «search» или «regex»:

vars:
  url: "http://example.com/users/foo/resources/bar"

tasks:
    - debug:
        msg: "matched pattern 1"
      when: url is match("http://example.com/users/.*/resources/.*")

    - debug:
        msg: "matched pattern 2"
      when: url is search("/users/.*/resources/.*")

    - debug:
        msg: "matched pattern 3"
      when: url is search("/users/")

    - debug:
        msg: "matched pattern 4"
      when: url is regex("example.com/\w+/foo")

«match» требует нулевых или более символов в начале строки, а «search» требует только сопоставления подстроки. По умолчанию «regex» работает как search, но regex также можно настроить для выполнения других тестов.

Сравнение версий

Введено в версии 1.6.

Примечание

В версии 2.5 version_compare было переименовано в version

Для сравнения номера версии, например, для проверки, является ли версия ansible_facts['distribution_version'] больше или равна ‘12.04’, можно использовать тест version.

Тест version также можно использовать для оценки ansible_facts['distribution_version'].

{{ ansible_facts['distribution_version'] is version('12.04', '>=') }}

Если ansible_facts['distribution_version'] больше или равно 12.04, этот тест возвращает True, в противном случае — False.

Тест version принимает следующие операторы:

<, lt, <=, le, >, gt, >=, ge, ==, =, eq, !=, <>, ne

Этот тест также принимает третий параметр, strict, который определяет, следует ли использовать строгое разбор версии, как определено в distutils.version.StrictVersion. По умолчанию используется False (с использованием distutils.version.LooseVersion), True включает строгое разбор версии:

{{ sample_version_var is version('1.0', operator='lt', strict=True) }}

Тесты теории множеств

Введено в версии 2.1.

Примечание

В версии 2.5 issubset и issuperset были переименованы в subset и superset

Чтобы проверить, содержит ли список другой список, или является ли один списком другим, можно использовать «подмножество» и «надмножество»:

vars:
    a: [1,2,3,4,5]
    b: [2,3]
tasks:
    - debug:
        msg: "A includes B"
      when: a is superset(b)

    - debug:
        msg: "B is included in A"
      when: b is subset(a)

Проверка наличия значения в списке

Введено в версии 2.8.

Ansible включает тест contains, который работает аналогично, но наоборот, по сравнению с предоставленным Jinja2 тестом in. Тест contains предназначен для работы с фильтрами select, reject, selectattr, и rejectattr.

vars:
  lacp_groups:
    - master: lacp0
      network: 10.65.100.0/24
      gateway: 10.65.100.1
      dns4:
        - 10.65.100.10
        - 10.65.100.11
      interfaces:
        - em1
        - em2

    - master: lacp1
      network: 10.65.120.0/24
      gateway: 10.65.120.1
      dns4:
        - 10.65.100.10
        - 10.65.100.11
      interfaces:
          - em3
          - em4

tasks:
  - debug:
      msg: "{{ (lacp_groups|selectattr('interfaces', 'contains', 'em1')|first).master }}"

Введено в версии 2.4.

Можно использовать any и all для проверки, являются ли все элементы в списке истинными или нет:

vars:
  mylist:
      - 1
      - "{{ 3 == 3 }}"
      - True
  myotherlist:
      - False
      - True
tasks:

  - debug:
      msg: "all are true!"
    when: mylist is all

  - debug:
      msg: "at least one is true"
    when: myotherlist is any

Тестирование путей

Примечание

В версии 2.5 следующие тесты были переименованы, чтобы удалить префикс is_

Следующие тесты могут предоставить информацию о пути на контроллере:

- debug:
    msg: "path is a directory"
  when: mypath is directory

- debug:
    msg: "path is a file"
  when: mypath is file

- debug:
    msg: "path is a symlink"
  when: mypath is link

- debug:
    msg: "path already exists"
  when: mypath is exists

- debug:
    msg: "path is {{ (mypath is abs)|ternary('absolute','relative')}}"

- debug:
    msg: "path is the same file as path2"
  when: mypath is same_file(path2)

- debug:
    msg: "path is a mount"
  when: mypath is mount

Результаты задач

Следующие задачи иллюстрируют тесты, предназначенные для проверки состояния задач:

tasks:

  - shell: /usr/bin/foo
    register: result
    ignore_errors: True

  - debug:
      msg: "it failed"
    when: result is failed

  # in most cases you'll want a handler, but if you want to do something right now, this is nice
  - debug:
      msg: "it changed"
    when: result is changed

  - debug:
      msg: "it succeeded in Ansible >= 2.1"
    when: result is succeeded

  - debug:
      msg: "it succeeded"
    when: result is success

  - debug:
      msg: "it was skipped"
    when: result is skipped

Примечание

С версии 2.1 также можно использовать success, failure, change и skip, чтобы грамматика соответствовала для тех, кто хочет строгости.

См. также

О Playbook
Введение в Playbook
Условные операторы
Условные операторы в Playbook
Использование переменных
Все о переменных
Циклы
Циклы в Playbook
Роли
Организация Playbook с помощью ролей
Рекомендации по наилучшим практикам
Рекомендации по наилучшим практикам в Playbook
Пользовательская рассылка
Есть вопрос? Задайте его на форуме!
irc.freenode.net
Чат IRC #ansible

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/user_guide/playbooks_tests.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API