Unit-Tests mit Terratest

Infrastructure as Code (IaC) ermöglicht es Ihnen, Infrastruktur wie Software zu verwalten. Genau wie Software können auch IaC-Konfigurationen Fehler enthalten!

• Zuverlässigkeit: Erkennen Sie Fehler vor der Bereitstellung.
• Konsistenz: Stellen Sie sicher, dass Ressourcen wie erwartet bereitgestellt werden.
• Vertrauen: Nehmen Sie Änderungen mit geringerem Risiko vor, bestehende Infrastruktur zu beschädigen.

Das Testen Ihres Terraform-Codes ist entscheidend für robuste und wartbare Cloud-Umgebungen.

Beim Testen von IaC sprechen wir häufig über zwei Hauptarten:

• Unit-Tests: Sie konzentrieren sich auf kleine, isolierte Teile Ihres Codes, beispielsweise ein einzelnes Terraform-Modul. Sie stellen sicher, dass einzelne Komponenten unabhängig voneinander korrekt funktionieren.
• Integrationstests: Sie überprüfen, ob mehrere Komponenten oder Module als System zusammenarbeiten, und stellen dafür häufig reale Ressourcen in einer Cloud-Umgebung bereit.

In dieser Lektion konzentrieren wir uns auf das Unit-Testing Ihrer Terraform-Module.

Terratest ist eine von HashiCorp (den Entwicklern von Terraform) entwickelte Go-Bibliothek, die speziell für das Testen von Infrastrukturcode konzipiert wurde.

• Sie unterstützt Sie beim Schreiben automatisierter Tests für Ihren Terraform-, Packer-, Kubernetes- und sonstigen IaC-Code.
• Terratest kann reale Infrastruktur bei Ihrem Cloud-Provider bereitstellen, darauf Assertions ausführen und sie anschließend wieder bereinigen.
• Es eignet sich sowohl für Unit- als auch für Integrationstests.

Für den Einstieg in Terratest benötigen Sie einige Dinge:

• Go: Terratest ist eine Go-Bibliothek. Daher muss Go installiert sein (Version 1.13 oder höher wird empfohlen).
• Terraform CLI: Die Befehlszeilenschnittstelle von Terraform muss installiert und verfügbar sein.
• Anmeldedaten des Cloud-Anbieters: Wenn Sie echte Ressourcen bereitstellen (auch bei Unit-Tests, die auf eine Cloud-API zugreifen), benötigen Sie authentifizierten Zugriff auf den Cloud-Anbieter (z. B. eine konfigurierte AWS CLI).

Außerdem benötigen Sie grundlegende Kenntnisse der Go-Programmierkonzepte.

Terratest-Tests werden in Go geschrieben und folgen den standardmäßigen Testkonventionen von Go:

• Testdateien enden mit _test.go (z. B. main_test.go).
• Testfunktionen beginnen mit Test (z. B. TestMyModule(t *testing.T)).
• Sie verwenden das integrierte Go-Paket testing.

Diese Dateien befinden sich normalerweise neben Ihrem Terraform-Modul oder in einem eigenen test-Verzeichnis.

Das zentrale Element eines Terratest-Terraform-Tests ist die Struktur terraform.Options. Dieses Objekt legt fest, wie Terratest Terraform ausführt.

Zu den wichtigsten Feldern gehören:

• TerraformDir: Pfad zu Ihrem Terraform-Modul.
• Vars: Eingabevariablen für Ihr Terraform-Modul.
• EnvVars: Umgebungsvariablen, die für den Terraform-Prozess gesetzt werden.
• BackendConfig: Konfiguration für Ihr Terraform-Backend.

Sie dient als Vorlage für die Ausführung von Terraform-Befehlen innerhalb des Tests.

Ein typischer Terratest-Unit-Test für Terraform umfasst die folgenden Schritte:

1. Optionen definieren: Erstellen Sie eine Struktur terraform.Options, die auf Ihr Modul verweist und Variablen festlegt.
2. Bereitstellen: Verwenden Sie terraform.InitAndApply(t, options), um Ihre Konfiguration zu initialisieren und anzuwenden.
3. Zerstörung aufschieben: Fügen Sie sofort defer terraform.Destroy(t, options) hinzu, damit nach Abschluss des Tests eine Bereinigung erfolgt.
4. Assertions durchführen: Verwenden Sie Go-Assertions aus testify/assert oder Terratests terraform.Output, um Ressourceneigenschaften oder Ausgaben zu überprüfen.

So wird eine saubere, isolierte Testumgebung sichergestellt.

Hier sehen Sie ein einfaches Go-Programm, das zeigt, wie terraform.Options eingerichtet wird. Dies ist ein grundlegender Schritt für jede Interaktion mit Terratest.

Nach dem Anwenden Ihrer Terraform-Konfiguration möchten Sie deren Ausgaben überprüfen. Terratest stellt Funktionen bereit, mit denen Sie diese Werte einfach abrufen können.

• terraform.Output(t, options, "output_name"): Ruft eine einzelne String-Ausgabe ab.
• terraform.OutputMap(t, options, "output_name"): Ruft eine Map-Ausgabe ab.
• terraform.OutputList(t, options, "output_name"): Ruft eine Listen-Ausgabe ab.

Anschließend verwenden Sie die Test-Assertions von Go (z. B. aus github.com/stretchr/testify/assert), um zu prüfen, ob die Ausgaben Ihren Erwartungen entsprechen.

Terratest unterstützt Sie beim Testen Ihres Terraform-Codes, indem es mit echten Cloud-Ressourcen interagiert. Welcher der folgenden Schritte gehört NICHT typischerweise zum Ablauf eines Terratest-Unit-Tests?

Sie haben die Grundlagen des Testens von Terraform mit Terratest gelernt!

• Terratest ist eine Go-Bibliothek zum Testen von IaC.
• Damit können Sie echte Cloud-Infrastruktur bereitstellen, überprüfen und bereinigen.
• Zu den wichtigsten Bestandteilen gehören _test.go-Dateien, func TestXxx(t *testing.T) und die Struktur terraform.Options.
• Der Ablauf umfasst das Definieren von Optionen, das Anwenden von Terraform, das Durchführen von Assertions und das Sicherstellen der Bereinigung mit defer.

Sehen Sie sich als Nächstes an, wie Sie komplexere Assertions schreiben und Terratest für automatisierte Tests in Ihre CI/CD-Pipelines integrieren.