Verwenden Sie Serverspec für die testgetriebene Entwicklung von Infrastrukturcode

Erstellt von Sushant Jagdale (AWS)

Übersicht

Dieses Muster zeigt Ihnen, wie Sie Serverspec verwenden, um Test-Driven Development (TDD) beim Schreiben von Infrastrukturcode in der Amazon Web Services (AWS) -Cloud zu verwenden. Das Muster deckt auch die Automatisierung mit AWS ab CodePipeline. TDD wird die Aufmerksamkeit darauf lenken, was der Infrastrukturcode tun muss, und eine klare Definition von erledigt festlegen. Sie können Serverspec verwenden, um Infrastrukturen zu testen, die mit Tools wie AWS CloudFormation, Terraform by HashiCorp und Ansible erstellt wurden.

Serverspec hilft beim Refactoring von Infrastrukturcode. Mit Serverspec können Sie RSpec-Tests schreiben, um die Installation verschiedener Pakete und Software zu überprüfen, Befehle auszuführen, nach laufenden Prozessen und Ports zu suchen, Dateiberechtigungseinstellungen zu überprüfen usw. Serverspec überprüft, ob Ihre Server korrekt konfiguriert sind. Sie installieren nur Ruby auf Ihren Servern. Sie müssen keine Agentsoftware installieren.

Eine testgetriebene Infrastruktur bietet die folgenden Vorteile:

Sie können dieses Muster verwenden, um Serverspec-Komponententests für Apache-Software auszuführen und die Dateiberechtigungseinstellungen während der Erstellung von Amazon Machine Image (AMI) zu überprüfen. Ein AMI wird nur erstellt, wenn alle Testfälle erfolgreich sind. Serverspec führt die folgenden Tests durch:

Voraussetzungen und Einschränkungen

Voraussetzungen

Produktversionen

Architektur

Zielarchitektur

Tools

Code

Der Code ist angehängt. Der Code verwendet die folgende Struktur mit drei Verzeichnissen und acht Dateien.

├── amazon-linux_packer-template.json (Packer template)
├── buildspec.yaml (CodeBuild .yaml file)
├── pipeline.yaml (AWS CloudFormation template to automate CodePipeline)
├── rspec_tests (RSpec required files and spec)
│   ├── Gem-file
│   ├── Rakefile
│   └── spec
│       ├── apache_spec.rb
│       └── spec_helper.rb
└── scripts
    └── rspec.sh (Installation of Ruby and initiation of RSpec)

Epen

aws sts get-caller-identity --profile <profile>

aws codecommit create-repository --repository-name "<provide repository-name>" --repository-description "repository to unit test the infrastructure code"

git clone <repository url>
cp -R /tmp/<code folder>/  <repository_folder>/
git add .
git commit -m"initial commit"
git push

http://<your instance public ip>/hello.html

Zugehörige Ressourcen

Zusätzliche Informationen

Schreiben Sie RSpec-Tests

Der RSpec-Test für dieses Muster befindet sich unter. <repository folder>/rspec_tests/spec/apache_spec.rb

require 'spec_helper'


describe service('httpd') do
  it { should be_enabled }
  it { should be_running }
end


describe port(80) do
  it { should be_listening }
end


describe file('/etc/httpd/conf/httpd.conf') do
  it { should exist }
  it { should be_owned_by 'root' }
  it { should contain 'ServerName www.example.com' }
end


describe file('/etc/httpd/conf/httpd.conf') do
  its(:content) { should match /ServerName www.example.com/ }
end


describe file('/var/www/html/hello.html') do
  it { should exist }
  it { should be_owned_by 'ec2-user' }
end


describe file('/var/log/httpd') do
  it { should be_directory }
end


describe file('/etc/sudoers') do
  it { should be_mode 440 }
end


describe group('root') do
  it { should have_gid 0 }
end

Sie können dem Verzeichnis Ihre eigenen Tests hinzufügen. /spec

Erstellen Sie die Pipeline

aws cloudformation create-stack --stack-name myteststack --template-body file://pipeline.yaml --parameters ParameterKey=RepositoryName,ParameterValue=<provide repository-name> ParameterKey=ApplicationName,ParameterValue=<provide application-name> ParameterKey=SecurityGroupId,ParameterValue=<provide SecurityGroupId> ParameterKey=VpcId,ParameterValue=<provide VpcId> ParameterKey=SubnetId,ParameterValue=<provide SubnetId> ParameterKey=Region,ParameterValue=<provide Region> ParameterKey=Keypair,ParameterValue=<provide Keypair> ParameterKey=AccountId,ParameterValue=<provide AccountId> --capabilities CAPABILITY_NAMED_IAM

Einzelheiten zu den Parametern

repository-name— Der Name des CodeCommit AWS-Repositorys

application-name— Der Amazon-Ressourcenname (ARNs), mit dem verknüpft istApplicationName; geben Sie einen beliebigen Namen an

SecurityGroupId— Jede Sicherheitsgruppen-ID von Ihrem AWS-Konto, für das Port 80 geöffnet ist

VpcId— Die ID Ihrer VPC

SubnetId— Die ID eines öffentlichen Subnetzes in Ihrer VPC

Region— Die AWS-Region, in der Sie dieses Muster ausführen

Keypair— Der Secure Shell (SSH) -Schlüsselname für die Anmeldung bei der EC2-Instance

AccountId— Ihre AWS-Konto-ID

Sie können auch eine CodePipeline Pipeline erstellen, indem Sie die AWS-Managementkonsole verwenden und dieselben Parameter wie in der vorherigen Befehlszeile übergeben.

Anlagen

Um auf zusätzliche Inhalte zuzugreifen, die mit diesem Dokument verknüpft sind, entpacken Sie die folgende Datei: attachment.zip