Wie um zu testen, Terraform-Dateien

Werde ich erweitern, Beginnen Sie die Antwort mit mehr Informationen über Küche-Terraform.

Küche-Terraform ist ein Satz von open-source-plugins, die laufen innerhalb Test-Küche, diese sollen sich in Ihre Terraform-Modul-repository zu test, Modul-Funktionalität vor, die in einem repository erstellt der Ressourcen. Fühlen Sie bitte sich frei, überprüfen Sie die Dokumentation der beiden Projekte für mehr details, aber ich werde gehen durch meine Empfehlungen für Integrationstest Ihre Terraform-code.

Ruby, Terraform
Für dieses Beispiel, die Terraform-Modul repo genannt werden: my_terraform_module

mkdir -p my_terraform_module
cd my_terraform_module

mkdir -p test/integration/kt_suite/controls \
         test/fixtures/tf_module/

Erstellen Sie eine Gemfile:

source "https://rubygems.org/" do
  gem "kitchen-terraform"
end

Installieren Sie die erforderlichen Komponenten (verwendet die Gemfile für die Abhängigkeiten der kitchen-terraform)

gem install bundler
bundle install

Erstellen Sie die Test-Küche-Datei .kitchen.yml - dies bringt den Test-frame, Test-Küche und Küche-Terraform

---
driver:
  name: terraform
  root_module_directory: test/fixtures/tf_module
  parallelism: 4

provisioner:
  name: terraform

transport:
  name: ssh

verifier:
  name: terraform
  groups:
    - name: basic
      controls:
        - file_check
        - state_file

platforms:
  - name: terraform

suites:
  - name: kt_suite

Ihre Terraform-code sollte an der Wurzel der Terraform-Modul-repository wie:

my_terraform_module/
  |-- main.tf

Beispiel-code, gehen Sie in main.tf

resource "null_resource" "create_file" {
  provisioner "local-exec" {
    command = "echo 'this is my first test' > foobar"
  }
}

Dann der Hinweis auf die Terraform-Modul nur, wie würden wir in Terraform live-repos - aber in einer test-fixture statt in dieser Datei: test/fixtures/tf_module/main.tf

module "kt_test" {
  source = "../../.."
}

Dann von dort aus können Sie Terraform gelten, aber es ist ein wenig anders mit Küche-Terraform-und Test-Küche, die Sie ausführen, ein konvergieren die hilft, halten Sie verfolgen der Staat und ein paar andere Elemente.

bundle exec kitchen converge

Nun haben Sie gesehen, Ihre Terraform-code eine gelten, die wir brauchen, um es zu testen. Test können wir die tatsächlichen Ressourcen, die erstellt wurden, das wäre wie ein integration-test, aber wir können auch testen Sie die Status-Datei, die ist ein semi-Einheit testen, aber ich bin mir nicht bewusst alles, was sich derzeit in den unit-tests gegen die HCL-code von Terraform.

Erstellen Sie eine inspec Standard-Profil-Datei: test/integration/kt_suite/inspec.yml

---
name: default

Erstellen Sie eine Inspec-Steuerelement für Ihre integration zu testen: test/integration/kt_suite/controls/basic.rb - ich bin mit einem test für das Beispiel Terraform-code, den ich früher für die main.tf

# frozen_string_literal: true

control "file_check" do
  describe file('.kitchen/kitchen-terraform/kt-suite-terraform/foobar') do
    it { should exist }
  end
end

Dies ist ein Beispiel-test von abrufen von Informationen aus der Status-Datei und testen, ob etwas existiert. Dies ist eine grundlegende, aber man kann auf jeden Fall exand auf dieses Beispiel.

# frozen_string_literal: true

terraform_state = attribute "terraform_state", {}

control "state_file" do
  describe "the Terraform state file" do
    subject do json(terraform_state).terraform_version end

    it "is accessible" do is_expected.to match /\d+\.\d+\.\d+/end
  end
end

Führen Inspec-Steuerelemente mit der Test-Küche und Küche-Terraform:

bundle exec kitchen verify

Nahm ich eine Menge von dieser aus dem erste-Schritte-Handbuch und einige der tutorials hier: https://newcontext-oss.github.io/kitchen-terraform/getting_started.html

Aus meiner Forschung ist dies eine schwierige Frage, da Terraform ist nicht dazu gedacht, für eine voll funktionsfähige Programmiersprache, und erklären Sie, was Ressourcen, die Sie wollen, mit Terraform, nicht, wie Sie zu bauen, versuchen, unit-test nicht wirklich geben Ihnen die Sicherheit, die Sie bauen Ressourcen, wie Sie möchten, ohne tatsächlich die Ausführung einer Anwendung. Dies macht versucht, unit-test fühlen Sie sich mehr wie ein linting mir.

Allerdings könnte man analysieren Ihr HCL-Dateien mit so etwas wie pyhcl, oder analysieren Sie plan-Dateien, aber aus meiner Erfahrung, das war viel Arbeit für wenig nutzen (aber ich könnte fehlt eine einfachere Methode!).

Hier sind einige alternativen, wenn Sie wollte, um zu testen, die Ergebnisse Ihrer terraform passt:

Küche-terraform ist ein Werkzeug für das schreiben Test-Küche Spezifikationen für Ihre Infrastruktur.

Küche-verifier-awspec hilft zusammenbringen awspec und kitchen-terraform, obwohl ich habe es nicht persönlich.

Wenn Sie mithilfe von AWS, die ich gefunden habe, AWS Config zu können, bieten viele der gleichen Vorteile wie andere Infrastruktur-testing-tools, ohne viel setup/Wartung. Es ist zwar ziemlich neu, und ich habe nicht verwendet es ausgiebig.

Auch wenn Sie die Zahlung für Terraform Premium erhalten Sie Zugang zu Sentinel, die scheint eine Menge ähnliche Vorteile AWS Config, aber ich habe es nicht persönlich.

Können Sie verwenden github.com/palantir/tfjson zum analysieren einer .plan Datei zu json.

Es ist ein Problem im moment, dass eine "unbekannt-plan Datei version: 2" Fehler. Dies ist, weil die vendored version von terraform ist zu alt.

Fix ist:

go get github.com/palantir/tfjson
cd $GOPATH/src/github.com/palantir/tfjson
rm -rf vendor
go get -v ./...

Dort ist dann ein Fehler in ../../hashicorp/terraform/config/testing.go. Zu beheben, ändern Sie einfach die Zeile

t.Helper()

zu

//t.Helper()

Laufen go get wieder und dann go install

go get -v ./...
go install ./...

Sollten Sie dann in der Lage sein, Folgendes zu tun produzieren json Ausgabe.

terraform plan --out=terraform.plan 
tfjson terraform.plan