hiera-examiner 0.3.11 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 27cfbdf5d39f17c19a04c2148e0c265265cff6c2
-  data.tar.gz: 88f7b9160086c98d044ebff2cca705894e7db9a6
+  metadata.gz: 4c29d2f21e94a81e69792ddad6a67a760e91cb2e
+  data.tar.gz: 4ac6a723906532cac3a686178d97fa35cd51cc41
 SHA512:
-  metadata.gz: da7165f4654e54e73c51c58c451abf754f4c3e62027802df246e91add7d12b633554df47612edc396537ee4e41178a410d10db21ea3c0a4d68ce8c299f69f2a5
-  data.tar.gz: e6f5b6b525c490e94c921d0e3e8ca980edee6805152eba6e1dd923a0b43a8220b7229bbc6dac14571bb9d128f3cfcdedc292714913013e7611f770cdf2dabeea
+  metadata.gz: 8609583d93fdfc0af31d0cc8686e9cd670813b978d280223ce925ccf0be39f0e107dacca70bad4824aa2f5d28b6a2eaa2cca7e5cb8ab8620d224ceb19f8749cf
+  data.tar.gz: a2654674b75df2206b95fe28ef85763a8222a7390ecef7800f3ce3065fc35442743492b34873eb80040815f5544653f8b3e3756b4a9d23f125939a7806258468

data/bin/hiera-examiner

@@ -1,17 +1,203 @@
 #!/usr/bin/env ruby
 
+$LOAD_PATH.delete '.'
+
+# CLI client for Hiera Examiner.
 require 'hiera-examiner'
+require 'hiera/util'
+require 'optparse'
+require 'pp'
+
+options = {
+  :default => nil,
+  :config  => '/vagrant/puppet/hiera/hiera.yaml',
+  :scope   => {},
+  :key     => nil,
+  :verbose => false,
+  :resolution_type => :priority
+}
+
+# Loads the scope from YAML or JSON files
+def load_scope(source, type=:yaml)
+  case type
+  when :mcollective
+    begin
+      require 'mcollective'
+
+      include MCollective::RPC
+
+      util = rpcclient("rpcutil")
+      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)
+
+    # Puppet makes dumb yaml files that do not promote data reuse.
+    scope = scope.values if scope.is_a?(Puppet::Node::Facts)
+
+  when :json
+    raise "Cannot find scope #{type} file #{source}" unless File.exist?(source)
+
+    require 'json'
+
+    scope = JSON.load(File.read(source))
+
+  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}"
+        exit 1
+    end
+  else
+    raise "Don't know how to load data type #{type}"
+  end
 
-if (ARGV[0])
-	examiner = HieraExaminer.new()		
-	if (ARGV[1])
-		examiner = HieraExaminer.new(ARGV[1])
-	end
-	
-	examiner.explain(ARGV[0])
+  raise "Scope from #{type} file #{source} should be a Hash" unless scope.is_a?(Hash)
+
+  scope
+end
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: hiera [options] key [default value] [variable='text'...]\n\nThe default value will be used if no value is found for the key. Scope variables\nwill be interpolated into %{variable} placeholders in the hierarchy and in\nreturned values.\n\n"
+
+  #opts.on("--version", "-V", "Version information") do
+  #  puts Hiera.version
+  #  exit
+  #end
+
+  opts.on("--debug", "-d", "Show debugging information") do
+    options[:verbose] = true
+  end
+
+  opts.on("--array", "-a", "Return all values as an array") do
+    options[:resolution_type] = :array
+  end
+
+  opts.on("--hash", "-h", "Return all values as a hash") do
+    options[:resolution_type] = :hash
+  end
+
+  opts.on("--config CONFIG", "-c", "Configuration file") do |v|
+    if File.exist?(v)
+      options[:config] = v
+    else
+      STDERR.puts "Cannot find config file: #{v}"
+      exit 1
+    end
+  end
+
+  opts.on("--json SCOPE", "-j", "JSON format file to load scope from") do |v|
+    begin
+      options[:scope] = load_scope(v, :json)
+    rescue Exception => e
+      STDERR.puts "Could not load JSON scope: #{e.class}: #{e}"
+      exit 1
+    end
+  end
+
+  opts.on("--yaml SCOPE", "-y", "YAML format file to load scope from") do |v|
+    begin
+      options[:scope] = load_scope(v)
+    rescue Exception => e
+      STDERR.puts "Could not load YAML scope: #{e.class}: #{e}"
+      exit 1
+    end
+  end
+
+  opts.on("--mcollective IDENTITY", "-m", "Use facts from a node (via mcollective) as scope") do |v|
+    begin
+      options[:scope] = load_scope(v, :mcollective)
+    rescue Exception => e
+      STDERR.puts "Could not load MCollective scope: #{e.class}: #{e}"
+      exit 1
+    end
+  end
+
+  opts.on("--inventory_service IDENTITY", "-i", "Use facts from a node (via Puppet's inventory service) as scope") do |v|
+    begin
+      options[:scope] = load_scope(v, :inventory_service)
+    rescue Exception => e
+      STDERR.puts "Could not load Puppet inventory service scope: #{e.class}: #{e}"
+      exit 1
+    end
+  end
+end.parse!
+
+# arguments can be:
+#
+# key default var=val another=val
+#
+# The var=val's assign scope
+unless ARGV.empty?
+  options[:key] = ARGV.delete_at(0)
+
+  ARGV.each do |arg|
+    if arg =~ /^(.+?)=(.+?)$/
+      options[:scope][$1] = $2
+    else
+      unless options[:default]
+        options[:default] = arg.dup
+      else
+        STDERR.puts "Don't know how to parse scope argument: #{arg}"
+      end
+    end
+  end
 else
-	puts 'hiera-examiner Usage:'
-	puts 'hiera-examiner <key> [path]'
-	puts '\tkey:\tHiera key to examine'
-	puts '\tpath:\tPath to hiera config file to use.  Default: /vagrant/puppet/hiera/hiera.yaml'
-end
+  STDERR.puts "Please supply a data item to look up"
+  exit 1
+end
+
+begin
+  hieraExaminer = HieraExaminer.new(options[:config])
+rescue Exception => e
+  if options[:verbose]
+    raise
+  else
+    STDERR.puts "Failed to start HieraExaminer: #{e.class}: #{e}"
+    exit 1
+  end
+end
+
+unless options[:verbose]
+  #HieraExaminer.logger = "noop"
+end
+
+hieraExaminer.explain(options[:key], options[:scope])

data/lib/hiera-examiner.rb

@@ -5,14 +5,14 @@ class HieraExaminer
 	require 'puppet'
 	require 'colorize'
 	
-	def initialize(conf = "/vagrant/puppet/hiera/hiera.yaml")
-		puts 'Conf = ' + conf
+	def initialize(conf)
+		puts conf
 		@conf = conf
 	end
 
-	def yamlLookup(key) 
-		scope = YAML.load("")
-		scope = {}
+	def yamlLookup(key, scope) 
+		# scope = YAML.load("")
+		# scope = {}
 		hiera = Hiera.new(:config => @conf) 
 		value = {val: nil, file: nil}
 		Hiera::Backend.datasourcefiles('yaml', scope, 'yaml') { |source, file| 
@@ -24,19 +24,26 @@ class HieraExaminer
 		return value
 	end
 	
-	def hieraLookup(key) 
-		scope = YAML.load("")
-		scope = {}
+	def hieraLookup(key, scope) 
+		# scope = YAML.load("")
+		# scope = {}
 		hiera = Hiera.new(:config => @conf) 
 		puts "Looking up '#{key}' in '#{@conf}' with '#{scope}'"
 		return hiera.lookup(key, @conf, scope)
 	end
 	
-	def explain(key)
-		puts "#{key.red}\n#{explainDetail(key, '', true)}"
+	def explain(key, scope)
+		puts 'key ' + (key or "UNKNOWN")
+		print 'scope ' 
+		puts scope
+		
+		puts "#{key.red}\n#{explainDetail(key, scope, '', true)}"
 	end
+	# def explain1(key)
+	# 	puts "#{key.red}\n#{explainDetail(key, '', true)}"
+	# end
 	
-	def explainDetail(key, prefix = '', showSource = false, yamlFileParam = '')
+	def explainDetail(key, scope, prefix = '', showSource = false, yamlFileParam = '')
 		startExp = /%{hiera\('/
 		endExp = /'\)}/
 		
@@ -46,7 +53,7 @@ class HieraExaminer
 			newIndex = firstIndex + 9
 			endIndex = key.index(endExp) - 1
 			padding = "#{prefix}#{' '.rjust((firstIndex + 2) - prefix.length)}"
-			yamlMap = yamlLookup(key[newIndex..endIndex])
+			yamlMap = yamlLookup(key[newIndex..endIndex], scope)
 			yamlVal = yamlMap[:val]
 			yamlFile = yamlMap[:file]
 			
@@ -81,8 +88,8 @@ class HieraExaminer
 			
 			return res
 		else
-			hieraVal = hieraLookup(key)
-			yamlMap = yamlLookup(key)
+			hieraVal = hieraLookup(key, scope)
+			yamlMap = yamlLookup(key, scope)
 			yamlVal = yamlMap[:val]
 			yamlFile = yamlMap[:file]
 			

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hiera-examiner
 version: !ruby/object:Gem::Version
-  version: 0.3.11
+  version: 0.4.1
 platform: ruby
 authors:
 - Adam Stortz