minfra-cli 3.0.2 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92da9781782e7ba198def006e419ccdcdd1fd09ebec4c3850b7aa6f8c49df1c2
-  data.tar.gz: 45d9cacec937e7a3f54e9c728ccec7162f74425cfb2b6ad9994ef910d31491fa
+  metadata.gz: 57af73071c5c324ef7f908176a695c2cbdee6d2a1be1d65f6d0b9a9055c10aa4
+  data.tar.gz: 45e45f3bc0766a8fe6354f3b036bcb3327a4c79df5c1026a9e84d3f8314b8b37
 SHA512:
-  metadata.gz: a7c643f8620a6f35877a38cd2e7b0c2b01c72404c13fc959ad786c362c45991df8b4c8a5bb701f21453646ce81cb7e22c3b3ccddea468e1e58ac8ada595e45c4
-  data.tar.gz: 041023473c66e0debd3e0f549e137795b532d1275d7fc31c4217ce6da7a2b108b78e30bcc04137a68e9019e2502e6d2f69960fd76f0123d2a5dbafbdcfc85a5e
+  metadata.gz: 242cdcc9c027b110adc0fc0c3615de37a627888a594b8104212c9631530c99d7b8fafcc1ab5f3bd7808cc08af53c988b309394583c6abf4a40b7b49b25c9318e
+  data.tar.gz: 286be675ceb5ad1839d5c500fb2e23219fa7dbce860dbe1308f5d884e0c350898b541de1288088e2330b46b1022f93786ca925d8bff608b5cf903737350d090e

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# 3.1.0
+ * overriding backends via MINFRA_HIERA_BACKENDS
+ * overriding Yaml Backend to allow :extension: setting
 # 3.0.2
  * removing complex dns manipulation and hardcoding google servers
 # 3.0.1

data/README.md

@@ -17,7 +17,7 @@ Is a KIND (k8s in docker) based development environment.
 |   |                      | default_stacks        |                                              | env.stacks or  env.roles   |
 |   |                      |                       |                  | infra::allow_insecure_k8s_connections |
 | when set to 'true' all hiera lookups are logged on debug level  | MINFRA_DEBUG_HIERA_LOOKUPS | | | |
-
+| to override the backends in the hiera file, comma separated | MINFRA_HIERA_BACKENDS | | | |
 
 ## Expected hiera data
 

data/lib/minfra/cli/cli_starter.rb

@@ -150,7 +150,13 @@ module Minfra
         root = base_path.join('hiera')
         root.join('hieradata',env_path).glob('*.eyaml').sort.each do |path|
           env_name = path.basename.sub(/(\..+)/,'').to_s
-          @envs[env_name]=Env.new(hiera_root: root, hiera_env_path: env_path, name: env_name, hiera_debug_lookups: ENV['MINFRA_DEBUG_HIERA_LOOKUPS'] == 'true')
+          @envs[env_name]=Env.new(
+            hiera_root: root, 
+            hiera_env_path: env_path, 
+            name: env_name, 
+            hiera_debug_lookups: ENV['MINFRA_DEBUG_HIERA_LOOKUPS'] == 'true', 
+            backends: ENV.fetch('MINFRA_HIERA_BACKENDS','').split(',')
+          )
         end
         @env = @envs[@env_name] # set the current env
       end

data/lib/minfra/cli/env.rb

@@ -2,13 +2,14 @@ module Minfra
   module Cli
     class Env
       attr_reader :name, :hiera
-      def initialize(name:, hiera_root:,   hiera_env_path:, hiera_debug_lookups: )
+      def initialize(name:, hiera_root:,   hiera_env_path:, hiera_debug_lookups:, backends: )
         @name = name            
         @hiera = HieraLooker.new( 
           root: hiera_root,
           env_name: name,
           env_path: hiera_env_path,
-          debug_lookups: hiera_debug_lookups
+          debug_lookups: hiera_debug_lookups,
+          backends: backends
         )
       end
       

data/lib/minfra/cli/hiera_looker.rb

@@ -5,13 +5,20 @@ module Minfra
   module Cli
     class HieraLooker
       include Logging
-      def initialize(root:, env_name:, env_path:, debug_lookups: false)
+      def initialize(root:, env_name:, env_path:, debug_lookups: false, backends: nil)
         @root = Pathname.new(root)
         @env_name = env_name
         @cache = {}
 
         @hiera = Hiera.new(config: @root.join('hiera.yaml').to_s)
+        # now that hiera has loaded the backends let's patch 'em
+        require 'minfra/cli/hiera_yaml_backend_patch' if defined?(Hiera::Backend::Yaml_backend)
+        
         Hiera.logger = :noop
+        if backends && !backends.empty?
+          @hiera.config[:backends] = backends 
+          Hiera::Config.load_backends
+        end
 
         hiera_main_path = @root.join("hieradata/#{env_path}/#{env_name}.eyaml")
 

data/lib/minfra/cli/hiera_yaml_backend_patch.rb

@@ -0,0 +1,50 @@
+class Hiera
+  module Backend
+    class Yaml_backend
+
+      def lookup(key, scope, order_override, resolution_type, context)
+        answer = nil
+        found = false
+
+        Hiera.debug("Looking up #{key} in YAML backend")
+        Backend.datasourcefiles(:yaml, scope, Config[:yaml][:extension] || "yaml", order_override) do |source, yamlfile|
+          data = @cache.read_file(yamlfile, Hash) do |data|
+            YAML.load(data) || {}
+          end
+
+          next if data.empty?
+          next 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 #{source}")
+
+          # 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
+            break
+          end
+        end
+        throw :no_such_key unless found
+        return answer
+      end
+    end
+  end
+end

data/lib/minfra/cli/version.rb

@@ -2,6 +2,6 @@
 
 module Minfra
   module Cli
-    VERSION = '3.0.2'
+    VERSION = '3.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minfra-cli
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 3.1.0
 platform: ruby
 authors:
 - Peter Schrammel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-07 00:00:00.000000000 Z
+date: 2024-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -205,6 +205,7 @@ files:
 - lib/minfra/cli/errors.rb
 - lib/minfra/cli/helm_runner.rb
 - lib/minfra/cli/hiera_looker.rb
+- lib/minfra/cli/hiera_yaml_backend_patch.rb
 - lib/minfra/cli/hook.rb
 - lib/minfra/cli/kubectl_runner.rb
 - lib/minfra/cli/logging.rb