hiera-simulator 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a409ed848956ad385eaa26c1ca9ceaf758deb132
+  data.tar.gz: df0f290c98e20878842060ef1f60ac87d7635ccf
+SHA512:
+  metadata.gz: 8fff178d310a6ecb83ca7cb109811003d0f945ebeec248b47489a6be0e2d726690f2fbeb63e162e50cd82131de45e3a9f1379dac29e00723006809ad960c407d
+  data.tar.gz: 0b612f1d2de47c239e6bddcc5c4228d3aedc38adfca4b418f90a57d03c388276db7831692f333cbf0adcd759404f8352604c9b64c514d1622a8157126778600d

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.hiera1

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+gem 'hiera', '= 1.3.4'

data/Gemfile.hiera1.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    hiera-simulator (0.2.1)
+      bundler
+      deep_merge
+      hiera
+      httparty
+      json
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    deep_merge (1.0.1)
+    diff-lcs (1.2.5)
+    hiera (1.3.4)
+      json_pure
+    httparty (0.13.7)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.3)
+    json_pure (1.8.3)
+    multi_xml (0.5.5)
+    rake (11.1.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hiera (= 1.3.4)
+  hiera-simulator!
+  rspec (>= 3.0.0)
+
+BUNDLED WITH
+   1.11.2

data/Gemfile.hiera3

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+gemspec
+gem 'hiera', '= 3.1.1'

data/Gemfile.hiera3.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    hiera-simulator (0.2.1)
+      bundler
+      deep_merge
+      hiera
+      httparty
+      json
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    deep_merge (1.0.1)
+    diff-lcs (1.2.5)
+    hiera (3.1.1)
+      json_pure
+    httparty (0.13.7)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.3)
+    json_pure (1.8.3)
+    multi_xml (0.5.5)
+    rake (11.1.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hiera (= 3.1.1)
+  hiera-simulator!
+  rspec (>= 3.0.0)
+
+BUNDLED WITH
+   1.11.2

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    hiera-simulator (0.2.1)
+      bundler
+      deep_merge
+      hiera
+      httparty
+      json
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    deep_merge (1.0.1)
+    diff-lcs (1.2.5)
+    hiera (1.3.4)
+      json_pure
+    httparty (0.13.7)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    json (1.8.3)
+    json_pure (1.8.3)
+    multi_xml (0.5.5)
+    rake (11.1.2)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hiera
+  hiera-simulator!
+  rspec (>= 3.0.0)
+
+BUNDLED WITH
+   1.11.2

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,50 @@
+# Hiera Simulator
+
+[![Build Status](https://travis-ci.org/kpaulisse/hiera-simulator.svg?branch=master)](https://travis-ci.org/kpaulisse/hiera-simulator)
+
+Pull facts about a node, and then preview Hiera changes there, without touching the node.
+
+This is intended for Puppet 3.x and below. In Puppet 4, the [`puppet lookup` command](https://docs.puppetlabs.com/puppet/4.4/reference/man/lookup.html) accomplishes the same thing. If you have Puppet 4, you should be using this built-in tool, and I will too once my Puppet installation gets to version 4.
+
+# Why?
+
+[Hiera](https://github.com/puppetlabs/hiera) is a critical part of a Puppet implementation, and it is amazingly helpful to separate data from code.
+
+The Hiera Simulator simplifies the development process by allowing someone to "preview" Hiera changes without committing to source control, awaiting results from CI tests, or touching any real hosts in the environment. While it's possible to do all this with stock Hiera, that involves copying facts and using less common command line options. Hiera Simulator handles all that for you, and then calls the *actual Hiera code* to do your lookup.
+
+# Setup
+
+This code is meant to run on a developer's workstation -- perhaps in some cases it's also suitable for your Puppet Master, but it's definitely not intended to be installed everywhere in your environment. Once you've installed the code, you'll have to do a bit of configuration so it knows where to find everything.
+
+- [Installation](./docs/installation.md)
+- [Configuration](./docs/configuration.md)
+
+Because the version of Hiera to use is set in the Gemfile, you may have to update the Gemfile to match your version. This code is intended to work correctly with both Hiera 1.3.4 and Hiera 3.1. No default version of the Hiera gem is required in the default Gemfile, so if you run Puppet from gems (like we do at my work), it won't conflict.
+
+# Usage
+
+Type `hiera-simulator --help` for a list of command line options.
+
+Here are the important ones:
+
+- `-n FQDN`: The FQDN of the host whose facts you want to use. This option is **required** unless you use `--fact-file FILENAME` to provide the facts for you.
+
+- `-d`: Turn on Hiera debug mode, which will show you what files were tried until it ultimately came up with your fact.
+
+- `--fact-file FILENAME`: Instead of providing a node name and letting Hiera Simulator find the facts for you, load the facts directly from the file you specify. The fact file may be in YAML or JSON format (parsing method depends on file extension).
+
+# Troubleshooting
+
+- [Troubleshooting](./docs/troubleshooting.md)
+
+# Limitations
+
+- [Limitations](./docs/limitations.md)
+
+# Changelog
+
+| Version | Notes |
+|---------|-------|
+| 0.2.1   | Remove PuppetDB hiera backend support, add --[no-]stringify-facts command line option |
+| 0.2.0   | Add support for PuppetDB API v4 |
+| 0.1.0   | Initial release |

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+task :default do
+  Rake::Task['spec'].invoke
+end
+
+desc 'Run all hiera-simulator gem specs'
+task :spec do
+  exec 'rspec -c spec'
+end

data/bin/hiera-simulator

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+if File.basename(File.dirname(File.absolute_path(__FILE__))) == 'exe'
+  require_relative '../lib/hiera-simulator'
+else
+  require 'hiera-simulator'
+end
+HieraSimulator::Cli.run

data/lib/hiera-simulator.rb

@@ -0,0 +1,2 @@
+raise 'Error: hiera-simulator requires Ruby >= 2.0.0' if RUBY_VERSION < '2.0.0'
+Dir["#{File.dirname(__FILE__)}/hiera-simulator/**/*.rb"].each { |f| require(f) }

data/lib/hiera-simulator/cli.rb

@@ -0,0 +1,144 @@
+require 'hiera/version'
+require 'optparse'
+require 'pp'
+
+module HieraSimulator
+  # Command Line Interface
+  class Cli
+    # Drive the command line interface - this is called externally
+    def self.run(options_in = nil, config_in = {})
+      options = options_in.nil? ? parse_options : options_in
+      answer = execute(options, config_in)
+      exit print_answer(answer, options)
+    end
+
+    # Handle command line interface
+    def self.execute(options, config_in)
+      config = HieraSimulator::Config.new(config_in)
+      command_line_override(options, config)
+      config.validate
+      facts = HieraSimulator::Facts.facts(config, options[:hostname], options[:stringify_facts])
+      raise "No facts found for host #{options[:hostname]}" if facts.empty?
+      hiera_options = { resolution_type: options[:resolution_type], verbose: options[:verbose] }
+      HieraSimulator::HieraLookup.lookup(options[:key], config, facts, hiera_options)
+    end
+
+    # Print answer
+    def self.print_answer(answer, options)
+      STDERR.puts "Hiera version = #{Hiera::VERSION}" if options[:verbose]
+      if answer.nil?
+        puts 'nil'
+        return 1
+      elsif answer.is_a?(String)
+        puts answer
+      else
+        pp answer
+      end
+      0
+    end
+
+    # Overrides from command line
+    def self.command_line_override(options, config)
+      merges = {}
+      [:hiera_yaml_path, :json_datadir, :yaml_datadir, :factdir, :fact_file].each do |key|
+        merges[key.to_s] = options[key] if options.key?(key) && !options[key].nil?
+      end
+      config.merge!(merges) unless merges.empty?
+    end
+
+    # Parse command line options
+    # @return [Hash] Parsed (command line) options
+    def self.parse_options
+      result = {
+        verbose: false,
+        resolution_type: :priority,
+        hostname: nil,
+        fact_file: nil,
+        stringify_facts: nil,
+      }
+      OptionParser.new do |opts|
+        opts.banner = 'Usage: hiera-simulator -n <Node_FQDN> [options] key'
+
+        opts.on('--hiera-yaml-path PATH', 'Path to hiera.yaml file') do |path|
+          dir = find_dir(File.dirname(path))
+          result[:hiera_yaml_path] = File.absolute_path(File.join(dir, File.basename(path)))
+          raise Errno::ENOENT, 'The specified hiera.yaml file does not exist' unless File.file?(result[:hiera_yaml_path])
+        end
+
+        opts.on('--yaml-datadir DIR', 'YAML data directory') do |datadir|
+          result[:yaml_datadir] = find_dir(datadir)
+        end
+
+        opts.on('--json-datadir DIR', 'JSON data directory') do |datadir|
+          result[:json_datadir] = find_dir(datadir)
+        end
+
+        opts.on('-d', '--debug', 'Turn on Hiera debugging/verbose mode') do
+          result[:verbose] = true
+        end
+
+        opts.on('--hostname FQDN', '-n', 'Use facts from last run of FQDN') do |fqdn|
+          result[:hostname] = fqdn
+        end
+
+        opts.on('--fact-file PATH', 'Use facts from the specified file (.yaml/.json only)') do |path|
+          result[:fact_file] = path
+          result[:hostname] = '.' if result[:hostname].nil?
+        end
+
+        opts.on('--factsdir DIR', '-f', 'Base directory of YAML facts') do |factdir|
+          result[:factdir] = find_dir(factdir)
+        end
+
+        opts.on('--puppetdb', '-p', 'Force lookup of facts in puppetdb') do |puppetdb|
+          result[:puppetdb] = puppetdb
+        end
+
+        opts.on('--array', 'Return answer as an array') do
+          result[:resolution_type] = :array
+        end
+
+        opts.on('--hash', 'Return answer as an hash') do
+          result[:resolution_type] = :hash
+        end
+
+        opts.on('--[no-]stringify-facts', 'Override default stringify facts behavior') do |x|
+          result[:stringify_facts] = x
+        end
+      end.parse!
+
+      if ARGV.empty?
+        puts 'ERROR: You did not specify a data item to look up!'
+        exit 1
+      end
+
+      if result[:hostname].nil?
+        puts 'ERROR: You did not specify a host name to simulate (-n <hostname>)'
+        exit 1
+      end
+
+      result[:key] = ARGV.delete_at(0)
+      result
+    end
+
+    # Find a user-supplied directory, either absolute path, or relative to the current
+    # working directory. If directory cannot be find, raise exception.
+    # @param dir [String] Directory name supplied by user
+    # @return [String] Absolute path to confirmed existing directory
+    def self.find_dir(dir)
+      result = []
+      dir_array = dir.is_a?(Array) ? dir : [dir]
+      dir_array.each do |dir_ent|
+        if File.directory?(dir_ent)
+          result << File.absolute_path(dir_ent)
+        elsif File.directory?(File.join(File.absolute_path(Dir.getwd), factdir))
+          result << File.join(File.absolute_path(Dir.getwd), dir_ent)
+        else
+          raise Errno::ENOENT, "Specified directory #{dir_ent} does not exist or is inaccessible"
+        end
+      end
+      return result[0] unless dir.is_a?(Array)
+      result
+    end
+  end
+end

data/lib/hiera-simulator/config.rb

@@ -0,0 +1,92 @@
+require 'yaml'
+
+module HieraSimulator
+  # Load the configuration for the Hiera simulator
+  #
+  # The order in which files are read in are:
+  # - $CWD/.hiera-simulator.yaml
+  # - $HOME/.hiera-simulator.yaml
+  # - /etc/hiera-simulator.yaml
+  #
+  # The reading of the configuration values happens very much like in Hiera itself, where
+  # the first time a key is seen, subsequent occurrences of that key are ignored.
+  class Config
+    attr_reader :config
+
+    # Constructor
+    # @param overrides [Hash] Override default settings for home_dir, global_config, and/or cwd
+    def initialize(overrides = {})
+      @home_dir = overrides.fetch(:home_dir, ENV['HOME'])
+      @global_configfile = overrides.fetch(:global_config, '/etc/hiera-simulator.yaml')
+      @working_dir = overrides.fetch(:cwd) { |_x| File.absolute_path(Dir.getwd) }
+      @config = overrides.fetch(:config) { |_x| retrieve_config }
+    end
+
+    # Get - shorthand method to retrieve a particular key from the config hash
+    # @param key [String] Key to retrieve
+    # @param default [Object] Default value
+    # @return [Object] Value of config setting
+    def get(key, default = nil)
+      @config.fetch(key, @config.fetch(key.to_s, @config.fetch(key.to_sym, default)))
+    end
+
+    # Merge! - Merge a hash
+    # @param newhash [Hash] Hash to merge in
+    def merge!(newhash)
+      @config.merge!(newhash)
+    end
+
+    # Validate configuration
+    def validate
+      raise_no_config_files_found if config.empty?
+    end
+
+    # Throw "Missing Parameter" error
+    def raise_missing_parameter(parameter)
+      errmsg = "\n\nERROR!!! A required parameter (#{parameter}) was missing.\n"
+      errmsg += "Tried these files: #{filelist.inspect}\n"
+      errmsg += "(None of these files could be found)\n" if retrieve_config.empty?
+      errmsg += "Please see https://github.com/kpaulisse/hiera-simulator/blob/master/doc/troubleshooting.rb for more.\n\n"
+      raise ConfigError, errmsg
+    end
+
+    private
+
+    # Read the configuration for the hiera simulator
+    # @param overrides [Hash] Override default settings for home_dir, global_config, and/or cwd
+    # @return [Hash] Merged configuration
+    def retrieve_config
+      result = {}
+      filelist.each do |file|
+        next unless File.file?(file)
+        data = YAML.load_file(file)
+        raise ConfigError, "File #{file} is not in the correct format. Expected hash got #{data.class}" unless data.is_a?(Hash)
+        result = data.merge(result)
+      end
+      result
+    end
+
+    # From the overrides, get the file list
+    # @return [Array<String>] File names of possible config files
+    def filelist
+      filename = '.hiera-simulator.yaml'
+      files = []
+      files << File.join(@working_dir, filename) unless @working_dir.nil?
+      files << File.join(@home_dir, filename) unless @home_dir.nil?
+      files << @global_configfile unless @global_configfile.nil?
+      files
+    end
+
+    # Throw "No config files contain config data" error
+    def raise_no_config_files_found
+      errmsg = "\nNo local or global hiera-simulator config files contain config data.\n"
+      errmsg += "Perhaps you have not yet configured hiera-simulator on this system?\n"
+      errmsg += "Please see https://github.com/kpaulisse/hiera-simulator/blob/master/doc/troubleshooting.rb for more.\n\n"
+      raise ConfigError, errmsg
+    end
+  end
+
+  class ConfigError < RuntimeError
+    # Specific error handling for handled exceptions in this class
+  end
+end

data/lib/hiera-simulator/fact_source/factfile.rb

@@ -0,0 +1,27 @@
+require 'json'
+require 'yaml'
+
+module HieraSimulator
+  module FactSource
+    # Retrieve facts from a specified file on the file system.
+    class FactFile
+      # Constructor
+      # @param config [HieraSimulator::Config] Config object
+      def initialize(config, override = {})
+        @fact_file = override.fetch(:fact_file, config.get('fact_file', nil))
+        raise HieraSimulator::FactSourceError, 'No :fact_file was passed to FactFile' if @fact_file.nil?
+      end
+
+      # Get facts for a node
+      # @param node [String] IGNORED
+      # @param stringify_facts [Boolean] IGNORED
+      # @return [Hash] Facts from the node in question
+      def facts(node = nil)
+        raise HieraSimulator::FactLookupError, "Invalid fact file specified: #{@fact_file}" unless File.file?(@fact_file)
+        return HieraSimulator::FactSource::Util.modify_and_load_yamlfile(@fact_file) if @fact_file =~ /\.yaml$/
+        return HieraSimulator::FactSource::Util.modify_and_load_jsonfile(@fact_file) if @fact_file =~ /\.json$/
+        raise HieraSimulator::FactLookupError, "Unknown extension for: #{@fact_file}; .yaml and .json files are supported"
+      end
+    end
+  end
+end

data/lib/hiera-simulator/fact_source/filesystem.rb

@@ -0,0 +1,25 @@
+require 'tempfile'
+require 'yaml'
+
+module HieraSimulator
+  module FactSource
+    # Retrieve facts from the file system. This object is a "connection" to those files.
+    class FileSystem
+      # Constructor
+      # @param config [HieraSimulator::Config] Config object
+      def initialize(config, override = {})
+        @fact_dir = override.fetch(:fact_dir, config.get('fact_dir', nil))
+        raise HieraSimulator::FactSourceError, 'No fact_dir was found in hiera-simulator configuration' if @fact_dir.nil?
+      end
+
+      # Get facts for a node
+      # @param node [String] Node FQDN as it should exist in PuppetDB
+      # @return [Hash] Facts from the node in question
+      def facts(node)
+        filepath = File.join(@fact_dir, node + '.yaml')
+        return HieraSimulator::FactSource::Util.modify_and_load_yamlfile(filepath) if File.readable?(filepath)
+        raise HieraSimulator::FactLookupError, "Fact retriever could not find or access #{filepath}"
+      end
+    end
+  end
+end

data/lib/hiera-simulator/fact_source/puppetdb.rb

@@ -0,0 +1,96 @@
+require 'httparty'
+require 'json'
+
+module HieraSimulator
+  module FactSource
+    # Retrieve facts from PuppetDB. This object is a connection to a PuppetDB instance.
+    class PuppetDB
+      # Constructor
+      # @param config [HieraSimulator::Config] Config object
+      def initialize(config, override = {})
+        @puppetdb_url = override.fetch(:puppetdb_url, config.get('puppetdb_url', nil))
+        raise HieraSimulator::FactSourceError, 'No PuppetDB URL was found in hiera-simulator configuration' if @puppetdb_url.nil?
+        @puppetdb_api_version = override.fetch(:puppetdb_api_version, config.get('puppetdb_api_version', 3))
+        @httparty_timeout = override.fetch(:timeout, config.get('timeout', 10))
+        @mock_puppetdb = override.fetch(:mock_puppetdb, config.get('mock_puppetdb', nil))
+        @stringify_facts = determine_stringify_facts(override, config)
+      end
+
+      # Get facts for a node
+      # @param node [String] Node FQDN as it should exist in PuppetDB
+      # @return [Hash] Facts from the node in question
+      def facts(node)
+        return facts_v3(node) if @puppetdb_api_version == 3
+        return facts_v4(node) if @puppetdb_api_version == 4
+        message = "HieraSimulator does not know how to handle PuppetDB API version #{@puppetdb_api_version}"
+        raise HieraSimulator::FactSourceError, message
+      end
+
+      private
+
+      def determine_stringify_facts(override, config)
+        return override.fetch(:stringify_facts) if override.key?(:stringify_facts)
+        default = false
+        default = true if @puppetdb_api_version <= 3
+        default = true if Hiera.version.to_i < 2
+        config.get('stringify_facts', default)
+      end
+
+      # PuppetDB API common
+      def facts_common(uri)
+        reply = response(uri)
+
+        # Stringify facts if needed (old hiera, old PuppetDB)
+        if @stringify_facts
+          result = {}
+          reply.each do |x|
+            HieraSimulator::FactSource::Util.stringify(x['name'], x['value']).each do |y|
+              result[y[0]] = y[1]
+            end
+          end
+          return result
+        end
+
+        # Don't stringify facts
+        result = {}
+        reply.map { |x| result[x['name']] = x['value'] }
+        result
+      end
+
+      # PuppetDB API v3
+      def facts_v3(source)
+        facts_common("/v3/nodes/#{source}/facts")
+      end
+
+      # PuppetDB API v4
+      def facts_v4(source)
+        facts_common("/pdb/query/v4/nodes/#{source}/facts")
+      end
+
+      # HTTP(S) Query
+      # @param path [String] Path portion of the URL
+      # @return [Hash] Facts from the node in question
+      def response(path)
+        return mocked_response(@mock_puppetdb) unless @mock_puppetdb.nil?
+        complete_url = @puppetdb_url + path
+        options = {
+          timeout: @httparty_timeout
+        }
+        begin
+          x = HTTParty.get(complete_url, options).parsed_response
+          raise HieraSimulator::FactLookupError, "PuppetDB resource not found: #{complete_url}" if x == 'Not Found'
+          return x
+        rescue Net::OpenTimeout => e
+          raise HieraSimulator::FactSourceError, "PuppetDB connection timeout: #{e.message}"
+        rescue Errno::ECONNREFUSED => e
+          raise HieraSimulator::FactSourceError, "PuppetDB connection refused: #{e.message}"
+        end
+      end
+
+      # Mock puppetdb response, for spec testing
+      def mocked_response(filepath)
+        JSON.parse(File.read(filepath))
+      end
+    end
+  end
+end

data/lib/hiera-simulator/fact_source/util.rb

@@ -0,0 +1,66 @@
+require 'json'
+require 'yaml'
+
+module HieraSimulator
+  module FactSource
+    # Some handy methods that may be used by multiple fact sources
+    class Util
+      # A typical Puppet YAML fact file looks like this:
+      # ```
+      # --- !ruby/object:Puppet::Node::Facts
+      #   name: your.fqdn.com
+      #   values:
+      #     key1: val1
+      #     key2: val2
+      # ```
+      # To avoid loading in all of Puppet just to parse what is basically a plain YAML file,
+      # this method strips off the first line and un-indents all of the remaining lines to
+      # make it a plain YAML file, and then parses that.
+      # @param filepath [String] File Path to read
+      # @return [Hash] Parsed YAML object
+      def self.modify_and_load_yamlfile(filepath)
+        content = File.read(filepath).split(/[\r\n]+/)
+        first_line = content.shift
+        unless first_line == '--- !ruby/object:Puppet::Node::Facts'
+          raise HieraSimulator::FactSourceError, "#{filepath} was not in expected Puppet::Node::Facts format"
+        end
+        content.unshift '---'
+        fixed_yaml = content.map { |line| line.sub(/^  /, '') }
+        data = YAML.load(fixed_yaml.join("\n"))
+        raise HieraSimulator::FactLookupError, "Invalid content in node fact file #{filepath}" unless data.key?('values')
+        result = {}
+        data['values'].each { |k, v| result['::' + k] = v }
+        result
+      end
+
+      # A typical fact file (e.g., from PuppetDB) looks like this:
+      # {
+      #   "key1": "value1",
+      #   "key2": "value2"
+      # }
+      # This reads the fact file and returns a hash with the facts in the proper format.
+      # @param filepath [String] File Path to read
+      # @return [Hash] Parsed YAML object
+      def self.modify_and_load_jsonfile(filepath)
+        data = JSON.parse(File.read(filepath))
+        result = {}
+        data.each { |k, v| result['::' + k] = v }
+        result
+      end
+
+      # Stringify key-value, needed for some older versions of Puppet and hiera
+      # @param name [String] current key
+      # @param value [Object] current value
+      # @param prior [String] prior value, for recursion
+      # @return [Array<[name, value]>] Stringified facts and values
+      def self.stringify(name, value, prior = '::' + name)
+        return [[ prior.sub(/::$/, ''), value ]] unless value.is_a?(Hash)
+        result = []
+        value.each do |k, v|
+          result.concat stringify(k, v, prior + '::' + k)
+        end
+        result
+      end
+    end
+  end
+end

data/lib/hiera-simulator/facts.rb

@@ -0,0 +1,36 @@
+module HieraSimulator
+  # Gather facts from the specified backend(s)
+  class Facts
+    # Constructor
+    # @param config [HieraSimulator::Config] Configuration object
+    def self.facts(config, node, stringify_facts = nil)
+      override = {}
+      override[:stringify_facts] = stringify_facts unless stringify_facts.nil?
+      errors = []
+      backends = config.get(:backends, %w(FileSystem PuppetDB))
+      backends = ['FactFile'] unless config.get('fact_file', nil).nil?
+      backends.each do |backend|
+        begin
+          obj = Module.const_get("HieraSimulator::FactSource::#{backend}").new(config, override)
+          return obj.facts(node)
+        rescue HieraSimulator::FactSourceError, HieraSimulator::FactLookupError => exc
+          errors << { exception: exc, backend: backend }
+          next
+        end
+      end
+      raise "Unable to retrieve facts for #{node}:\n#{format_errors(errors)}"
+    end
+
+    def self.format_errors(error_array)
+      error_array.map { |x| "- #{x[:backend]}: #{x[:exception]}" }.join("\n")
+    end
+  end
+
+  class FactLookupError < RuntimeError
+    # Catch handled exceptions from data source
+  end
+
+  class FactSourceError < RuntimeError
+    # Catch handled exceptions from data source
+  end
+end

data/lib/hiera-simulator/hieralookup.rb

@@ -0,0 +1,55 @@
+require 'hiera'
+require 'hiera/util'
+require 'tempfile'
+
+module HieraSimulator
+  # Actually interact with the Hiera gem
+  class HieraLookup
+    # Look up a key in hiera
+    # @param key [String] Key to look up
+    # @param config [HieraSimulator::Config] Configuration object
+    # @param verbose [Boolean] Enable verbose mode for hiera
+    def self.lookup(key, config, facts, options = {})
+      hiera_tmp_config = generate_hiera_file(config)
+      hiera = Hiera.new(config: hiera_tmp_config)
+      Hiera.logger = options.fetch(:verbose, false) ? 'console' : 'noop'
+      result = hiera.lookup(key, nil, facts, nil, options.fetch(:resolution_type, :priority))
+      File.unlink(hiera_tmp_config)
+      result
+    end
+
+    # Generate a temporary hiera configuration file, adjusting for directory paths
+    # in a local development environment.
+    def self.generate_hiera_file(config)
+      hiera_yaml_path = config.get('hiera_yaml_path', '(undefined)')
+      raise Errno::ENOENT, "Cannot open hiera_yaml_path '#{hiera_yaml_path}'" unless File.file?(hiera_yaml_path)
+      hiera_cfg = YAML.load_file(hiera_yaml_path)
+
+      backends = config.get('backends', hiera_cfg[:backends])
+      hiera_cfg[:backends] = backends unless backends == 'preserve'
+
+      if hiera_cfg[:backends].include?('yaml')
+        yaml_datadir = config.get('yaml_datadir', nil)
+        config.raise_missing_parameter 'yaml_datadir' if yaml_datadir.nil?
+        hiera_cfg[:yaml] = { datadir: yaml_datadir }
+      end
+
+      if hiera_cfg[:backends].include?('json')
+        json_datadir = config.get('json_datadir', nil)
+        config.raise_missing_parameter 'json_datadir' if json_datadir.nil?
+        hiera_cfg[:json] = { datadir: json_datadir }
+      end
+
+      other_backends = hiera_cfg[:backends] - ['yaml','json']
+      if other_backends.any?
+        STDERR.puts "WARNING: Ignoring unsupported backend(s): #{other_backends.join(', ')}"
+        hiera_cfg[:backends] = hiera_cfg[:backends] & ['yaml', 'json']
+      end
+
+      hiera_file = Tempfile.new('hiera.yaml')
+      hiera_file.write hiera_cfg.to_yaml
+      hiera_file.close
+      hiera_file.path
+    end
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: hiera-simulator
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Kevin Paulisse
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hiera
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: deep_merge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Used to pre-test changes in a Puppet codebase
+email: 
+executables:
+- hiera-simulator
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.hiera1
+- Gemfile.hiera1.lock
+- Gemfile.hiera3
+- Gemfile.hiera3.lock
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/hiera-simulator
+- lib/hiera-simulator.rb
+- lib/hiera-simulator/cli.rb
+- lib/hiera-simulator/config.rb
+- lib/hiera-simulator/fact_source/factfile.rb
+- lib/hiera-simulator/fact_source/filesystem.rb
+- lib/hiera-simulator/fact_source/puppetdb.rb
+- lib/hiera-simulator/fact_source/util.rb
+- lib/hiera-simulator/facts.rb
+- lib/hiera-simulator/hieralookup.rb
+homepage: http://github.com/kpaulisse/hiera-simulator
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Determine what hiera would output for a set of facts
+test_files: []