Как протестировать роли Ansible с помощью Molecule в Ubuntu 18.04

Contents

1 Шаг 1 — Подготовка среды
2 Шаг 2 — Создание роли в молекуле
3 Шаг 3 — Настройка Apache и Firewalld
4 Шаг 4 — Изменение роли для запуска тестов
5 Шаг 5 — Написание тестовых случаев
6 Шаг 6 — Проверка роли с помощью Molecule
7 Вывод

Шаг 1 — Подготовка среды

Если вы выполнили предварительные требования, у вас должны быть venvустановлены и правильно настроены Python 3, , и Docker. Давайте начнем с создания виртуальной среды для тестирования Ansible с помощью Molecule.

Начните с входа в систему как пользователь без полномочий root и создайте новую виртуальную среду:

python3 -m venv my_env

Активируйте его, чтобы убедиться, что ваши действия ограничены этой средой:

source my_env/bin/activate

Затем в вашей активированной среде установите wheelпакет, который предоставляет bdist_wheel setuptoolsрасширение, pipиспользуемое для установки Ansible:

python3 -m pip install wheel

Теперь вы можете установить moleculeи dockerс pip. Ansible будет автоматически установлен как зависимость для Molecule:

python3 -m pip install molecule docker

Вот что будет делать каждый из этих пакетов:

molecule: это основной пакет Molecule, который вы будете использовать для тестирования ролей. Установка moleculeавтоматически устанавливает Ansible вместе с другими зависимостями и позволяет использовать Ansible playbooks для выполнения ролей и тестов.
docker: эта библиотека Python используется Molecule для взаимодействия с Docker. Это понадобится вам, поскольку вы используете Docker в качестве драйвера.

Далее создадим роль в Molecule.

Шаг 2 — Создание роли в молекуле

После настройки среды вы можете использовать Molecule для создания базовой роли, которую вы будете использовать для тестирования установки Apache. Эта роль создаст структуру каталогов и некоторые начальные тесты, а также укажет Docker в качестве драйвера, чтобы Molecule использовала Docker для запуска своих тестов.

Создайте новую роль с именем ansible-apache:

molecule init role -r ansible-apache -d docker

Флаг -rуказывает имя роли, а -dуказывает драйвер, который предоставляет хосты для использования Molecule при тестировании.

Перейдите в каталог только что созданной роли:

cd ansible-apache

Протестируйте роль по умолчанию, чтобы проверить правильность настройки Molecule:

molecule test

Вы увидите выходные данные со списком всех тестовых действий по умолчанию. Перед началом теста Molecule проверяет файл конфигурации, molecule.ymlчтобы убедиться, что все в порядке. Он также печатает эту тестовую матрицу, которая определяет порядок тестовых действий:

Output

--> Validating schema /home/sammy/ansible-apache/molecule/default/molecule.yml.
Validation completed successfully.
--> Test matrix

└── default
    ├── lint
    ├── destroy
    ├── dependency
    ├── syntax
    ├── create
    ├── prepare
    ├── converge
    ├── idempotence
    ├── side_effect
    ├── verify
    └── destroy
...

Мы подробно обсудим каждое тестовое действие после того, как вы создадите свою роль и настроите свои тесты. На данный момент обратите внимание на PLAY_RECAPдля каждого теста и убедитесь, что ни одно из действий по умолчанию не возвращает failedстатус. Например, действие PLAY_RECAPпо умолчанию 'create'должно выглядеть так:

Output

...
PLAY RECAP *********************************************************************
localhost                  : ok=5    changed=4    unreachable=0    failed=0

Перейдем к изменению роли для настройки Apache и firewalld.

Шаг 3 — Настройка Apache и Firewalld

Чтобы настроить Apache и firewalld, вы создадите файл задач для роли, указав пакеты для установки и службы для включения. Эти данные будут извлечены из файла переменных и шаблона, который вы будете использовать для замены страницы индекса Apache по умолчанию.

Находясь в ansible-apacheкаталоге, создайте файл задач для роли, используя nanoили ваш любимый текстовый редактор:

nano tasks/main.yml

Вы увидите, что файл уже существует. Удалите то, что там есть, и замените его следующим кодом, чтобы установить необходимые пакеты и включить правильные службы, настройки HTML по умолчанию и настройки брандмауэра:

~/ansible-apache/tasks/main.yml

---
- name: "Ensure required packages are present"
  yum:
    name: "{{ pkg_list }}"
    state: present

- name: "Ensure latest index.html is present"
  template:
    src: index.html.j2
    dest: /var/www/html/index.html

- name: "Ensure httpd service is started and enabled"
  service:
    name: "{{ item }}"
    state: started
    enabled: true
  with_items: "{{ svc_list }}"

- name: "Whitelist http in firewalld"
  firewalld:
    service: http
    state: enabled
    permanent: true
    immediate: true

В этом плейбуке 4 задания:

"Ensure required packages are present": эта задача установит пакеты, перечисленные в файле переменных в папке pkg_list. Файл переменных будет расположен по адресу ~/ansible-apache/vars/main.yml, и вы создадите его в конце этого шага.
"Ensure latest index.html is present": эта задача скопирует страницу шаблона index.html.j2и вставит ее поверх индексного файла по умолчанию, /var/www/html/index.htmlсозданного Apache. На этом шаге вы также создадите новый шаблон.
"Ensure httpd service is started and enabled": эта задача запустит и активирует службы, перечисленные svc_listв файле переменных.
"Whitelist http in firewalld": эта задача внесет httpслужбу в белый список в формате firewalld. Firewalld — это комплексное решение брандмауэра, которое по умолчанию присутствует на серверах CentOS. Чтобы httpслужба работала, вам нужно открыть необходимые порты. Указание firewalldвнести службу в белый список гарантирует, что она внесет в белый список все порты, которые требуются службе.

Сохраните и закройте файл, когда закончите.

Далее создадим templatesкаталог для index.html.j2страницы шаблона:

mkdir templates

Создайте саму страницу:

nano templates/index.html.j2

Вставьте следующий шаблонный код:

~/ansible-apache/templates/index.html.j2

<div style="text-align: center">
    <h2>Managed by Ansible</h2>
</div>

Сохраните и закройте файл.

Последним шагом в завершении роли является написание файла переменных, который предоставляет имена пакетов и сервисов для нашей основной ролевой игры:

nano vars/main.yml

Вставьте содержимое по умолчанию со следующим кодом, который указывает pkg_listи svc_list:

~/ansible-apache/vars/main.yml

---
pkg_list:
  - httpd
  - firewalld
svc_list:
  - httpd
  - firewalld

Эти списки содержат следующую информацию:

pkg_list: содержит имена пакетов, которые будет устанавливать роль: httpdи firewalld.
svc_list: содержит имена служб, которые будет запускать и включать роль: httpdи firewalld.

Примечание. Убедитесь, что в вашем файле переменных нет пустых строк, иначе ваш тест не удастся выполнить во время линтинга.

Теперь, когда вы закончили создание своей роли, давайте настроим Molecule, чтобы проверить, работает ли она должным образом.

Шаг 4 — Изменение роли для запуска тестов

В нашем случае настройка Molecule включает в себя изменение файла конфигурации Molecule molecule.ymlдля добавления спецификаций платформы. Поскольку вы тестируете роль, которая настраивает и запускает httpdслужбу systemd, вам потребуется использовать образ с настроенной системой systemd и включенным привилегированным режимом. Для этого руководства вы будете использовать milcom/centos7-systemdобраз , доступный на Docker Hub . Привилегированный режим позволяет запускать контейнеры почти со всеми возможностями хост-компьютера.

Давайте отредактируем, molecule.ymlчтобы отразить эти изменения:

nano molecule/default/molecule.yml

Добавьте выделенную информацию о платформе:

~/ansible-apache/молекула/по умолчанию/молекула.yml

---
dependency:
  name: galaxy
driver:
  name: docker
lint:
  name: yamllint
platforms:
  - name: centos7
    image: milcom/centos7-systemd
    privileged: true
provisioner:
  name: ansible
  lint:
    name: ansible-lint
scenario:
  name: default
verifier:
  name: testinfra
  lint:
    name: flake8

Сохраните и закройте файл, когда закончите.

Теперь, когда вы успешно настроили тестовую среду, давайте перейдем к написанию тестовых случаев, которые Molecule будет запускать для вашего контейнера после выполнения роли.

Шаг 5 — Написание тестовых случаев

В тесте на эту роль вы проверите следующие условия:

Что пакеты и установлены httpd.firewalld
Что службы httpdи firewalldзапущены и включены.
Что httpслужба включена в настройках вашего брандмауэра.
Он содержит те же данные, что index.htmlи в вашем файле шаблона.

Если все эти тесты пройдены, роль работает так, как задумано.

Чтобы написать тестовые примеры для этих условий, давайте отредактируем тесты по умолчанию в ~/ansible-apache/molecule/default/tests/test_default.py. Используя Testinfra, мы напишем тестовые примеры в виде функций Python, использующих классы Molecule.

Открыто test_default.py:

nano molecule/default/tests/test_default.py

Удалите содержимое файла, чтобы вы могли писать тесты с нуля.

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

Начните с импорта необходимых модулей Python: