hiera_explain 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 590bb159ecb68d039aaaf5d853ad42058480a1b8
+  data.tar.gz: 916b60c7bbffee5b014f634fc652fe07e9fc2136
+SHA512:
+  metadata.gz: 68019f8c76a2b4efc04777ef43ddac3ea23c0e16cca1eba58654de2cfbffb36cdbf80df592b16c8057f01e36a0eb29931b10bbda26f7a40194305ed095a226f4
+  data.tar.gz: b5a5dc1c0a417efa43345db4af7244020e84073e3d065321ce5e843727ade6b560a4aa1773bd6ba290aa2ea585ae0f4572e61922db5c9d19acb5341e8603a9ec

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,207 @@
+# Hiera Explain
+
+Hiera is sometimes inscrutable. Its data retrieval model can be surprising in
+its simplicity. It's common for people to struggle with how to format data in
+their Hiera datasources and retrieve it properly.
+
+This tool is designed to help demystify Hiera. When you invoke `hiera_explain`,
+it will use whatever scope you provide to evaluate the `hiera.yaml` file and
+print it out exactly as Hiera will interpret it. What is scope? That's merely
+the collection of facts or other variables provided for Hiera to use.
+
+## Usage
+
+The examples here will use this sample `hiera.yaml` configuration file:
+
+```yaml
+---
+:backends:
+  - yaml
+  - json
+
+:yaml:
+  :datadir: /etc/puppetlabs/code/hieradata
+
+:json:
+  :datadir: /etc/puppetlabs/code/hieradata
+
+:hierarchy:
+  - "%{clientcert}"
+  - overrides
+  - "environments/%{environment}/hieradata/%{osfamily}"
+  - "environments/%{environment}/hieradata/%{clientcert}"
+  - "environments/%{environment}/hieradata/defaults"
+  - classroom
+  - tuning
+  - common
+  - defaults
+```
+
+When you invoke `hiera_explain`, it will first show you each `datadir` expanded
+out with any variables Hiera can interpolate. Then it will evaluate and display
+the hierarchy, as Hiera would interpret it.
+
+```
+root@master:~ # hiera_explain
+Backend data directories:
+  * yaml: /etc/puppetlabs/code/hieradata
+  * json: /etc/puppetlabs/code/hieradata
+
+Expanded hierarchy:
+  * master.puppetlabs.vm
+  * overrides
+  * environments/production/hieradata/RedHat
+  * environments/production/hieradata/master.puppetlabs.vm
+  * environments/production/hieradata/defaults
+  * classroom
+  * tuning
+  * common
+  * defaults
+```
+
+Next it will show you the exact file paths that Hiera will look in as it's
+resolving the keys you're looking up. It will indicate which files exist with a
+checked box and with color coding.
+
+```
+File lookup order:
+  [X] /etc/puppetlabs/code/hieradata/master.puppetlabs.vm.yaml
+  [ ] /etc/puppetlabs/code/hieradata/overrides.yaml
+  [ ] /etc/puppetlabs/code/hieradata/environments/production/hieradata/RedHat.yaml
+  [ ] /etc/puppetlabs/code/hieradata/environments/production/hieradata/master.puppetlabs.vm.yaml
+  [ ] /etc/puppetlabs/code/hieradata/environments/production/hieradata/defaults.yaml
+  [X] /etc/puppetlabs/code/hieradata/classroom.yaml
+  [ ] /etc/puppetlabs/code/hieradata/tuning.yaml
+  [ ] /etc/puppetlabs/code/hieradata/common.yaml
+  [X] /etc/puppetlabs/code/hieradata/defaults.yaml
+  [ ] /etc/puppetlabs/code/hieradata/master.puppetlabs.vm.json
+  [X] /etc/puppetlabs/code/hieradata/overrides.json
+  [ ] /etc/puppetlabs/code/hieradata/environments/production/hieradata/RedHat.json
+  [ ] /etc/puppetlabs/code/hieradata/environments/production/hieradata/master.puppetlabs.vm.json
+  [ ] /etc/puppetlabs/code/hieradata/environments/production/hieradata/defaults.json
+  [ ] /etc/puppetlabs/code/hieradata/classroom.json
+  [ ] /etc/puppetlabs/code/hieradata/tuning.json
+  [ ] /etc/puppetlabs/code/hieradata/common.json
+  [ ] /etc/puppetlabs/code/hieradata/defaults.json
+```
+
+Finally, it will actually dump out *all data* available for you to look up with
+Hiera functions in your Puppet code. It is also color coded, and and will indicate
+which values are unable to be resolved with `hiera_hash()`.
+
+```
+Priority lookup results:
+   * hiera('foo') => bar
+   * hiera('message') => This is a sample variable that came from a Hiera datasource
+   * hiera('hashies') => {"key"=>"value"}
+   * hiera('puppet_enterprise::profile::console::rbac_session_timeout') => 4320
+   * hiera('puppet_enterprise::profile::puppetdb::listen_address') => 0.0.0.0
+   * hiera('pe_repo::base_path') =>
+
+Array lookup results:
+   * hiera_array('pe_repo::base_path') => [nil, "https://master.puppetlabs.vm:8140/packages/classroom"]
+   * hiera_array('puppet_enterprise::profile::console::rbac_session_timeout') => [4320]
+   * hiera_array('puppet_enterprise::profile::puppetdb::listen_address') => ["0.0.0.0"]
+   * hiera_array('message') => ["This is a sample variable that came from a Hiera datasource", "this comes from json"]
+   * hiera_array('foo') => ["bar"]
+   * hiera_array('hashies') => [{"key"=>"value"}]
+
+Hash lookup results:
+   * hiera_hash('pe_repo::base_path') => No hash datatype in ["master.puppetlabs.vm.yaml", "classroom.yaml"]
+   * hiera_hash('puppet_enterprise::profile::console::rbac_session_timeout') => No hash datatype in ["classroom.yaml"]
+   * hiera_hash('puppet_enterprise::profile::puppetdb::listen_address') => No hash datatype in ["classroom.yaml"]
+   * hiera_hash('message') => No hash datatype in ["defaults.yaml", "overrides.json"]
+   * hiera_hash('foo') => No hash datatype in ["overrides.json"]
+   * hiera_hash('hashies') => {"key"=>"value"}
+```
+
+![Screenshot](screenshot.png)
+
+### Options
+
+`hiera_explain` can use scope from a variety of sources. You can pass a JSON or
+YAML file containing a full dump of facts, or you can retrieve those using
+MCollective or PuppetDB. You can pass in as many sources of scope data as you like.
+
+```
+root@master:~ # hiera_explain -h
+
+Usage : hiera_explain [--json PATH] [--yaml PATH] [--mcollective IDENTITY] [--puppetdb IDENTITY].
+
+    -j, --json PATH                  Load scope from a JSON file.
+    -y, --yaml PATH                  Load scope from a YAML file.
+    -m, --mcollective IDENTITY       Use MCollective to retrieve scope for an identity.
+    -p, --puppetdb IDENTITY          Use PuppetDB to retrieve scope for an identity.
+    -i, --inventory IDENTITY         Use Puppet's inventory service to retrieve scope (deprecated!)
+    -n, --no-color                   Disable console colors.
+    -d, --debug                      Display debugging messages
+
+    -h, --help                       Displays this help
+```
+
+You can even override facts one at a time on the command line.
+
+```
+root@master:~ # hiera_explain -p master.puppetlabs.vm clientcert=foo.bar.baz
+Backend data directories:
+  * yaml: /etc/puppetlabs/code/hieradata
+  * json: /etc/puppetlabs/code/hieradata
+
+Expanded hierarchy:
+  * foo.bar.baz
+  * overrides
+  * environments/production/hieradata/RedHat
+  * environments/production/hieradata/foo.bar.baz
+  * environments/production/hieradata/defaults
+  * classroom
+  * tuning
+  * common
+  * defaults
+```
+
+### Adding supported backends.
+
+A standard Hiera backend won't provide the data we need to look up all available
+data. I've added support for `yaml`, `json`, and `eyaml` backend out-of-the-box,
+but it's fairly easy to add support for your own backend.
+
+Simply provide a monkeypatching class like the following. It should return a
+hash of Hiera data, given a path.
+
+```ruby
+class HieraExplain::Datasource
+
+  # marshall is a data serialization format for Ruby. There does not exist
+  # a Hiera backend for using it, nor should there be as it's a binary format.
+  # But if there were, this would make hiera_explain understand it.
+  def self.marshall(path)
+    Marshal::load(File.read(path))
+  end
+
+end
+```
+
+The filename and the method it provides *must* be the same as the name for your
+backend.
+
+```
+root@master:modules # $ tree marshall
+marshall
+└── lib
+    ├── hiera
+    │   └── backends
+    │       └── marshall_backend.rb
+    └── hiera_explain
+        └── datasource
+            └── marshall.rb
+```
+
+## Disclaimer
+
+This is early in development, although the script this is based on has been used
+in the classroom for quite a while now.
+
+Contact
+-------
+
+binford2k@gmail.com

data/bin/hiera_explain

@@ -0,0 +1,153 @@
+#! /opt/puppetlabs/puppet/bin/ruby
+require 'hiera'
+require 'puppet'
+require 'colorize'
+require 'optparse'
+
+require 'hiera_explain'
+require 'hiera_explain/scope'
+require 'hiera_explain/datasource'
+
+begin
+  Puppet.initialize_settings
+rescue => e
+  Puppet.settings.parse
+end
+
+hiera = Hiera.new(:config => Puppet.settings[:hiera_config])
+scope = HieraExplain::Scope.new()
+optparse = OptionParser.new { |opts|
+    opts.banner = "Usage : hiera_explain [--json PATH] [--yaml PATH] [--mcollective IDENTITY] [--puppetdb IDENTITY].
+
+"
+
+    opts.on("-j PATH", "--json PATH", "Load scope from a JSON file.") do |arg|
+      scope.load_scope(arg, :json)
+    end
+
+    opts.on("-y PATH", "--yaml PATH", "Load scope from a YAML file.") do |arg|
+      scope.load_scope(arg, :yaml)
+    end
+
+    opts.on("-m IDENTITY", "--mcollective IDENTITY", "Use MCollective to retrieve scope for an identity.") do |arg|
+      scope.load_scope(arg, :mcollective)
+    end
+
+    opts.on("-p IDENTITY", "--puppetdb IDENTITY", "Use PuppetDB to retrieve scope for an identity.") do |arg|
+      scope.load_scope(arg, :puppetdb)
+    end
+
+    opts.on("-i IDENTITY", "--inventory IDENTITY", "Use Puppet's inventory service to retrieve scope #{'(deprecated!)'.yellow}") do |arg|
+      if Gem::Version.new(Puppet.version) > Gem::Version.new('4')
+        puts "WARNING: Many great apologies, but I fear that the inventory service has been deprecated.".red
+        exit 1
+      end
+      scope.load_scope(arg, :inventory_service)
+    end
+
+    opts.on("-n", "--no-color", "Disable console colors.") do
+      String.disable_colorization = true
+    end
+
+    opts.on("-d", "--debug", "Display debugging messages") do
+        loglevel = Logger::DEBUG
+    end
+
+    opts.separator('')
+
+    opts.on("-h", "--help", "Displays this help") do
+        puts
+        puts opts
+        puts
+        exit
+    end
+}
+optparse.parse!
+
+# Default to the curren't node's MCO's fact cache
+scope.load_scope("/etc/puppetlabs/mcollective/facts.yaml", :yaml) if scope.empty?
+scope['environment'] ||= 'production'
+
+# data buckets
+priority_lookup = {}
+array_lookup    = {}
+hash_lookup     = {}
+hash_errors     = {}
+
+# Cribbed from Hiera source to ensure we're parsing the same way.
+unless ARGV.empty?
+  ARGV.each do |arg|
+    if arg =~ /^(.+?)=(.+?)$/
+      scope[$1] = $2
+    else
+      STDERR.puts "Don't know how to parse scope argument: #{arg}"
+    end
+  end
+end
+
+puts 'Backend data directories:'
+Hiera::Config[:backends].each do |backend|
+  puts "  * #{backend}: #{Hiera::Backend.datadir(backend, scope)}"
+end
+puts
+
+puts 'Expanded hierarchy:'
+Hiera::Backend.datasources(scope) do |datasource|
+  puts "  * #{datasource}"
+end
+puts
+
+puts 'File lookup order:'
+Hiera::Config[:backends].each do |backend|
+  datadir = Hiera::Backend.datadir(backend, scope)
+  next unless datadir
+
+  Hiera::Backend.datasources(scope) do |source|
+    path = File.join(datadir, "#{source}.#{backend}")
+
+    unless File.exists?(path)
+      puts "  [ ] #{path}".red
+
+    else
+      puts "  [X] #{path}".green
+
+      data = HieraExplain.load_datasource(backend, path)
+      priority_lookup = data.merge(priority_lookup)
+
+      data.each do |key, value|
+        array_lookup[key] ||= Array.new
+        array_lookup[key] << value
+
+        hash_lookup[key] ||= Hash.new
+        if (value.class == Hash)
+          hash_lookup[key].merge!(value)
+        else
+          hash_errors[key] ||= Array.new
+          hash_errors[key]  << "#{source}.#{backend}"
+        end
+      end
+
+    end
+
+  end
+end
+puts
+
+puts 'Priority lookup results:'
+priority_lookup.each { |key, value| puts "   * hiera('#{key}') => #{value.to_s.green}" }
+puts
+
+puts 'Array lookup results:'
+array_lookup.each { |key, value| puts "   * hiera_array('#{key}') => #{value.inspect.green}" }
+puts
+
+puts 'Hash lookup results:'
+hash_lookup.each do |key, value|
+  print "   * hiera_hash('#{key}') => "
+  if(hash_errors.has_key? key)
+    puts "No hash datatype in #{hash_errors[key].inspect}".red
+  else
+    puts value.inspect.green
+  end
+end
+puts

data/lib/hiera_explain.rb

@@ -0,0 +1,20 @@
+class HieraExplain
+
+  def self.load_datasource(backend, path)
+    return {} unless File.exists? path
+
+    begin
+      require "hiera_explain/datasource/#{backend}"
+    rescue LoadError => e
+    end
+
+    begin
+      return HieraExplain::Datasource.send(backend.to_s, path)
+    rescue => e
+      puts "The #{backend} backend has a malformed datasource at #{path}"
+      data = {}
+    end
+
+    data
+  end
+end

data/lib/hiera_explain/datasource.rb

@@ -0,0 +1,22 @@
+class HieraExplain::Datasource
+
+  def self.yaml(path)
+    require 'yaml'
+    YAML.load_file(path)
+  end
+
+  def self.json(path)
+    require 'json'
+    JSON.parse(File.read(path))
+  end
+
+  def self.eyaml(path)
+    require 'yaml'
+    data = YAML.load_file(path)
+    data.each do |key, value|
+      data[key] = '<<encrypted>>' if data =~ /.*ENC\[.*?\]/
+    end
+    data
+  end
+
+end

data/lib/hiera_explain/datasource/marshall.rb

@@ -0,0 +1,10 @@
+class HieraExplain::Datasource
+
+  # marshall is a data serialization format for Ruby. There does not exist
+  # a Hiera backend for using it, nor should there be as it's a binary format.
+  # But if there were, this would make hiera_explain understand it.
+  def self.marshall(path)
+    Marshal::load(File.read(path))
+  end
+
+end

data/lib/hiera_explain/scope.rb

@@ -0,0 +1,116 @@
+require 'rubygems'
+
+class HieraExplain::Scope
+  attr_accessor :scope
+
+  def initialize()
+    @scope = {}
+  end
+
+  def empty?
+    @scope.empty?
+  end
+
+  def include?(key)
+    @scope.include?(key)
+  end
+
+  def [](key)
+    @scope[key]
+  end
+
+  def []=(key, value)
+    @scope[key] = value
+  end
+
+  # Loads the scope from YAML or JSON files
+  def load_scope(source, type=:yaml)
+    case type
+    when :mcollective
+      begin
+        require 'mcollective'
+
+        util = MCollective::RPC::Client.new('rpcutil',
+                  :configfile => MCollective::Util.config_file_for_user,
+                  :options    => MCollective::Util.default_options,
+               )
+        util.progress = false
+        nodestats = util.custom_request("inventory", {}, source, {"identity" => source}).first
+
+        raise "Failed to retrieve facts for node #{source}: #{nodestats[:statusmsg]}" unless nodestats[:statuscode] == 0
+
+        scope = nodestats[:data][:facts]
+      rescue Exception => e
+        STDERR.puts "MCollective lookup failed: #{e.class}: #{e}"
+        exit 1
+      end
+
+    when :yaml
+      raise "Cannot find scope #{type} file #{source}" unless File.exist?(source)
+
+      require 'yaml'
+
+      # Attempt to load puppet in case we're going to be fed
+      # Puppet yaml files
+      begin
+          require 'puppet'
+      rescue
+      end
+
+      scope = YAML.load_file(source)
+
+    when :json
+      raise "Cannot find scope #{type} file #{source}" unless File.exist?(source)
+
+      require 'json'
+
+      scope = JSON.load(File.read(source))
+
+    when :puppetdb
+      require 'puppet'
+      begin
+        Puppet.initialize_settings unless Puppet.settings.global_defaults_initialized?
+        Puppet::Node::Facts.indirection.terminus_class = :puppetdb
+        scope = YAML.load(Puppet::Node::Facts.indirection.find(source).to_yaml)
+      rescue Exception => e
+          STDERR.puts "PuppetDB fact lookup failed: #{e.class}: #{e}"
+          exit 1
+      end
+
+    when :inventory_service
+      # For this to work the machine running the hiera command needs access to
+      # /facts REST endpoint on your inventory server.  This access is
+      # controlled in auth.conf and identification is by the certname of the
+      # machine running hiera commands.
+      #
+      # Another caveat is that if your inventory server isn't at the short dns
+      # name of 'puppet' you will need to set the inventory_sever option in
+      # your puppet.conf.  Set it in either the master or main sections.  It
+      # is fine to have the inventory_server option set even if the config
+      # doesn't have the fact_terminus set to rest.
+      begin
+        require 'puppet/util/run_mode'
+        $puppet_application_mode = Puppet::Util::RunMode[:master]
+#         require 'puppet'
+#         Puppet.settings.parse
+        Puppet::Node::Facts.indirection.terminus_class = :rest
+        scope = YAML.load(Puppet::Node::Facts.indirection.find(source).to_yaml)
+        # Puppet makes dumb yaml files that do not promote data reuse.
+        scope = scope.values if scope.is_a?(Puppet::Node::Facts)
+      rescue Exception => e
+          STDERR.puts "Puppet inventory service lookup failed: #{e.class}: #{e}"
+        puts e.backtrace
+          exit 1
+      end
+    else
+      raise "Don't know how to load data type #{type}"
+    end
+
+    # Puppet makes dumb yaml files that do not promote data reuse.
+    scope = scope.values if scope.is_a?(Puppet::Node::Facts)
+    raise "Scope from #{type} file #{source} should be a Hash" unless scope.is_a?(Hash)
+
+    @scope.merge! scope
+  end
+
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: hiera_explain
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ben Ford
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: puppet
+  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: colorize
+  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'
+description: |2
+    Hiera lookups have always been hard for people to understand. This tool will
+    display the entire lookup hierarchy, including filenames, exactly as Hiera will
+    interpret them and in the order that Hiera will resolve them.
+
+    Then it will display all the data which can be retrieved from Hiera, given the
+    node scope being used.
+email: binford2k@gmail.com
+executables:
+- hiera_explain
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- LICENSE
+- bin/hiera_explain
+- lib/hiera_explain/datasource/marshall.rb
+- lib/hiera_explain/datasource.rb
+- lib/hiera_explain/scope.rb
+- lib/hiera_explain.rb
+homepage: https://github.com/binford2k/hiera_explain
+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.0.14.1
+signing_key: 
+specification_version: 4
+summary: Provides an explanation of how Hiera retrieves data.
+test_files: []