rspec-puppet-utils 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA1: 
-  data.tar.gz: 1cee9e4a75b93b9b3d2bbdd4d9c18d6f224c5448
-  metadata.gz: da8f2e5c38ad50874bfcdba758d6e239922654da
+  data.tar.gz: b0dfaaec1638d3f1d372730e2e988c64e5d9223a
+  metadata.gz: 49631403a559b447615d123c159513b69bea340d
 SHA512: 
-  data.tar.gz: d75f54a18d91e8ca31bf1ed170ec118e35b1253cf9f91ac3dd9e972d4234e91cefcd8a9ec912324d7e92a4683e9d9438a02b28210123caab03e27f3b503a7d71
-  metadata.gz: 8135746b0dfe552fd456f5b5eb747a1180f4c8c943d1918ee8b1beb0b46004fd3dcce66fed644a4c78748279f6dfa7069e952956ef4d28c21783c3976f460983
+  data.tar.gz: d268e8294f419de6ef69486b865b55e3fcfa1bf11d6b5716213154bf306f4f4bc102f0852e84804ae64f453593ce0a3c307704fbf218003fe5bd2735890a8467
+  metadata.gz: a9c3ec8679ca46e3cf44153a62fe5881883247f92af38fe473da8b42bf227722971c8223d3bf9da95e56f3c9c8d01e39e0ab989f0103851026412988bde8e8dd

data/README.md

@@ -2,7 +2,7 @@
 
 This is a more refined version of a previous project about [rspec-puppet unit testing](https://github.com/TomPoulton/rspec-puppet-unit-testing), it provides a class for mocking functions, a harness for testing templates, and a simple tool for testing hiera data files. The motivation for mocking functions etc is provided in that project so I won't go over it here.
 
-See [release notes for v2.0.0](../../wiki/Release-Notes#v200)
+See [release notes for v2.0.1](../../wiki/Release-Notes#v201)
 
 ## Usage
 
@@ -16,13 +16,14 @@ require 'spec_helper'
 describe 'foo::bar' do
 
   let!(:add_stuff) { MockFunction.new('add_stuff') { |f|
-      f.stubs(:call).with([1, 2]).returns(3)
+      f.stub.with([1, 2]).returns(3)
     }
   }
 
   it 'should do something with add_stuff' do
     # Specific stub for this test
-    add_stuff.stubs(:call).with([]).returns(nil)
+    add_stuff.stub.with([]).returns(nil)
+    ...
     ...
   end
 end
@@ -36,8 +37,8 @@ MockFunction.new('func', {:type => :statement})
 You can mock Hiera:
 ```ruby
 MockFunction.new('hiera') { |f|
-  f.stubs(:call).with(['non-ex']).raises(Puppet::ParseError.new('Key not found'))
-  f.stubs(:call).with(['db-password']).returns('password1')
+  f.stub.with(['non-ex']).raises(Puppet::ParseError.new('Key not found'))
+  f.stub.with(['db-password']).returns('password1')
 }
 ```
 You handle when the functions are created yourself, e.g. you can assign it to a local variable `func = MockFunction...` create it in a before block `before(:each) do MockFunction... end` or use let `let!(:func) { MockFunction... }`
@@ -47,6 +48,7 @@ If you use let, **use `let!()` and not `let()`**, this is because lets are lazy-
 Also if you use `let` when mocking hiera, **you can't use `:hiera` as the name due to conflicts** so you have to do something like `let!(:mock_hiera) { MockFunction.new('hiera') }`
 
 Notes:
+- `f.stub` and `f.expect` are helper methods for `f.stubs(:call)` and `f.expects(:call)`
 - You always stub the `call` method as that gets called internally
 - The `call` method takes an array of arguments
 
@@ -105,39 +107,30 @@ describe 'YAML hieradata' do
 
   # Files are loaded recursively
   validator = HieraData::YamlValidator.new('spec/fixtures/hieradata')
+  validator.load_data :ignore_empty
+  # Use load_data without args to catch empty files
 
-  it 'should not contain syntax errors' do
-    # Use true to ignore empty files (default false)
-    expect { validator.load true }.to_not raise_error
+  # Check types
+  it 'should use arrays for api host lists' do
+    validator.validate('my-api-hosts') { |v|
+      expect(v).to be_an Array
+    }
   end
 
-  context 'with valid yaml' do
-
-    validator.load true
-
-    # Check types
-    it 'should use arrays for api host lists' do
-      validator.validate('my-api-hosts') { |v|
-        expect(v).to be_an Array
-      }
-    end
-
-    # Use regex to match keys
-    it 'ports should only contain digits' do
-      validator.validate(/-port$/) { |v|
-        expect(v).to match /^[0-9]+$/
-      }
-    end
-
-    # Supply a list of files that the key must be in
-    # (all matches in all other files are still validated)
-    # :live and :qa correspond to live.yaml and qa.yaml
-    it 'should override password in live and qa' do
-      validator.validate('password', [:live, :qa]) { |v|
-        expect ...
-      }
-    end
+  # Use regex to match keys
+  it 'ports should only contain digits' do
+    validator.validate(/-port$/) { |v|
+      expect(v).to match /^[0-9]+$/
+    }
+  end
 
+  # Supply a list of files that the key must be in
+  # (all matches in all other files are still validated)
+  # :live and :qa correspond to live.yaml and qa.yaml
+  it 'should override password in live and qa' do
+    validator.validate('password', [:live, :qa]) { |v|
+      expect ...
+    }
   end
 
 end
@@ -155,6 +148,8 @@ Diff:
 +"TwoFive"
 ```
 
+For more about usage see the [wiki page](../../wiki/Hiera-Data-Validator)
+
 ## 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/lib/mock_function.rb

@@ -1,4 +1,5 @@
 require 'puppet'
+require 'mocha'
 
 module RSpecPuppetUtils
 
@@ -6,17 +7,27 @@ module RSpecPuppetUtils
 
     def initialize(name, options = {})
       parse_options! options
-      if options[:type] == :rvalue
-        this = self
-        Puppet::Parser::Functions.newfunction(name.to_sym, options) { |args| this.call args}
-        yield self if block_given?
-      else
-        # Even though the puppet function does not return a value,
-        # this mock still needs to do something, what it returns doesn't really matter.
-        Puppet::Parser::Functions.newfunction(name.to_sym, options) { |args| args }
+      this = self
+      Puppet::Parser::Functions.newfunction(name.to_sym, options) { |args| this.call args}
+      yield self if block_given?
+
+      if options[:type] == :statement
+        # call is called on statement function incase expects(:call) is needed
+        # The method is defined incase expects(:call) isn't used
+        def this.call args
+          args
+        end
       end
     end
 
+    def stub
+      self.stubs(:call)
+    end
+
+    def expect
+      self.expects(:call)
+    end
+
     private
 
     def parse_options!(options)

data/rspec-puppet-utils.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |gem|
   gem.name          = 'rspec-puppet-utils'
-  gem.version       = '2.0.1'
+  gem.version       = '2.0.2'
   gem.description   = 'Helper classes for mock/stub functions, templates and hierdata'
   gem.summary       = ''
   gem.author        = 'Tom Poulton'

data/spec/classes/mock_function_spec.rb

@@ -80,15 +80,45 @@ describe MockFunction do
 
   end
 
+  describe '#stub' do
+
+    let(:func) { MockFunction.new('func') }
+
+    it 'should stub #call' do
+      expectation = func.stub
+      expect(expectation).to be_a Mocha::Expectation
+      expect(expectation.matches_method? :call).to eq true
+    end
+
+  end
+
+  describe '#expect' do
+
+    let(:func) { MockFunction.new('func') }
+
+    it 'should register expect on #call' do
+      expectation = func.expect
+      expect(expectation).to be_a Mocha::Expectation
+      expect(expectation.matches_method? :call).to eq true
+      func.call [nil] # satisfy the expect we just created!
+    end
+
+  end
+
   context 'when :type => :statement' do
 
+    let!(:statement) { MockFunction.new 'statement', {:type => :statement} }
+
     it 'should not raise error' do
-      MockFunction.new 'statement', {:type => :statement}
       expect {
         scope.function_statement []
       }.to_not raise_error
     end
 
+    it 'should respond to #call' do
+      expect(statement.respond_to? :call).to eq true
+    end
+
   end
 
   context 'when :type => :rvalue' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rspec-puppet-utils
 version: !ruby/object:Gem::Version 
-  version: 2.0.1
+  version: 2.0.2
 platform: ruby
 authors: 
 - Tom Poulton
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2014-03-24 00:00:00 Z
+date: 2014-03-27 00:00:00 Z
 dependencies: []
 
 description: Helper classes for mock/stub functions, templates and hierdata