rspec-puppet-utils 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
-SHA1: 
-  metadata.gz: e9e1b2ce2d09e5a50fff68ae9cc3f1e7e639ec18
-  data.tar.gz: c8184a93084596ce109c344c438107a4914f4cfc
 SHA512: 
-  metadata.gz: e51385d1bdf52f5ade7292fc13cf3b58f27008db4db08ff9c4fb056af3d091042054b3b75737530f26bfbe7ed27d3c98149fa84137823ddb9635ae0ad01c4a77
-  data.tar.gz: 7aa2fe95f16d78ea0382451c6b9de02c3fb2286193f445d74a4c7df308da7d0d7bca6dfd935d334ecadbd8a2448202a0ad024dc9b80974aa3a82bfcf4250b712
+  data.tar.gz: 3e303ac68dc2710bf81b485b78fb9fe2060aa1e362e28bbeecc2c6c7b3d060b82a82cb5c117ef0861ee2a7ab9e6a5b93f9b6d49ae76472849d1f85d8ea335f57
+  metadata.gz: cf4ed17265b26a8e22cd38c093f7029e47e60ede625acebcef3cc921421a98409335e7503e73a21973e220afbdf8caf9579550f58df4cdf85349c877daea5f73
+SHA1: 
+  data.tar.gz: 9de61be3f57bd1a2e660b27afa93fbe3434274a5
+  metadata.gz: f68d290d274904354046b1871b430cbae5e846e4

data/Gemfile

@@ -1,8 +1,8 @@
 source 'https://rubygems.org/'
 
-gem 'puppet'
+gem 'puppet', '~> 3'
 gem 'mocha'
-gem 'rspec'
+gem 'rspec', '3.1.0'
 gem 'rspec-puppet'
 gem 'puppetlabs_spec_helper'
 gem 'thor'

data/README.md

@@ -65,6 +65,64 @@ Clearing the cache ensures tests aren't coupled and order dependent. The downsid
 - You always stub the `execute` method as that gets called internally
 - The `execute` method takes a set of arguments instead of an array of arguments
 
+### MockResource (experimental feature)
+
+I've created a rough version for now just to help myself out, if people find it useful or find bugs, let me know
+
+#####Usage:
+
+To stop your tests dissapearing down a rabbit hole, you can use the rspec-puppet `let(:pre_condition) { ... }` feature to create mock versions of resources that your puppet class depends on. For example:
+
+```puppet
+class my_module::my_class {
+
+  include foo::bar
+  
+  $useful_var = $foo::bar::baz
+  
+  external_module::complex_type { 'complex thing':
+    param_one      => 'one',
+    param_two      => 'two',
+    required_param => 'important value',
+  }
+  
+  <actual stuff you want to test>
+}
+```
+
+In the tests for `my_class`, you don't want to use the actual `foo::bar` and `external_module::complex_type` resources because it could be a lot of complex setup code, it can be difficult to test multiple scenarios, and you are by extension testing these other classes (which should have tests of their own)
+
+You can therefore mock these resources by creating fakes that have the same "interface", but empty bodies:
+```ruby
+let(:pre_condition) { [
+    "class foo::bar { $baz = 'a value' }",
+    "define external_module::complex_type ( $param_one = 'default', $param_two = undef, $required_param ) {}",
+] }
+```
+
+This can get quite complex if there are multiple parameters and/or internal variables. `MockResource` is designed to make it easier to mock out these dependencies
+```ruby
+mock_bar = MockResource.new 'foo::bar', {
+    :vars => { :baz => some_var_you_want_to_use_later }
+}
+
+mock_complex_type = MockResource.new 'external_module::complex_type', {
+    :type => :define,
+    :params => {
+        :param_one      => 'default',
+        :param_two      => :undef,
+        :required_param => nil,
+    }
+}
+
+let(:pre_condition) { [
+    mock_bar.render,
+    mock_complex_thing.render,
+] }
+```
+
+Hopefully you spend less time debugging syntax errors in your test strings, and more time writing useful code
+
 ### TemplateHarness
 
 If your templates have some logic in them that you want to test, you'd ideally like to get hold of the generated template so you can inspect it programmatically rather than just using a regex. In this case use `TemplateHarness`

data/lib/mock_resource.rb

@@ -0,0 +1,43 @@
+module RSpecPuppetUtils
+
+  # MockResource is an experimental feature, API may change!
+  # Use at your own risk... although feedback would be helpful :)
+  class MockResource
+
+    def initialize(name, resource_definition = {})
+      @name = name
+      @resource_definition = resource_definition
+    end
+
+    def render
+      type = @resource_definition[:type] || :class
+      vars = join_vars @resource_definition[:vars], "\n"
+
+      if @resource_definition[:params].nil?
+        param_section = ''
+      else
+        params = join_vars @resource_definition[:params], ', '
+        param_section = "( #{params} )"
+      end
+
+      "#{type} #{@name} #{param_section} { #{vars} }"
+    end
+
+    def join_vars(vars, join_string)
+      return '' unless vars
+      parsed_vars = []
+      vars.each { |key, val|
+        param = "$#{key}"
+        value = normalise_value val
+        val ? parsed_vars.push("#{param} = #{value}") : parsed_vars.push(param)
+      }
+      parsed_vars.join join_string
+    end
+
+    def normalise_value(value)
+      # If string, wrap with quotes
+      value.is_a?(String) ? "'#{value}'" : value
+    end
+
+  end
+end

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.1.0'
+  gem.version       = '2.2.0'
   gem.description   = 'Helper classes for mock/stub functions, templates and hierdata'
   gem.summary       = ''
   gem.author        = 'Tom Poulton'

data/spec/classes/mock_resource_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+require 'lib/mock_resource'
+
+include RSpecPuppetUtils
+
+describe MockResource do
+
+  let(:resource_name) { 'my_mock_resource' }
+  let(:resource_definition) {
+    {
+        :params => {
+            :string_param => 'hello',
+            :undef_param => :undef,
+            :required_param => nil,
+        },
+        :vars => {
+            :my_var_one => 'uno',
+            :my_var_two => 2,
+        }
+    }
+  }
+
+  describe 'render' do
+
+    subject(:mock_resource) { MockResource.new(resource_name, resource_definition).render }
+
+    it 'returns the rendered resource' do
+      expect(mock_resource).to match /class .* \{/
+    end
+
+    it 'adds the name to the resource' do
+      expect(mock_resource).to match /class #{resource_name}/
+    end
+
+    it 'renders string params in quotes' do
+      expect(mock_resource).to match /\(.*\$string_param = 'hello'.*\)/
+    end
+
+    it 'renders undef params without quotes' do
+      expect(mock_resource).to match /\(.*\$undef_param = undef.*\)/
+    end
+
+    it 'renders required params without an assigned value' do
+      expect(mock_resource).to match /\(.*\$required_param(,.*|\s*\))/
+    end
+
+    it 'renders string variables with quotes' do
+      expect(mock_resource).to match /\{.*\$my_var_one = 'uno'.*\}/m
+    end
+
+    it 'renders numerical variables without quotes' do
+      expect(mock_resource).to match /\{.*\$my_var_two = 2.*\}/m
+    end
+
+    context 'when no params are provided' do
+
+      before :each do
+        resource_definition.delete :params
+      end
+
+      it 'renders no parenthesis' do
+        expect(mock_resource).to match /#{resource_name}\s+\{.*\}/m
+      end
+
+    end
+
+    context 'when type is :define' do
+
+      before :each do
+        resource_definition[:type] = :define
+      end
+
+      it 'renders a defined type' do
+        expect(mock_resource).to match /define #{resource_name}/
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rspec-puppet-utils
 version: !ruby/object:Gem::Version 
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors: 
 - Tom Poulton
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2015-07-28 00:00:00 Z
+date: 2015-10-28 00:00:00 Z
 dependencies: []
 
 description: Helper classes for mock/stub functions, templates and hierdata
@@ -28,12 +28,14 @@ files:
 - lib/hieradata/validator.rb
 - lib/hieradata/yaml_validator.rb
 - lib/mock_function.rb
+- lib/mock_resource.rb
 - lib/rspec-puppet-utils.rb
 - lib/template_harness.rb
 - rspec-puppet-utils.gemspec
 - spec/classes/hieradata/validator_spec.rb
 - spec/classes/hieradata/yaml_validator_spec.rb
 - spec/classes/mock_function_spec.rb
+- spec/classes/mock_resource_spec.rb
 - spec/classes/template_harness_spec.rb
 - spec/classes/utils_spec.rb
 - spec/fixtures/hieradata/empty/empty.yaml
@@ -77,6 +79,7 @@ test_files:
 - spec/classes/hieradata/validator_spec.rb
 - spec/classes/hieradata/yaml_validator_spec.rb
 - spec/classes/mock_function_spec.rb
+- spec/classes/mock_resource_spec.rb
 - spec/classes/template_harness_spec.rb
 - spec/classes/utils_spec.rb
 - spec/fixtures/hieradata/empty/empty.yaml