RubyGems - kafo - Versions diffs - 6.5.0 → 7.1.0 - Mend

kafo 6.5.0 → 7.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (27) hide show

checksums.yaml +4 -4
data/README.md +5 -7
data/bin/kafofy +2 -2
data/doc/Kafo.html +151 -0
data/doc/_index.html +754 -0
data/doc/class_list.html +51 -0
data/doc/file.README.html +1038 -0
data/doc/file_list.html +56 -0
data/doc/frames.html +17 -0
data/doc/index.html +1038 -0
data/doc/method_list.html +3331 -0
data/doc/top-level-namespace.html +110 -0
data/lib/kafo/exceptions.rb +3 -0
data/lib/kafo/execution_environment.rb +11 -0
data/lib/kafo/failed_puppet_resource.rb +53 -0
data/lib/kafo/help_builders/advanced.rb +1 -1
data/lib/kafo/help_builders/base.rb +1 -1
data/lib/kafo/hook_context.rb +8 -0
data/lib/kafo/kafo_configure.rb +14 -4
data/lib/kafo/puppet_command.rb +0 -5
data/lib/kafo/puppet_module.rb +1 -1
data/lib/kafo/puppet_report.rb +64 -0
data/lib/kafo/version.rb +1 -1
data/modules/kafo_configure/manifests/init.pp +1 -10
data/modules/kafo_configure/spec/classes/init_spec.rb +0 -7
metadata +24 -14
data/modules/kafo_configure/lib/puppet/parser/functions/add_progress.rb +0 -43

data/doc/top-level-namespace.html ADDED Viewed

@@ -0,0 +1,110 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.9.34
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" />
+<script type="text/javascript">
+  pathId = "";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html?1"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <div id="content"><h1>Top Level Namespace
+</h1>
+<div class="box_info">
+</div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Kafo.html" title="Kafo (module)">Kafo</a></span>
+</p>
+</div>
+      <div id="footer">
+  Generated on Fri Jul 14 17:35:54 2023 by
+  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.34 (ruby-3.2.2).
+</div>
+    </div>
+  </body>
+</html>

data/lib/kafo/exceptions.rb CHANGED Viewed

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

data/lib/kafo/execution_environment.rb CHANGED Viewed

@@ -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/failed_puppet_resource.rb ADDED Viewed

@@ -0,0 +1,53 @@
+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
+  end
+end

data/lib/kafo/help_builders/advanced.rb CHANGED Viewed

@@ -6,7 +6,7 @@ module Kafo
       def add_module(name, items)
         data = by_parameter_groups(items)
         if data.keys.size > 1
-          puts module_header(name + ':')
+          line module_header(name + ':')
           data.keys.each do |group|
             add_list(header(2, group), data[group])
           end

data/lib/kafo/help_builders/base.rb CHANGED Viewed

@@ -17,7 +17,7 @@ module Kafo
       def add_list(heading, items)
         return if items.empty?
         if heading == 'Options'
-          puts "\n#{heading}:"
+          line "\n#{heading}:"
           data = by_module(items)

data/lib/kafo/hook_context.rb CHANGED Viewed

@@ -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 CHANGED Viewed

@@ -20,8 +20,10 @@ 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_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
@@ -304,7 +308,7 @@ module Kafo
       store = Store.new()
       store_path = self.class.config.app[:store_dir]
       store_path = File.expand_path(File.join(CONFIG_DIR, '../store.d')) if store_path.empty? && defined?(CONFIG_DIR)
-      store.add_dir(store_path) if File.exists?(store_path)
+      store.add_dir(store_path) if File.exist?(store_path)
       store
     end
@@ -542,6 +546,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
@@ -556,10 +566,10 @@ module Kafo
     end
     def config_file
-      return CONFIG_FILE if defined?(CONFIG_FILE) && File.exists?(CONFIG_FILE)
+      return CONFIG_FILE if defined?(CONFIG_FILE) && File.exist?(CONFIG_FILE)
       return self.class.scenario_manager.select_scenario if self.class.scenario_manager.configured?
-      return '/etc/kafo/kafo.yaml' if File.exists?('/etc/kafo/kafo.yaml')
-      return "#{::RbConfig::CONFIG['sysconfdir']}/kafo/kafo.yaml" if File.exists?("#{::RbConfig::CONFIG['sysconfdir']}/kafo/kafo.yaml")
+      return '/etc/kafo/kafo.yaml' if File.exist?('/etc/kafo/kafo.yaml')
+      return "#{::RbConfig::CONFIG['sysconfdir']}/kafo/kafo.yaml" if File.exist?("#{::RbConfig::CONFIG['sysconfdir']}/kafo/kafo.yaml")
       File.join(Dir.pwd, 'config', 'kafo.yaml')
     end

data/lib/kafo/puppet_command.rb CHANGED Viewed

@@ -73,16 +73,11 @@ module Kafo
     def manifest
       %{echo '
         $kafo_config_file="#{@configuration.config_file}"
-        #{add_progress}
         #{generate_version_checks.join("\n") if @puppet_version_check}
         #{@command}
       '}
     end
-    def add_progress
-      %{$kafo_add_progress=#{!KafoConfigure.verbose}}
-    end
     def generate_version_checks
       checks = []
       modules_path.each do |modulepath|

data/lib/kafo/puppet_module.rb CHANGED Viewed

@@ -36,7 +36,7 @@ module Kafo
       if @configuration.module_dirs.count == 1
         module_dir       = @configuration.module_dirs.first
       else
-        module_dir         = @configuration.module_dirs.find { |dir| File.exists?(File.join(dir, module_manifest_path)) } ||
+        module_dir         = @configuration.module_dirs.find { |dir| File.exist?(File.join(dir, module_manifest_path)) } ||
           warn("Manifest #{module_manifest_path} was not found in #{@configuration.module_dirs.join(', ')}")
       end
       @manifest_path     = File.join(module_dir, module_manifest_path)

data/lib/kafo/puppet_report.rb ADDED Viewed

@@ -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(/\!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/version.rb CHANGED Viewed

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

data/modules/kafo_configure/manifests/init.pp CHANGED Viewed

@@ -3,15 +3,6 @@
 #   optional $answers class parameter
 #   $modulepath/config/answers.yaml
 #   /etc/kafo-configure/answers.yaml
-#
-# @param add_progress
-#   Whether to add a progress bar. Only works on Puppet < 6.
-class kafo_configure(
-  Boolean $add_progress = $::kafo_add_progress,
-) {
-  if $add_progress and SemVer($facts['puppetversion']) =~ SemVerRange('< 6.0.0') {
-    add_progress()
-  }
+class kafo_configure {
   lookup('classes', {merge => unique}).include
 }

data/modules/kafo_configure/spec/classes/init_spec.rb CHANGED Viewed

@@ -2,16 +2,9 @@ require 'spec_helper'
 describe 'kafo_configure' do
   let(:hiera_config) { 'spec/fixtures/hiera/hiera.yaml' }
-  let(:facts) { { puppetversion: Puppet.version } }
   context 'without parameters' do
-    let(:params) { {add_progress: false} }
     it { is_expected.to compile.with_all_deps }
     it { is_expected.to contain_class('dummy') }
   end
-  context 'with progress' do
-    let(:params) { {add_progress: true} }
-    it { is_expected.to compile.with_all_deps }
-  end
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kafo
 version: !ruby/object:Gem::Version
-  version: 6.5.0
+  version: 7.1.0
 platform: ruby
 authors:
 - Marek Hulan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-05-31 00:00:00.000000000 Z
+date: 2023-08-31 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:
     - - ">="
@@ -148,20 +148,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 1.3.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.6.2
+        version: 1.3.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
@@ -215,8 +215,17 @@ files:
 - bin/kafofy
 - config/config_header.txt
 - config/kafo.yaml.example
+- doc/Kafo.html
+- doc/_index.html
+- doc/class_list.html
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
 - doc/kafo_run.png
 - doc/kafo_run.uml
+- doc/method_list.html
+- doc/top-level-namespace.html
 - lib/kafo.rb
 - lib/kafo/app_option/declaration.rb
 - lib/kafo/app_option/definition.rb
@@ -250,6 +259,7 @@ 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
@@ -275,6 +285,7 @@ files:
 - lib/kafo/puppet_configurer.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
@@ -286,7 +297,6 @@ files:
 - modules/kafo_configure/lib/puppet/functions/kafo_configure/dump_lookups.rb
 - modules/kafo_configure/lib/puppet/functions/kafo_configure/dump_variables.rb
 - modules/kafo_configure/lib/puppet/functions/kafo_configure/to_yaml.rb
-- modules/kafo_configure/lib/puppet/parser/functions/add_progress.rb
 - modules/kafo_configure/manifests/dump_values.pp
 - modules/kafo_configure/manifests/init.pp
 - modules/kafo_configure/manifests/puppet_version_semver.pp
@@ -313,14 +323,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: A gem for making installations based on puppet user friendly

data/modules/kafo_configure/lib/puppet/parser/functions/add_progress.rb DELETED Viewed

@@ -1,43 +0,0 @@
-module Puppet::Parser::Functions
-  newfunction(:add_progress) do |args|
-    loaded = false
-    begin
-      require 'puppet/transaction'
-      loaded = true
-    rescue LoadError
-      ::Puppet.warning 'Unable to load puppet/transaction for progress bar support, this version may not be supported'
-    end
-    if loaded
-      # Monkey patch the transaction to put our wrapper around the report object
-      class Puppet::Transaction
-        attr_accessor :in_main_catalog
-        def is_interesting?(resource)
-          return false if resource.class.name == :component  # ignore defined types
-          ![:schedule, :class, :stage, :filebucket, :anchor, :concat_fragment].include?(resource.to_s.split('[')[0].downcase.to_sym)
-        end
-        def tracked_resources
-          @tracked_resources ||= catalog.vertices.select { |resource| is_interesting?(resource) }.map(&:to_s)
-        end
-        def evaluate_with_trigger(*args, &block)
-          if catalog.version
-            self.in_main_catalog = true
-            tracked_resources.each { |r| ::Puppet.info "MONITOR_RESOURCE #{r}" }
-          end
-          evaluate_without_trigger(*args, &block)
-          self.in_main_catalog = false if catalog.version
-        end
-        if method_defined?(:evaluate) && method_defined?(:report)
-          alias_method :evaluate_without_trigger, :evaluate
-          alias_method :evaluate, :evaluate_with_trigger
-        else
-          ::Puppet.warning 'Unable to patch Puppet transactions for progress bar support, this version may not be supported'
-        end
-      end
-    end
-  end
-end