minfra-cli 2.0.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 424233e63c75e0e9b9d65bd7dba78a3f3d2132c547f3cf37b7acb3fdb66784c5
-  data.tar.gz: 0ad7e2960fff01802a047e33e955d0b77e8cf3284c4033a18111ccde42175aec
+  metadata.gz: 20d6ef8704c3f8f61e70deebd60afc9663a9df46e2741f03a30eb9f5020fe2e0
+  data.tar.gz: b173a73d17868a0b8f13ce11cdefc0e997aa50af7bb07c0448946fa121d9275d
 SHA512:
-  metadata.gz: c689a675040c603ef5acf7f04a6c147212d40749652536599dee68fe0bd078c3e79b4e3f41aec92c2850f5106c72ccee79ad5f9d31e509a7498f8d1bdf4f5644
-  data.tar.gz: 93816f96aab379a0bf972808359e7298ae55afea97f204683d07878cb1937689dd2054d3ff3aba5bd3d1a4d49796bf32dc164e8692e3a37f765047331de6d094
+  metadata.gz: 5725dd5eed53295676e895f14bf84a3d729fa82664b5578dde1540f47455b1050e236d9321291185ed935e14a1a9de3b691e82b8ce83db9c0f7b19419877cab4
+  data.tar.gz: 6b92c6757e2d0ccfaefe8d6847c55c77800159e820ff7f41f54c4d3bff9801118b566febed21be9f92bcfd4cd9a443dcb29f09487e8a7366d0273a92858be337

data/.gitignore

@@ -14,5 +14,6 @@ vendor
 spec/docker-compose.run.yml
 
 minfra-cli-*.gem
+Gemfile.lock
 
 .rspec

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 2.2.0
+ * fixing: should not modify l('env.roles')
+ * cleanup: removing template testing --debug flag, causing noise
+ * cleanup: removing Documentation hooks
+ * fixing: hiera lookup retrying on gpg memory error exceptions
+ * 
+# 2.1.0
+ * add :all hook
+ * fixing setup dev
+ * colored errors
+ * wrapping hiera lookup errors of gpg
+ * adding HIERA_DEBUG_LOOKUPS=true
 # 2.0.1
  Refactorings
  * installing into Kernel only when 'exec' not at 'init' time
@@ -17,7 +29,7 @@
  * new Kernel method: minfra_cli which is the CliStarter Object
 
 # 1.13.3
- * BUG: fixing 'labelÄ
+ * BUG: fixing 'label'
 # 1.13.2
  * BUG: fixing 'generic_secret'
 # 1.13.1

data/README.md

@@ -14,7 +14,9 @@ Is a KIND (k8s in docker) based development environment.
 |   | MINFRA_ARGV_FILE     |                       | --minfra_argv_file [PATH TO A CSV FILE FILE] |   |
 |   | MINFRA_LOGGING_LEVEL | minfra.logging_level  |                                              |   |
 |   |                      | minfra.hiera.env_path |                                              |   |
-|   |                      | default_stacks        |                                              | env.stacks | env.roles   |
+|   |                      | 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 | | | |
 
 
 ## Expected hiera data

data/lib/minfra/cli/ask.rb

@@ -18,6 +18,7 @@ module Minfra
       end
 
       def self.text(question, default = nil)
+        answer = nil
         loop do
           message = format('%s%s: ', question, default && " (#{default})")
           $stdout.write message

data/lib/minfra/cli/cli_starter.rb

@@ -31,6 +31,7 @@ module Minfra
 
         init_minfrarc
         init_envs
+        
         init_hiera
         init_plugins
 
@@ -140,7 +141,7 @@ module Minfra
       end
 
       def init_hiera
-        @hiera = @env.hiera
+        @hiera = @env.hiera 
       end
       
       def init_envs
@@ -149,7 +150,7 @@ 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)
+          @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')
         end
         @env = @envs[@env_name] # set the current env
       end

data/lib/minfra/cli/commands/kube.rb

@@ -101,7 +101,7 @@ module Minfra
         run(%(docker network rm #{kind_name}), exit_on_error: false)
       end
 
-      def deploy(stack_name, reason_message)
+      def deploy(stack_name, _reason_message)
         # TBD: options is global, avoid it!
 
         test = options[:test]
@@ -145,8 +145,6 @@ module Minfra
 
         exit_error('Deployment aborted!') if !(@config.dev? || options[:force] == true) && !Ask.boolean('Are the changes ok?')
 
-        message = "deploying stack #{stack.name}: #{reason_message}."
-        Minfra::Cli::Document.document(@config, "started #{message}")
         orch = Orchparty::App.new(cluster_name: cluster,
                                   application_name: stack.name,
                                   force_variable_definition: false,
@@ -154,7 +152,6 @@ module Minfra
                                   status_dir: stack.release_path,
                                   options:)
         orch.send(method)
-        Minfra::Cli::Document.document(@config, "finished #{message}")
       end
 
       def rollback(stack_name, env, deployment, cluster)

data/lib/minfra/cli/commands/project.rb

@@ -47,9 +47,7 @@ module Minfra
         ARGV.delete('test')
 
         if File.exist?('./bin/run_tests')
-          # config = Config.load('staging')
           project = ProjectInfo.load(Pathname.pwd)
-          # Minfra::Cli::Document.document(config, "Using project specific ./bin/run_tests in #{project.name}")
           debug "Using project specific ./bin/run_tests in #{project.name}"
           system('./bin/run_tests', out: $stdout, err: :out)
         else

data/lib/minfra/cli/commands/setup.rb

@@ -18,8 +18,6 @@ module Minfra
       def setup_config
         config = Minfra::Cli.config
         ensure_path_and_template(config.config_path, config.base_path.join('config', 'me_config.json.erb'))
-        config.init!
-        config.load('dev')
       end
 
       def ensure_path_and_template(dest_path, template_path, params = {})

data/lib/minfra/cli/commands/stack.rb

@@ -35,7 +35,7 @@ module Minfra
       def deploy(stack_name, message = '')
         stacks = l('env.roles') || l('env.stacks') || []
         default_stacks = minfra_config.project.default_stacks || []
-        stacks = stacks.concat(default_stacks)
+        stacks = stacks + default_stacks
         if stacks.include?(stack_name) || options[:force] || options[:test]
           kube.deploy(stack_name, message)
         else

data/lib/minfra/cli/common.rb

@@ -25,14 +25,6 @@ module Minfra
         end
       end
 
-      def parse_cmd(cmd, silence: false)
-        reply = JSON.parse(run_cmd(cmd, silence:))
-      rescue JSON::ParserError, TypeError
-        error "ERROR: #{$ERROR_INFO.message}"
-        error reply
-        error "command was: #{cmd}"
-        exit 1
-      end
     end
   end
 end

data/lib/minfra/cli/env.rb

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

data/lib/minfra/cli/hiera_looker.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
+require 'English'
 module Minfra
   module Cli
     class HieraLooker
-      def initialize(root:, env_name:, env_path:)
+      include Logging
+      def initialize(root:, env_name:, env_path:, debug_lookups: false)
         @root = Pathname.new(root)
         @env_name = env_name
         @cache = {}
@@ -18,13 +20,15 @@ module Minfra
         scope = { 'hieraroot' => @root.to_s, 'env' => @env_name }
 
         @special_lookups = @hiera.lookup('lookup_options', {}, scope, nil, :priority)
-        
+
         node_scope = @hiera.lookup('env', {}, scope, nil, :deeper)
         @scope = scope.merge(node_scope)
+        @debug_lookups = debug_lookups
       end
 
       def l(value, default = nil)
-#        debugger if @env_name == 'production-management' && value == 'env.tags'
+        debug "hiera: #{value}" if @debug_lookups
+        #        debugger if @env_name == 'production-management' && value == 'env.tags'
         return @cache[value] if @cache.key?(value)
 
         values = value.split('.')
@@ -35,7 +39,23 @@ module Minfra
                       else
                         :deep
                       end
-        result = @hiera.lookup(fst_value, default, @scope, nil, lookup_type)
+        retry_attempts = 0
+        begin
+          result = @hiera.lookup(fst_value, default, @scope, nil, lookup_type)
+        rescue GPGME::Error::NoSecretKey
+          error("Have no gpg configuration to decrypt your hiera key: #{value}")
+          raise Errors::ExitError
+        rescue GPGME::Error::BadPassphrase
+          error("Your password was wrong for hiera key: #{value}")
+          raise Errors::ExitError
+        rescue GPGME::Error
+          error("Having decrypt problems for hiera key: #{value}, #{$ERROR_INFO.message}")
+          raise Errors::ExitError
+        rescue Errno::ENOMEM # see https://github.com/ueno/ruby-gpgme/issues/147
+          retry_attempts += 1
+          sleep 1
+          retry if retry_attempts < 5
+        end
         result = result.dig(*values) if !values.empty? && result.is_a?(Hash) # we return nil or the scalar value and only drill down on hashes
         result = default if result.nil?
         result = Hashie::Mash.new(result) if result.is_a?(Hash)
@@ -46,9 +66,9 @@ module Minfra
       def l!(value, default = nil)
         v = l(value, default)
         raise("Value not found! #{value}") if v.nil?
+
         v
       end
-      
     end
   end
 end

data/lib/minfra/cli/hook.rb

@@ -12,9 +12,12 @@ class Thor
       elsif public_method?(instance)
         hooks = instance.instance_variable_get(:@_invocations).values.flatten
         arity = instance.method(name).arity
+        Minfra::Cli.call_before_hooks(instance, ['all']) if hooks.size == 1
         Minfra::Cli.call_before_hooks(instance, hooks)
+#        debugger
         instance.__send__(name, *args)
         Minfra::Cli.call_after_hooks(instance, hooks)
+        Minfra::Cli.call_after_hooks(instance, ['all']) if hooks.size == 1
       elsif local_method?(instance, :method_missing)
         # Minfra::Cli.call_before_hooks(instance,hooks)
         instance.__send__(:method_missing, name.to_sym, *args)
@@ -77,6 +80,7 @@ module Minfra
         end
 
         def call_after_hooks(obj, names)
+#          debug("Checking after hook #{names}")
           @hooks.select { |h| h.match?(:after, names) }.each do |h|
             debug("Hook  after: #{names.join(',')}")
             h.exec(obj)

data/lib/minfra/cli/logging.rb

@@ -4,7 +4,7 @@ module Minfra
   module Cli
     module Logging
       def error(str)
-        logger.error str
+        logger.error(colored(str, :red))
       end
 
       def exit_error(str)
@@ -17,11 +17,11 @@ module Minfra
       end
 
       def warn(str)
-        logger.warn str
+        logger.warn(colored(str, :yellow))
       end
 
       def debug(str)
-        logger.debug str
+        logger.debug(str)
       end
 
       def deprecated(comment)
@@ -33,6 +33,14 @@ module Minfra
       def logger
         Minfra::Cli.logger
       end
+      LOGGING_COLORS={ red: '1;31;40', green: '1;32;40' , dark_green: '0;32;40' , yellow: '1;33;40' }
+      def colored(str, color)
+        if $stdout.isatty
+          "\e[#{LOGGING_COLORS[color] || LOGGING_COLORS[:color1]}m#{str}\e[0m"
+        else
+          str
+        end    
+      end
     end
   end
 end

data/lib/minfra/cli/runner.rb

@@ -13,14 +13,16 @@ module Minfra
 
         attr_reader :stdout_lines
 
-        def initialize
+        def initialize(on_output: nil)
           @stderr_lines = []
           @stdout_lines = []
           @status = nil
+          @on_output = on_output
         end
 
         def add(line, stream = :stdout)
           line.chomp!
+          @on_output.call(line, stream) if @on_output
           if stream == :stdout
             @stdout_lines << line
             debug line
@@ -60,23 +62,25 @@ module Minfra
         new(cmd, **args).run
       end
 
-      attr_reader :exit_on_error, :runner, :cmd
+      attr_reader :exit_on_error, :runner, :cmd, :on_output
 
-      def initialize(cmd, exit_on_error: true, runner: :popen)
+      def initialize(cmd, exit_on_error: true, runner: :popen, on_output: nil)
         @cmd = cmd
         @exit_on_error = exit_on_error
         @runner = runner
+        @on_output = on_output
       end
 
       def run
         debug("running (#{@runner}): #{@cmd}")
-        res = case @runner
+        res = Result.new(on_output:)
+        case @runner
               when :system
-                run_system(Result.new)
+                run_system(res)
               when :popen
-                run_threaded(Result.new)
+                run_threaded(res)
               when :exec
-                run_exec(Result.new)
+                run_exec(res)
               else
                 raise "unknown runner #{@runner}"
               end

data/lib/minfra/cli/templater.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'erb'
-
 module Minfra
   module Cli
     # not threadsafe!
@@ -30,14 +29,15 @@ module Minfra
 
         source.glob('**/*') do |filename|
           rel_path = filename.relative_path_from(source)
-
           if File.directory?(filename) # check if it s  file and extension is not .tf
             FileUtils.mkdir_p("#{destination}/#{rel_path}")
           elsif extensions.include?(File.extname(filename)) # a file
+#            puts("templating: #{filename}")
             content = File.read(filename)
             modified_content = Minfra::Cli::Templater.render(content, {})
             File.write("#{destination}/#{rel_path}", modified_content)
           else
+#            puts("copying  : #{filename}")
             FileUtils.cp(filename, destination.join(rel_path))
           end
         end

data/lib/minfra/cli/version.rb

@@ -2,6 +2,6 @@
 
 module Minfra
   module Cli
-    VERSION = '2.0.1'
+    VERSION = '2.2.0'
   end
 end

data/lib/minfra/cli.rb

@@ -18,7 +18,6 @@ require_relative 'cli/hook'
 require_relative 'cli/common'
 require_relative 'cli/command'
 require_relative 'cli/ask'
-require_relative 'cli/document'
 require_relative 'cli/runner'
 require_relative 'cli/helm_runner'
 require_relative 'cli/kubectl_runner'

data/lib/orchparty/kubernetes_application.rb

@@ -188,7 +188,7 @@ module Orchparty
 
       def print_install
         build_chart do |chart_path|
-          cmd = "helm template --namespace #{namespace} --debug --kube-context #{cluster_name} --output-dir #{chart_path.join(
+          cmd = "helm template --namespace #{namespace} --kube-context #{cluster_name} --output-dir #{chart_path.join(
             '..', 'helm_expanded'
           )}   #{service.name} #{chart_path}"
           @out_io.puts `$cmd`

data/minfra-cli.gemspec

@@ -36,5 +36,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "hiera", "3.9.0"
   spec.add_runtime_dependency "hiera-eyaml", "3.3.0"
   spec.add_runtime_dependency "hiera-eyaml-gpg", "0.7.4"
+  spec.add_runtime_dependency "gpgme", "~>2.0.0"
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minfra-cli
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Peter Schrammel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-01-05 00:00:00.000000000 Z
+date: 2024-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -142,6 +142,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.7.4
+- !ruby/object:Gem::Dependency
+  name: gpgme
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 description: A cli framework for k8s based development and deployment.
 email:
 - peter.schrammel@gmx.de
@@ -157,7 +171,6 @@ files:
 - CHANGELOG.md
 - Dockerfile
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - bin/build
@@ -188,7 +201,6 @@ files:
 - lib/minfra/cli/common.rb
 - lib/minfra/cli/config.rb
 - lib/minfra/cli/core_ext.rb
-- lib/minfra/cli/document.rb
 - lib/minfra/cli/env.rb
 - lib/minfra/cli/errors.rb
 - lib/minfra/cli/helm_runner.rb

data/Gemfile.lock

@@ -1,81 +0,0 @@
-PATH
-  remote: .
-  specs:
-    minfra-cli (2.0.0)
-      activesupport (= 7.0.7.2)
-      erubis (~> 2.7)
-      hashie (~> 3.5)
-      hiera (= 3.9.0)
-      hiera-eyaml (= 3.3.0)
-      hiera-eyaml-gpg (= 0.7.4)
-      rest-client (~> 2.0)
-      table_print (= 1.5.6)
-      thor (~> 1.0, >= 1.0.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activesupport (7.0.7.2)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      tzinfo (~> 2.0)
-    concurrent-ruby (1.2.2)
-    diff-lcs (1.5.0)
-    domain_name (0.6.20231109)
-    erubis (2.7.0)
-    hashie (3.6.0)
-    hiera (3.9.0)
-    hiera-eyaml (3.3.0)
-      highline
-      optimist
-    hiera-eyaml-gpg (0.7.4)
-      hiera-eyaml (>= 1.3.8)
-    highline (2.1.0)
-    http-accept (1.7.0)
-    http-cookie (1.0.5)
-      domain_name (~> 0.5)
-    i18n (1.14.1)
-      concurrent-ruby (~> 1.0)
-    mime-types (3.5.1)
-      mime-types-data (~> 3.2015)
-    mime-types-data (3.2023.1205)
-    minitest (5.20.0)
-    netrc (0.11.0)
-    optimist (3.1.0)
-    rake (12.3.3)
-    rest-client (2.1.0)
-      http-accept (>= 1.7.0, < 2.0)
-      http-cookie (>= 1.0.2, < 2.0)
-      mime-types (>= 1.16, < 4.0)
-      netrc (~> 0.8)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
-    table_print (1.5.6)
-    thor (1.3.0)
-    timecop (0.9.8)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  minfra-cli!
-  rake (~> 12.0)
-  rspec (~> 3.0)
-  timecop (~> 0.9.5)
-
-BUNDLED WITH
-   2.1.4

data/lib/minfra/cli/document.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Minfra
-  module Cli
-    class Document
-      def self.document(config, message)
-        new(config).document(message)
-      end
-
-      def initialize(config)
-        @config = config
-      end
-
-      def document(_message)
-        return true if @config.dev?
-
-        puts 'TBD: calling documentation hooks'
-        true
-      end
-    end
-  end
-end