hiera_explain 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 590bb159ecb68d039aaaf5d853ad42058480a1b8
-  data.tar.gz: 916b60c7bbffee5b014f634fc652fe07e9fc2136
+  metadata.gz: 62b43e9bbbd325c266ea3353f8117437d9e28aa9
+  data.tar.gz: f1265853cac0fe2d6c164edf2d8a2f3572937eb0
 SHA512:
-  metadata.gz: 68019f8c76a2b4efc04777ef43ddac3ea23c0e16cca1eba58654de2cfbffb36cdbf80df592b16c8057f01e36a0eb29931b10bbda26f7a40194305ed095a226f4
-  data.tar.gz: b5a5dc1c0a417efa43345db4af7244020e84073e3d065321ce5e843727ade6b560a4aa1773bd6ba290aa2ea585ae0f4572e61922db5c9d19acb5341e8603a9ec
+  metadata.gz: ea1959e7315819eaefd3f77aef057a9da2b1d3e423cebf859a93c7e37e152fc2849f535d49c050d1b805b34bad499945ce203dcddfb4d79ce65d4c7ada8add06
+  data.tar.gz: 5c75677b4298ae512b46008c9b2c81ce3e28e92806ce28378fd550501118d6ad4f9a1cb19060ea77bcc26b6ac41b3cbb34c2585e79be142c379c32a25065ff66

data/README.md

@@ -9,6 +9,17 @@ 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](#usage)
+* [Options](#options)
+    * [Overriding facts](#overriding-facts)
+    * [Filtering output](#filtering-output)
+    * [Displaying sources for results](#displaying-sources-for-results)
+* [Adding supported backends](#adding-supported-backends)
+* [Disclaimer](#disclaimer)
+* [Contact](#contact)
+
+![Screenshot](screenshot.png)
+
 ## Usage
 
 The examples here will use this sample `hiera.yaml` configuration file:
@@ -107,16 +118,14 @@ Array lookup results:
    * 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('pe_repo::base_path') => Not a hash datatype in ["master.puppetlabs.vm.yaml", "classroom.yaml"]
+   * hiera_hash('puppet_enterprise::profile::console::rbac_session_timeout') => Not a hash datatype in ["classroom.yaml"]
+   * hiera_hash('puppet_enterprise::profile::puppetdb::listen_address') => Not a hash datatype in ["classroom.yaml"]
+   * hiera_hash('message') => Not a hash datatype in ["defaults.yaml", "overrides.json"]
+   * hiera_hash('foo') => Not a 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
@@ -128,6 +137,9 @@ root@master:~ # hiera_explain -h
 
 Usage : hiera_explain [--json PATH] [--yaml PATH] [--mcollective IDENTITY] [--puppetdb IDENTITY].
 
+    -c, --config CONFIG              Load Hiera settings from an alternate hiera.yaml.
+    -f, --filter FILTER              Only keys matching this string or regex will be displayed.
+    -v, --verbose                    Show verbose datasource details.
     -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.
@@ -139,6 +151,8 @@ Usage : hiera_explain [--json PATH] [--yaml PATH] [--mcollective IDENTITY] [--pu
     -h, --help                       Displays this help
 ```
 
+#### Overriding facts
+
 You can even override facts one at a time on the command line.
 
 ```
@@ -159,6 +173,66 @@ Expanded hierarchy:
   * defaults
 ```
 
+#### Filtering output
+
+If you have many keys set and the output is too long, you can pass in a filter
+using either a full string or a regular expression. For example:
+
+```
+root@master:~ # hiera_explain -f message
+[...]
+Priority lookup results:
+   * hiera('message') => This message is customized for the master.
+
+Array lookup results:
+   * hiera_array('message') => ["This message is customized for the master.", "This is a sample variable that came from a Hiera datasource"]
+
+Hash lookup results:
+   * hiera_hash('message') => Not a hash datatype in ["master.puppetlabs.vm.yaml", "defaults.yaml"]
+
+root@master:~ # hiera_explain -f /^puppet_enterprise/
+[...]
+Priority lookup results:
+   * hiera('puppet_enterprise::profile::console::rbac_session_timeout') => 4320
+   * hiera('puppet_enterprise::profile::puppetdb::listen_address') => 0.0.0.0
+
+Array lookup results:
+   * hiera_array('puppet_enterprise::profile::console::rbac_session_timeout') => [4320]
+   * hiera_array('puppet_enterprise::profile::puppetdb::listen_address') => ["0.0.0.0"]
+
+Hash lookup results:
+   * hiera_hash('puppet_enterprise::profile::console::rbac_session_timeout') => Not a hash datatype in ["classroom.yaml"]
+   * hiera_hash('puppet_enterprise::profile::puppetdb::listen_address') => Not a hash datatype in ["classroom.yaml"]
+```
+
+#### Displaying sources for results
+
+To see which datasource(s) resolved any given variable returned, you can pass the
+`--verbose` flag. This might generate a very long printout, so you might want to
+couple it with the `--filter` flag as well.
+
+```
+root@master:~ # hiera_explain -v -f /message/
+[...]
+Priority lookup results:
+   * hiera('message') => This message is customized for the master.
+      - /etc/puppetlabs/code/hieradata/master.puppetlabs.vm.yaml
+   * hiera('hashmessage') => {"key"=>"A message embedded in a hash"}
+      - /etc/puppetlabs/code/hieradata/defaults.yaml
+
+Array lookup results:
+   * hiera_array('message') => ["This message is customized for the master.", "This is a sample variable t4hat came from a Hiera datasource"]
+      - /etc/puppetlabs/code/hieradata/master.puppetlabs.vm.yaml
+      - /etc/puppetlabs/code/hieradata/defaults.yaml
+   * hiera_array('hashmessage') => [{"key"=>"A message embedded in a hash"}]
+      - /etc/puppetlabs/code/hieradata/defaults.yaml
+
+Hash lookup results:
+   * hiera_hash('message') => Not a hash datatype in ["master.puppetlabs.vm.yaml", "defaults.yaml"]
+   * hiera_hash('hashmessage') => {"key"=>"A message embedded in a hash"}
+      - /etc/puppetlabs/code/hieradata/defaults.yaml
+```
+
 ### Adding supported backends.
 
 A standard Hiera backend won't provide the data we need to look up all available
@@ -171,10 +245,10 @@ hash of Hiera data, given a path.
 ```ruby
 class HieraExplain::Datasource
 
-  # marshall is a data serialization format for Ruby. There does not exist
+  # marshal 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)
+  def self.marshal(path)
     Marshal::load(File.read(path))
   end
 
@@ -185,21 +259,22 @@ The filename and the method it provides *must* be the same as the name for your
 backend.
 
 ```
-root@master:modules # $ tree marshall
-marshall
+root@master:modules # $ tree marshal
+marshal
 └── lib
     ├── hiera
     │   └── backends
-    │       └── marshall_backend.rb
+    │       └── marshal_backend.rb
     └── hiera_explain
         └── datasource
-            └── marshall.rb
+            └── marshal.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.
+in the classroom for quite a while now. This currently only supports Hiera
+version 1.x.
 
 Contact
 -------

data/bin/hiera_explain

@@ -14,13 +14,32 @@ rescue => e
   Puppet.settings.parse
 end
 
-hiera = Hiera.new(:config => Puppet.settings[:hiera_config])
-scope = HieraExplain::Scope.new()
+config  = Puppet.settings[:hiera_config]
+scope   = HieraExplain::Scope.new()
+filter  = nil
+verbose = false
+
 optparse = OptionParser.new { |opts|
     opts.banner = "Usage : hiera_explain [--json PATH] [--yaml PATH] [--mcollective IDENTITY] [--puppetdb IDENTITY].
 
 "
 
+    opts.on("-c CONFIG", "--config CONFIG", "Load Hiera settings from an alternate hiera.yaml.") do |arg|
+      config = File.expand_path(arg)
+    end
+
+    opts.on("-f FILTER", "--filter FILTER", "Only keys matching this string or regex will be displayed.") do |arg|
+      if arg[0] == '/' and arg[-1] == '/'
+        filter = Regexp.new(arg[1...-1])
+      else
+        filter = arg
+      end
+    end
+
+    opts.on("-v", "--verbose", "Show verbose datasource details.") do
+      verbose = true
+    end
+
     opts.on("-j PATH", "--json PATH", "Load scope from a JSON file.") do |arg|
       scope.load_scope(arg, :json)
     end
@@ -64,15 +83,20 @@ optparse = OptionParser.new { |opts|
 }
 optparse.parse!
 
-# Default to the curren't node's MCO's fact cache
+# Default to the current 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     = {}
+priority_lookup  = {}
+priority_sources = {}
+
+array_lookup     = {}
+array_sources    = {}
+
+hash_lookup      = {}
+hash_sources     = {}
+hash_errors      = {}
 
 # Cribbed from Hiera source to ensure we're parsing the same way.
 unless ARGV.empty?
@@ -85,8 +109,17 @@ unless ARGV.empty?
   end
 end
 
+# now that we've got scope, start evaluating it.
+hiera = Hiera.new(:config => config)
+
 puts 'Backend data directories:'
 Hiera::Config[:backends].each do |backend|
+  # make sure we've got any third-party datasources loaded up
+  begin
+    require "hiera_explain/datasource/#{backend}"
+  rescue LoadError => e
+  end
+
   puts "  * #{backend}: #{Hiera::Backend.datadir(backend, scope)}"
 end
 puts
@@ -115,12 +148,19 @@ Hiera::Config[:backends].each do |backend|
       priority_lookup = data.merge(priority_lookup)
 
       data.each do |key, value|
+        priority_sources[key] ||= path
+        array_sources[key]    ||= Array.new
+        hash_sources[key]     ||= Array.new
+
+
         array_lookup[key] ||= Array.new
-        array_lookup[key] << value
+        array_lookup[key]  << value
+        array_sources[key] << path
 
         hash_lookup[key] ||= Hash.new
         if (value.class == Hash)
           hash_lookup[key].merge!(value)
+          hash_sources[key]  << path
         else
           hash_errors[key] ||= Array.new
           hash_errors[key]  << "#{source}.#{backend}"
@@ -134,20 +174,31 @@ end
 puts
 
 puts 'Priority lookup results:'
-priority_lookup.each { |key, value| puts "   * hiera('#{key}') => #{value.to_s.green}" }
+priority_lookup.each do |key, value|
+  next unless HieraExplain.match(key, filter)
+  puts "   * hiera('#{key}') => #{value.to_s.green}"
+  puts "      - #{priority_sources[key].cyan}" if verbose
+end
 puts
 
 puts 'Array lookup results:'
-array_lookup.each { |key, value| puts "   * hiera_array('#{key}') => #{value.inspect.green}" }
+array_lookup.each do |key, value|
+  next unless HieraExplain.match(key, filter)
+  puts "   * hiera_array('#{key}') => #{value.inspect.green}"
+  array_sources[key].each { |source| puts "      - #{source.cyan}"} if verbose
+end
 puts
 
 puts 'Hash lookup results:'
 hash_lookup.each do |key, value|
+  next unless HieraExplain.match(key, filter)
+
   print "   * hiera_hash('#{key}') => "
   if(hash_errors.has_key? key)
-    puts "No hash datatype in #{hash_errors[key].inspect}".red
+    puts "Not a hash datatype in #{hash_errors[key].inspect}".red
   else
     puts value.inspect.green
   end
+  hash_sources[key].each { |source| puts "      - #{source.cyan}"} if verbose
 end
 puts

data/lib/hiera_explain.rb

@@ -3,11 +3,6 @@ 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
@@ -17,4 +12,16 @@ class HieraExplain
 
     data
   end
+
+  def self.match(key, filter)
+    return true if filter.nil?
+
+    case filter
+    when String
+      key == filter
+    when Regexp
+      key =~ filter
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hiera_explain
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ben Ford
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-09 00:00:00.000000000 Z
+date: 2016-04-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: puppet
@@ -68,7 +68,7 @@ files:
 - README.md
 - LICENSE
 - bin/hiera_explain
-- lib/hiera_explain/datasource/marshall.rb
+- lib/hiera_explain/datasource/marshal.rb
 - lib/hiera_explain/datasource.rb
 - lib/hiera_explain/scope.rb
 - lib/hiera_explain.rb