Getting Started

Last updated: 17 August 2021


Installing rspec-puppet

If you are using Bundler to manage the gems in your module or control repository (highly recommended), you should add rspec-puppet to your Gemfile and then run bundle install.

gem 'rspec-puppet', '~> 2.0'

Alternatively, you can install rspec-puppet using gem.

$ gem install rspec-puppet

Installing Puppet

rspec-puppet needs to have Puppet installed on the host in order to operate, but does not have it specified in the gem as dependency as Puppet can be installed as a native package or gem.

If you do not have Puppet installed, you’ll need to do so now. If you are using Bundler to manage the gems in your module or control repository, you should add Puppet to your Gemfile and then run bundle install.

gem 'puppet', ENV.fetch('PUPPET_GEM_VERSION', '>= 0')

The above snippet will allow you to specify a Puppet version to use in the PUPPET_GEM_VERSION environment variable. This is a common pattern that you will find in many open source modules that support multiple Puppet versions.


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 require.

$ cd path/to/your/module
$ touch metadata.json
$ rspec-puppet-init

Manual setup on Unix-based hosts

Create a spec directory inside your module

$ cd path/to/your/module
$ mkdir spec

Puppet expects to be able to read a default manifest file (usually manifests/site.pp), so a blank one needs to be created.

$ mkdir -p spec/fixtures/{manifests,modules}
$ touch spec/fixtures/manifests/site.pp

RSpec needs to be configured to use rspec-puppet, which is done in the spec/spec_helper.rb file which should be created now with the following content.

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')

Optionally, if you are using Rake to automate tasks in your module, you can add a spec task to your Rakefile.

require 'rspec/core/rake_task' do |t|
  t.pattern = 'spec/**/*_spec.rb'

Manual setup on Windows hosts

Coming soon!