kafo 7.0.0 → 7.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ae11e11628c99446f1b247135f656e0f5546c6045499b05b9b00b83665b5afc
-  data.tar.gz: bd4361d90a598e7f3beb6a27f28a5f7992a0e30b033f327cfbe5dd0488676766
+  metadata.gz: b2f9f3f9827dd2b9f738acab79a596169fd4c4ea075ec5a99c35a40f291dfcee
+  data.tar.gz: 1695c0717da6eb8809a14114bd09746efcb1dd82773cf585dbb987ea97c13f8e
 SHA512:
-  metadata.gz: 709acb14a02a183b1f3b5b604014d6d22aedca7d15e08fdd29408296aa189d9813be07b873cb151b412015b5a0c3b313a6224e7e91c8dea5a44c77063fb0b263
-  data.tar.gz: b53a7e0ddbe08344b26d68a965ad14a550930be9bf943920df2d352a45d5edb1806e4b9612623109a7db33d8470722a36a73429631985f20728cd57446f2f712
+  metadata.gz: 0d26ee6f46875bcaa7f77c2e83dfc7b77aaee073f0977e9dedb1afc977fd118bc55fb430f450dacab0b8d016bf0805462a4a8c4bfe5cbd82e4d515abcc6c915a
+  data.tar.gz: c5b129d7e90fb1895afc03781b723e2cd9fa792eb2f3ac1d754a8c744f120a555be977067af66f4c1868ab5fc195093bd1623195b117f73be57106888504ff43

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_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/exceptions.rb

@@ -8,4 +8,7 @@ module Kafo
 
   class ParserError < StandardError
   end
+
+  class PuppetReportError < StandardError
+  end
 end

data/lib/kafo/execution_environment.rb

@@ -19,6 +19,15 @@ module Kafo
       end
     end
 
+    def reportdir
+      @reportdir ||= File.join(directory, 'reports')
+    end
+
+    def reports
+      # Reports are stored in $reportdir/$certname/$report
+      Dir.glob(File.join(reportdir, '*', '*.*')).sort_by { |path| File.mtime(path) }
+    end
+
     def store_answers
       answer_data = HieraConfigurer.generate_data(@config.modules, @config.app[:order])
       @logger.debug("Writing temporary answers to #{answer_file}")
@@ -37,6 +46,8 @@ module Kafo
         'environmentpath' => environmentpath,
         'factpath'        => factpath,
         'hiera_config'    => hiera_config,
+        'reports'         => 'store',
+        'reportdir'       => reportdir,
       }.merge(settings)
 
       PuppetConfigurer.new(puppet_conf, settings)

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/hook_context.rb

@@ -196,5 +196,13 @@ module Kafo
     def exit_code
       self.kafo.exit_code
     end
+
+    # Return the Puppet report, if any.
+    # Only available after Puppet actual ran.
+    #
+    # @return [Optional[Kafo::PuppetReport]]
+    def puppet_report
+      self.kafo.puppet_report
+    end
   end
 end

data/lib/kafo/kafo_configure.rb

@@ -21,7 +21,9 @@ require 'kafo/help_builder'
 require 'kafo/wizard'
 require 'kafo/system_checker'
 require 'kafo/puppet_command'
+require 'kafo/puppet_failed_resource'
 require 'kafo/puppet_log_parser'
+require 'kafo/puppet_report'
 require 'kafo/progress_bar'
 require 'kafo/hooking'
 require 'kafo/exit_handler'
@@ -34,6 +36,8 @@ module Kafo
   class KafoConfigure < Clamp::Command
     include StringHelper
 
+    attr_accessor :puppet_report
+
     class << self
       include AppOption::Declaration
 
@@ -510,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
@@ -542,6 +544,12 @@ module Kafo
       @progress_bar.close if @progress_bar
       logger.notice "System configuration has finished."
 
+      if (last_report = execution_env.reports.last)
+        # For debugging: you can easily copy the last report to fixtures
+        # FileUtils.cp(last_report, File.join(__dir__, '..', '..', 'test', 'fixtures', 'reports', File.basename(last_report)))
+        self.puppet_report = PuppetReport.load_report_file(last_report)
+      end
+
       self.class.hooking.execute(:post)
       self.class.exit(exit_code)
     end

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/puppet_failed_resource.rb

@@ -0,0 +1,68 @@
+module Kafo
+  class PuppetFailedResource
+    # @param [Hash] status
+    #   The status hash from the report
+    # @param [Array[Hash]] logs
+    #   Relevant log lines for this resoure
+    def initialize(status, logs)
+      @status = status
+      @logs = logs
+    end
+
+    # @example
+    #   puppet_failed_resource.resource == 'Exec[/bin/true]'
+    # @return [String] A resource
+    def resource
+      @status['resource']
+    end
+
+    # @example
+    #   puppet_failed_resource.type == 'Exec'
+    # @return [String] A resource type
+    def type
+      @status['resource_type']
+    end
+
+    # @example
+    #   puppet_failed_resource.title == '/bin/true'
+    # @return [String] A resource title
+    def title
+      @status['title']
+    end
+
+    def to_s
+      "Puppet #{type} resource '#{title}'"
+    end
+
+    # @return [Array[String]] The event messages
+    def event_messages
+      @status['events'].map { |event| event['message'] }
+    end
+
+    # A collection of Puppet log messages
+    #
+    # The log messages include detailed information of what failed. Some debug
+    # information, such as timing but crucially the command output, both stdout
+    # and stderr.
+    #
+    # @return [Array[String]] The Puppet log messages for this resource
+    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

@@ -0,0 +1,64 @@
+module Kafo
+  # An abstraction over the Puppet report format
+  #
+  # @see https://puppet.com/docs/puppet/8/format_report.html
+  class PuppetReport
+    # Load a Puppet report from a path
+    #
+    # Both YAML and JSON are supported.
+    #
+    # @param [String] path
+    #   The path to Puppet report
+    #
+    # @return [PuppetReport] The report from the path
+    def self.load_report_file(path)
+      raise ArgumentError, 'No path given' unless path || path.empty?
+      raise ArgumentError, "#{path} is not a readable file" unless File.file?(path) && File.readable?(path)
+
+      data = case File.extname(path)
+             when '.yaml'
+               require 'yaml'
+               content = File.read(path).gsub(%r{!ruby/object.*$}, '')
+               YAML.safe_load(content, permitted_classes: [Time, Symbol])
+             when '.json'
+               require 'json'
+               JSON.parse(File.read(path))
+             else
+               raise ArgumentError, "Unsupported file extension for #{path}"
+             end
+
+      PuppetReport.new(data)
+    end
+
+    # @param [Hash] report
+    #   The Puppet report
+    def initialize(report)
+      @report = report
+    end
+
+    # @return [Integer] The report format
+    def report_format
+      @report['report_format']
+    end
+
+    # @return [Array[Hash]] The Puppet logs
+    def logs
+      @report['logs']
+    end
+
+    # @return [Array[PuppetFailedResource]] The failed resources and their status
+    def failed_resources
+      statuses = @report['resource_statuses']
+
+      raise PuppetReportError, "No resource statuses found in report" unless statuses
+
+      statuses.select { |_title, status| status['failed'] }.map do |title, status|
+        # TODO: There's also a message with source Puppet
+        # Executing with uid=USER: '/tmp/failing-command'
+        # This shows up after Executing '/tmp/failing-command'
+        related_logs = logs.select { |log| log['source'].include?(title) }
+        PuppetFailedResource.new(status, related_logs)
+      end
+    end
+  end
+end

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.0.0"
+  VERSION = "7.2.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.0.0
+  version: 7.2.0
 platform: ruby
 authors:
 - Marek Hulan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-05 00:00:00.000000000 Z
+date: 2023-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -31,7 +31,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -45,7 +45,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -59,7 +59,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-reporters
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -87,7 +87,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: kafo_wizards
+  name: ansi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -101,7 +101,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ansi
+  name: kafo_wizards
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -273,8 +273,10 @@ 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
 - lib/kafo/scenario_manager.rb
 - lib/kafo/scenario_option.rb
 - lib/kafo/store.rb