hiera-puppet-helper 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA512: 
+  metadata.gz: 6865edd07321653bcbd6d79820e025cb123ad18990468c1d28057df1886b2aa9e1430ee695c0e9bb6b10ac3049915de58c48f9ce248225d1c25fd3c5e2b32f2e
+  data.tar.gz: cd834a8a545bced7409efa40f624acdd959a51b8d42c14ebcc53870b01c24587de1cf8eda807ab633dd38653889ed2c332c839a6e7488a963e986eac39637568
+SHA1: 
+  metadata.gz: 71e91d3a9d2fdda500f25ac85e0567c1253f13c8
+  data.tar.gz: 022b038e0166688d4fa7e655f10f6dfc9ca603c9

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-hiera-puppet.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Michael Franz Aigner
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,131 @@
+# Rspec::Hiera::Puppet
+
+Hiera fixtures for puppet-rspec tests.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rspec-hiera-puppet'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rspec-hiera-puppet
+
+## Usage
+
+### Basic
+
+The following assumes that you are already be familiar with
+[rspec-puppet](https://github.com/rodjek/rspec-puppet/).
+
+To use this gem add the following include to spec/spec\_helper.rb:
+
+    require 'rspec-hiera-puppet'
+
+For the purpose of demonstrating a Hiera fixture, lets assume there is the
+following contrived example of a Puppet class:
+
+  _modules/example/manifests/init.pp_
+
+    class example {
+      notify { 'foo': message => hiera('foo_message') }
+    }
+
+In your specs for this class you can define a Hiera fixture by setting
+'hiera\_data' to a hash that contains the data that you want the Puppet
+'hiera' function to return:
+
+  _spec/classes/example\_spec.rb_
+
+    describe "example" do
+      let(:hiera_data) { { :foo_message => "bar" } }
+
+      it { should contain_notify("foo").with_message("bar") }
+    end
+
+### Advanced
+
+It is possible to load the hiera fixtures with any Hiera backend, just define
+a method 'hiera\_config' that returns the desired Hiera configuration. For a
+list of possible configuration options, see
+[https://github.com/puppetlabs/hiera#configuration](https://github.com/puppetlabs/hiera#configuration).
+
+The following example spec loads the Hiera fixture data from Yaml files:
+
+  _spec/classes/example\_spec.rb_
+
+    describe "example" do
+      let(:hiera_config) do
+        { :backends => ['yaml'],
+          :hierarchy => [
+            '%{fqdn}/%{calling_module}',
+            '%{calling_module}'],
+          :yaml => {
+            :datadir => File.expand_path(File.join(__FILE__, '..', '..', 'hieradata')) }}
+      end
+
+      it { should contain_notify("foo").with_message("bar") }
+    end
+
+Be aware that setting 'hiera\_config' takes precedence before setting
+'hiera\_data', meaning with the above Hiera configuration, the value of
+'hiera\_data' will be ignored. The next example will demonstrate how to address
+that.
+
+If you want a combination of fixture data from Yaml files and fixture data from
+'hiera\_data', you can use the Hiera 'rspec' backend, which is also provided
+by this gem. The 'rspec' backend uses its configuration hash as data store to
+look up data. The following example combine both the 'rspec' backend, and the
+'yaml' backend, with the effect that the data is first looked up in the
+'hiera\_data' fixture defined by the spec and then in Yaml files as well:
+
+  _spec/classes/example\_spec.rb_
+
+    describe "example" do
+      let(:hiera_config) do
+        { :backends => ['rspec', 'yaml'],
+          :hierarchy => [
+            '%{fqdn}/%{calling_module}',
+            '%{calling_module}'],
+          :yaml => {
+            :datadir => File.expand_path(File.join(__FILE__, '..', '..', 'hieradata')) },
+          :rspec => respond_to?(:hiera_data) ? hiera_data : {} }
+      end
+
+      it { should contain_notify("foo").with_message("bar") }
+    end
+
+To avoid having to copy-paste the Hier configuration into each and every spec,
+you can use a shared context. The following is a full-featured example that
+demonstrates the use of a shared context.
+
+  _spec/spec\_helper.rb_
+
+    require 'rspec-hiera-puppet'
+
+    fixture_path = File.expand_path(File.join(__FILE__, '..', 'fixtures'))
+
+    shared_context "hieradata" do
+      let(:hiera_config) do
+        { :backends => ['rspec', 'yaml'],
+          :hierarchy => [
+            '%{fqdn}/%{calling_module}',
+            '%{calling_module}'],
+          :yaml => {
+            :datadir => File.join(fixture_path, 'hieradata') },
+          :rspec => respond_to?(:hiera_data) ? hiera_data : {} }
+      end
+    end
+
+  _spec/classes/example\_spec.rb_
+
+    describe "example" do
+      include_context "hieradata"
+
+      it { should contain_notify("foo").with_message("bar") }
+    end

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/hiera-puppet-helper.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/hiera-puppet-helper/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Maarten Thibaut"]
+  gem.email         = ["mthibaut@cisco.com"]
+  gem.description   = %q{Hiera fixtures for rspec-puppet tests.}
+  gem.summary       = %q{Hiera fixtures for rspec-puppet tests.}
+  gem.homepage      = "https://github.com/mthibaut/rspec-hiera-puppet"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "hiera-puppet-helper"
+  gem.require_paths = ["lib"]
+  gem.version       = Rspec::Hiera::Puppet::VERSION
+
+  gem.add_dependency('puppet', '>= 3.0')
+  gem.add_dependency('hiera', '>= 1.0')
+  gem.add_dependency('hiera-puppet', '>= 1.0')
+  gem.add_dependency('rspec')
+  gem.add_dependency('rspec-puppet')
+end

data/lib/hiera-puppet-helper.rb

@@ -0,0 +1,3 @@
+require 'hiera-puppet-helper/version'
+require 'hiera-puppet-helper/puppet'
+require 'hiera-puppet-helper/rspec'

data/lib/hiera-puppet-helper/puppet.rb

@@ -0,0 +1,146 @@
+require 'puppet'
+
+class Puppet::Parser::Compiler
+  alias_method :compile_unadorned, :compile
+
+  def compile
+    spec = Thread.current[:spec]
+
+    if spec
+      register_function_hiera(spec)
+      register_function_hiera_array(spec)
+      register_function_hiera_hash(spec)
+      register_function_hiera_include(spec)
+    end
+
+    compile_unadorned
+  end
+
+  def register_function_hiera(spec)
+    Puppet::Parser::Functions.newfunction(:hiera, :type => :rvalue) do |*args|
+      # Functions called from puppet manifests that look like this:
+      # lookup("foo", "bar")
+      # internally in puppet are invoked: func(["foo", "bar"])
+      #
+      # where as calling from templates should work like this:
+      # scope.function_lookup("foo", "bar")
+      #
+      # Therefore, declare this function with args '*args' to accept any number
+      # of arguments and deal with puppet's special calling mechanism now:
+      if args[0].is_a?(Array)
+        args = args[0]
+      end
+
+      key = args[0]
+      default = args[1]
+      override = args[2]
+
+      require 'hiera'
+      require 'hiera/scope'
+
+      hiera = Hiera.new(:config => spec.hiera_config.merge(:logger => 'puppet'))
+
+      if self.respond_to?("[]")
+        hiera_scope = self
+      else
+        hiera_scope = Hiera::Scope.new(self)
+      end
+
+      answer = hiera.lookup(key, default, hiera_scope, override, :priority)
+
+      raise(Puppet::ParseError, "Could not find data item #{key} in any Hiera data file and no default supplied") if answer.nil?
+
+      return answer
+    end
+  end
+
+  def register_function_hiera_array(spec)
+    Puppet::Parser::Functions.newfunction(:hiera_array, :type => :rvalue) do |*args|
+      if args[0].is_a?(Array)
+        args = args[0]
+      end
+
+      key = args[0]
+      default = args[1]
+      override = args[2]
+
+      require 'hiera'
+      require 'hiera/scope'
+
+      hiera = Hiera.new(:config => spec.hiera_config.merge(:logger => 'puppet'))
+
+      if self.respond_to?("[]")
+        hiera_scope = self
+      else
+        hiera_scope = Hiera::Scope.new(self)
+      end
+
+      answer = hiera.lookup(key, default, hiera_scope, override, :array)
+
+      raise(Puppet::ParseError, "Could not find data item #{key} in any Hiera data file and no default supplied") if answer.empty?
+
+      answer
+    end
+  end
+
+  def register_function_hiera_hash(spec)
+    Puppet::Parser::Functions.newfunction(:hiera_hash, :type => :rvalue) do |*args|
+      if args[0].is_a?(Array)
+        args = args[0]
+      end
+
+      raise(Puppet::ParseError, "Please supply a parameter to perform a Hiera lookup") if args.empty?
+
+      key = args[0]
+      default = args[1]
+      override = args[2]
+
+      require 'hiera'
+      require 'hiera/scope'
+
+      hiera = Hiera.new(:config => spec.hiera_config.merge(:logger => 'puppet'))
+
+      if self.respond_to?("{}")
+        hiera_scope = self
+      else
+        hiera_scope = Hiera::Scope.new(self)
+      end
+
+      answer = hiera.lookup(key, default, hiera_scope, override, :hash)
+
+      raise(Puppet::ParseError, "Could not find data item #{key} in any Hiera data file and no default supplied") if answer.empty?
+
+      answer
+    end
+  end
+
+  def register_function_hiera_include(spec)
+    Puppet::Parser::Functions.newfunction(:hiera_include) do |*args|
+      if args[0].is_a?(Array)
+        args = args[0]
+      end
+
+      key = args[0]
+      default = args[1]
+      override = args[2]
+
+      require 'hiera'
+      require 'hiera/scope'
+
+      hiera = Hiera.new(:config => spec.hiera_config.merge(:logger => 'puppet'))
+
+      if self.respond_to?("[]")
+        hiera_scope = self
+      else
+        hiera_scope = Hiera::Scope.new(self)
+      end
+
+      answer = hiera.lookup(key, default, hiera_scope, override, :array)
+
+      raise(Puppet::ParseError, "Could not find data item #{key} in any Hiera data file and no default supplied") if answer.empty?
+
+      method = Puppet::Parser::Functions.function(:include)
+      send(method, answer)
+    end
+  end
+end

data/lib/hiera-puppet-helper/rspec.rb

@@ -0,0 +1,24 @@
+require 'rspec'
+
+module HieraPuppetHelper
+  module HieraDefaultConfiguration
+    extend RSpec::SharedContext
+
+    let(:hiera_config) do
+      { :backends => ['rspec'],
+        :rspec => respond_to?(:hiera_data) ? hiera_data : {} }
+    end
+  end
+end
+
+RSpec.configure do |c|
+  c.include(HieraPuppetHelper::HieraDefaultConfiguration)
+
+  c.before(:each) do
+    Thread.current[:spec] = self
+  end
+
+  c.after(:each) do
+    Thread.current[:spec] = nil
+  end
+end

data/lib/hiera-puppet-helper/version.rb

@@ -0,0 +1,7 @@
+module Rspec
+  module Hiera
+    module Puppet
+      VERSION = "1.0.0"
+    end
+  end
+end

data/lib/hiera/backend/rspec_backend.rb

@@ -0,0 +1,60 @@
+class Hiera
+  module Backend
+    class Rspec_backend
+      def initialize
+        Hiera.debug("Hiera RSpec backend starting")
+      end
+
+      def lookup(key, scope, order_override, resolution_type)
+        answer = nil
+
+        Hiera.debug("Looking up #{key} in RSpec backend")
+
+        Backend.datasources(scope, order_override) do |source|
+          Hiera.debug("Looking for data source #{source}")
+
+          data = Config[:rspec]
+
+          next if ! data
+          next if data.empty?
+
+          if data.include?(key)
+            raw_answer = data[key]
+          elsif data.include?(key.to_sym)
+            raw_answer = data[key.to_sym]
+          else
+            next
+          end
+
+          # Extra logging that we found the key. This can be outputted
+          # multiple times if the resolution type is array or hash but that
+          # should be expected as the logging will then tell the user ALL the
+          # places where the key is found.
+          Hiera.debug("Found #{key} in #{source}")
+
+          # for array resolution we just append to the array whatever
+          # we find, we then goes onto the next file and keep adding to
+          # the array
+          #
+          # for priority searches we break after the first found data item
+          new_answer = Backend.parse_answer(raw_answer, scope)
+          case resolution_type
+          when :array
+            raise Exception, "Hiera type mismatch: expected Array and got #{new_answer.class}" unless new_answer.kind_of? Array or new_answer.kind_of? String
+            answer ||= []
+            answer << new_answer
+          when :hash
+            raise Exception, "Hiera type mismatch: expected Hash and got #{new_answer.class}" unless new_answer.kind_of? Hash
+            answer ||= {}
+            answer = new_answer.merge answer
+          else
+            answer = new_answer
+            break
+          end
+        end
+
+        return answer
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: hiera-puppet-helper
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Maarten Thibaut
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-04-03 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: puppet
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hiera
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: hiera-puppet
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id005 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec-puppet
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id005
+  type: :runtime
+  version_requirements: *id006
+description: Hiera fixtures for rspec-puppet tests.
+email: 
+- mthibaut@cisco.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- hiera-puppet-helper.gemspec
+- lib/hiera-puppet-helper.rb
+- lib/hiera-puppet-helper/puppet.rb
+- lib/hiera-puppet-helper/rspec.rb
+- lib/hiera-puppet-helper/version.rb
+- lib/hiera/backend/rspec_backend.rb
+homepage: https://github.com/mthibaut/rspec-hiera-puppet
+licenses: []
+
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id005
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id005
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Hiera fixtures for rspec-puppet tests.
+test_files: []
+