Einsatz von Testinfra

In einer modernen DevOps-Umgebung ist es entscheidend, nicht nur die Konfiguration von Servern zu automatisieren, sondern auch sicherzustellen, dass die Infrastruktur wie erwartet funktioniert. Ansible ist ein großartiges Tool für die Automatisierung von Infrastrukturaufgaben, aber wie kannst du sicherstellen, dass die resultierende Konfiguration korrekt ist? Hier kommt Testinfra ins Spiel.

In diesem Blog-Tutorial zeige ich dir, wie du Testinfra verwenden kannst, um Tests für deine Ansible-basierten Infrastrukturänderungen zu schreiben und sicherzustellen, dass deine Server die gewünschten Zustände erreichen.

Was ist Testinfra?

Testinfra ist ein Python-Framework, das die Infrastrukturtests automatisiert und vereinfacht. Es basiert auf Pytest und wurde entwickelt, um sicherzustellen, dass deine Server nach der Konfiguration durch Ansible die gewünschten Zustände aufweisen, z. B. dass bestimmte Pakete installiert sind, Dienste laufen oder Konfigurationsdateien korrekt eingerichtet wurden.

Warum Testinfra verwenden?

• Automatisierte Überprüfung: Testinfra ermöglicht dir, nach der Ausführung eines Ansible-Playbooks zu prüfen, ob alles wie gewünscht konfiguriert wurde.
• Einheitlichkeit: Testinfra stellt sicher, dass alle Server einheitlich konfiguriert sind.
• Fehlerbehebung: Mit Testinfra kannst du Fehler in der Infrastruktur schneller finden und beheben, bevor sie in die Produktion gelangen.

Voraussetzungen

Bevor wir beginnen, stelle sicher, dass du folgende Voraussetzungen erfüllst:

1. Ein funktionierendes Ansible-Setup.
2. Python und pytest sind auf deinem Control-Node installiert.
3. Testinfra ist auf deinem System installiert. Installiere es mit dem folgenden Befehl:

pip install pytest-testinfra

1. Ein Beispiel-Ansible-Playbook

Zunächst benötigen wir ein Ansible-Playbook, das wir testen können. Nehmen wir an, du möchtest sicherstellen, dass Apache installiert und ausgeführt wird. Hier ist ein einfaches Playbook apache-install.yml, das Apache auf einem Server installiert:

---
- name: Installiere Apache Webserver
  hosts: webserver
  become: true
  tasks:
    - name: Aktualisiere den apt-Cache
      apt:
        update_cache: yes

    - name: Installiere Apache
      apt:
        name: apache2
        state: present

    - name: Starte und aktiviere Apache
      systemd:
        name: apache2
        enabled: yes
        state: started

2. Testinfra-Tests schreiben

Nachdem du das Playbook ausgeführt hast, kannst du nun Tests schreiben, um sicherzustellen, dass Apache korrekt installiert und konfiguriert ist. Dazu erstellen wir eine Datei namens test_apache.py.

import testinfra

def test_apache_is_installed(host):
    apache = host.package("apache2")
    assert apache.is_installed

def test_apache_running_and_enabled(host):
    apache = host.service("apache2")
    assert apache.is_running
    assert apache.is_enabled

def test_apache_port_listening(host):
    socket = host.socket("tcp://0.0.0.0:80")
    assert socket.is_listening

Erklärung der Tests:

1. test_apache_is_installed: Überprüft, ob das Paket apache2 auf dem Server installiert ist.
2. test_apache_running_and_enabled: Stellt sicher, dass der Apache-Dienst läuft und so konfiguriert ist, dass er beim Booten startet.
3. test_apache_port_listening: Überprüft, ob Apache auf Port 80 lauscht, was bedeutet, dass der Webserver Anfragen entgegennehmen kann.

3. Tests ausführen

Um die Tests auszuführen, führst du den folgenden Befehl in dem Verzeichnis aus, in dem sich deine test_apache.py-Datei befindet:

pytest --hosts=ansible://webserver

Erklärung:

• –hosts=ansible://webserver: Testinfra nutzt Ansible, um die Hosts zu identifizieren. In diesem Fall testet es den webserver, den wir in unserer Inventardatei definiert haben.
• Testinfra nutzt die bestehenden Verbindungen und Ansible-Inventory-Dateien, um auf die Hosts zuzugreifen und Tests durchzuführen.

4. Integration in den CI/CD-Workflow

Die Tests können auch in einen Continuous-Integration/Continuous-Delivery (CI/CD)-Workflow integriert werden, um sicherzustellen, dass jede Infrastrukturänderung getestet wird, bevor sie in die Produktion gelangt. Du kannst dies in Tools wie Jenkins, GitLab CI oder GitHub Actions integrieren, um automatisierte Tests für deine Infrastruktur einzurichten.

Ein Beispiel für die Integration in GitLab CI:

stages:
  - test

test_infrastructure:
  stage: test
  script:
    - pip install pytest-testinfra
    - pytest --hosts=ansible://webserver

Dies führt sicher, dass bei jedem Commit die Infrastrukturänderungen getestet werden.

5. Erweiterte Testmöglichkeiten mit Testinfra

Testinfra bietet eine breite Palette an Testmöglichkeiten, um nahezu jede Komponente deiner Serverinfrastruktur zu testen. Hier sind einige zusätzliche Beispiele:

Datei überprüfen

Du kannst überprüfen, ob eine bestimmte Datei existiert und bestimmte Eigenschaften aufweist:

def test_apache_config_file(host):
    config_file = host.file("/etc/apache2/apache2.conf")
    assert config_file.exists
    assert config_file.user == "root"
    assert config_file.group == "root"
    assert config_file.mode == 0o644

Benutzerspezifische Tests

Du kannst auch sicherstellen, dass bestimmte Benutzer oder Gruppen auf dem System vorhanden sind:

Paketversion überprüfen

Falls du eine bestimmte Paketversion erwartest, kannst du dies ebenfalls testen:

def test_apache_version(host):
    apache = host.package("apache2")
    assert apache.version.startswith("2.4")

Fazit

Testinfra bietet eine großartige Möglichkeit, die Automatisierung mit Ansible um eine automatisierte Testebene zu ergänzen. Du kannst sicherstellen, dass deine Infrastruktur nicht nur automatisiert, sondern auch korrekt konfiguriert ist, bevor sie in eine produktive Umgebung überführt wird. Durch die Verwendung von Testinfra in Kombination mit Ansible kannst du deinen Infrastruktur-Code zuverlässiger und robuster gestalten.

Experimentiere mit verschiedenen Testfällen und integriere sie in deinen CI/CD-Workflow, um sicherzustellen, dass deine Infrastruktur in einwandfreiem Zustand ist.

Viel Erfolg beim Testen deiner Infrastruktur!