Cookbook のテスト（ChefsMeetingNagoya Vol.2）

Foodcritic

http://acrmp.github.io/foodcritic/
Chef 専用の静的テストツールで、ChefDK に含まれています。

Cookbook のディレクトリでコマンドを実行すると、Foorcritic のルールに違反したコードが検出されます。

$ foodcritic ./

検出結果にはどのルールに違反しているかがわかるように、ルールの番号が付加されています。
Foorcritic の公式サイトには各ルールの詳細な情報と、修正例が記載されていますので、参考にしてください。

Reek

https://github.com/troessner/reek
複雑な Ruby コードを検出する静的テストツールです。

実行方法は Foorcritic と同じです。

$ reek ./

これは ChefDK には含まれていない、Ruby 全般のツールです。
こういったツールでも、 ChefDK の chef gem install コマンドを使ってインストールし、利用することができます。

$ chef gem install reek

chef gem install コマンドでインストールしたコマンドラインツールは、ChefDK の chef shell-init コマンドを実行しておけばそのまま利用することができるようになります。

$ echo 'eval "$(chef shell-init bash)"' >> ~/.bashrc

また、そうでない場合も chef exec コマンドを経由して実行することもできます。

chef exec reek ./

開発環境にはインストール済みです。

Flay

http://ruby.sadi.st/Flay.html
Ruby の重複コードを検出する静的テストツールです。

これも、実行方法は Foorcritic と同じです。

$ flay ./

このツールも Ruby のものなので、利用するには chef gem install コマンドでインストールします。

開発環境にはインストール済みです。

ChefSpec

https://github.com/sethvargo/chefspec
Chef 専用の動的テストツールで、ChefDK に含まれています。
主に Recipe の DSL が期待通りにコンパイルされているかを確認します。

単純な Recipe の場合、Recipe と ChefSpec のテストコードがほぼイコールになってしまい、
同じことを２度書く手間が増えるだけで、特にメリットを感じませんでした。

現状では ChefSpec は利用していませんし、よほど規模の大きい Cookbook を作らない限りは今後も利用しないと思います。

Serverspec

http://serverspec.org/
サーバーの状態をテストする動的テストツールです。
Chef 専用のものではありませんが、Kitchen が対応していて、標準で利用可能です。
今回は Kitchen から利用することを前提にすすめます。

テストコードの配置

Kitchen で Serverspec を実行する場合、テストコードを決まったパスに配置する必要があります。

まず、テストコードを配置するディレクトリを作成します。

$ mkdir -p ./test/integration/default/serverspec/

※ "default" の部分は .kitchen.yml で指定した suites の name です。

そして、テストコードのファイル名は *_spec.rb とします。

$ touch ./test/integration/default/serverspec/default_spec.rb

※ _spec.rb の前の部分はなんでもいいようです。 Cookbook のテストの場合は Recipe の名前と同じにするのが多い気がします。

テストコードの記述

Serverspec のテストコードはものすごく簡単で、ドキュメントを見れば一目瞭然です。

たとえば、あるパスにファイルが存在することを確認するには、以下のように記述できます。

require 'serverspec' 
include Serverspec::Helper::Exec
include Serverspec::Helper::DetectOS
 
describe file('/etc/passwd') do
  it { should be_file }
end

Kitchen で Serverspec を実行

Kitchen インスタンスで Serverspec を実行するには、次のコマンドを使用します。

$ kitchen verify

そうすると、Serverspec が自動的にインストールされ、テストが実行されます。
実行結果は以下のようにログに出力されます。

Service "jenkins"    should be running
        
Finished in 0.04041 seconds
1 example, 0 failures

kitchen verify のほかに、kitchen test コマンドも存在します。

通常 kitchen test ではインスタンスの起動からテストの実行、インスタンスの破棄までを一気に実行します。
ローカル環境で試す場合は kitchen test に --destroy=never オプションをつけておくとインスタンスが破棄されずに、テストまでを一気にやってくれるので便利かもしれません。
また、CI 環境では必ずインスタンスを破棄したいので、kitchen test --destroy=always がオススメです。

テストができたら

ここまでで第２回のハンズオンは終了です。
次のページでは開発環境を作るときに使用した Vagrant の基礎的な部分を紹介しています。
興味のある方は参考にしてください。

ページ ツリー