kafo 6.1.1 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9ce6e0d19780eb90d3fce6d40bdb0cc6dad3c249e5f3462cbcfbc5c785abd95
-  data.tar.gz: 0acbff7b82150ef61629a12bae8769c11fbf509e7458ebe39288493774bdcacf
+  metadata.gz: 4298932fae581df1967c430be034c621ed435954ac95acf7cf7b23c9b7692d40
+  data.tar.gz: 8ce698b286d5ec94c19adfcfc23e541c8b0599cb1399e689ee00b4413668552c
 SHA512:
-  metadata.gz: 3a829dd674a2a4c21593b72b15fd348dcea9f7c555c02a3d3ebcfc3f84fa24abc1f46a38586399e539114a0020c74841efa4622a3b0a4b732e72dfbebe321369
-  data.tar.gz: d047bafa9ee5b763c14c66f8dd5dfed0f35a2c18babd2609e7567b7d02b8379dd54ac07afe779fc0eb64032bc9044623e86f29f0ce16ce0385a9579f5e8b2235
+  metadata.gz: 769146a010f1007993961a0075a03b1cbf9c4055a59bd8259940379662eaa36003ad5a83b746452e8dd0b35ea47640eb1a3064516a7a776d6e8030c6403321a1
+  data.tar.gz: dd05194e14a17c54a205b5eacc35677b78fe4f036b8ab851972a8301c59b1e327555dd065772d82476a190d878d50226ed0253afe1c5dc129496ee316555bac3

data/README.md

@@ -816,6 +816,32 @@ if app_value(:reset_foreman_db) && !app_value(:noop)
 end
 ```
 
+Hooks can additionally be defined by combining all related stages into a single file
+known as a Multi-stage hook. Multi-stage hooks live in a special directory inside
+the hooks directory: ```$installer_dir/hooks/multi```. Taking the previous example:
+
+```ruby
+# hooks/multi/10-reset_option_feature.rb
+boot do
+  app_option '--reset-foreman-db', :flag, 'Drop foreman database first? You will lose all data!', :default => false
+end
+
+pre do
+  if app_value(:reset_foreman_db) && !app_value(:noop)
+    `which foreman-rake > /dev/null 2>&1`
+    if $?.success?
+      logger.info 'Dropping database!'
+      output = `foreman-rake db:drop 2>&1`
+      logger.debug output.to_s
+      unless $?.success?
+        logger.warn "Unable to drop DB, ignoring since it's not fatal, output was: '#{output}''"
+      end
+    else
+      logger.warn 'Foreman not installed yet, can not drop database!'
+    end
+  end
+end
+```
 
 If you want to add more directories to be search you can use the "hook_dirs" option
 in the installer configuration file.

data/Rakefile

@@ -4,7 +4,7 @@ load 'tasks/jenkins.rake'
 
 Rake::TestTask.new('test:ruby') do |t|
   t.libs << 'lib' << 'test'
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList['test/**/*_test.rb'] - FileList['test/tmp/**/*_test.rb']
   t.verbose = true
 end
 
@@ -31,6 +31,13 @@ namespace 'test' do
   end
 end
 
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue LoadError
+  puts 'Rubocop not loaded'
+end
+
 CLEAN.include 'test/tmp'
 
 task :test => ['test:ruby', 'test:puppet_modules']

data/lib/kafo/app_option/declaration.rb

@@ -3,7 +3,6 @@ require_relative 'definition'
 module Kafo
   module AppOption
     module Declaration
-
       include Clamp::Option::Declaration
 
       def app_option(switches, type, description, opts = {}, &block)
@@ -13,7 +12,6 @@ module Kafo
           declared_options << option
         end
       end
-
     end
   end
 end

data/lib/kafo/app_option/definition.rb

@@ -1,7 +1,6 @@
 module Kafo
   module AppOption
     class Definition < Clamp::Option::Definition
-
       def initialize(switches, type, description, options = {})
         @advanced = options.fetch(:advanced, false)
         super(switches, type, description, options)
@@ -10,7 +9,6 @@ module Kafo
       def advanced?
         @advanced
       end
-
     end
   end
 end

data/lib/kafo/color_scheme.rb

@@ -1,4 +1,4 @@
-require 'highline/import'
+require 'highline'
 
 module Kafo
   class ColorScheme
@@ -7,7 +7,7 @@ module Kafo
       ::ENV['TERM'] && !`which tput 2> /dev/null`.empty? && `tput colors`.to_i > 0
     end
 
-    def initialize(options={})
+    def initialize(options = {})
       @background = options[:background].nil? ? :dark : options[:background]
       @colors = options[:colors].nil? ? self.class.colors_possible? : options[:colors]
     end

data/lib/kafo/configuration.rb

@@ -5,43 +5,44 @@ require 'kafo/puppet_module'
 require 'kafo/color_scheme'
 require 'kafo/data_type_parser'
 require 'kafo/execution_environment'
+require 'kafo/scenario_option'
 
 module Kafo
   class Configuration
     attr_reader :config_file, :answer_file, :scenario_id
 
     DEFAULT = {
-        :name                 => '',
-        :description          => '',
-        :enabled              => true,
-        :log_dir              => '/var/log/kafo',
-        :log_owner            => nil,
-        :log_group            => nil,
-        :store_dir            => '',
-        :log_name             => 'configuration.log',
-        :log_level            => 'notice',
-        :no_prefix            => false,
-        :mapping              => {},
-        :answer_file          => './config/answers.yaml',
-        :installer_dir        => '.',
-        :module_dirs          => ['./modules'],
-        :colors               => Kafo::ColorScheme.colors_possible?,
-        :color_of_background  => :dark,
-        :hook_dirs            => [],
-        :check_dirs           => nil,
-        :custom               => {},
-        :facts                => {},
-        :low_priority_modules => [],
-        :verbose              => false,
-        :verbose_log_level    => 'notice',
-        :skip_puppet_version_check => false,
-        :parser_cache_path    => nil,
-        :ignore_undocumented  => nil,
-        :order                => nil,
-        :hiera_config         => nil,
-        :kafo_modules_dir     => nil,
-        :config_header_file   => nil,
-        :dont_save_answers    => nil,
+      ScenarioOption::NAME                      => '',
+      ScenarioOption::DESCRIPTION               => '',
+      ScenarioOption::ENABLED                   => true,
+      ScenarioOption::LOG_DIR                   => '/var/log/kafo',
+      ScenarioOption::LOG_OWNER                 => nil,
+      ScenarioOption::LOG_GROUP                 => nil,
+      ScenarioOption::STORE_DIR                 => '',
+      ScenarioOption::LOG_NAME                  => 'configuration.log',
+      ScenarioOption::LOG_LEVEL                 => 'notice',
+      ScenarioOption::NO_PREFIX                 => false,
+      ScenarioOption::MAPPING                   => {},
+      ScenarioOption::ANSWER_FILE               => './config/answers.yaml',
+      ScenarioOption::INSTALLER_DIR             => '.',
+      ScenarioOption::MODULE_DIRS               => ['./modules'],
+      ScenarioOption::COLORS                    => Kafo::ColorScheme.colors_possible?,
+      ScenarioOption::COLOR_OF_BACKGROUND       => :dark,
+      ScenarioOption::HOOK_DIRS                 => [],
+      ScenarioOption::CHECK_DIRS                => nil,
+      ScenarioOption::CUSTOM                    => {},
+      ScenarioOption::FACTS                     => {},
+      ScenarioOption::LOW_PRIORITY_MODULES      => [],
+      ScenarioOption::VERBOSE                   => false,
+      ScenarioOption::VERBOSE_LOG_LEVEL         => 'notice',
+      ScenarioOption::SKIP_PUPPET_VERSION_CHECK => false,
+      ScenarioOption::PARSER_CACHE_PATH         => nil,
+      ScenarioOption::IGNORE_UNDOCUMENTED       => nil,
+      ScenarioOption::ORDER                     => nil,
+      ScenarioOption::HIERA_CONFIG              => nil,
+      ScenarioOption::KAFO_MODULES_DIR          => nil,
+      ScenarioOption::CONFIG_HEADER_FILE        => nil,
+      ScenarioOption::DONT_SAVE_ANSWERS         => nil,
     }
 
     def self.get_scenario_id(filename)
@@ -129,7 +130,7 @@ module Kafo
     def modules
       @modules ||= begin
         register_data_types
-        @data.keys.map { |mod| PuppetModule.new(mod, PuppetModule.find_parser, self).parse }.sort
+        @data.keys.map { |mod| PuppetModule.new(mod, configuration: self).parse }.sort
       end
     end
 
@@ -158,7 +159,7 @@ module Kafo
     end
 
     def add_module(name)
-      mod = PuppetModule.new(name, PuppetModule.find_parser, self).parse
+      mod = PuppetModule.new(name, configuration: self).parse
       unless modules.map(&:name).include?(mod.name)
         mod.enable
         @modules << mod
@@ -170,7 +171,7 @@ module Kafo
       save_configuration(app)
     end
 
-    def migrate_configuration(from_config, options={})
+    def migrate_configuration(from_config, options = {})
       keys_to_skip = options.fetch(:skip, [])
       keys = [:log_dir, :log_name, :log_level, :no_prefix,
         :colors, :color_of_background, :custom, :verbose_log_level]
@@ -197,7 +198,7 @@ module Kafo
           }
 EOS
 
-        @logger.notice 'Loading default values from puppet modules...'
+        @logger.info "Loading default values from puppet modules..."
         command = PuppetCommand.new(dump_manifest, [], puppetconf, self).command
         stdout, stderr, status = Open3.capture3(*PuppetCommand.format_command(command))
 
@@ -222,7 +223,7 @@ EOS
           end
         end
 
-        @logger.notice "... finished"
+        @logger.info "... finished loading default values from puppet modules."
 
         load_yaml_from_output(stdout.split($/))
       end

data/lib/kafo/data_types/integer.rb

@@ -19,7 +19,9 @@ module Kafo
       end
 
       def typecast(value)
-        value =~ /\d+/ ? value.to_i : value
+        Integer(value)
+      rescue TypeError, ArgumentError
+        value
       end
 
       def valid?(input, errors = [])

data/lib/kafo/data_types/numeric.rb

@@ -2,7 +2,9 @@ module Kafo
   module DataTypes
     class Numeric < DataType
       def typecast(value)
-        value =~ /\d+/ ? value.to_f : value
+        Float(value)
+      rescue TypeError, ArgumentError
+        value
       end
 
       def valid?(input, errors = [])

data/lib/kafo/exceptions.rb

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

data/lib/kafo/hook_context.rb

@@ -34,8 +34,8 @@ module Kafo
     #
     # @example
     #   app_option ['-n', '--noop'], :flag, 'Run puppet in noop mode?', :default => false
-    def app_option(*args)
-      self.kafo.class.app_option(*args)
+    def app_option(*args, &block)
+      self.kafo.class.app_option(*args, &block)
     end
 
     # Returns whether the given app option exists. This is useful when there's a conditional option that is

data/lib/kafo/hooking.rb

@@ -1,4 +1,5 @@
 require 'kafo/hook_context'
+require 'kafo/multi_stage_hook'
 
 module Kafo
   class Hooking
@@ -36,6 +37,14 @@ module Kafo
             register(hook_type, file, &hook_block)
           end
         end
+
+        # Multi stage hooks are special
+        Dir.glob(File.join(base_dir, 'multi', '*.rb')).sort.each do |file|
+          logger.debug "Loading multi stage hook #{file}"
+          hook = File.read(file)
+          MultiStageHook.new(file, self, TYPES).instance_eval(hook, file, 1)
+        end
+
         @loaded = true
       end
       self
@@ -47,13 +56,19 @@ module Kafo
 
     def execute(group, log_stage: true)
       logger = Logger.new(group)
-      logger.notice "Executing hooks in group #{group}" if log_stage
-      self.hooks[group].keys.sort_by(&:to_s).each do |name|
+      logger.info "Executing hooks in group #{group}" if log_stage
+
+      sorted_hooks = self.hooks[group].keys.sort do |a, b|
+        File.basename(a.to_s) <=> File.basename(b.to_s)
+      end
+
+      sorted_hooks.each do |name|
         hook = self.hooks[group][name]
         result = HookContext.execute(self.kafo, logger, &hook)
         logger.debug "Hook #{name} returned #{result.inspect}"
       end
-      logger.notice "All hooks in group #{group} finished" if log_stage
+
+      logger.info "All hooks in group #{group} finished" if log_stage
       @group = nil
     end
 

data/lib/kafo/kafo_configure.rb

@@ -143,7 +143,14 @@ module Kafo
       # so we limit parsing only to app config options (because of --help and later defined params)
       parse clamp_app_arguments
       parse_app_arguments # set values from ARGS to config.app
-      Logging.setup(verbose: config.app[:verbose]) unless ARGV.any? { |option| ['--help', '--full-help'].include? option }
+
+      if ARGV.any? { |option| ['--help', '--full-help'].include? option }
+        Logging.setup_verbose(level: :error)
+      else
+        Logging.setup(verbose: config.app[:verbose])
+      end
+
+      logger.notice("Loading installer configuration. This will take some time.")
       self.class.set_color_scheme
 
       self.class.hooking.execute(:init)
@@ -166,6 +173,10 @@ module Kafo
     def run(*args)
       started_at = Time.now
       logger.debug("Running installer with args #{args.inspect}")
+      if config.app[:verbose]
+        logger.notice("Running installer with log based terminal output at level #{config.app[:verbose_log_level].upcase}.")
+        logger.notice("Use -l to set the terminal output log level to ERROR, WARN, NOTICE, INFO, or DEBUG. See --full-help for definitions.")
+      end
       super
     ensure
       logger.debug("Installer finished in #{Time.now - started_at} seconds")
@@ -311,6 +322,25 @@ module Kafo
       self.class.app_option(*args, &block)
     end
 
+    def terminal_log_levels_message
+      if ARGV.include?('--full-help')
+        <<~HEREDOC.chomp
+          Log level for log based terminal output.
+          The available levels are
+          ERROR  - Only show errors which prevented the installer from completing successfully.
+          WARN   - Deprecation warnings and other information users may want to be aware of.
+          NOTICE - High level information about installer execution and progress.
+          INFO   - More detailed information about execution and progress. Also shows when the installer makes a change to system configuration.
+          DEBUG  - Show all information about execution, including configuration items where no change was needed.
+        HEREDOC
+      else
+        <<~HEREDOC.chomp
+          Log level for log based terminal output.
+          The available levels are ERROR, WARN, NOTICE, INFO, DEBUG. See --full-help for definitions.
+        HEREDOC
+      end
+    end
+
     def set_app_options
       app_option ['--[no-]colors'], :flag, 'Use color output on STDOUT',
                  :default => config.app[:colors], :advanced => true
@@ -333,7 +363,7 @@ module Kafo
                  :default => false, :advanced => true
       app_option ['-v', '--[no-]verbose'], :flag, 'Display log on STDOUT instead of progressbar',
                  :default => config.app[:verbose]
-      app_option ['-l', '--verbose-log-level'], 'LEVEL', 'Log level for verbose mode output',
+      app_option ['-l', '--verbose-log-level'], 'LEVEL', terminal_log_levels_message,
                  :default => 'notice'
       app_option ['-S', '--scenario'], 'SCENARIO', 'Use installation scenario'
       app_option ['--disable-scenario'], 'SCENARIO', 'Disable installation scenario',
@@ -365,9 +395,9 @@ module Kafo
       params.sort.each do |param|
         doc = param.doc.nil? ? 'UNDOCUMENTED' : param.doc.join("\n")
         app_option parametrize(param), '', doc + " (current: #{param.value_to_s})",
-                          :multivalued => param.multivalued?
+                   :multivalued => param.multivalued?
         app_option parametrize(param, 'reset-'), :flag,
-                          "Reset #{param.name} to the default value (#{param.default_to_s})"
+                   "Reset #{param.name} to the default value (#{param.default_to_s})"
       end
     end
 
@@ -440,7 +470,7 @@ module Kafo
     end
 
     def validate_all(logging = true)
-      logger.notice 'Running validation checks'
+      logger.info "Running validation checks."
       results = enabled_params.map do |param|
         result = param.valid?
         errors = param.validation_errors.join(', ')
@@ -477,13 +507,7 @@ module Kafo
         log_parser = PuppetLogParser.new
         logger = Logger.new('configure')
 
-        start_message = <<-HEREDOC
-Starting system configuration.
-  The total number of configuration tasks may increase during the run.
-  Observe logs or specify --verbose-log-level to see individual configuration tasks.
-HEREDOC
-
-        logger.notice(start_message.chomp)
+        logger.notice("Starting system configuration.")
 
         PTY.spawn(*PuppetCommand.format_command(command)) do |stdin, stdout, pid|
           begin
@@ -492,9 +516,9 @@ HEREDOC
               method, message = log_parser.parse(line)
               progress_log(method, message, logger)
 
-              if (output = line.match(%r{(.+\]): Starting to evaluate the resource( \((?<count>\d+) of (?<total>\d+)\))?}))
-                if (output[:count].to_i % 100) == 1 && output[:count].to_i != 1
-                  logger.notice("#{output[:count].to_i - 1} out of #{output[:total]} done.")
+              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
               end
 

data/lib/kafo/multi_stage_hook.rb

@@ -0,0 +1,13 @@
+module Kafo
+  class MultiStageHook
+    def initialize(name, registry, types)
+      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)
+        end
+      end
+    end
+  end
+end

data/lib/kafo/param.rb

@@ -123,12 +123,12 @@ module Kafo
       @type.multivalued?
     end
 
-    def <=> o
+    def <=>(other)
       unless @module.configuration.app[:no_prefix]
-        r = self.module_name <=> o.module_name
+        r = self.module_name <=> other.module_name
         return r unless r == 0
       end
-      self.name <=> o.name
+      self.name <=> other.name
     end
 
     def visible?(context = [])

data/lib/kafo/progress_bar.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+require 'highline'
 require 'powerbar'
 require 'ansi/code'
 require 'set'
@@ -20,7 +21,7 @@ module Kafo
       @all_lines                                = 0
       @total                                    = :unknown
       @resources                                = Set.new
-      @term_width                               = HighLine::SystemExtensions.terminal_size[0] || 0
+      @term_width                               = terminal_width
       @bar                                      = PowerBar.new
       @bar.settings.tty.infinite.template.main  = infinite_template
       @bar.settings.tty.finite.template.main    = finite_template
@@ -85,6 +86,17 @@ module Kafo
 
     private
 
+    def terminal_width
+      # HighLine 2 has Terminal, 1 has SystemExtensions
+      terminal_size = if HighLine.respond_to?(:default_instance)
+                        HighLine.default_instance.terminal.terminal_size
+                      else
+                        HighLine::SystemExtensions.terminal_size
+                      end
+
+      terminal_size ? (terminal_size[0] || 0) : 0
+    end
+
     def done_message
       text = 'Done'
       text + (' ' * (50 - text.length))

data/lib/kafo/puppet_module.rb

@@ -25,7 +25,7 @@ module Kafo
       end
     end
 
-    def initialize(identifier, parser = self.class.find_parser, configuration = KafoConfigure.config)
+    def initialize(identifier, parser: nil, configuration: KafoConfigure.config)
       @identifier        = identifier
       @configuration     = configuration
       @name              = get_name
@@ -65,6 +65,7 @@ module Kafo
     def parse(builder_klass = ParamBuilder)
       @raw_data = @parser_cache.get(identifier, manifest_path) if @parser_cache
       if @raw_data.nil?
+        @parser = self.class.find_parser if @parser.nil?
         if @parser.nil? || @parser == :none
           raise ParserError.new("No Puppet module parser is installed and no cache of the file #{manifest_path} is available. Please check debug logs and install optional dependencies for the parser.")
         else
@@ -96,16 +97,16 @@ module Kafo
       Hash[params.map { |param| [param.name, param.value] }]
     end
 
-    def <=> o
+    def <=>(other)
       @configuration.app[:low_priority_modules].each do |module_name|
-        return 1 if self.name.include?(module_name) && !o.name.include?(module_name)
-        return -1 if !self.name.include?(module_name) && o.name.include?(module_name)
-        if self.name.include?(module_name) && o.name.include?(module_name)
-          return self.name.sub(/.*#{module_name}/, '') <=> o.name.sub(/.*#{module_name}/, '')
+        return 1 if self.name.include?(module_name) && !other.name.include?(module_name)
+        return -1 if !self.name.include?(module_name) && other.name.include?(module_name)
+        if self.name.include?(module_name) && other.name.include?(module_name)
+          return self.name.sub(/.*#{module_name}/, '') <=> other.name.sub(/.*#{module_name}/, '')
         end
       end
 
-      self.name <=> o.name
+      self.name <=> other.name
     end
 
     private

data/lib/kafo/scenario_manager.rb

@@ -1,4 +1,5 @@
 # encoding: UTF-8
+require 'highline/import'
 require 'kafo_wizards'
 require 'pathname'
 
@@ -6,7 +7,7 @@ module Kafo
   class ScenarioManager
     attr_reader :config_dir, :last_scenario_link, :previous_scenario
 
-    def initialize(config, last_scenario_link_name='last_scenario.yaml')
+    def initialize(config, last_scenario_link_name = 'last_scenario.yaml')
       @logger = Logger.new('scenario_manager')
       @config_dir = File.file?(config) ? File.dirname(config) : config
       @last_scenario_link = File.join(config_dir, last_scenario_link_name)
@@ -31,7 +32,7 @@ module Kafo
     end
 
     def list_available_scenarios
-      say ::HighLine.color("Available scenarios", :notice)
+      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}")
@@ -77,7 +78,7 @@ module Kafo
       !!(defined?(CONFIG_DIR) && CONFIG_DIR)
     end
 
-    def scenario_from_args(arg_name='--scenario|-S')
+    def scenario_from_args(arg_name = '--scenario|-S')
       # try scenario provided in the args via -S or --scenario
       ARGV.each_with_index do |arg, index|
         parsed = arg.match(/^(#{arg_name})($|=(?<scenario>\S+))/)
@@ -111,7 +112,7 @@ module Kafo
     end
 
     def show_scenario_diff(prev_scenario, new_scenario)
-      say ::HighLine.color("Scenarios are being compared, that may take a while...", :notice)
+      say ::HighLine.color("Scenarios are being compared, that may take a while...", :info)
       prev_conf = load_and_setup_configuration(prev_scenario)
       new_conf = load_and_setup_configuration(new_scenario)
       print_scenario_diff(prev_conf, new_conf)

data/lib/kafo/scenario_option.rb

@@ -0,0 +1,92 @@
+module Kafo
+  # A class containing constants for all scenario options
+  class ScenarioOption
+    # @group Basic
+
+    # Human readable scenario name
+    NAME = :name
+
+    # Description of the installer scenario and its purpose
+    DESCRIPTION = :description
+
+    # Path to answer file, if the file does not exist a $pwd/config/answers.yaml is used as a fallback
+    ANSWER_FILE = :answer_file
+
+    # Enable colors? If you don't touch this, we'll autodetect terminal capabilities
+    COLORS = :colors
+    # Color scheme, we support :bright and :dark (first is better for white background, dark for black background)
+    COLOR_OF_BACKGROUND = :color_of_background
+
+    # @group Logging
+
+    # Destination for the log files
+    LOG_DIR = :log_dir
+    LOG_NAME = :log_name
+    LOG_LEVEL = :log_level
+    LOG_OWNER = :log_owner
+    LOG_GROUP = :log_group
+
+    # Whether verbose logging is enabled
+    VERBOSE = :verbose
+
+    # When verbose logging is enabled, which level (and up) is shown.
+    VERBOSE_LOG_LEVEL = :verbose_log_level
+
+    # @group State
+
+    # Custom storage is handy if you use hooks and you must store some
+    # configuration which should persist among installer runs. It can be also
+    # used for passing value from one hook to another.
+    CUSTOM = :custom
+
+    FACTS = :facts
+
+    # @group Advanced
+
+    # Checks, implemented as executable files, are loaded from the listed
+    # directories.
+    CHECK_DIRS = :check_dirs
+
+    # Hooks in these extra directories will be loaded, by default they are
+    # loaded from $installer_dir/hooks/$type when you specify your directory,
+    # it will be search for $yourdir/$type/*.rb
+    HOOK_DIRS = :hook_dirs
+
+    # Option to load puppet modules from a specific path. Optional and
+    # $pwd/modules is used by default, multiple dirs are allowed
+    MODULE_DIRS = :module_dirs
+
+    # Kafo has a cache for information parsed from Puppet modules. This
+    # determines the location where that information is stored.
+    PARSER_CACHE_PATH = :parser_cache_path
+
+    # By default all module parameters must be documented or an error is
+    # raised. This can be used to not raise an error when undocumented
+    # parameters are found.
+    IGNORE_UNDOCUMENTED = :ignore_undocumented
+
+    # Kafo tuning, customization of core functionality
+
+    # An optional mapping of classes
+    MAPPING = :mapping
+    NO_PREFIX = :no_prefix
+    ORDER = :order
+    LOW_PRIORITY_MODULES = :low_priority_modules
+    HIERA_CONFIG = :hiera_config
+    KAFO_MODULES_DIR = :kafo_modules_dir
+    CONFIG_HEADER_FILE = :config_header_file
+    DONT_SAVE_ANSWERS = :dont_save_answers
+
+    # These options are in DEFAULT but not in kafo.yaml.example
+
+    # Whether the scenario is enabled or not
+    ENABLED = :enabled
+    STORE_DIR = :store_dir
+    INSTALLER_DIR = :installer_dir
+
+    # Puppet modules declare the Puppet version they're compatible with. Kafo
+    # implements checks to verify this is correct with the Puppet version
+    # that's running. This can be used to bypass the checks
+    SKIP_PUPPET_VERSION_CHECK = :skip_puppet_version_check
+  end
+end

data/lib/kafo/store.rb

@@ -4,7 +4,7 @@ module Kafo
   class Store
     attr_accessor :data
 
-    def initialize(path=nil)
+    def initialize(path = nil)
       @data = {}
       load_path(path) if path
     end

data/lib/kafo/string_helper.rb

@@ -18,7 +18,7 @@ module Kafo
       "#{prefix}#{d(param.name)}"
     end
 
-    def parametrize(param, prefix='')
+    def parametrize(param, prefix = '')
       "--#{prefix}#{with_prefix(param)}"
     end
   end

data/lib/kafo/version.rb

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

data/lib/kafo/wizard.rb

@@ -1,5 +1,6 @@
 # encoding: UTF-8
-require 'highline/import'
+require 'forwardable'
+require 'highline'
 require 'yaml'
 
 module Kafo
@@ -8,14 +9,17 @@ module Kafo
       Kafo::ENV::LANG =~ /UTF-8\z/
     end
 
+    extend Forwardable
+    def_delegators :@highline, :agree, :ask, :choose, :say
+
     OK = utf_support? ? '✓' : 'y'
     NO = utf_support? ? '✗' : 'n'
 
-    def initialize(kafo)
+    def initialize(kafo, input = $stdin, output = $stdout)
       @kafo   = kafo
       @config = kafo.config
       @name   = @config.app[:name] || 'Kafo'
-      setup_terminal
+      @highline = setup_terminal(input, output)
     end
 
     def run
@@ -68,7 +72,7 @@ END
 
     def display_hash
       data = Hash[@config.modules.map { |mod| [mod.name, mod.enabled? ? mod.params_hash : false] }]
-      say HighLine.color(YAML.dump(data), :notice)
+      say HighLine.color(YAML.dump(data), :info)
     end
 
     def configure_module(mod)
@@ -79,7 +83,7 @@ END
           menu.prompt = 'Choose an option from the menu... '
           menu.select_by = :index
 
-          menu.choice("Enable/disable #{mod.name} module, current value: #{HighLine.color(mod.enabled?.to_s, :notice)}") { turn_module(mod) }
+          menu.choice("Enable/disable #{mod.name} module, current value: #{HighLine.color(mod.enabled?.to_s, :info)}") { turn_module(mod) }
           if mod.enabled?
             render_params(mod.primary_parameter_group.params, menu)
 
@@ -114,7 +118,7 @@ END
     def render_params(params, menu)
       params.each do |param|
         if param.visible?(@kafo.params)
-          menu.choice "Set #{HighLine.color(param.name, :important)}, current value: #{HighLine.color(param.value_to_s, :notice)}" do
+          menu.choice "Set #{HighLine.color(param.name, :important)}, current value: #{HighLine.color(param.value_to_s, :info)}" do
             configure(param)
           end
         end
@@ -141,13 +145,13 @@ END
     end
 
     def configure_single(param)
-      say "\ncurrent value: #{HighLine.color(param.value_to_s, :notice)}"
+      say "\ncurrent value: #{HighLine.color(param.value_to_s, :info)}"
       ask("new value:")
     end
 
     def configure_multi(param)
-      say HighLine.color('every line is a separate value, blank line to quit, for hash use key:value syntax', :notice)
-      say "\ncurrent value: #{HighLine.color(param.value_to_s, :notice)} %>"
+      say HighLine.color('every line is a separate value, blank line to quit, for hash use key:value syntax', :info)
+      say "\ncurrent value: #{HighLine.color(param.value_to_s, :info)} %>"
       ask("new value:") do |q|
         q.gather = ""
       end
@@ -164,7 +168,7 @@ END
         say "\n" + HighLine.color("Resetting parameters of module #{mod.name}", :headline)
         choose do |menu|
           mod.params.each do |param|
-            menu.choice "Reset #{HighLine.color(param.name, :important)}, current value: #{HighLine.color(param.value_to_s, :notice)}, default value: #{HighLine.color(param.default_to_s, :notice)}" do
+            menu.choice "Reset #{HighLine.color(param.name, :important)}, current value: #{HighLine.color(param.value_to_s, :info)}, default value: #{HighLine.color(param.default_to_s, :info)}" do
               reset(param)
             end if param.visible?(@kafo.params)
           end
@@ -178,11 +182,17 @@ END
       say "\n" + HighLine.color("Value for #{param.name} reset to default", :important)
     end
 
-    def setup_terminal
-      $terminal         = HighLine.new
-      data              = HighLine::SystemExtensions.terminal_size
-      $terminal.wrap_at = data.first > 80 ? 80 : data.first if data.first
-      $terminal.page_at = data.last if data.last
+    def setup_terminal(input, output)
+      highline = HighLine.new(input, output)
+      # HighLine 2 vs 1
+      data = if highline.respond_to?(:terminal)
+               highline.terminal.terminal_size
+             else
+               HighLine::SystemExtensions.terminal_size
+             end
+      highline.wrap_at = data.first > 80 ? 80 : data.first if data.first
+      highline.page_at = data.last if data.last
+      highline
     end
   end
 end

data/modules/kafo_configure/metadata.json

@@ -9,7 +9,7 @@
   "requirements": [
     {
       "name": "puppet",
-      "version_requirement": ">= 4.5.0 < 7.0.0"
+      "version_requirement": ">= 4.5.0 < 8.0.0"
     }
   ]
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kafo
 version: !ruby/object:Gem::Version
-  version: 6.1.1
+  version: 6.4.0
 platform: ruby
 authors:
 - Marek Hulan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-20 00:00:00.000000000 Z
+date: 2021-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -171,7 +171,7 @@ dependencies:
         version: 1.6.21
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -181,7 +181,7 @@ dependencies:
         version: 1.6.21
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: powerbar
   requirement: !ruby/object:Gem::Requirement
@@ -262,6 +262,7 @@ files:
 - lib/kafo/logging.rb
 - lib/kafo/migration_context.rb
 - lib/kafo/migrations.rb
+- lib/kafo/multi_stage_hook.rb
 - lib/kafo/param.rb
 - lib/kafo/param_builder.rb
 - lib/kafo/param_group.rb
@@ -275,6 +276,7 @@ files:
 - lib/kafo/puppet_log_parser.rb
 - lib/kafo/puppet_module.rb
 - lib/kafo/scenario_manager.rb
+- lib/kafo/scenario_option.rb
 - lib/kafo/store.rb
 - lib/kafo/string_helper.rb
 - lib/kafo/system_checker.rb
@@ -293,7 +295,6 @@ files:
 - modules/kafo_configure/spec/classes/init_spec.rb
 - modules/kafo_configure/spec/fixtures/hiera/hiera.yaml
 - modules/kafo_configure/spec/fixtures/hiera/test.yaml
-- modules/kafo_configure/spec/fixtures/manifests/site.pp
 - modules/kafo_configure/spec/fixtures/modules/dummy/manifests/init.pp
 - modules/kafo_configure/spec/fixtures/modules/dummy/manifests/params.pp
 - modules/kafo_configure/spec/functions/dump_lookups_spec.rb
@@ -319,7 +320,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: A gem for making installations based on puppet user friendly