erb-hiera 0.4.4 → 0.5.0.pre.rc0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 4642172c2c4bab8f39e492e461256322096897a32272fe87047cfeaf2341816f
-  data.tar.gz: 7e2cebbe242334a48b41232e94cc47b3484310d973320897f677454c72966c6d
+SHA1:
+  metadata.gz: 2ca8894f2efe1edb0039fbacff8c3295e8105e89
+  data.tar.gz: a0003dd9922d0c13660882553231e09810592b6d
 SHA512:
-  metadata.gz: 85ba2730995a1fe190f572ca7113afbfd6230d573fc3e9a255fa96cc2a985ddb962db5667ce87a48eb2d06602e83f06f8ea59aa3ed648d7a562ce34160907a41
-  data.tar.gz: d5b80222740cf2a94b0955b09c6824ea199722b8c41be59e4a71709063ad00efb4439988d476b2b830a2b47cb0367ed37c5d6ffafdff78bd42b323248b065b7c
+  metadata.gz: 7475d8b195b11559609c2f9e665459516bc7b458dc2de6015ea22d4fc4c475669fc94efc8c83c64c19a2ef1d2be4c843afd5c5242e72372faf66854c7744349c
+  data.tar.gz: ff648a3b56a1437e65654ca456ad8982f974d65fefb0831545eff259f7354ed7054c2ab4dcae056e4d26fec556edc52ea87e5177a0b4a45dc74830507818e256

data/README.md

@@ -15,18 +15,33 @@ gem install erb-hiera
 ```
 $ ./bin/erb-hiera --help
 Options:
-  --config=<s>          specify config file
-  --hiera-config=<s>    specify hiera config file
-  --dry-run             don't write out files
-  --verbose             print compiled template(s)
-  --debug               print backtrace on error
+  -m, --mapping-config=<s>    specify mapping config file
+  -c, --hiera-config=<s>      specify hiera config file
+                               
+  -i, --input=<s>             override input config options
+  -o, --output=<s>            override output config options
+                               
+  -s, --scope=<s>             override the lookup scope
+  -v, --variables=<s>         override facts
+                               
+  --dry-run                   don't write out files
+                               
+  --verbose                   print compiled templates
+  --debug                     enable hiera logging and print backtrace on error
+                               
 ```
 
 ## Example
 
 ```
 cd example
-erb-hiera --config config.yaml --hiera-config hiera.yaml --verbose
+erb-hiera --mapping-config mapping.yaml --hiera-config hiera.yaml --verbose
+
+# render a specific template using injected erb scope (outputs only to stdout)
+erb-hiera --mapping-config mapping.yaml --hiera-config hiera.yaml --scope '{ "environment": "prod" }' -o -
+
+# use normal lookup path but override a fact at the top level
+erb-hiera --mapping-config mapping.yaml --hiera-config hiera.yaml --variables '{ "environment::description": "override description" }' -o -
 ```
 
 ## References

data/example/hiera/environment/default.yaml

@@ -0,0 +1 @@
+environment::description: "this is the default environment"

data/example/hiera/environment/prod.yaml

@@ -0,0 +1 @@
+environment::description: "this is the prod environment"

data/example/output/prod/template.txt

@@ -0,0 +1,2 @@
+common variable: some common variable
+environment variable: this is the prod environment

data/lib/erb-hiera/cli.rb

@@ -4,11 +4,19 @@ module ErbHiera
   module CLI
     def self.parse
       option_parser = Trollop::Parser.new do
-        opt :config,       "specify config file", :type => :string
-        opt :hiera_config, "specify hiera config file", :type => :string
-        opt :verbose,      "print compiled templates"
-        opt :debug,        "print backtrace on error"
-        opt :dry_run,      "don't write out files"
+        opt :mapping_config, "specify mapping config file",       :type => :string, :short => :m
+        opt :hiera_config,   "specify hiera config file\n ",      :type => :string, :short => :c
+
+        opt :input,          "override input config options",     :type => :string, :short => :i
+        opt :output,         "override output config options\n ", :type => :string, :short => :o
+
+        opt :scope,          "override the lookup scope",         :type => :string, :short => :s
+        opt :variables,      "override facts\n ",                 :type => :string, :short => :v
+
+        opt :dry_run,        "don't write out files\n "
+
+        opt :verbose,        "print compiled templates"
+        opt :debug,          "enable hiera logging and print backtrace on error\n "
       end
 
       options = Trollop.with_standard_exception_handling(option_parser) do
@@ -18,9 +26,9 @@ module ErbHiera
         option_parser.parse ARGV
       end
 
-      # validate cli args
-      raise ArgumentError, "config file not specified" unless options[:config_given]
-      raise ArgumentError, "config file not readable"  unless File.readable?(options[:config])
+      if options[:config_given]
+        raise ArgumentError, "config file not readable"  unless File.readable?(options[:config])
+      end
 
       raise ArgumentError, "hiera config file not specified" unless options[:hiera_config_given]
       raise ArgumentError, "hiera config file not readable"  unless File.readable?(options[:hiera_config])

data/lib/erb-hiera/hiera.rb

@@ -2,38 +2,26 @@ require "hiera"
 
 module ErbHiera
   module Hiera
-    def self.hiera(key)
-      hiera = ::Hiera.new(:config => ErbHiera.options[:hiera_config])
-      ::Hiera.logger = "noop"
-      value = hiera.lookup(key, nil, ErbHiera.scope, nil, :priority)
+    def self.erb_hiera
+      @hiera ||= begin
+        hiera = ::Hiera.new(:config => ErbHiera.options[:hiera_config])
 
-      unless value
-        puts "\nerror: cannot find value for key: #{key}"
-        exit 1
-      end
+        # injecting the Hash backend ensures that the --variables flag will always work as expected
+        hiera.config[:backends].insert(0, "hash") unless hiera.config[:backends][0] == "hash"
 
-      puts "# #{key}: #{value}" if ErbHiera.options[:verbose]
-      value
-    end
+        ::Hiera.logger = ErbHiera.options[:debug_given] ? "console" : "noop"
 
-    def self.hiera_array(key)
-      hiera = ::Hiera.new(:config => ErbHiera.options[:hiera_config])
-      ::Hiera.logger = "noop"
-      value = hiera.lookup(key, nil, ErbHiera.scope, nil, :array)
+        if ErbHiera.options[:debug_given]
+          puts "# hiera config"
+          puts hiera.config.to_yaml
+        end
 
-      unless value
-        puts "\nerror: cannot find value for key: #{key}"
-        exit 1
+        hiera
       end
-
-      puts "# #{key}: #{value}" if ErbHiera.options[:verbose]
-      value
     end
 
-    def self.hiera_hash(key)
-      hiera = ::Hiera.new(:config => ErbHiera.options[:hiera_config])
-      ::Hiera.logger = "noop"
-      value = hiera.lookup(key, nil, ErbHiera.scope, nil, :hash)
+    def self.hiera(key, type: :priority)
+      value = erb_hiera.lookup(key, nil, ErbHiera.scope, nil, type)
 
       unless value
         puts "\nerror: cannot find value for key: #{key}"
@@ -44,6 +32,17 @@ module ErbHiera
       value
     end
 
+    def self.hiera_array(key)
+      hiera(key, type: :array)
+    end
+
+    def self.hiera_hash(key)
+      hiera(key, type: :hash)
+    end
+
+    private
+
+    # bind calls from template to context of this module
     def self.get_binding
       binding
     end

data/lib/erb-hiera/version.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
 module ErbHiera
-  VERSION = "0.4.4"
+  VERSION = "0.5.0-rc0"
 end

data/lib/erb-hiera.rb

@@ -2,6 +2,7 @@
 
 require "erb"
 require "yaml"
+require "json"
 require "fileutils"
 
 require "erb-hiera/version"
@@ -10,6 +11,8 @@ require "erb-hiera/directory"
 require "erb-hiera/hiera"
 require "erb-hiera/manifest"
 
+require "hiera/backend/hash_backend"
+
 module ErbHiera
   class << self
     attr_accessor :options, :scope
@@ -17,17 +20,20 @@ module ErbHiera
 
   def self.run
     @options = CLI.parse
-
     mappings.each do |mapping|
-      ErbHiera.scope  = mapping["scope"]
-      input           = mapping["dir"]["input"]
-      output          = mapping["dir"]["output"]
+      ErbHiera.scope  = scope_from_cli   || mapping["scope"]
+      input           = options[:input]  || mapping["dir"]["input"]
+      output          = options[:output] || mapping["dir"]["output"]
 
       [:input, :output].each do |location|
-        raise StandardError, "error: undefined #{dir.to_s.split('_')[0]}put" unless binding.local_variable_get(location)
+        unless binding.local_variable_get(location)
+          raise StandardError, "error: undefined #{dir.to_s.split('_')[0]}put"
+        end
       end
 
-      # if input is a file then out_file is a file too
+      output = STDOUT if output == "-"
+
+      # if input is a file then out_file should be a file too
       if input =~ /.erb$/
         generate(output, input)
         next
@@ -41,22 +47,29 @@ module ErbHiera
     end
   rescue => error
     handle_error(error)
-    exit 1
   end
 
   private
 
+  def self.scope_from_cli
+    JSON.load(options[:scope]) if options[:scope]
+  end
+
   def self.generate(out_file, manifest)
     Manifest.info(manifest, out_file) if options[:verbose]
-
     erb = ERB.new(File.read(manifest), nil, "-").result(Hiera.get_binding)
 
     puts erb if options[:verbose]
 
-    unless options[:dry_run]
-      FileUtils.mkdir_p File.dirname(out_file) unless Dir.exists?(File.dirname(out_file))
-      File.write(out_file, erb)
+    return if options[:dry_run]
+
+    if out_file == STDOUT
+      puts erb
+      return
     end
+
+    FileUtils.mkdir_p File.dirname(out_file) unless Dir.exists?(File.dirname(out_file))
+    File.write(out_file, erb)
   end
 
   def self.handle_error(error)
@@ -67,10 +80,11 @@ module ErbHiera
 
     puts
     puts error
+    exit 1
   end
 
   def self.mappings
-    YAML.load_file(options[:config])
+    YAML.load_file(ErbHiera.options[:mapping_config])
   end
 
   def self.manifests(dir)

data/lib/hiera/backend/hash_backend.rb

@@ -0,0 +1,52 @@
+class Hiera
+  module Backend
+    class Hash_backend
+      def initialize(cache=nil)
+        Hiera.debug("Hiera Hash backend starting")
+      end
+
+      def lookup(key, scope, order_override, resolution_type, context)
+        answer = nil
+        found = false
+
+        Hiera.debug("Looking up #{key} in Hash backend")
+
+        throw :no_such_key unless ErbHiera.options[:variables_given]
+
+        data = JSON.load(ErbHiera.options[:variables])
+
+        throw :no_such_key unless data.include?(key)
+        found = true
+
+        # Extra logging that we found the key. This can be outputted
+        # multiple times if the resolution type is array or hash but that
+        # should be expected as the logging will then tell the user ALL the
+        # places where the key is found.
+        Hiera.debug("Found #{key} in Hash backend")
+
+        # for array resolution we just append to the array whatever
+        # we find, we then goes onto the next file and keep adding to
+        # the array
+        #
+        # for priority searches we break after the first found data item
+        new_answer = Backend.parse_answer(data[key], scope, {}, context)
+        case resolution_type.is_a?(Hash) ? :hash : resolution_type
+        when :array
+          raise Exception, "Hiera type mismatch for key '#{key}': expected Array and got #{new_answer.class}" unless new_answer.kind_of? Array or new_answer.kind_of? String
+          answer ||= []
+          answer << new_answer
+        when :hash
+          raise Exception, "Hiera type mismatch for key '#{key}': expected Hash and got #{new_answer.class}" unless new_answer.kind_of? Hash
+          answer ||= {}
+          answer = Backend.merge_answer(new_answer, answer, resolution_type)
+        else
+          answer = new_answer
+          return answer
+        end
+
+        throw :no_such_key unless found
+        return answer
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: erb-hiera
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0.pre.rc0
 platform: ruby
 authors:
 - Rob Wilson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-09 00:00:00.000000000 Z
+date: 2018-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hiera
@@ -103,12 +103,15 @@ extra_rdoc_files: []
 files:
 - README.md
 - bin/erb-hiera
-- example/config.yaml
 - example/hiera.yaml
 - example/hiera/common.yaml
+- example/hiera/environment/default.yaml
 - example/hiera/environment/dev.yaml
+- example/hiera/environment/prod.yaml
 - example/hiera/environment/stage.yaml
+- example/mapping.yaml
 - example/output/dev/template.txt
+- example/output/prod/template.txt
 - example/output/stage/template.txt
 - example/templates/template.txt
 - lib/erb-hiera.rb
@@ -117,6 +120,7 @@ files:
 - lib/erb-hiera/hiera.rb
 - lib/erb-hiera/manifest.rb
 - lib/erb-hiera/version.rb
+- lib/hiera/backend/hash_backend.rb
 homepage: https://github.com/roobert/erb-hiera
 licenses:
 - MIT
@@ -132,12 +136,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: ERB Hiera Document Generator