kafo 7.1.0 → 7.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44e0dd9be8a98bd4f048dd0baf43c021fd831e0cf434ce2db3effe2cc2061ad1
-  data.tar.gz: 9a7be6fdac62d347577b61e3796d5f3ac3973442072736afbca8cfc29698c216
+  metadata.gz: c8adeff1136ef4700d8f5f00a034912ff73380d0985c28c820223b085909cc4f
+  data.tar.gz: 98d05a4a406ebd9d59870ffd86fab6ad07198b917157e96255244861b994621c
 SHA512:
-  metadata.gz: f190ab0f2f7f61abb81ff395d0845d0702396f1357e05398ff4490fc16eef30bffeb3f9235231cc898254cfcb0913da84a1a47b648f3a96de4f1b53657c54be6
-  data.tar.gz: 5bf2c4dcb5deed312ba8bbf09236c438cbd6eb6233150cd9bf69054e455ad718f2cd01106c319748aff2cb3468a256c3217d69293123ffa7a37bce3358a4fa6a
+  metadata.gz: 36ed613f932dbc8b12f643e16bc898d9f820b546b8c35b2a956b921662829248bcc17e9114c6d19d2b1bda4146baf91d113969e78f35272c0936dd08e79f08d3
+  data.tar.gz: ac2bd021eab081aecc1b14c7953de9ca869f69b8e0cc01b6721c4cdb79339ad099570ee37d66878df03bdf488640ae6972d5350e708397200bb6103931ebfce0

data/Rakefile

@@ -31,11 +31,12 @@ namespace 'test' do
   end
 end
 
-begin
-  require 'rubocop/rake_task'
-  RuboCop::RakeTask.new
-rescue LoadError
-  puts 'Rubocop not loaded'
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  # These make the rubocop experience maybe slightly less terrible
+  task.options = ['--display-cop-names', '--display-style-guide', '--extra-details']
+  # Use Rubocop's Github Actions formatter if possible
+  task.formatters << 'github' if ENV['GITHUB_ACTIONS'] == 'true'
 end
 
 CLEAN.include 'test/tmp'

data/bin/kafo-export-params

@@ -125,7 +125,7 @@ module Kafo
       end
 
       def print_out
-        puts "| #{('Parameter name').ljust(40)} | #{'Description'.ljust(@max)} |"
+        puts "| #{'Parameter name'.ljust(40)} | #{'Description'.ljust(@max)} |"
         puts "| #{'-'*40} | #{'-' * @max} |"
         @config.modules.sort.each do |mod|
           mod.params.sort.each do |param|

data/lib/kafo/configuration.rb

@@ -383,7 +383,7 @@ EOS
     # Loads YAML from mixed output, finding the "---" and "..." document start/end delimiters
     def load_yaml_from_output(lines)
       start = lines.find_index { |l| l.start_with?('---') }
-      last = lines[start..-1].find_index("...")
+      last = lines[start..].find_index("...")
       if start.nil? || last.nil?
         puts "Could not find default values in output"
         @logger.error 'Could not find default values in Puppet output, cannot continue'

data/lib/kafo/data_type.rb

@@ -61,7 +61,7 @@ module Kafo
             bracket_count = 1
             until bracket_count.zero?
               next_bracket = scanner.scan_until(/[\[\]]/) or raise ConfigurationException, "missing close bracket in argument #{args.count + 1} in data type #{input}"
-              case next_bracket[-1..-1]
+              case next_bracket[-1..]
               when '['
                 bracket_count += 1
               when ']'
@@ -102,7 +102,7 @@ module Kafo
     end
 
     def typecast(value)
-      value == 'UNDEF' ? nil : value
+      (value == 'UNDEF') ? nil : value
     end
 
     def valid?(value, errors = [])

data/lib/kafo/data_type_parser.rb

@@ -8,9 +8,26 @@ module Kafo
 
     def initialize(manifest)
       @logger = KafoConfigure.logger
-      @types = {}
+
+      lines = []
+      type_line_without_newlines = +''
       manifest.each_line do |line|
-        if (type = TYPE_DEFINITION.match(line.force_encoding("UTF-8")))
+        line = line.force_encoding("UTF-8").strip
+        next if line.start_with?('#')
+
+        line = line.split(' #').first.strip
+        if line =~ TYPE_DEFINITION
+          lines << type_line_without_newlines
+          type_line_without_newlines = line
+        else
+          type_line_without_newlines << line
+        end
+      end
+      lines << type_line_without_newlines
+
+      @types = {}
+      lines.each do |line|
+        if (type = TYPE_DEFINITION.match(line))
           @types[type[1]] = type[2]
         end
       end

data/lib/kafo/data_types/float.rb

@@ -19,7 +19,7 @@ module Kafo
       end
 
       def typecast(value)
-        value.to_s =~ /\d+/ ? value.to_f : value
+        value.to_s.match?(/\d+/) ? value.to_f : value
       end
 
       def valid?(input, errors = [])

data/lib/kafo/data_types/not_undef.rb

@@ -8,13 +8,11 @@ module Kafo
       attr_reader :inner_type, :inner_value
 
       def initialize(inner_type_or_value)
-        begin
-          @inner_type = DataType.new_from_string(inner_type_or_value)
-          @inner_value = nil
-        rescue ConfigurationException
-          @inner_type = nil
-          @inner_value = inner_type_or_value
-        end
+        @inner_type = DataType.new_from_string(inner_type_or_value)
+        @inner_value = nil
+      rescue ConfigurationException
+        @inner_type = nil
+        @inner_value = inner_type_or_value
       end
 
       def to_s

data/lib/kafo/data_types/optional.rb

@@ -8,13 +8,11 @@ module Kafo
       attr_reader :inner_type, :inner_value
 
       def initialize(inner_type_or_value)
-        begin
-          @inner_type = DataType.new_from_string(inner_type_or_value)
-          @inner_value = nil
-        rescue ConfigurationException
-          @inner_type = nil
-          @inner_value = inner_type_or_value
-        end
+        @inner_type = DataType.new_from_string(inner_type_or_value)
+        @inner_value = nil
+      rescue ConfigurationException
+        @inner_type = nil
+        @inner_value = inner_type_or_value
       end
 
       def to_s

data/lib/kafo/help_builders/base.rb

@@ -84,10 +84,8 @@ module Kafo
       end
 
       def parametrization
-        @parametrization ||= begin
-          @params.inject({}) do |h,p|
-            h.update(parametrize(p) => p, parametrize(p, 'reset-') => p)
-          end
+        @parametrization ||= @params.inject({}) do |h,p|
+          h.update(parametrize(p) => p, parametrize(p, 'reset-') => p)
         end
       end
     end

data/lib/kafo/hiera_configurer.rb

@@ -22,7 +22,7 @@ module Kafo
       classes = []
       data = modules.select(&:enabled?).inject({}) do |config, mod|
         classes << mod.class_name
-        config.update(Hash[mod.params_hash.map { |k, v| ["#{mod.class_name}::#{k}", v] }])
+        config.update(mod.params_hash.transform_keys { |k| "#{mod.class_name}::#{k}" })
       end
       data['classes'] = sort_modules(classes, order)
       data

data/lib/kafo/kafo_configure.rb

@@ -20,8 +20,8 @@ require 'kafo/string_helper'
 require 'kafo/help_builder'
 require 'kafo/wizard'
 require 'kafo/system_checker'
-require 'kafo/failed_puppet_resource'
 require 'kafo/puppet_command'
+require 'kafo/puppet_failed_resource'
 require 'kafo/puppet_log_parser'
 require 'kafo/puppet_report'
 require 'kafo/progress_bar'
@@ -514,29 +514,27 @@ module Kafo
         logger.notice("Starting system configuration.")
 
         PTY.spawn(*PuppetCommand.format_command(command)) do |stdin, stdout, pid|
-          begin
-            stdin.each do |line|
-              line = normalize_encoding(line)
-              method, message = log_parser.parse(line)
-              progress_log(method, message, logger)
-
-              if (output = line.match(/(.+\]): Starting to evaluate the resource( \((?<count>\d+) of (?<total>\d+)\))?/))
-                if (output[:count].to_i % 250) == 1 && output[:count].to_i != 1
-                  logger.notice("#{output[:count].to_i - 1} configuration steps out of #{output[:total]} steps complete.")
-                end
+          stdin.each do |line|
+            line = normalize_encoding(line)
+            method, message = log_parser.parse(line)
+            progress_log(method, message, logger)
+
+            if (output = line.match(/(?:.+\]): Starting to evaluate the resource(?: \((?<count>\d+) of (?<total>\d+)\))?/))
+              if (output[:count].to_i % 250) == 1 && output[:count].to_i != 1
+                logger.notice("#{output[:count].to_i - 1} configuration steps out of #{output[:total]} steps complete.")
               end
-
-              @progress_bar.update(line) if @progress_bar
             end
-          rescue Errno::EIO # we reach end of input
-            exit_status = PTY.check(pid, true)
-            if exit_status.nil? # process is still running
-              begin
-                Process.wait(pid)
-              rescue Errno::ECHILD # process could exit meanwhile so we rescue
-              end
-              self.class.exit_handler.exit_code = $?.exitstatus
+
+            @progress_bar.update(line) if @progress_bar
+          end
+        rescue Errno::EIO # we reach end of input
+          exit_status = PTY.check(pid, true)
+          if exit_status.nil? # process is still running
+            begin
+              Process.wait(pid)
+            rescue Errno::ECHILD # process could exit meanwhile so we rescue
             end
+            self.class.exit_handler.exit_code = $?.exitstatus
           end
         end
       rescue PTY::ChildExited => e # could be raised by PTY.check

data/lib/kafo/multi_stage_hook.rb

@@ -4,8 +4,8 @@ module Kafo
       default_name = name
 
       types.each do |hook_type|
-        self.class.send(:define_method, hook_type) do |name=nil, &block|
-          registry.send(:register, hook_type, name || default_name, &block)
+        self.class.send(:define_method, hook_type) do |hook_name = nil, &block|
+          registry.send(:register, hook_type, hook_name || default_name, &block)
         end
       end
     end

data/lib/kafo/param.rb

@@ -47,7 +47,7 @@ module Kafo
     # For literal default values, only use 'manifest_default'. For variable or values from a data
     # lookup, use the value loaded back from the dump in 'default'.
     def default
-      @type.typecast(dump_default_needed? || !@default.nil? ? @default : manifest_default)
+      @type.typecast((dump_default_needed? || !@default.nil?) ? @default : manifest_default)
     end
 
     def default=(default)
@@ -71,7 +71,7 @@ module Kafo
     end
 
     def manifest_default_params_variable
-      manifest_default[1..-1] if dump_default_needed?
+      manifest_default[1..] if dump_default_needed?
     end
 
     def module_name
@@ -132,7 +132,7 @@ module Kafo
     end
 
     def visible?(context = [])
-      condition.nil? || condition.empty? ? true : evaluate_condition(context)
+      (condition.nil? || condition.empty?) ? true : evaluate_condition(context)
     end
 
     def condition_value
@@ -155,7 +155,7 @@ module Kafo
           arg
         end
       end.map do |arg|
-        arg == :undef ? nil : arg
+        (arg == :undef) ? nil : arg
       end
     end
 

data/lib/kafo/progress_bar.rb

@@ -39,7 +39,7 @@ module Kafo
 
       if (line_monitor = MONITOR_RESOURCE.match(line))
         @resources << line_monitor[1]
-        @total = (@total == :unknown ? 1 : @total + 1)
+        @total = ((@total == :unknown) ? 1 : @total + 1)
       end
 
       if (line_start = EVALTRACE_START.match(line))
@@ -71,7 +71,7 @@ module Kafo
 
     def close
       @bar.show({ :msg   => done_message,
-                  :done  => @total == :unknown ? @bar.done + 1 : @total,
+                  :done  => (@total == :unknown) ? @bar.done + 1 : @total,
                   :total => @total }, true)
       @bar.close
     end

data/lib/kafo/progress_bars/black_white.rb

@@ -6,7 +6,7 @@ module Kafo
 
       def finite_template
         'Installing'.ljust(22) + ' ${<msg>} [${<percent>%}]' +
-        (@term_width >= 83 ? ' [${<bar>}]' : '')
+        ((@term_width >= 83) ? ' [${<bar>}]' : '')
       end
 
       def infinite_template

data/lib/kafo/progress_bars/colored.rb

@@ -16,7 +16,7 @@ module Kafo
         'Installing'.ljust(22) +
             ANSI::Code.yellow { ' ${<msg>}' } +
             ANSI::Code.green { ' [${<percent>%}]' } +
-            (@term_width >= 83 ? ' [${<bar>}]' : '')
+            ((@term_width >= 83) ? ' [${<bar>}]' : '')
       end
 
       def infinite_template

data/lib/kafo/puppet_command.rb

@@ -43,7 +43,7 @@ module Kafo
       File.join([bin_path, bin_name].compact)
     end
 
-    def self.is_aio_puppet?
+    def self.aio_puppet?
       puppet_command = search_puppet_path('puppet')
       File.realpath(puppet_command).start_with?('/opt/puppetlabs')
     rescue Errno::ENOENT
@@ -51,7 +51,7 @@ module Kafo
     end
 
     def self.format_command(command)
-      if is_aio_puppet?
+      if aio_puppet?
         [clean_env_vars, command, :unsetenv_others => true]
       else
         [::ENV, command, :unsetenv_others => false]

data/lib/kafo/{failed_puppet_resource.rb → puppet_failed_resource.rb}

@@ -49,5 +49,20 @@ module Kafo
     def log_messages
       @logs.map { |log| log['message'] }
     end
+
+    # A collection of Puppet log messages grouped by source
+    #
+    # The log messages include detailed information of what failed. Some debug
+    # information, such as timing but crucially the command output, both stdout
+    # and stderr.
+    #
+    # A resource can have multiple sources. For example, exec can have both
+    # unless and returns. Combining the output of those can be confusing, so
+    # this presents them separate.
+    #
+    # @return [Hash[String, Array[String]]] The Puppet log messages for this resource
+    def log_messages_by_source
+      @logs.group_by { |log| log['source'] }.transform_values { |logs| logs.map { |log| log['message'] } }
+    end
   end
 end

data/lib/kafo/puppet_module.rb

@@ -123,7 +123,7 @@ module Kafo
 
     # mapping from configuration with stringified keys
     def mapping
-      @mapping ||= Hash[@configuration.app[:mapping].map { |k, v| [k.to_s, v] }]
+      @mapping ||= @configuration.app[:mapping].transform_keys(&:to_s)
     end
 
     # custom module directory name
@@ -137,7 +137,7 @@ module Kafo
     end
 
     def get_class_name
-      manifest_name == 'init' ? name : "#{dir_name}::#{manifest_name.gsub('/', '::')}"
+      (manifest_name == 'init') ? name : "#{dir_name}::#{manifest_name.gsub('/', '::')}"
     end
 
     def get_params_path
@@ -165,11 +165,11 @@ module Kafo
     end
 
     def default_manifest_name
-      identifier.include?('::') ? identifier.split('::')[1..-1].join('/') : 'init'
+      identifier.include?('::') ? identifier.split('::')[1..].join('/') : 'init'
     end
 
     def default_params_name
-      identifier.include?('::') ? (identifier.split('::')[1..-1] + ['params']).join('/') : 'params'
+      identifier.include?('::') ? (identifier.split('::')[1..] + ['params']).join('/') : 'params'
     end
 
     def get_name

data/lib/kafo/puppet_report.rb

@@ -18,7 +18,7 @@ module Kafo
       data = case File.extname(path)
              when '.yaml'
                require 'yaml'
-               content = File.read(path).gsub(/\!ruby\/object.*$/, '')
+               content = File.read(path).gsub(%r{!ruby/object.*$}, '')
                YAML.safe_load(content, permitted_classes: [Time, Symbol])
              when '.json'
                require 'json'

data/lib/kafo/scenario_manager.rb

@@ -35,7 +35,7 @@ module Kafo
       say ::HighLine.color("Available scenarios", :info)
       available_scenarios.each do |config_file, content|
         scenario = File.basename(config_file, '.yaml')
-        use = (File.expand_path(config_file) == @previous_scenario ? 'INSTALLED' : "use: --scenario #{scenario}")
+        use = ((File.expand_path(config_file) == @previous_scenario) ? 'INSTALLED' : "use: --scenario #{scenario}")
         say ::HighLine.color("  #{content[:name]} ", :title)
         say "(#{use})"
         say "        " + content[:description] if !content[:description].nil? && !content[:description].empty?

data/lib/kafo/version.rb

@@ -1,5 +1,5 @@
 # encoding: UTF-8
 module Kafo
   PARSER_CACHE_VERSION = 1
-  VERSION = "7.1.0"
+  VERSION = "7.3.0"
 end

data/lib/kafo/wizard.rb

@@ -190,7 +190,7 @@ END
              else
                HighLine::SystemExtensions.terminal_size
              end
-      highline.wrap_at = data.first > 80 ? 80 : data.first if data.first
+      highline.wrap_at = (data.first > 80) ? 80 : data.first if data.first
       highline.page_at = data.last if data.last
       highline
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kafo
 version: !ruby/object:Gem::Version
-  version: 7.1.0
+  version: 7.3.0
 platform: ruby
 authors:
 - Marek Hulan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-31 00:00:00.000000000 Z
+date: 2023-11-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -259,7 +259,6 @@ files:
 - lib/kafo/execution_environment.rb
 - lib/kafo/exit_handler.rb
 - lib/kafo/fact_writer.rb
-- lib/kafo/failed_puppet_resource.rb
 - lib/kafo/help_builder.rb
 - lib/kafo/help_builders/advanced.rb
 - lib/kafo/help_builders/base.rb
@@ -283,6 +282,7 @@ files:
 - lib/kafo/progress_bars/colored.rb
 - lib/kafo/puppet_command.rb
 - lib/kafo/puppet_configurer.rb
+- lib/kafo/puppet_failed_resource.rb
 - lib/kafo/puppet_log_parser.rb
 - lib/kafo/puppet_module.rb
 - lib/kafo/puppet_report.rb