Как протестировать ансамблевые роли с помощью молекулы в Ubuntu 18.04

Автор выбралMozilla Foundation для получения пожертвования в рамках программыWrite for DOnations.

Вступление

Модульное тестирование вAnsible является ключом к проверке правильности работы ролей. Molecule упрощает этот процесс, позволяя указывать сценарии для тестирования ролей в различных средах. Используя Ansible под капотом, Molecule передает роли провайдеру, который развертывает роль в настроенной среде и вызывает верификатор (например,Testinfra) для проверки отклонения конфигурации. Это гарантирует, что ваша роль внесла все ожидаемые изменения в среду в этом конкретном сценарии.

В этом руководстве вы создадите роль Ansible, которая развертываетApache на хосте и настраиваетfirewalld на CentOS 7. Чтобы проверить правильность работы этой роли, вы создадите тест в Molecule, используяDocker в качестве драйвера и Testinfra, библиотеку Python для тестирования состояния серверов. Molecule предоставит контейнеры Docker для проверки роли, а Testinfra проверит, что сервер настроен так, как задумано. Когда вы закончите, вы сможете создавать несколько тестовых случаев для сборок в разных средах и запускать эти тесты, используя Molecule.

Предпосылки

Прежде чем начать это руководство, вам потребуется следующее:

Один сервер Ubuntu 18.04. Следуйте инструкциям в руководствеInitial Server Setup with Ubuntu 18.04, чтобы создать пользователя sudo без полномочий root, и убедитесь, что вы можете подключиться к серверу без пароля.
Docker установлен на вашем сервере. Выполните шаги 1 и 2 вHow To Install and Use Docker on Ubuntu 18.04, включая добавление пользователя без полномочий root в группуdocker.
Python 3 иvenv установлены и настроены на вашем сервере. СледуйтеHow To Install Python 3 and Set Up a Programming Environment on an Ubuntu 18.04 Server за руководством.
Знакомство с Ansible playbooks. Для обзора см.Configuration Management 101: Writing Ansible Playbooks.

[[step-1 -—- prepare-the-environment]] == Шаг 1. Подготовка окружающей среды

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

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

python3 -m venv my_env

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

source my_env/bin/activate

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

python3 -m pip install wheel

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

python3 -m pip install molecule docker

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

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

Далее, давайте создадим роль в Молекуле.

[[шаг-2 -—- создание-роль-в-молекуле]] == Шаг 2 - Создание роли в молекуле

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

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

molecule init role -r ansible-apache -d docker

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

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

cd ansible-apache

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

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.

[[step-3 -—- configuring-apache-and-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


    Managed by Ansible

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

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

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.

[.note] #Note: Убедитесь, что в вашем файле переменных нет пустых строк, иначе ваш тест завершится неудачно во время линтинга.
#

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

[[step-4 -—- modifying-the-role-for-running-tests]] == Шаг 4 - изменение роли для запуска тестов

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

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

nano molecule/default/molecule.yml

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

~/ansible-apache/molecule/default/molecule.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 будет запускать для вашего контейнера после выполнения роли.

[[step-5 -—- writing-test-case]] == Шаг 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

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

[.note] #Note: При написании тестов убедитесь, что они разделены двумя новыми строками, иначе они завершатся ошибкой.
#

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