Configuration

Last updated: 26 October 2017

rspec-puppet can be configured by modifying the RSpec.configure block in your spec/spec_helper.rb file. If you followed the setup instructions you’ll already have an RSpec.configure block that you can modify.

RSpec.configure do |c|
  c.<config option> = <value>
end

Required settings

manifest_dir

Type: String
Puppet Version(s): 2.x, 3.x

The path to the directory containing your basic manifests like site.pp.

module_path

Type: String
Puppet Version(s): 2.x, 3.x, 4.x, 5.x

The path to the directory containing the Puppet modules.

Useful settings

default_facts

Type: Hash
Default: None
Puppet Version(s): 2.x, 3.x, 4.x, 5.x

A hash of default facts that should be used for all the tests.

hiera_config

Type: String
Default: /dev/null
Puppet Version(s): 3.x, 4.x, 5.x

The path to your hiera.yaml file (if used).

default_node_params

Type: Hash
Default: None
Puppet Version(s): 4.x, 5.x

A hash of default node parameters that should be used for all the tests.

default_trusted_facts

Type: Hash
Default: None
Puppet Version(s): 4.x, 5.x

A hash of default trusted facts that should be used for all the tests (available in the manifests as $trusted). In order to use this, trusted_node_data must also be set to true.

trusted_node_data

Type: Boolean
Default: false
Puppet Version(s): ~> 3.4, 4.x, 5.x

Makes rspec-puppet use the $trusted hash when testing catalogues.

setup_fixtures

Type: Boolean
Default: true
Puppet Version(s): 2.x, 3.x, 4.x, 5.x

Configures rspec-puppet to automatically create a link from the root of your module to spec/fixtures/<module name> at the beginning of the test run.

Optional overrides

Only set these values if you need to. rspec-puppet is generally pretty good at determining the values itself, but if you need to override them you can.

confdir

Type: String
Default: /etc/puppet
Puppet Version(s): 2.x, 3.x, 4.x, 5.x

The path to the main Puppet configuration directory.

See the Puppet documentation for further details.

config

Type: String
Default: Puppet’s default value
Puppet Version(s): 2.x, 3.x, 4.x, 5.x

The path to puppet.conf.

See the Puppet documentation for further details.

manifest

Type: String
Default: Puppet’s default value
Puppet Version(s): 2.x, 3.x

The entry-point manifest for Puppet, usually <manifest_dir>/site.pp.

See the Puppet documentation for further details.

template_dir

Type: String
Default: None
Puppet Version(s): 2.x, 3.x

The path to the directory that Puppet should search for templates stored outside of modules.

See the Puppet documentation for further details.

environmentpath

Type: String
Default: /etc/puppetlabs/code/environments
Puppet Version(s): 4.x, 5.x

The search path for environment directories.

See the Puppet documentation for further details.

parser

Type: String
Default: current
Puppet Version(s): ~> 3.2

This switches between the 3.x (current) and 4.x (future) parsers.

See the Puppet documentation for further details.

ordering

Type: String
Default: title-hash
Puppet Version(s): ~> 3.3, 4.x, 5.x

How unrelated resources should be ordered when applying a catalogue.

  • manifest - Use the order in which the resources are declared in the manifest.
  • title-hash - Order the resources randomly, but in a consistent manner across runs (the order will only change if the code changes).
  • random - Order the resources randomly (ideal for finding resources that do not have explicit dependencies).

See the Puppet documentation for further details.

strict_variables

Type: Boolean
Default: false
Puppet Version(s): ~> 3.5, 4.x, 5.x

Makes Puppet raise an error when it tries to reference a variable that hasn’t been defined (not including variables that have been explicitly set to undef).

stringify_facts

Type: Boolean
Default: true
Puppet Version(s): ~> 3.3, 4.x, 5.x

Makes rspec-puppet coerce all the fact values into strings (matching the behaviour of older versions of Puppet).

enable_pathname_stubbing

Type: Boolean
Default: false
Puppet Version(s): 2.x, 3.x, 4.x, 5.x

Configures rspec-puppet to stub out Pathname#absolute? with its own implementation. This should only be enabled if you’re running into an issue running cross-platform tests where you have Ruby code (types, providers, functions, etc) that use Pathname#absolute?.

derive_node_facts_from_nodename

Type: Boolean
Default: true
Puppet Version(s): 2.x, 3.x, 4.x, 5.x

If true, rspec-puppet will override the fdqn, hostname, and domain facts with values that it derives from the node name (specified with let(:node).

In some circumstances (e.g. where your nodename/certname is not the same as your FQDN), this behaviour is undesirable and can be disabled by changing this setting to false.