更新日: 2014年7月30日
RSpec

Serverspecの使い方入門、Chefで構成管理するサーバー環境をテスト

Chef で Cookbook/Recipe の作成に一通り慣れてきましたので、Serverspec でサーバー状態のテストを行います。Serverspec は、サーバーテストを行えるように RSpec を拡張したテスト・フレームワークです。

今回は入門編ですが、ざっと Readme や関連エントリーに目を通した感じですと、RSpec を知っていれば馴染みのある感じでとっつきやすそうです。Vagrant 上の CentOS 仮想マシンで、Serverspec によるテストを行います。

Serverspec – Home
GitHub: serverspec

【お知らせ】英単語を画像イメージで楽に暗記できる辞書サイトを作りました。英語学習中の方は、ぜひご利用ください！

画像付き英語辞書 Imagict | 英単語をイメージで暗記
【開発記録】
英単語を画像イメージで暗記できる英語辞書サービスを作って公開しました

Gemfile に serverspec を追加してインストール

Chef のリポジトリを作成したディレクトリの Gemfile に、serverspec の gem を追加します。

Gemfile


source "https://rubygems.org"

gem "chef"
gem "berkshelf"
gem "knife-solo"
gem "serverspec"

source "https://rubygems.org"

gem "chef"

gem "berkshelf"

gem "knife-solo"

gem "serverspec"

続いて、bundle install。


$ bundle install --path vendor/bundle

$ bundle install --path vendor/bundle

serverspec-init コマンドで spec ファイル生成

serverspec-init コマンドを実行して、以下のように対話型で作業を進めます。


$ bundle exec serverspec-init
Select OS type:

  1) UN*X
  2) Windows

Select number: 1

Select a backend type:

  1) SSH
  2) Exec (local)

Select number: 1

Vagrant instance y/n: y
Auto-configure Vagrant from Vagrantfile? y/n: n
Input vagrant instance name: centos.vagrant
 + spec/
 + spec/centos.vagrant/
 + spec/centos.vagrant/httpd_spec.rb
 + spec/spec_helper.rb
 + Rakefile

$ bundle exec serverspec-init

Select OS type:

1) UN*X

2) Windows

Select number: 1

Select a backend type:

1) SSH

2) Exec (local)

Select number: 1

Vagrant instance y/n: y

Auto-configure Vagrant from Vagrantfile? y/n: n

Input vagrant instance name: centos.vagrant

+ spec/

+ spec/centos.vagrant/

+ spec/centos.vagrant/httpd_spec.rb

+ spec/spec_helper.rb

+ Rakefile

UN*X、SSH接続、Vagrantを利用、の設定にしました。spec/, Rakefile が生成されています。

~/.ssh/config へ vagrant への SSH 接続設定を追加

serverspec は ssh 接続でサーバーに入った後にテストを実行するので、事前に vagrant に ssh 接続する設定を ~/.ssh/config に追加しておきます。


$ vagrant ssh-config --host host_name

$ vagrant ssh-config --host host_name

で、vagrant 仮想サーバーへの ssh 設定を出力してくれるので、以下のようにして ~/.ssh/config に設定を追加する。


$ vagrant ssh-config --host centos.vagrant >> ~/.ssh/config

$ vagrant ssh-config --host centos.vagrant >> ~/.ssh/config

実際の出力の確認。


$ vagrant ssh-config --host centos.vagrant
Host centos.vagrant
  HostName 127.0.0.1
  User vagrant
  Port 2222
  UserKnownHostsFile /dev/null
  StrictHostKeyChecking no
  PasswordAuthentication no
  IdentityFile /Users/username/.vagrant.d/insecure_private_key
  IdentitiesOnly yes
  LogLevel FATAL

$ vagrant ssh-config --host centos.vagrant

Host centos.vagrant

HostName 127.0.0.1

User vagrant

Port 2222

UserKnownHostsFile /dev/null

StrictHostKeyChecking no

PasswordAuthentication no

IdentityFile /Users/username/.vagrant.d/insecure_private_key

IdentitiesOnly yes

LogLevel FATAL

SSH接続の確認。


$ ssh centos.vagrant

$ ssh centos.vagrant

接続できればOK。

serverspec のテストコードを書く

serverspec-init で作成された httpd_spec.rb を参考にして、nginx 用の spec テストを書きました。

spec/centos.vagrant/nginx_spec.rb

require 'spec_helper'

describe package('nginx') do
  it { should be_installed }
end

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

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

describe file('/etc/nginx/conf.d/nginx.conf') do
  it { should be_file }
  its(:content) { should match(/server_name webserver\.vagrant;/) }
end

require 'spec_helper'

describe package('nginx') do

it { should be_installed }

end

describe service('nginx') do

it { should be_enabled }

it { should be_running }

end

describe port(80) do

it { should be_listening }

end

describe file('/etc/nginx/conf.d/nginx.conf') do

it { should be_file }

its(:content) { should match(/server_name webserver\.vagrant;/) }

end

ほぼそのまま英語なので、読めば分かりますね。

serverspec テストの実行

続いて、通常の RSpec テストと同様に serverspec のテストを実行します。


$ bundle exec rake spec
/Users/username/.rbenv/versions/2.1.2/bin/ruby -S rspec spec/centos.vagrant/httpd_spec.rb spec/centos.vagrant/nginx_spec.rb
The machine with the name 'centos.vagrant' was not found configured for
this Vagrant environment.
The machine with the name 'centos.vagrant' was not found configured for
this Vagrant environment.
......

Finished in 4.43 seconds
6 examples, 0 failures