rspec-puppet 0.0.9 → 0.1.0

data/README.md

@@ -1,4 +1,4 @@
-# RSpec tests for your Puppet manifests
+# RSpec tests for your Puppet manifests & modules
 
 ## Installation
 
@@ -24,14 +24,18 @@ structure and naming convention.
            |     +-- <class_name>_spec.rb
            |
            +-- defines
+           |     |
+           |     +-- <define_name>_spec.rb
+           |
+           +-- functions
                  |
-                 +-- <define_name>_spec.rb
+                 +-- <function_name>_spec.rb
 
 ## Example groups
 
 If you use the above directory structure, your examples will automatically be
-placed in the correct groups and have access to the custom matchers.  If you
-choose not to, you can force the examples into the required groups as follows.
+placed in the correct groups and have access to the custom matchers.  *If you
+choose not to*, you can force the examples into the required groups as follows.
 
 ```ruby
 describe 'myclass', :type => :class do
@@ -41,11 +45,17 @@ end
 describe 'mydefine', :type => :define do
   ...
 end
+
+describe 'myfunction', :type => :puppet_function do
+  ...
+end
 ```
 
-## Matchers
+## Defined Types & Classes
+
+### Matchers
 
-### Checking if a class has been included
+#### Checking if a class has been included
 
 You can test if a class has been included in the catalogue with the
 `include_class` matcher.  It takes the class name as a string as its only
@@ -55,7 +65,7 @@ argument
 it { should include_class('foo') }
 ```
 
-### Checking if a resources exists
+#### Checking if a resource exists
 
 You can test if a resource exists in the catalogue with the generic
 `contain_<resource type>` matcher.
@@ -85,9 +95,9 @@ generic `without_<parameter>` chains.
 it { should contain_file('/foo/bar').without_mode }
 ```
 
-## Writing tests
+### Writing tests
 
-### Basic test structure
+#### Basic test structure
 
 To test that
 
@@ -112,19 +122,19 @@ describe 'sysctl' do
 end
 ```
 
-### Specifying the title of a resource
+#### Specifying the title of a resource
 
 ```ruby
 let(:title) { 'foo' }
 ```
 
-### Specifying the parameters to pass to a resources or parametised class
+#### Specifying the parameters to pass to a resources or parametised class
 
 ```ruby
 let(:params) { {:ensure => 'present', ...} }
 ```
 
-### Specifying the FQDN of the test node
+#### Specifying the FQDN of the test node
 
 If the manifest you're testing expects to run on host with a particular name,
 you can specify this as follows
@@ -133,7 +143,7 @@ you can specify this as follows
 let(:node) { 'testhost.example.com' }
 ```
 
-### Specifying the facts that should be available to your manifest
+#### Specifying the facts that should be available to your manifest
 
 By default, the test environment contains no facts for your manifest to use.
 You can set them with a hash
@@ -142,7 +152,7 @@ You can set them with a hash
 let(:facts) { {:operatingsystem => 'Debian', :kernel => 'Linux', ...} }
 ```
 
-### Specifying the path to find your modules
+#### Specifying the path to find your modules
 
 I recommend setting a default module path by adding the following code to your
 `spec_helper.rb`
@@ -158,3 +168,97 @@ However, if you want to specify it in each example, you can do so
 ```ruby
 let(:module_path) { '/path/to/your/module/dir' }
 ```
+
+## Functions
+
+### Matchers
+
+All of the standard RSpec matchers are available for you to use when testing
+Puppet functions.
+
+```ruby
+it 'should be able to do something' do
+  subject.call('foo') == 'bar'
+end
+```
+
+For your convenience though, a `run` matcher exists to provide easier to
+understand test cases.
+
+```ruby
+it { should run.with_params('foo').and_return('bar') }
+```
+
+### Writing tests
+
+#### Basic test structure
+
+```ruby
+require 'spec_helper'
+
+describe '<function name>' do
+  ...
+end
+```
+
+#### Specifying the name of the function to test
+
+The name of the function must be provided in the top level description, e.g.
+
+```ruby
+describe 'split' do
+```
+
+#### Specifying the arguments to pass to the function
+
+You can specify the arguments to pass to your function during the test(s) using
+either the `with_params` chain method in the `run` matcher
+
+```ruby
+it { should run.with_params('foo', 'bar', ['baz']) }
+```
+
+Or by using the `call` method on the subject directly
+
+```ruby
+it 'something' do
+  subject.call('foo', 'bar', ['baz'])
+end
+```
+
+#### Testing the results of the function
+
+You can test the result of a function (if it produces one) using either the
+`and_returns` chain method in the `run` matcher
+
+```ruby
+it { should run.with_params('foo').and_return('bar') }
+```
+
+Or by using any of the existing RSpec matchers on the subject directly
+
+```ruby
+it 'something' do
+  subject.call('foo') == 'bar'
+  subject.call('baz').should be_an Array
+end
+```
+
+#### Testing the errors thrown by the function
+
+You can test whether the function throws an exception using either the
+`and_raises_error` chain method in the `run` matcher
+
+```ruby
+it { should run.with_params('a', 'b').and_raise_error(Puppet::ParseError) }
+it { should_not run.with_params('a').and_raise_error(Puppet::ParseError) }
+```
+
+Or by using the existing `raises_error` RSpec matcher
+
+```ruby
+it 'something' do
+  expect { subject.call('a', 'b') }.should raise_error(Puppet::ParseError)
+  expect { subject.call('a') }.should_not raise_error(Puppet::ParseError)
+end
+```

data/lib/rspec-puppet/example.rb

@@ -1,6 +1,7 @@
 require 'rspec-puppet/support'
 require 'rspec-puppet/example/define_example_group'
 require 'rspec-puppet/example/class_example_group'
+require 'rspec-puppet/example/function_example_group'
 
 RSpec::configure do |c|
   def c.escaped_path(*parts)
@@ -14,4 +15,8 @@ RSpec::configure do |c|
   c.include RSpec::Puppet::ClassExampleGroup, :type => :class, :example_group => {
     :file_path => c.escaped_path(%w[spec classes])
   }
+
+  c.include RSpec::Puppet::FunctionExampleGroup, :type => :puppet_function, :example_group => {
+    :file_path => c.escaped_path(%w[spec functions])
+  }
 end

data/lib/rspec-puppet/example/class_example_group.rb

@@ -1,6 +1,6 @@
 module RSpec::Puppet
   module ClassExampleGroup
-    include RSpec::Puppet::Matchers
+    include RSpec::Puppet::ManifestMatchers
     include RSpec::Puppet::Support
 
     def subject

data/lib/rspec-puppet/example/define_example_group.rb

@@ -1,6 +1,6 @@
 module RSpec::Puppet
   module DefineExampleGroup
-    include RSpec::Puppet::Matchers
+    include RSpec::Puppet::ManifestMatchers
     include RSpec::Puppet::Support
 
     def subject

data/lib/rspec-puppet/example/function_example_group.rb

@@ -0,0 +1,17 @@
+module RSpec::Puppet
+  module FunctionExampleGroup
+    include RSpec::Puppet::FunctionMatchers
+
+    def subject
+      function_name = self.class.top_level_description.downcase
+
+      Puppet[:modulepath] = self.respond_to?(:module_path) ? module_path : RSpec.configuration.module_path
+      Puppet[:libdir] = Dir["#{Puppet[:modulepath]}/*/lib"].entries.join(File::PATH_SEPARATOR)
+      Puppet::Parser::Functions.autoloader.loadall
+
+      scope = Puppet::Parser::Scope.new
+
+      scope.method "function_#{function_name}".to_sym
+    end
+  end
+end

data/lib/rspec-puppet/matchers.rb

@@ -1,3 +1,4 @@
 require 'rspec-puppet/matchers/create_generic'
 require 'rspec-puppet/matchers/create_resource'
 require 'rspec-puppet/matchers/include_class'
+require 'rspec-puppet/matchers/run'

data/lib/rspec-puppet/matchers/create_generic.rb

@@ -1,5 +1,5 @@
 module RSpec::Puppet
-  module Matchers
+  module ManifestMatchers
     class CreateGeneric
       def initialize(*args, &block)
         @exp_resource_type = args.shift.to_s.gsub(/^(create|contain)_/, '')
@@ -76,7 +76,7 @@ module RSpec::Puppet
     end
 
     def method_missing(method, *args, &block)
-      return RSpec::Puppet::Matchers::CreateGeneric.new(method, *args, &block) if method.to_s =~ /^(create|contain)_/
+      return RSpec::Puppet::ManifestMatchers::CreateGeneric.new(method, *args, &block) if method.to_s =~ /^(create|contain)_/
       super
     end
   end

data/lib/rspec-puppet/matchers/create_resource.rb

@@ -1,5 +1,5 @@
 module RSpec::Puppet
-  module Matchers
+  module ManifestMatchers
     extend RSpec::Matchers::DSL
 
     matcher :create_resource do |expected_type, expected_title|

data/lib/rspec-puppet/matchers/include_class.rb

@@ -1,5 +1,5 @@
 module RSpec::Puppet
-  module Matchers
+  module ManifestMatchers
     extend RSpec::Matchers::DSL
 
     matcher :include_class do |expected_class|

data/lib/rspec-puppet/matchers/run.rb

@@ -0,0 +1,76 @@
+module RSpec::Puppet
+  module FunctionMatchers
+    extend RSpec::Matchers::DSL
+
+    matcher :run do
+      match do |func_obj|
+        if @params
+          @func = lambda { func_obj.call(@params) }
+        else
+          @func = lambda { func_obj.call }
+        end
+
+        if @expected_error
+          begin
+            @func.call
+          rescue @expected_error
+            #XXX check error string here
+            true
+          rescue
+            false
+          end
+        else
+          if @expected_return
+            @func.call == @expected_return
+          else
+            begin
+              @func.call
+            rescue
+              false
+            end
+            true
+          end
+        end
+      end
+
+      chain :with_params do |*params|
+        @params = params
+      end
+
+      chain :and_return do |value|
+        @expected_return = value
+      end
+
+      # XXX support error string and regexp
+      chain :and_raise_error do |value|
+        @expected_error = value
+      end
+
+      failure_message_for_should do |func_obj|
+        func_name = func_obj.name.gsub(/^function_/, '')
+        func_params = @params.inspect[1..-2]
+
+        if @expected_return
+          "expected #{func_name}(#{func_params}) to have returned #{@expected_return.inspect} instead of #{@func.call.inspect}"
+        elsif @expected_error
+          "expected #{func_name}(#{func_params}) to have raised #{@expected_error.inspect}"
+        else
+          "expected #{func_name}(#{func_params}) to have run successfully"
+        end
+      end
+
+      failure_message_for_should_not do |func_obj|
+        func_name = func_obj.name.gsub(/^function_/, '')
+        func_params = @params.inspect[1..-2]
+
+        if @expected_return
+          "expected #{func_name}(#{func_params}) to not have returned #{@expected_return.inspect}"
+        elsif @expected_error
+          "expected #{func_name}(#{func_params}) to not have raised #{@expected_error.inspect}"
+        else
+          "expected #{func_name}(#{func_params}) to not have run successfully"
+        end
+      end
+    end
+  end
+end

data/rspec-puppet.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'rspec-puppet'
-  s.version = '0.0.9'
+  s.version = '0.1.0'
   s.homepage = 'https://github.com/rodjek/rspec-puppet/'
   s.summary = 'RSpec tests for your Puppet manifests'
   s.description = 'RSpec tests for your Puppet manifests'
@@ -8,10 +8,12 @@ Gem::Specification.new do |s|
   s.files = [
     'lib/rspec-puppet/example/class_example_group.rb',
     'lib/rspec-puppet/example/define_example_group.rb',
+    'lib/rspec-puppet/example/function_example_group.rb',
     'lib/rspec-puppet/example.rb',
     'lib/rspec-puppet/matchers/create_generic.rb',
     'lib/rspec-puppet/matchers/create_resource.rb',
     'lib/rspec-puppet/matchers/include_class.rb',
+    'lib/rspec-puppet/matchers/run.rb',
     'lib/rspec-puppet/matchers.rb',
     'lib/rspec-puppet/support.rb',
     'lib/rspec-puppet.rb',
@@ -25,6 +27,7 @@ Gem::Specification.new do |s|
     'spec/defines/sysctl_spec.rb',
     'spec/fixtures/boolean/manifests/init.pp',
     'spec/fixtures/sysctl/manifests/init.pp',
+    'spec/functions/split_spec.rb',
     'spec/spec_helper.rb',
   ]
 

data/spec/functions/split_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe 'split' do
+  it { should run.with_params('aoeu', 'o').and_return(['a', 'eu']) }
+  it { should run.with_params('foo').and_raise_error(Puppet::ParseError) }
+  it { should_not run.with_params('foo').and_raise_error(Puppet::DevError) }
+
+  it 'something' do
+    expect { subject.call('foo') }.should raise_error(Puppet::ParseError)
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rspec-puppet
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 27
   prerelease: 
   segments: 
   - 0
+  - 1
   - 0
-  - 9
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors: 
 - Tim Sharpe
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-16 00:00:00 Z
+date: 2011-11-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -42,10 +42,12 @@ extra_rdoc_files: []
 files: 
 - lib/rspec-puppet/example/class_example_group.rb
 - lib/rspec-puppet/example/define_example_group.rb
+- lib/rspec-puppet/example/function_example_group.rb
 - lib/rspec-puppet/example.rb
 - lib/rspec-puppet/matchers/create_generic.rb
 - lib/rspec-puppet/matchers/create_resource.rb
 - lib/rspec-puppet/matchers/include_class.rb
+- lib/rspec-puppet/matchers/run.rb
 - lib/rspec-puppet/matchers.rb
 - lib/rspec-puppet/support.rb
 - lib/rspec-puppet.rb
@@ -59,6 +61,7 @@ files:
 - spec/defines/sysctl_spec.rb
 - spec/fixtures/boolean/manifests/init.pp
 - spec/fixtures/sysctl/manifests/init.pp
+- spec/functions/split_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/rodjek/rspec-puppet/
 licenses: []