Test your Chef cookbooks nicely.
This project is heavily inspired by RSpec-puppet.
gem install rspec-chef
Follow this structure to organize your recipes:
library
|
+-- cookbooks
|
+-- specs
|
+-- recipes
| |
| +-- <recipe_name>_spec.rb
|
+-- providers
|
+-- <lwrp_name>_spec.rb
Or force the example group into the spec:
describe 'cookbook::recipe', :type => :recipe do
...
endor, for an LWRP test:
describe 'cookbook_provider', :type => :provider do
...
endAll of the standard RSpec matchers are available for you to use when testing Chef recipes.
Checking if a recipe contains a resource
Use the matcher contain_<resource_type> matcher:
it { should contain_remote_file }It can take the name of the resource as a parameter:
it { should contain_remote_file('/etc/chef/dna.json') }It can take the parameters that the resource takes:
it { should contain_remote_file('/etc/chef/dna.json', {:action => :nothing}) }Use the chained method with to test the further attributes that the resource gets:
it { should contain_remote_file('/etc/chef/dna.json').with(:source, 'dna.json.erb') }Use the chained method without to the the resource doesn't get further unexpected attributes:
it { should contain_remote_file('/etc/chef/dna.json').without(:owner, :group) }Log level
The Chef log level can be specified using let for each group:
describe 'foo::bar' do
let(:log_level) { :debug }
endOr it can be set as a global RSpec setting:
RSpec.configure do |c|
c.log_level = :debug
endCookbooks path
The path to the cookbooks can be specified using let for each group:
describe 'foo::bar' do
let(:cookbook_path) { File.expand_path('../cookbooks', __FILE__) }
endOr it can be set as a global RSpec setting:
RSpec.configure do |c|
c.cookbook_path = File.expand_path('../cookbooks', __FILE__)
endwhere it can also be set as an array of paths, which will be searched in turn:
RSpec.configure do |c|
c.cookbook_path = [
File.expand_path('../site-cookbooks', __FILE__),
File.expand_path('../cookbooks', __FILE__)
]
endJSON attributes
Each recipe includes a node. This node can be feeded with a hash using let in the description group:
describe 'foo::bar' do
let(:json_attributes) { {:foo => :bar} }
endWith a file in our file system:
describe 'foo::bar' do
let(:json_attributes) { '/etc/chef/dna.json' }
endOr with plain JSON:
describe 'foo::bar' do
let(:json_attributes) { '{"foo": "bar"}' }
endThe JSON attributes can also be set as a global RSpec setting:
RSpec.configure do |c|
c.json_attributes = {:foo => :bar}
endDefault attributes may also be specified, to which the json_attributes will be added:
RSpec.configure do |c|
c.default_attributes = {:foo => :bar}
endLWRP Resource Specification
When testing LWRP providers, the corresponding resource may be defined using let:
describe 'foo::bar' do
let(:resource) {
{ :foo => 'bar' }
}
end