So testen Sie Ansible-Rollen mit Molecule unter Ubuntu 16.04

_Der Autor hat das Programm Mozilla Foundation ausgewählt, um eine Spende im Rahmen des Programms Write for DOnations zu erhalten.

Einführung

Unit-Tests unter Ansible sind der Schlüssel, um sicherzustellen, dass die Rollen wie vorgesehen funktionieren. Molecule erleichtert diesen Vorgang, indem Sie Szenarien angeben können, in denen Rollen für verschiedene Umgebungen getestet werden. Mit Ansible under the hood verlagert Molecule Rollen an einen Provisioner, der die Rolle in einer konfigurierten Umgebung bereitstellt, und ruft einen Prüfer (z. B. Testinfra) auf, um die Konfigurationsabweichung zu überprüfen. Dadurch wird sichergestellt, dass Ihre Rolle alle erwarteten Änderungen an der Umgebung in diesem bestimmten Szenario vorgenommen hat.

In diesem Handbuch erstellen Sie eine Ansible-Rolle, die Apache auf einem Host bereitstellt und Firewalld unter CentOS 7 konfiguriert. Um zu testen, ob diese Rolle wie beabsichtigt funktioniert, erstellen Sie einen Test in Molecule mit Docker als Treiber und Testinfra, einer Python-Bibliothek zum Testen des Serverstatus. Molecule stellt Docker-Container bereit, um die Rolle zu testen, und Testinfra überprüft, ob der Server wie vorgesehen konfiguriert wurde. Wenn Sie fertig sind, können Sie mehrere Testfälle für Builds in verschiedenen Umgebungen erstellen und diese Tests mit Molecule ausführen.

Voraussetzungen

Bevor Sie mit diesem Handbuch beginnen, benötigen Sie Folgendes:

Ein Ubuntu 16.04 Server. Befolgen Sie die Schritte im Initial Server Setup mit Ubuntu 16.04 -Handbuch, um einen Benutzer ohne Rootberechtigung zu erstellen. und stellen Sie sicher, dass Sie ohne Kennwort eine Verbindung zum Server herstellen können.
Docker auf Ihrem Server installiert. Führen Sie die Schritte 1 und 2 unter https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-16-04 durch. Installieren und Verwenden von Docker unter Ubuntu 16.04] , und stellen Sie sicher, dass Sie Ihren Nicht-Root-Benutzer zur Gruppe "+ docker +" hinzufügen.
Vertrautheit mit Ansible-Spielbüchern. Eine Übersicht finden Sie unter Configuration Management 101: Writing Ansible Playbooks.

Schritt 1 - Vorbereiten der Umgebung

Um unsere Rolle und Tests zu erstellen, erstellen wir zunächst eine virtuelle Umgebung und installieren Molecule. Durch die Installation von Molecule wird auch Ansible installiert, sodass mithilfe von Playbooks Rollen erstellt und Tests ausgeführt werden können.

Beginnen Sie, indem Sie sich als Benutzer ohne Rootberechtigung anmelden und sicherstellen, dass Ihre Repositorys auf dem neuesten Stand sind:

sudo apt-get update

Dadurch wird sichergestellt, dass Ihr Paket-Repository die neueste Version des Pakets "+ python-pip " enthält, mit der " pip " und Python 2.7 installiert werden. Wir werden ` pip ` verwenden, um eine virtuelle Umgebung zu erstellen und zusätzliche Pakete zu installieren. Um ` pip +` zu installieren, führen Sie Folgendes aus:

sudo apt-get install -y python-pip

Verwenden Sie + pip +, um das Python-Modul + virtualenv + zu installieren:

python -m pip install virtualenv

Als nächstes erstellen und aktivieren wir die virtuelle Umgebung:

python -m virtualenv

Aktivieren Sie es, um sicherzustellen, dass Ihre Aktionen auf diese Umgebung beschränkt sind:

source my_env/bin/activate

Installiere + molecule und` + docker` mit + pip:

python -m pip install molecule docker

Hier ist, was jedes dieser Pakete tun wird:

+ Molekül +: Dies ist das Hauptpaket für Moleküle, mit dem Sie Rollen testen. Durch die Installation von + molecule + wird Ansible automatisch zusammen mit anderen Abhängigkeiten installiert und die Verwendung von Ansible-Playbooks zum Ausführen von Rollen und Tests ermöglicht.
+ docker +: Diese Python-Bibliothek wird von Molecule zur Anbindung an Docker verwendet. Sie benötigen dies, da Sie Docker als Treiber verwenden.

Als nächstes erstellen wir eine Rolle in Molecule.

Schritt 2 - Eine Rolle im Molekül erstellen

Wenn Ihre Umgebung eingerichtet ist, können Sie mit Molecule eine grundlegende Rolle zum Testen einer Apache-Installation erstellen. Diese Rolle erstellt die Verzeichnisstruktur und einige erste Tests und gibt Docker als Treiber an, damit Molecule Docker zum Ausführen seiner Tests verwendet.

Erstellen Sie eine neue Rolle mit dem Namen "+ ansible-apache":

molecule init role -r ansible-apache -d docker

Das Flag "+ -r " gibt den Namen der Rolle an, während " -d +" den Treiber angibt, der die Hosts bereitstellt, die Molecule beim Testen verwenden soll.

Wechseln Sie in das Verzeichnis der neu angelegten Rolle:

cd ansible-apache

Testen Sie die Standardrolle, um zu überprüfen, ob Molecule ordnungsgemäß eingerichtet wurde:

molecule test

Es wird eine Ausgabe angezeigt, in der alle Standardtestaktionen aufgelistet sind:

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

Vor dem Start des Tests überprüft Molecule die Konfigurationsdatei "+ molecule.yml +", um sicherzustellen, dass alles in Ordnung ist. Es wird auch diese Testmatrix gedruckt, die die Reihenfolge der Testaktionen angibt.

Wir werden jede Testaktion im Detail besprechen, sobald Sie Ihre Rolle erstellt und Ihre Tests angepasst haben. Achten Sie vorerst auf das "+ PLAY_RECAP " für jeden Test und stellen Sie sicher, dass keine der Standardaktionen den Status " failed " zurückgibt. Zum Beispiel sollte " PLAY_RECAP " für die Standardaktion "" create "+" folgendermaßen aussehen:

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

Fahren wir mit dem Ändern der Rolle zum Konfigurieren von Apache und Firewalld fort.

Schritt 3 - Konfigurieren von Apache und Firewalld

Zum Konfigurieren von Apache und Firewalld erstellen Sie eine Aufgabendatei für die Rolle, in der die zu installierenden Pakete und die zu aktivierenden Dienste angegeben werden. Diese Details werden aus einer Variablendatei und einer Vorlage extrahiert, die Sie zum Ersetzen der Apache-Standardindexseite verwenden.

Erstellen Sie eine Aufgabendatei für die Rolle mit + nano + oder Ihrem bevorzugten Texteditor:

nano tasks/main.yml

Sie werden sehen, dass die Datei bereits vorhanden ist. Löschen Sie die Inhalte und fügen Sie den folgenden Code ein, um die erforderlichen Pakete zu installieren und die richtigen Dienste, HTML-Standardeinstellungen und Firewall-Einstellungen zu aktivieren:

~ / 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

Dieses Spielbuch enthält 4 Aufgaben:

" Sicherstellen, dass erforderliche Pakete vorhanden sind ": Diese Task installiert die in der Variablendatei unter + pkg_list + aufgelisteten Pakete. Die Variablendatei befindet sich unter "+ ~ / ansible-apache / vars / main.yml +" und wird am Ende dieses Schritts erstellt.
" Sicherstellen, dass die neueste index.html vorhanden ist ": Diese Aufgabe kopiert eine Vorlagenseite + index.html.j2 + und fügt sie in die Standardindexdatei `+ / var / www / html / index.html + ein `, generiert von Apache. In diesem Schritt erstellen Sie auch die Vorlage.
" Sicherstellen, dass der httpd-Dienst gestartet und aktiviert ist ": Diese Task startet und aktiviert die in + svc_list + in der Variablendatei aufgelisteten Dienste.
" Whitelist http in firewalld ": Diese Task listet den Dienst + http + in + firewalld + auf. Firewalld ist eine vollständige Firewall-Lösung, die standardmäßig auf CentOS-Servern vorhanden ist. Damit der "+ http " - Dienst funktioniert, müssen Sie die erforderlichen Ports verfügbar machen. Wenn Sie " firewalld +" anweisen, einen Dienst auf die Whitelist zu setzen, wird sichergestellt, dass alle für den Dienst erforderlichen Ports auf der Whitelist aufgeführt werden.

Speichern und schließen Sie die Datei, wenn Sie fertig sind.

Als nächstes erstellen wir ein "+ templates " -Verzeichnis für die " index.html.j2 +" -Vorlagenseite:

mkdir templates

Erstellen Sie die Seite selbst:

nano templates/index.html.j2

Fügen Sie den folgenden Code ein:

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

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

Speichern und schließen Sie die Datei.

Der letzte Schritt zum Abschließen der Rolle besteht darin, die Variablendatei zu schreiben, in der die Namen der Pakete und Dienste für Ihr Hauptrollenspielbuch angegeben sind:

nano vars/main.yml

Fügen Sie den Standardinhalt mit dem folgenden Code ein, der "+ pkg_list " und " svc_list +" angibt:

~ / ansible-apache / vars / main.yml

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

Diese Listen enthalten folgende Informationen:

+ pkg_list +: Enthält die Namen der Pakete, die von der Rolle installiert werden: + httpd + und + firewalld +.
+ svc_list +: Enthält die Namen der Dienste, die von der Rolle gestartet und aktiviert werden: + httpd + und + firewalld +.

Nachdem Sie die Rolle erstellt haben, konfigurieren Sie Molecule, um zu testen, ob sie wie beabsichtigt funktioniert.

Schritt 4 - Ändern der Rolle zum Ausführen von Tests

In unserem Fall beinhaltet das Konfigurieren von Molecule das Ändern der Molecule-Konfigurationsdatei "+ molecule.yml ", um Plattformspezifikationen hinzuzufügen. Da Sie eine Rolle testen, mit der der Dienst " httpd " systemd konfiguriert und gestartet wird, müssen Sie ein Image mit konfiguriertem systemd und aktiviertem privilegiertem Modus verwenden. Für dieses Tutorial verwenden Sie das Image " milcom / centos7-systemd +" available on Docker Hub. Im privilegierten Modus können Container mit fast allen Funktionen ihres Hostcomputers ausgeführt werden.

Bearbeiten wir "+ molecule.yml +", um diese Änderungen wiederzugeben:

nano molecule/default/molecule.yml

Fügen Sie die hervorgehobenen Plattforminformationen hinzu:

~ / ansible-apache / molecule / default / 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

Speichern und schließen Sie die Datei, wenn Sie fertig sind.

Nachdem Sie die Testumgebung erfolgreich konfiguriert haben, können Sie nun die Testfälle schreiben, die Molecule nach Ausführung der Rolle für Ihren Container ausführt.

Schritt 5 - Testfälle schreiben

Im Test für diese Rolle überprüfen Sie die folgenden Bedingungen:

Dass die Pakete "+ httpd " und " firewalld +" installiert sind.
Dass die Dienste "+ httpd " und " firewalld +" ausgeführt und aktiviert werden.
Dass der "+ http +" - Dienst in Ihren Firewall-Einstellungen aktiviert ist.
Das + index.html + enthält die gleichen Daten, die in Ihrer Vorlagendatei angegeben sind.

Wenn alle diese Tests erfolgreich sind, funktioniert die Rolle wie beabsichtigt.

Um die Testfälle für diese Bedingungen zu schreiben, bearbeiten wir die Standardtests in "+ ~ / ansible-apache / molecule / default / tests / test_default.py +". Mit Testinfra schreiben Sie die Testfälle als Python-Funktionen, die Molekülklassen verwenden.

Öffne + test_default.py +:

nano molecule/default/tests/test_default.py

Löschen Sie den Inhalt der Datei, damit Sie die Tests von Grund auf neu schreiben können.

Importieren Sie zunächst die erforderlichen Python-Module: