This document discusses testing Puppet code and modules. It provides examples of using tools like Puppet-lint, rspec-puppet, and inspec to validate code quality and test functionality. It also covers setting up test automation with Guard, Travis CI, and Test Kitchen. The goal is to establish testing, linting, and automation workflows to ensure code works as intended across platforms.

1. Testing for people who hate testing
Bram vogelaar
TTT
12 May 2017

3. Does this $h*t even compile?
$ puppet parser validate validate.pp
Error: Syntax error at ')' at validate.pp:1:13

4. Does this $h*t look good?
gem install puppet­lint rubocop
$ puppet­lint lint.pp
lint.pp ­ ERROR: trailing whitespace found on line 1
$ puppet­lint ­­fix lint.pp
lint.pp ­ FIXED: trailing whitespace found on line 1
$rubocop
Inspecting 45 files
.WCCCCCCCWWCWWWWCCCCCCCCCCCCCCWCCCCCCWCWCWWCW
Offenses:
lib/facter/is_master.rb:4:5: C: Do not prefix reader method names with

5. Does this $h*t do what i think it does?
gem install rspec­puppet
context 'with service_enable set to true' do
it { is_expected.to contain_service('neo4j') }
it { is_expected.not_to contain_file('/etc/init.d/neo4j') }
it { is_expected.not_to contain_systemd__unit_file('neo4j.service') }
it { is_expected.to contain_service('neo4j').with('name' => 'neo4j') }

6. How much of this $h*t is even tested?
at_exit { RSpec::Puppet::Coverage.report! }
# Watch the world burn!
RSpec::Puppet::Coverage.report!(70)

7. So this $h*t will work on $laptop
gem install rspec­puppet­facts
require 'spec_helper'
describe 'example::params' do
on_os_under_test.each do |os, facts|
context "on #{os}" do
let(:facts) { facts }
context "It should not contain any resources" do
it { should contain_class('example::params') }
it { should have_resource_count(0) }
end
end
end
end

8. require 'spec_helper'
describe 'profiles::selinux' do
on_os_under_test.each do |os, facts|
context "on #{os}" do
let(:facts) do
facts.merge({
:selinux_agent_vardir => '/var/lib/puppet',
})
end
context 'with defaults for all parameters' do
it { should contain_class('profiles::selinux') }
end
end
end
end

9. But does this $h*t even work for real
gem install test­kitchen
driver:
name: vagrant
provisioner:
name: puppet_apply
require_chef_for_busser: false
manifest: init.pp
manifests_path: examples
verifier:
name: inspec
suite_name: default
platforms:
­ name: ubuntu­14.04
provisioner:
puppet_apt_collections_repo: https://apt.puppetlabs.com/puppetlabs­release­pc1­trusty.deb

10. Is your $h*t really up
control 'service 01' do
impact 1.0
title 'neo4j service is running'
desc 'Ensures that the neo4j service is up and running'
describe service('neo4j') do
it { should be_enabled }
it { should be_installed }
it { should be_running }
end
end

12. Gemfile: Download all the $h*t
$ gem install bundler
group :test do
gem 'json', '< 2.0.0', :require => false if RUBY_VERSION < '2.0.0'
gem 'json_pure', '<= 2.0.1', :require => false if RUBY_VERSION < '2.0.0'
gem 'metadata­json­lint', :require => false
gem 'puppet­strings', :require => false
gem 'puppet_facts', :require => false
gem 'puppetlabs_spec_helper', :require => false
$ bundle update

13. Rakefile: Automate this $h*t
$ gem install rake
require 'puppetlabs_spec_helper/rake_tasks'
require 'puppet­lint/tasks/puppet­lint'
require 'puppet­strings/tasks'
if Bundler.rubygems.find_name('test­kitchen').any?
require 'kitchen/rake_tasks'
Kitchen::RakeTasks.new
end
$ bundle exec rake validate lint spec

14. Lets speed this $h*t up
# Tests are slow
$ bundle exec rake parallel_spec
# Git checkout is slow
$ bundle exec rake spec_prep
$ bundle exec rake spec_standalone
$ bundle exec rake spec_clean

15. Guardfile: ctrl+F5 this $h*t
$ gem install guard­rake
guard 'rake', :task => 'validate' do
watch(%r{^examples/(.+).pp$})
watch(%r{^manifests/(.+).pp$})
watch(%r{^templates/(.+).erb$})
end
$ bundle exec guard

16. guard notifications

17. .travis.yml: Does this $h*t run on $legacy
$ gem install travis
sudo: false
language: ruby
bundler_args: ­­without development integration
script: "bundle exec rake validate lint spec SPEC_OPTS='­­color ­­format documentation'"
matrix:
fast_finish: true
include:
­ rvm: 2.1.10
env: PUPPET_GEM_VERSION="~> 3.0" STRICT_VARIABLES="yes" FUTURE_PARSER="yes"
­ rvm: 2.1.10
env: PUPPET_GEM_VERSION="~> 4.0" STRICT_VARIABLES="yes"
$ travis show

18. Does this $h*t scale
$ gem install modulesync
$ tree
├── managed_modules.yml
├── moduleroot
│ ├── Gemfile
│ ├── .gitignore
│ ├── Guardfile
│ ├── .kitchen.yml
│ ├── Puppetfile
│ ├── Rakefile
│ ├── .rspec
│ ├── .rubocop.yml
│ ├── spec
│ │ └── spec_helper.rb
│ └── .travis.yml
└── modulesync.yml
$ msync update ­m "adding more gems"

19. Links to this $h*t
http://puppet­lint.com/
https://voxpupuli.org/plugins/
http://rspec­puppet.com/
https://github.com/puppetlabs/beaker
http://kitchen.ci/
https://github.com/neillturner/kitchen­puppet
http://bundler.io/v1.5/gemfile.html
http://rake.rubyforge.org/
http://guardgem.org/
https://travis­ci.org/

20. Demo

21. $ gem install puppet­strings
$ bundle exec rake strings:generate
Files: 5
Modules: 0 ( 0 undocumented)
Classes: 0 ( 0 undocumented)
Constants: 0 ( 0 undocumented)
Attributes: 0 ( 0 undocumented)
Methods: 0 ( 0 undocumented)
Puppet Classes: 5 ( 0 undocumented)
Puppet Defined Types: 0 ( 0 undocumented)
Puppet Types: 0 ( 0 undocumented)
Puppet Providers: 0 ( 0 undocumented)
Puppet Functions: 0 ( 0 undocumented)
100.00% documented