rspec-puppet

RSpec tests for your Puppet manifests

View the Project on GitHub rodjek/rspec-puppet

Home

Tutorial

Setup

Matchers

Changelog

Setup

Automatic setup

rspec-puppet ships with a small script that will automate the setup process for you by creating the various files and directories that rspec and rspec-puppet requires in order to function correctly.

$ cd path/to/your/module
$ rspec-puppet-init

Manual setup

First, create the directories that will contain your spec files

$ cd path/to/your/module
$ mkdir -p spec/{classes,defines,hosts,functions}

Puppet always expects to be able to read a site.pp file, so we’ll create a blank one for it to read when running the tests

$ mkdir -p spec/fixtures/manifests
$ touch spec/fixtures/manifests/site.pp

In order for Puppet’s manifest autoloader to work correctly, it expects to find your manifests under <modulepath>/<your module name>/manifests/. If we just set the modulepath to the root of your module, it will be missing <your module name> from the path, so we work around this by creating a directory under spec/fixtures/modules and symlinking your module contents into it

$ mkdir spec/fixtures/modules/<your module name>
$ cd spec/fixtures/modules/<your module name>
$ for i in files lib manifests templates; do ln -s ../../../../$i $i; done
$ cd ../../../../

Now, you need to configure rspec-puppet to use the fixtures we just set up. Create spec/spec_helper.rb with the following contents

require 'rspec-puppet'

fixture_path = File.expand_path(File.join(__FILE__, '..', 'fixtures'))

RSpec.configure do |c|
  c.module_path = File.join(fixture_path, 'modules')
  c.manifest_dir = File.join(fixture_path, 'manifests')
end

All that’s left is to create a Rakefile with a task to run the tests

require 'rake'
require 'rspec/core/rake_task'

RSpec::Core::RakeTask.new(:spec) do |t|
  t.pattern = 'spec/*/*_spec.rb'
end

Configuring RSpec to know about your Puppet setup

You can see above how we told RSpec where to find our manifest and module directories, but there’s other things you can tell RSpec about your Puppet setup if necessary (you should only set these if your tests aren’t working correctly, for most setups the default values will suffice).

manifest_dir
The path to the directory containing your basic manifests like site.pp.
module_path
The path to the directory containing your modules.
manifest
The entry-point manifest for Puppet, usually <manifest_dir>/site.pp.
template_dir
The path to the directory where Puppet will look for templates outside of modules.
config
The path to the puppet.conf.
confdir
The path to the main Puppet configuration directory.
default_facts
A hash of default facts that should be used for all your tests.
hiera_config
The path to your hiera.yaml file, if you use Hiera.