rspec-puppet-utils 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA512: 
+  metadata.gz: 73d31647aca9a8ea92a51e91875d9428ddf36d65522e540205bd22fc056c577c025bac30e777479234c390977a1b13d815a64ebb5a33e742543e489b59493d80
+  data.tar.gz: 875c88ed3de884c3acdf8341e3dc675d011fba4f04b112ac3f9cb370580af86ba5ec9d256c0f82c62787b151035903bc1e5e40b11b3f8b1a1ac8cfab6026c2a6
+SHA1: 
+  metadata.gz: a44abeac9ab5e7f480bc8a9e0d1587cd41e8d596
+  data.tar.gz: 69010a95237c2e8c0c0e8777b266e98d7c00e3ae

data/.gitignore

@@ -0,0 +1,6 @@
+.idea
+*.iml
+.ruby-version
+.ruby-gemset
+Gemfile.lock
+pkg

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org/'
+
+gem 'puppet'
+gem 'mocha'
+gem 'rspec'
+gem 'rspec-puppet'
+gem 'puppetlabs_spec_helper'

data/README.md

@@ -0,0 +1,97 @@
+# rspec-puppet-utils
+
+This is the continuation of a previous project about [rspec-puppet unit testing](https://github.com/TomPoulton/rspec-puppet-unit-testing), it provides a more refined version of the helper method for mocking functions, plus a harness for testing templates. The motivation for mocking functions etc is provided there so I won't go over it here.
+
+## Usage
+
+### MockFunction
+
+The basic usage is to create your mock function with `MockFunction.new` and then use `mocha` to stub any particular calls that you need
+
+```ruby
+require 'spec_helper'
+
+describe 'foo::bar' do
+
+  add_stuff = MockFunction.new(self, 'add_stuff')
+  before(:each) do
+    add_stuff.stubs(:call).with([1, 2]).returns(3)
+  end
+
+  it 'should do something with add_stuff' do
+    ...
+  end
+end
+```
+
+You can specify a default value:
+```ruby
+func = MockFunction.new(self, 'func', {:default_value => true})
+```
+
+You can mock a function that doesn't return a value (`:rvalue` is the default):
+```ruby
+func = MockFunction.new(self, 'func', {:type => :statement})
+```
+
+You can mock Hiera:
+```ruby
+hiera = MockFunction.new(self, 'hiera')
+before(:each) do
+  hiera.stubs(:call).with(['non-ex']).raises(Puppet::ParseError.new('Key not found'))
+  hiera.stubs(:call).with(['db-password']).returns('password1')
+end
+```
+
+Note:
+- You always stub the `call` method as that gets called internally
+- The `call` method takes an array of arguments
+- `self` is a way of getting hold of the current `RSpec::Core::ExampleGroup` instance. If anyone knows how to do this more cleanly let me know!
+
+### TemplateHarness
+
+If your templates have some logic in them that you want to test, and you'd ideally like to get hold of the generated template so you can inspect it programatically rather than just using a regex then use `TemplateHarness`
+
+Given a basic template:
+
+
+```ruby
+<%
+    from_class = @class_var
+    from_fact  = scope.lookupvar('fact-name')
+    from_hiera = scope.function_hiera('hiera-key')
+-%>
+<%= "#{from_class} #{from_fact} #{from_hiera}" %>
+
+```
+
+A test could look like this:
+
+
+```ruby
+require 'spec_helper'
+
+describe 'my_template' do
+
+  let(:scope) { PuppetlabsSpec::PuppetInternals.scope }
+  before(:each) do
+    scope.stubs(:lookupvar).with('fact-name').returns('fact-value')
+    scope.stubs(:function_hiera).with('hiera-key').returns('hiera-value')
+  end
+  
+  it 'should render template' do
+    harness = TemplateHarness.new('spec/.../.../my_template.erb', scope)
+    harness.set('@class_var', 'classy')
+    result = harness.run
+    expect(result).to eq 'classy fact-value hiera-value'
+  end
+
+end
+```
+
+Note:
+- The path resolution is pretty simple, just pass it a normal relative path, **not** like the paths you pass into the `template` function in puppet (where you expect puppet to add the `templates` section to the path)
+
+## Setup
+- Add `rspec-puppet-utils` to your Gemfile (or use `gem install rspec-puppet-utils`)
+- Add `require 'rspec-puppet-utils'` to the top of your `spec_helper`

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:rspec)
+
+task :build => :rspec

data/lib/rspec-puppet-utils.rb

@@ -0,0 +1,64 @@
+require 'rspec-puppet'
+require 'mocha'
+require 'erb'
+
+RSpec.configure do |c|
+  c.mock_with :mocha
+end
+
+class MockFunction
+
+  attr_accessor :function_type, :has_default_value, :default_value
+
+  def initialize(example_group, name, options = {})
+    opts = options.nil? ? {} : options
+
+    @function_type = opts.has_key?(:type) ? opts[:type] : :rvalue
+
+    opts[:default_value] = nil if @function_type == :statement
+
+    @has_default_value = false
+    if opts.has_key?(:default_value)
+      @has_default_value = true
+      @default_value = opts[:default_value]
+    end
+
+    this = self
+    example_group.before(:each) {
+      Puppet::Parser::Functions.newfunction(name.to_sym, {:type => this.function_type}) { |args| this.call(args) }
+      this.stubs(:call).returns(this.default_value) if this.has_default_value
+    }
+  end
+end
+
+class TemplateHarness
+
+  def initialize(template, scope = nil)
+    @template = template
+    @isolator = Isolator.new(scope)
+  end
+
+  def set(name, value)
+    var_name = name.start_with?('@') ? name : "@#{name}"
+    @isolator.instance_variable_set(var_name, value)
+  end
+
+  def run
+    b = @isolator.get_binding
+    template = File.exists?(@template) ? File.new(@template).read : @template
+    ERB.new(template, 0, '-').result b
+  end
+
+  class Isolator
+    # Isolates the binding so that only the defined set
+    # of instance variables are available to erb
+    def initialize scope
+      @scope = scope
+    end
+    def get_binding
+      scope = @scope
+      binding
+    end
+  end
+
+end

data/rspec-puppet-utils.gemspec

@@ -0,0 +1,14 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.name          = 'rspec-puppet-utils'
+  gem.version       = '1.0.0'
+  gem.description   = 'Helper classes for mock functions and templates'
+  gem.summary       = ''
+  gem.author        = 'Tom Poulton'
+  #gem.license       = ''
+
+  gem.homepage      = 'https://github.com/Accuity/rspec-puppet-utils'
+  gem.files         = `git ls-files`.split($/)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+end

data/spec/classes/mock_function_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper'
+require 'rspec-puppet-utils'
+
+describe MockFunction do
+
+  let(:scope) { PuppetlabsSpec::PuppetInternals.scope }
+
+  context 'with no options' do
+
+    func = MockFunction.new(self, 'func')
+
+    it 'should return an object' do
+      expect(func).to_not eq nil
+    end
+
+    it 'should not attach stub method to object' do
+      expect { func.call 'a' }.to raise_error NoMethodError
+    end
+
+    it 'should set function_type to :rvalue' do
+      expect(func.function_type).to eq :rvalue
+    end
+
+  end
+
+  context 'with options set to nil' do
+
+    it 'should not throw error creating function' do
+      expect { MockFunction.new(example.example_group, 'nil_options', nil) }.to_not raise_error
+    end
+
+  end
+
+  context 'with a default value of true' do
+
+    default_of_true = MockFunction.new(self, 'default_of_true', {:default_value => true})
+
+    it 'function should return true' do
+      expect(default_of_true.call 'a').to eq true
+    end
+
+  end
+
+  context 'with a default value of nil' do
+
+    default_of_nil = MockFunction.new(self, 'default_of_nil', {:default_value => nil})
+
+    it 'function should return true' do
+      expect(default_of_nil.call 'a').to eq nil
+    end
+
+  end
+
+  context 'with a type of :statement' do
+
+    statement = MockFunction.new(self, 'statement', {:type => :statement})
+
+    it 'should set function_type to :statement' do
+      expect(statement.function_type).to eq :statement
+    end
+
+    it 'should wire up a stub call method' do
+      expect { statement.call }.to_not raise_error
+    end
+
+  end
+
+  context 'when using a puppet scope' do
+
+    func = MockFunction.new(self, 'func', {:default_value => true})
+
+    it 'puppet should be able to call function' do
+      result = scope.function_func ['a']
+      expect(result).to eq true
+    end
+
+    it 'should be able to stub calls' do
+      func.stubs(:call).with([1, 2]).returns(3)
+      result = scope.function_func [1, 2]
+      expect(result).to eq 3
+    end
+
+  end
+
+end

data/spec/classes/template_harness_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'rspec-puppet-utils'
+
+describe TemplateHarness do
+
+  it 'should render template' do
+    harness = TemplateHarness.new('<%= "inside template" %>')
+    expect(harness.run).to eq 'inside template'
+  end
+
+  it 'should handle -%> syntax' do
+    harness = TemplateHarness.new('<% animal = "penguin" -%><%= animal %>')
+    expect { harness.run }.to_not raise_error
+  end
+
+  it 'should provide access to scope' do
+    scope = PuppetlabsSpec::PuppetInternals.scope
+    scope.stubs(:lookupvar).with('honey').returns('badger')
+    harness = TemplateHarness.new('<%= scope.lookupvar("honey") %>', scope)
+    expect(harness.run).to eq 'badger'
+  end
+
+  it 'should provide access to instance vars' do
+    harness = TemplateHarness.new('<%= @foo %>')
+    harness.set('@foo', 'bar')
+    expect(harness.run).to eq 'bar'
+  end
+
+  it 'should add @ to instance vars when missing' do
+    harness = TemplateHarness.new('<%= @alice %>')
+    harness.set('alice', 'bob')
+    expect(harness.run).to eq 'bob'
+  end
+
+  it 'should isolate instance vars' do
+    harness = TemplateHarness.new('<%= @not_exist %>')
+    harness.instance_variable_set('@not_exist', 'pixies')
+    expect(harness.run).to eq ''
+  end
+
+  it 'should read file if it exists' do
+    harness = TemplateHarness.new('spec/fixtures/templates/returns_elephant.erb')
+    expect(harness.run).to eq 'elephant'
+  end
+
+end

data/spec/fixtures/templates/returns_elephant.erb

@@ -0,0 +1 @@
+<%= 'elephant' %>

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rspec-puppet'
+require 'puppetlabs_spec_helper/module_spec_helper'
+
+RSpec.configure do |c|
+  c.color = true
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification 
+name: rspec-puppet-utils
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Tom Poulton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2014-03-04 00:00:00 Z
+dependencies: []
+
+description: Helper classes for mock functions and templates
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/rspec-puppet-utils.rb
+- rspec-puppet-utils.gemspec
+- spec/classes/mock_function_spec.rb
+- spec/classes/template_harness_spec.rb
+- spec/fixtures/templates/returns_elephant.erb
+- spec/spec_helper.rb
+homepage: https://github.com/Accuity/rspec-puppet-utils
+licenses: []
+
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - &id001 
+    - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id001
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: ""
+test_files: 
+- spec/classes/mock_function_spec.rb
+- spec/classes/template_harness_spec.rb
+- spec/fixtures/templates/returns_elephant.erb
+- spec/spec_helper.rb