インフラストラクチャコードのテスト駆動開発には Serverspec を使用する

作成者: Sushant Jagdale (AWS）

[概要]

このパターンは、Amazon Web Services (TDD) クラウドでインフラストラクチャコードを記述するときに、Serverspec を使用してテスト駆動型開発 (AWS) を使用する方法を示しています。このパターンは、 によるオートメーションもカバーしますAWS CodePipeline。TDD は、インフラストラクチャコードが何をする必要があるかに注目し、完了の明確な定義を設定します。Serverspec を使用して、、Terraform by AWS CloudFormation、 HashiCorpAnsible などのツールによって作成されたインフラストラクチャをテストできます。

Serverspec はインフラストラクチャコードのリファクタリングに役立ちます。Serverspec を使用すると、さまざまなパッケージやソフトウェアのインストールをチェックするRSpecテストを記述したり、コマンドを実行したり、実行中のプロセスやポートをチェックしたり、ファイルアクセス許可設定をチェックしたりできます。Serverspec は、サーバーが正しく構成されているかどうかをチェックします。サーバーには Ruby のみをインストールします。エージェントソフトウェアをインストールする必要はありません。

テスト駆動型インフラストラクチャには次の利点があります。

このパターンを使用して、Amazon Machine Image (AMI) の作成中に、Apache ソフトウェアの Serverspec ユニットテストを実行し、ファイルアクセス許可設定を確認できます。AMI は、すべてのテストケースが合格した場合にのみ作成されます。Serverspec は以下のテストを実行します。

前提条件と制限

前提条件

製品バージョン

アーキテクチャ

ターゲット アーキテクチャ

ツール

コード

コードは添付されています。このコードでは、3 つのディレクトリと 8 つのファイルからなる次のような構造になっています。

├── 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)

エピック

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

関連リソース

追加情報

書き込みRSpecテスト

このパターンのRSpecテストは にあります<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

/specディレクトリに独自のテストを追加することができます。

パイプラインの作成

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

パラメーターの詳細

repository-name – AWS CodeCommit リポジトリの名前

application-name – Amazon リソースネーム (ARNs) は にリンクされていますApplicationName。任意の名前を指定します。

SecurityGroupId — ポート 80 が開いているAWSアカウントからのセキュリティグループ ID

VpcId – の ID VPC

SubnetId – のパブリックサブネットの ID VPC

Region – このパターンを実行しているAWSリージョン

Keypair – EC2インスタンスにログインするための Secure Shell (SSH) キー名

AccountId – AWSアカウント ID

AWS マネジメントコンソールを使用して、前のコマンドラインと同じパラメータを渡すことで、 CodePipeline パイプラインを作成することもできます。

添付ファイル

このドキュメントに関連する追加コンテンツにアクセスするには、次のファイルを解凍してください。「attachment.zip」