Download as PDF, PPTX
![sample
should contain File[/tmp/sample] (FAILED - 1)
!
Finished in 0.4584 seconds
1 example, 1 failure
Gareth Rushgrove](https://image.slidesharecdn.com/tddforpuppet-140416190522-phpapp02/85/Test-Driven-Development-with-Puppet-53-320.jpg)
![sample
should contain File[/tmp/sample]
!
Finished in 0.3881 seconds
1 example, 0 failures
Gareth Rushgrove](https://image.slidesharecdn.com/tddforpuppet-140416190522-phpapp02/85/Test-Driven-Development-with-Puppet-56-320.jpg)
![task :test => [
:syntax,
:lint,
:spec,
]
Gareth Rushgrove](https://image.slidesharecdn.com/tddforpuppet-140416190522-phpapp02/85/Test-Driven-Development-with-Puppet-78-320.jpg)
![Total resources: 24
Touched resources: 8
Resource coverage: 33.33%
!
Untouched resources:
Class[Nginx]
File[preferences.d]
Anchor[apt::update]
Class[Apt::Params]
File[sources.list]
Exec[Required packages: 'debian-keyring debian-arch
Anchor[apt::source::nginx]
Class[Apt::Update]
File[configure-apt-proxy]
Apt::Key[Add key: 7BD9BF62 from Apt::Source nginx]
Anchor[apt::key/Add key: 7BD9BF62 from Apt::Source
Anchor[apt::key 7BD9BF62 present]
File[nginx.list]Gareth Rushgrove](https://image.slidesharecdn.com/tddforpuppet-140416190522-phpapp02/85/Test-Driven-Development-with-Puppet-112-320.jpg)
Uploaded byPuppet
Test Driven Development with Puppet
The document discusses Test Driven Development (TDD) for Puppet, emphasizing that all Puppet code should be treated as software development. It guides developers through writing and running tests using RSpec and introduces automated testing practices using tools like Guard and Beaker. The author highlights the importance of testing Puppet modules as they become more complex and offers insights into setting up an effective testing workflow.
More Related Content
Similar to Test Driven Development with Puppet
Test Driven Development with Puppet
- 1. Test Driven Development! for Puppet! Puppetneeds software development Gareth Rushgrove
- 2. Who (Who is thisperson?)
- 3.
- 4.
- 8. The problem (This isn’ta rant, but…)
- 9. Who here isa software developer? Gareth Rushgrove
- 10. If you’re writing Puppetcode you’re a software developer Gareth Rushgrove
- 11. As a software developerit’s your job to learn software engineering practices Gareth Rushgrove
- 12. What is TestDriven Development (And why should you care)
- 13. A common practicein software engineering Gareth Rushgrove
- 14. Not just testing GarethRushgrove
- 15. Encourages simple designs andinspires confidence Gareth Rushgrove
- 16. First write an(initially failing) automated test case Gareth Rushgrove
- 17. Then produce the minimumamount of code to pass that test Gareth Rushgrove
- 18. And finally refactor thenew code to acceptable standards Gareth Rushgrove
- 19. Test Driven Design GarethRushgrove
- 20.
- 21. Unit testing with RSpec andGuard (Not puppet specific)
- 22. A unit isthe smallest testable part of an application Gareth Rushgrove
- 23. Testing puppet requires alittle Ruby knowledge so we’ll use Ruby examples Gareth Rushgrove
- 24.
- 25. First lets writea test. For this we use the RSpec testing framework Gareth Rushgrove
- 26. require 'person' ! describe Person,"#say" do it "should say something" do ! end end Gareth Rushgrove
- 27. require 'person' ! describe Person,"#say" do it "should say something" do bob = Person.new bob.say("hello").should eq("hello everyone") end end Gareth Rushgrove
- 28. Now lets runour test. It should fail Gareth Rushgrove
- 29.
- 30. Failures: 1) Person#say shouldsay something Failure/Error: bob.say("hello").should eq("hello everyone") expected: "hello everyone" got: nil Finished in 0.00171 seconds 1 example, 1 failure Gareth Rushgrove
- 31. Now lets writethe implementation Gareth Rushgrove
- 32. class Person def say(word) word+ " everyone" end end Gareth Rushgrove
- 33. And run ourtest again Gareth Rushgrove
- 34. Person#say should say something ! Finishedin 0.00199 seconds 1 example, 0 failures Gareth Rushgrove
- 35. Why not havetests automatically run whenever you change the code? Gareth Rushgrove
- 36. That’s what Guard does GarethRushgrove
- 37. guard :rspec, cmd:'bundle exec rspec' do watch(%r{^spec/.+_spec.rb$}) watch(%r{^lib/.+.rb$}) { 'spec' } end Gareth Rushgrove
- 38.
- 39. Lets see aquick demo Gareth Rushgrove
- 40. Why test puppet codeat all (Testing declarative languages)
- 41.
- 42.
- 43. Modules increasingly have interfaceswith other modules Gareth Rushgrove
- 44. Modules increasingly used inmany operating system and version combinations Gareth Rushgrove
- 45. Modules increasingly used inmany Ruby and Puppet version combinations Gareth Rushgrove
- 46. Unit testing puppet with rspec-puppet (Finallysome puppet code)
- 47.
- 48. A very simplepuppet class Gareth Rushgrove
- 49. class sample { } GarethRushgrove
- 50. First write thetest Gareth Rushgrove
- 51. require 'spec_helper' ! describe "sample"do it { should create_file('/tmp/sample')} end Gareth Rushgrove
- 52. Then run thetest Gareth Rushgrove
- 53. sample should contain File[/tmp/sample](FAILED - 1) ! Finished in 0.4584 seconds 1 example, 1 failure Gareth Rushgrove
- 54. And then writethe (puppet) code to make the test pass Gareth Rushgrove
- 55. class sample { file{ "/tmp/sample": ensure => present, } } Gareth Rushgrove
- 56. sample should contain File[/tmp/sample] ! Finishedin 0.3881 seconds 1 example, 0 failures Gareth Rushgrove
- 57. Lets run thetests automatically whenever you change anything Gareth Rushgrove
- 58. guard :rspec, cmd:'bundle exec rspec' do watch(%r{^spec/.+_spec.rb$}) watch(%r{^manifests/.+.pp$}) { 'spec' } end Gareth Rushgrove
- 59. Lets see aquick demo of that too Gareth Rushgrove
- 60. You can alsotest hosts, defines, facts, functions, hieradata Gareth Rushgrove
- 61. Syntax checking, linting, ohmy (Creating a build process)
- 62.
- 63.
- 64.
- 65. puppet-lint --with-filename /etc/puppet/modules foo/manifests/bar.pp:trailing whitespace found on line 1 apache/manifests/server.pp: variable not enclosed in {} on line 56 Gareth Rushgrove
- 66.
- 67. Validate Puppet and ERBsyntax
- 68.
- 69. rake syntax ---> syntax:manifests --->syntax:templates ---> syntax:hiera:yaml Gareth Rushgrove
- 70. What is Rakeand why do we use it (Still no puppet)
- 71. Rake is aRuby! build tool Gareth Rushgrove
- 72. It’s like Makebut in Ruby Gareth Rushgrove
- 73. It’s very easyto distribute Rake tasks as Ruby gems Gareth Rushgrove
- 74.
- 75.
- 76.
- 77. Lets make a commandto run lint, syntax and spec Gareth Rushgrove
- 78. task :test =>[ :syntax, :lint, :spec, ] Gareth Rushgrove
- 79.
- 80.
- 81.
- 82. Test what actually happens,not what is meant to happen Gareth Rushgrove
- 83.
- 84.
- 85. Test against different operatingsystems Gareth Rushgrove
- 86. HOSTS: ubuntu-server-12042-x64: roles: - master platform: ubuntu-server-12.04-amd64 box:ubuntu-server-12042-x64-vbox4210-nocm box_url: http://puppet-vagrant-boxes.puppetlabs.com/u hypervisor: vagrant ! CONFIG: log_level: verbose type: foss Gareth Rushgrove
- 87. HOSTS: centos-64-x64: roles: - master platform: el-6-x86_64 box: centos-64-x64-vbox4210-nocm box_url : http://puppet-vagrant-boxes.puppetlabs.com/ hypervisor : vagrant ! CONFIG: log_level: verbose type: foss Gareth Rushgrove
- 88.
- 89.
- 90.
- 91. Helpers to install puppetand modules Gareth Rushgrove
- 92.
- 93.
- 94. Test that Puppetruns without errors Gareth Rushgrove
- 95. context 'default parameters'do it 'should work with no errors' do pp = “class { 'sample': }” ! expect(apply_manifest(pp).exit_code).to_not eq(1) end end Gareth Rushgrove
- 96. Test runs are idempotent GarethRushgrove
- 97. context 'default parameters'do it 'should work with no errors' do pp = “class { 'sample': }” ! expect(apply_manifest(pp).exit_code).to_not eq(1) expect(apply_manifest(pp).exit_code).to eq(0) end end Gareth Rushgrove
- 98. Test that themodule installs packages, run services, etc. Gareth Rushgrove
- 99.
- 100. describe package('nginx') do it{ should be_installed } end ! describe service('nginx') do it { should be_enabled } it { should be_running } end ! describe port(80) do it { should be_listening} end Gareth Rushgrove
- 101. Other useful tools (andwhat we’re still missing)
- 102.
- 103.
- 104.
- 106.
- 107. --- language: ruby bundler_args: --withoutdevelopment before_install: rm Gemfile.lock || true rvm: - 1.8.7 - 1.9.3 - 2.0.0 script: bundle exec rake test env: - PUPPET_VERSION="~> 2.7.0" - PUPPET_VERSION="~> 3.1.0" - PUPPET_VERSION="~> 3.2.0" - PUPPET_VERSION="~> 3.3.0" - PUPPET_VERSION="~> 3.4.0" Gareth Rushgrove
- 108.
- 109. matrix: exclude: - rvm: 2.0.0 env:PUPPET_VERSION="~> 2.7.0" - rvm: 2.0.0 env: PUPPET_VERSION="~> 3.1.0" - rvm: 1.9.3 env: PUPPET_VERSION="~> 2.7.0" Gareth Rushgrove
- 110. Experimental code coverage supportin rspec-puppet master Gareth Rushgrove
- 111. at_exit { RSpec::Puppet::Coverage.report!} Gareth Rushgrove
- 112. Total resources: 24 Touchedresources: 8 Resource coverage: 33.33% ! Untouched resources: Class[Nginx] File[preferences.d] Anchor[apt::update] Class[Apt::Params] File[sources.list] Exec[Required packages: 'debian-keyring debian-arch Anchor[apt::source::nginx] Class[Apt::Update] File[configure-apt-proxy] Apt::Key[Add key: 7BD9BF62 from Apt::Source nginx] Anchor[apt::key/Add key: 7BD9BF62 from Apt::Source Anchor[apt::key 7BD9BF62 present] File[nginx.list]Gareth Rushgrove
- 113. A puppet module skeletonwith everything working out of the box Gareth Rushgrove
- 114.
- 115. puppet module generatesample Gareth Rushgrove
- 116. A pretty complete example (TheDocker module)
- 117.
- 118.
- 119. Gareth Rushgrove 50 pullrequest and counting
- 120.
- 121.
- 122.
- 123. 6 classes, 2defines, 413 lines of puppet code, 387 lines of test code Gareth Rushgrove
- 124. Take away (If allyou remember is…)
- 125.
- 126. The first testis the hardest Gareth Rushgrove
- 127. Politely demand tests forcontributions Gareth Rushgrove
- 128. Test the interfacenot the implementation Gareth Rushgrove
- 129. Questions? (And thanks forlistening)