Как протестировать Ansible роли с молекулой в Ubuntu 16.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 16.04. Следуйте инструкциям в руководстве Initial Server Setup с Ubuntu 16.04, чтобы создать пользователя sudo без полномочий root, и убедитесь, что вы можете подключиться к серверу без пароля.
Docker установлен на вашем сервере. Выполните шаги 1 и 2 в Как установить и использовать Docker в Ubuntu 16.04 и обязательно добавьте своего пользователя без полномочий root в группу + docker +.
Знакомство с Ansible playbooks. Для просмотра см. Https://www.digitalocean.com/community/tutorials/configuration-management-101-writing-ansible-playbooks[Configuration Management 101: Написание Ansible Playbooks].

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

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

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

sudo apt-get update

Это обеспечит включение в ваш репозиторий последней версии пакета + python-pip +, который установит + pip + и Python 2.7. Мы будем использовать + pip + для создания виртуальной среды и установки дополнительных пакетов. Чтобы установить + pip +, запустите:

sudo apt-get install -y python-pip

Используйте + pip + для установки модуля Python `+ virtualenv +:

python -m pip install virtualenv

Далее давайте создадим и активируем виртуальную среду:

python -m virtualenv

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

source my_env/bin/activate

Установите + молекулу и` + docker` с помощью + pip:

python -m pip install molecule docker

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

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

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

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

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

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

molecule init role -r ansible-apache -d docker

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

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

cd ansible-apache

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

molecule test

Вы увидите вывод, в котором перечислены все тестовые действия по умолчанию:

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
...

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

Мы подробно обсудим каждое действие теста после того, как вы создали свою роль и настроили свои тесты. А пока обратите внимание на + 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 по умолчанию.

Создайте файл задач для роли, используя + nano + или ваш любимый текстовый редактор:

nano tasks/main.yml

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

~ / Анзибль-Apache / задачи / 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 задания:

" Убедитесь, что необходимые пакеты присутствуют ": Эта задача установит пакеты, перечисленные в файле переменных в + pkg_list +. Файл переменных будет расположен в + ~ / ansible-apache / vars / main.yml +, и вы создадите его в конце этого шага.
" Убедитесь, что последний index.html присутствует ": эта задача скопирует страницу шаблона + index.html.j2 + и вставит ее в файл индекса по умолчанию, `+ / var / www / html / index.html + `, сгенерированный Apache. Вы также создадите шаблон на этом шаге.
" Убедитесь, что служба httpd запущена и включена ": эта задача запустится и включит службы, перечисленные в + svc_list + в файле переменных.
" Белый список http в firewalld ": эта задача внесет белый список в службу + http + в + firewalld +. Firewalld - это законченное решение брандмауэра, присутствующее по умолчанию на серверах CentOS. Чтобы служба + http + работала, вам нужно предоставить необходимые порты. Указание + firewalld + для внесения в белый список службы гарантирует, что она занесет в белый список все порты, которые требуются службе.

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

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

mkdir templates

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

nano templates/index.html.j2

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

~ / Анзибль-апаш / шаблоны / index.html.j2

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

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

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

nano vars/main.yml

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

~ / Анзибль-апаш / вары / main.yml

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

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

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

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

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

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

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

nano molecule/default/molecule.yml

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

~ / Анзибль-апаш / молекула / по умолчанию / molecule.yml

---
dependency:
 name: galaxy
driver:
 name: docker
lint:
 name: yamllint
platforms:



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 / молекуле / default / tests / test_default.py +. Используя Testinfra, вы будете писать контрольные примеры в виде функций Python, которые используют классы Molecule.

Откройте + test_default.py +:

nano molecule/default/tests/test_default.py

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

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