infra-testing-helpers 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: de94109a3f6ebcd8bb5baa59cb2e3c2e41bca81c
+  data.tar.gz: 950e518c5011359ea20d9afca7d15efba8c74203
+SHA512:
+  metadata.gz: 9471040c69fe8765545396325bef988e625f23bf1591a6210a4fca0185d6dbf6e43052e5a4d4584ad6b43bafcab36d3c9fe7e16d71406fbf0a46532fd5c2ac4c
+  data.tar.gz: ba8b44264e4758e553518d2849d3be4caee55437469e3d228818b642fdc32e5e6a8a8d2bece6f620ee3a4f25e7724e9fe6a4068705720d41897de869d13eee30

data/.gitignore

@@ -0,0 +1,3 @@
+.vagrant/
+*.swp
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec 

data/Gemfile.lock

@@ -0,0 +1,47 @@
+PATH
+  remote: .
+  specs:
+    infra-testing-helpers (0.0.1)
+      rspec (~> 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    multi_json (1.11.0)
+    net-scp (1.2.1)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.9.2)
+    rake (10.3.2)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.2)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-its (1.2.0)
+      rspec-core (>= 3.0.0)
+      rspec-expectations (>= 3.0.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+    serverspec (2.10.1)
+      multi_json
+      rspec (~> 3.0)
+      rspec-its
+      specinfra (~> 2.15)
+    specinfra (2.19.3)
+      net-scp
+      net-ssh
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  infra-testing-helpers!
+  rake (~> 10)
+  serverspec (~> 2)

data/README.md

@@ -0,0 +1,66 @@
+# InfraTestingHelpers
+> Your helping hand for infrastructure code testing
+
+InfraTestingHelpers provides integrations with Vagrant, Puppet and Serverspec to make infrastructure code testing easy! I'll show you around to see how it can help you too. There is some assumed knowledge of Serverspec so have a read of the [tutorial] if you haven't done so already
+
+## Serverspec integraton
+Lets say you've written some tests for Serverspec that test your Puppet modules. InfraTestingHelpers provide a way to run your Puppet code against a Vagrant box before validating with Serverspec
+### Setup
+Install with `gem install infra-testing-helpers`
+
+Next, lets have a look at your `spec_helper.rb` (probably generated by Serverspec) and add the parts we need in for InfraTestingHelpers.
+```ruby
+...
+require 'infra_testing_helpers'
+InfraTestingHelpers.module_path = 'modules/:another_module_path/'
+InfraTestingHelpers.site_pp = 'Exec { path => "/sbin:/usr/sbin:/bin:/usr/bin" }'
+InfraTestingHelpers.vagrant_shared_folder = '/etc/puppet'
+...
+```
+- `require 'infra_testing_helpers'` mixes in the functions we will use later in our specs as well as sets up a global `before` hook in RSpec. 
+- `InfraTestingHelpers.module_path` is the location of your modules. This defaults to just `modules/` if nothing is specified. 
+- `InfraTestingHelpers.site_pp` is the contents of your own `site.pp` file. If yours is rather large, you might want to dynamically populate this (`File.read`). Again, this is optional.
+- `InfraTestingHelpers.vagrant_shared_folder` reflects where your shared folder is in your `Vagrantfile`. This defaults to `/vagrant`.
+
+### Specs
+Lets look at an example spec `modules/apache/spec/default/apache_spec.rb`.
+
+``` ruby
+require 'spec_helper'
+apply_manifest 'include apache'
+
+describe 'apache' do
+
+  describe 'its default MPM mode is perfork' do
+    describe process('httpd') do
+      it { should be_running }
+    end
+  end
+  
+  describe 'worker mode' do
+    before do
+      apply_manifest 'class {"apache": mpm => "worker"}'
+      describe process('httpd.woker') do
+        it { should be_running }
+      end
+    end
+  end
+  
+end
+```
+
+Lets apply the manifest with  `rspec modules/apache/spec/default/apache_spec.rb`.
+
+```
+Notice: Compiled catalog for vagrant-ubuntu-trusty-64.local in environment production in 0.05 seconds
+Notice: Finished catalog run in 0.03 seconds
+.Notice: Compiled catalog for vagrant-ubuntu-trusty-64.local in environment production in 0.04 seconds
+Notice: Finished catalog run in 0.01 seconds
+.
+Finished in 6.92 seconds (files took 5.05 seconds to load)
+2 examples, 0 failures
+```
+
+`apply_manifest` will apply Puppet code differently depending on the scope in which it is called. In the global rspec scope, it will apply the manifests before running any tests. If you have multiple specs with `apply_manifest` in the global scope, they are lazily evaluated and run as a single puppet apply. This helps speed up Puppet runs and can detect duplicate resource definitions.
+
+When `apply_manifests` is run within a `before` block it is applied instantly. This is useful for testing manifests that can not co-exist with others or for testing different arguments to the same manifest.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = 'spec/unit/**/*_spec.rb'
+end
+
+RSpec::Core::RakeTask.new(:functional) do |t|
+  t.pattern = 'spec/functional/**/*_spec.rb'
+end

data/Vagrantfile

@@ -0,0 +1,9 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+Vagrant.configure(2) do |config|
+  config.vm.box = "ubuntu/trusty64"
+   config.vm.provider "virtualbox" do |vb|
+     vb.memory = "512"
+   end
+end

data/infra-testing-helpers.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "infra-testing-helpers"
+  spec.version       = '0.0.1'
+  spec.authors       = ["Ryan Doyle"]
+  spec.email         = ["ryan@doylenet.net"]
+  spec.summary       = %q{Integrations with RSpec, Puppet and Vagrant to help infrastructure testing}
+  spec.description   = %q{RSpec helper functions to run Puppet code as part of Serverspec tests}
+  spec.homepage      = "https://github.com/ryandoyle/infra-testing-helpers"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rspec", '~> 3'
+
+  spec.add_development_dependency "serverspec", '~> 2'
+  spec.add_development_dependency "rake", '~> 10'
+
+end

data/lib/infra_testing_helpers.rb

@@ -0,0 +1,41 @@
+require 'infra_testing_helpers/helper'
+
+module InfraTestingHelpers
+
+  @settings = {
+    :module_path         => 'modules/',
+    :site_pp             => '',
+    :vagrant_shared_folder => '/vagrant'
+  }
+
+  def self.vagrant_shared_folder
+    @settings[:vagrant_shared_folder]
+  end
+
+  def self.vagrant_shared_folder=(mount_point)
+    @settings[:vagrant_shared_folder] = mount_point
+  end
+
+  def self.site_pp
+    @settings[:site_pp]
+  end
+
+  def self.site_pp=(puppet_code)
+    @settings[:site_pp] = puppet_code
+  end
+
+  def self.module_path
+    @settings[:module_path]
+  end
+
+  def self.module_path=(path)
+    @settings[:module_path] = path
+  end
+
+end
+
+include InfraTestingHelpers::Helper
+
+RSpec.configure do |c|
+  c.before(:suite)   { apply_all_manifests }
+end

data/lib/infra_testing_helpers/box.rb

@@ -0,0 +1,30 @@
+module InfraTestingHelpers
+  class PuppetApplyFailed < StandardError; end
+  class Box
+    def initialize(name, project_mount_point)
+      @name = name
+      @project_mount_point = project_mount_point
+      @applied = false
+    end
+
+    attr_reader :name
+
+    def apply(manifest)
+      exit_code = run_command("sudo puppet apply --detailed-exitcode --modulepath #{@project_mount_point}/#{manifest.module_path}", :stdin => manifest.puppet_code)
+      raise PuppetApplyFailed unless exit_code == 0 or exit_code == 2
+      @applied = true
+    end
+
+    def applied?
+      @applied
+    end
+
+
+    def run_command(command, opts = {})
+      stdin = opts[:stdin] ? " << EOF\n#{opts[:stdin]}\nEOF" : ""
+      system "vagrant ssh #{@name} --command \"#{command}\"#{stdin}"
+      $?.exitstatus
+    end
+  
+  end
+end

data/lib/infra_testing_helpers/helper.rb

@@ -0,0 +1,33 @@
+require 'infra_testing_helpers/box'
+require 'infra_testing_helpers/site'
+
+module InfraTestingHelpers
+  module Helper
+
+    def apply_manifest(manifest_code)
+      if box.applied?
+        local_site = InfraTestingHelpers::Site.new(InfraTestingHelpers.site_pp, InfraTestingHelpers.module_path)
+        local_site.add_manifest(manifest_code)
+        box.apply(local_site)
+      else
+        global_site.add_manifest(manifest_code)
+      end
+
+    end
+
+    def apply_all_manifests
+      box.apply(global_site)
+    end
+
+    private
+
+    def global_site
+      @@global_site ||= InfraTestingHelpers::Site.new(InfraTestingHelpers.site_pp, InfraTestingHelpers.module_path)
+    end
+
+    def box
+      @@box ||= InfraTestingHelpers::Box.new('default', InfraTestingHelpers.vagrant_shared_folder)
+    end
+
+  end
+end

data/lib/infra_testing_helpers/site.rb

@@ -0,0 +1,21 @@
+module InfraTestingHelpers
+  class Site
+
+    def initialize(site_code, module_path)
+      @site_code = site_code
+      @module_path = module_path
+      @manifest_code = ""
+    end
+
+    attr_reader :module_path
+
+    def add_manifest(manifest)
+      @manifest_code << "#{manifest}\n"
+    end
+
+    def puppet_code
+      "#{@site_code}\n#{@manifest_code}"
+    end
+
+  end
+end

data/spec/functional/modules/test2_manifest/manifests/init.pp

@@ -0,0 +1,3 @@
+class test2_manifest {
+  file {'/tmp/testfile2.txt': ensure => file }
+}

data/spec/functional/modules/test_manifest/manifests/init.pp

@@ -0,0 +1,3 @@
+class test_manifest {
+  file {'/tmp/testfile.txt': ensure => file }
+}

data/spec/functional/sample2_spec.rb

@@ -0,0 +1,7 @@
+require 'functional_spec_helper'
+
+apply_manifest 'include test2_manifest'
+
+describe file('/tmp/testfile2.txt') do
+  it { should be_file }
+end

data/spec/functional/sample_spec.rb

@@ -0,0 +1,12 @@
+require 'functional_spec_helper'
+
+apply_manifest 'include test_manifest'
+
+describe file('/tmp/testfile.txt') do
+
+  before do
+    apply_manifest "file {'/tmp/testfile.txt': ensure => file }"
+  end
+
+  it { should be_file }
+end

data/spec/functional_spec_helper.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+require 'serverspec'
+require 'net/ssh'
+require 'tempfile'
+require 'infra_testing_helpers'
+
+InfraTestingHelpers.module_path = 'spec/functional/modules/'
+InfraTestingHelpers.site_pp = "notify {'This is my site.pp':}"
+
+set :backend, :ssh
+
+host = 'default'
+
+`vagrant up #{host}`
+
+config = Tempfile.new('', Dir.tmpdir)
+config.write(`vagrant ssh-config #{host}`)
+config.close
+
+options = Net::SSH::Config.for(host, [config.path])
+
+options[:user] ||= Etc.getlogin
+
+set :host,        options[:host_name] || host
+set :ssh_options, options

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib/')

data/spec/unit/puppet_vagrant/box_spec.rb

@@ -0,0 +1,96 @@
+require 'spec_helper'
+
+require 'infra_testing_helpers/box'
+
+describe InfraTestingHelpers::Box do
+
+  let(:manifest) { double('Manifest') }
+  let(:box) { described_class.new('default', '/vagrant') }
+  
+  before do 
+    allow_message_expectations_on_nil
+    allow($?).to receive(:exitstatus).and_return(0)
+    allow(manifest).to receive(:module_path).and_return('modules/')
+    allow(manifest).to receive(:puppet_code).and_return('include some_manifest')
+  end
+
+  describe '#apply' do
+
+    it 'successfully applies a manifest to the box' do
+      expect(box).to receive(:run_command).with('sudo puppet apply --detailed-exitcode --modulepath /vagrant/modules/',  {:stdin=>"include some_manifest"}).and_return(0)
+      box.apply(manifest)
+    end
+
+    it 'successfully applies a manifest to the box and deals with weird exit codes' do
+      expect(box).to receive(:run_command).with('sudo puppet apply --detailed-exitcode --modulepath /vagrant/modules/',  {:stdin=>"include some_manifest"}).and_return(2)
+      box.apply(manifest)
+    end
+    
+
+    it 'raises a InfraTestingHelpers::PuppetApplyFailed error if the puppet apply fails' do
+      allow(box).to receive(:run_command).with('sudo puppet apply --detailed-exitcode --modulepath /vagrant/modules/',  {:stdin=>"include some_manifest"}).and_return(1)
+
+      expect{box.apply(manifest)}.to raise_error(InfraTestingHelpers::PuppetApplyFailed)
+    end
+
+
+  end
+
+  describe '#applied?' do
+
+    it 'is false if a manifest has not been applied' do
+      expect(box.applied?).to be false
+    end
+
+    it 'is true when a manifest is applied successfully' do
+      allow(box).to receive(:run_command).and_return(0)
+      box.apply(manifest)
+
+      expect(box.applied?).to be true
+    end
+    it 'is false when a manifest is not applied successfully' do
+      allow(box).to receive(:run_command).with('sudo puppet apply --detailed-exitcode --modulepath /vagrant/modules/',  {:stdin=>"include some_manifest"}).and_return(1)
+      expect{box.apply(manifest)}.to raise_error(InfraTestingHelpers::PuppetApplyFailed)
+
+      expect(box.applied?).to be false
+    end
+
+  end
+
+  describe '#run_command' do
+    it 'runs the command on the box' do
+      expect(box).to receive(:system).with('vagrant ssh default --command "some_command"')
+      box.run_command('some_command')
+    end
+
+    it 'runs the command on the box with the box name' do
+      box = described_class.new('somebox', '/vagrant')
+      expect(box).to receive(:system).with('vagrant ssh somebox --command "some_command"')
+      box.run_command('some_command')
+    end
+
+    it 'returns the exit status of the command that ran' do
+      allow(box).to receive(:system)
+      allow($?).to receive(:exitstatus).and_return(1)
+
+      expect(box.run_command('foo')).to eql(1)
+    end
+
+    it 'pipes stdin to the command if given' do
+      expect(box).to receive(:system).with("vagrant ssh default --command \"some_command\" << EOF\nsomething\nEOF")
+      box.run_command('some_command', :stdin => "something")
+    end
+  end
+
+  describe '#name' do
+    it 'defaults to the "default" box name if not specified' do
+      expect(box.name).to eql 'default'
+    end
+
+    it 'has a name if specified' do
+      box = described_class.new('somebox', '/vagrant')
+      expect(box.name).to eql 'somebox'
+    end
+  end
+
+end

data/spec/unit/puppet_vagrant/helper_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+require 'infra_testing_helpers/helper'
+
+class TestInfraTestingHelper
+  include InfraTestingHelpers::Helper
+end
+
+describe InfraTestingHelpers::Helper do 
+
+  let(:helper) { TestInfraTestingHelper.new }
+  let(:global_site) { double('Global Site') }
+  let(:local_site) { double('Local Site') }
+  let(:box) { double('InfraTestingHelpers::Box') }
+
+
+  before do
+    allow(helper).to receive(:global_site).and_return global_site
+    allow(helper).to receive(:box).and_return box
+    allow(box).to receive(:applied?).and_return false
+    allow(InfraTestingHelpers).to receive(:module_path)
+    allow(InfraTestingHelpers).to receive(:site_pp)
+  end
+
+  describe '#apply_manifest' do
+    it 'adds the manifest to the site to be applied' do
+      expect(global_site).to receive(:add_manifest).with 'include ntp'
+
+      helper.apply_manifest('include ntp')
+    end
+
+    it 'applies the manifest straight away if it was previously applied' do
+      allow(box).to receive(:applied?).and_return true 
+      allow(InfraTestingHelpers::Site).to receive(:new).and_return local_site
+      allow(local_site).to receive(:add_manifest)
+
+      expect(box).to receive(:apply).with(local_site)
+
+      helper.apply_manifest('include ntp')
+    end
+  end
+
+  describe '#apply_all_manifests' do
+    it 'applies all manifests for a site' do
+      expect(box).to receive(:apply).with(global_site)
+
+      helper.apply_all_manifests
+    end
+  end
+end

data/spec/unit/puppet_vagrant/site_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+require 'infra_testing_helpers/site'
+
+describe InfraTestingHelpers::Site do
+
+  let(:site) { described_class.new('site.pp code', '/some/module/path') }
+
+  describe '#puppet_code' do
+    it 'should contain the site.pp code' do
+      expect(site.puppet_code).to include 'site.pp code'
+    end
+    it 'should have a new line between the site code and the manifest code' do
+      site.add_manifest 'include ntp'
+
+      expect(site.puppet_code).to include "site.pp code\ninclude ntp"
+    end
+  end
+
+  describe '#add_manifest' do
+    it 'should add the manifest to the puppet code' do
+      site.add_manifest('include ntp')
+
+      expect(site.puppet_code).to include 'include ntp'
+    end
+    it 'should add a new line after each manifest' do
+      site.add_manifest('include ntp')
+      site.add_manifest('include apache')
+
+      expect(site.puppet_code).to include "include ntp\ninclude apache"
+    end
+  end
+
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: infra-testing-helpers
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan Doyle
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: serverspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+description: RSpec helper functions to run Puppet code as part of Serverspec tests
+email:
+- ryan@doylenet.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- Vagrantfile
+- infra-testing-helpers.gemspec
+- lib/infra_testing_helpers.rb
+- lib/infra_testing_helpers/box.rb
+- lib/infra_testing_helpers/helper.rb
+- lib/infra_testing_helpers/site.rb
+- spec/functional/modules/test2_manifest/manifests/init.pp
+- spec/functional/modules/test_manifest/manifests/init.pp
+- spec/functional/sample2_spec.rb
+- spec/functional/sample_spec.rb
+- spec/functional_spec_helper.rb
+- spec/spec_helper.rb
+- spec/unit/puppet_vagrant/box_spec.rb
+- spec/unit/puppet_vagrant/helper_spec.rb
+- spec/unit/puppet_vagrant/site_spec.rb
+homepage: https://github.com/ryandoyle/infra-testing-helpers
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Integrations with RSpec, Puppet and Vagrant to help infrastructure testing
+test_files:
+- spec/functional/modules/test2_manifest/manifests/init.pp
+- spec/functional/modules/test_manifest/manifests/init.pp
+- spec/functional/sample2_spec.rb
+- spec/functional/sample_spec.rb
+- spec/functional_spec_helper.rb
+- spec/spec_helper.rb
+- spec/unit/puppet_vagrant/box_spec.rb
+- spec/unit/puppet_vagrant/helper_spec.rb
+- spec/unit/puppet_vagrant/site_spec.rb