kafo 6.2.1 → 6.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03c5d65cf1a7ca3fa3676c6a36a7d0c374f24d06c16cebcb4be5f307f1a39695
-  data.tar.gz: 295369c378adab5c4587f1177ac87eed3b7c5c8f829118ac7c3e7593e43c4d89
+  metadata.gz: 674a595f056324470ff9175d38779f7ab8c153e044ab4892dc99ca0d6487b7ba
+  data.tar.gz: 83ffe976aa56291ebad41e0e7ba22d72908bbe299d926bb1af1aa5b1fbef0a75
 SHA512:
-  metadata.gz: 02e645d54f620a69ff7be17bea01af6d05496a92d1a26e60956d671c7342ccce5382db92552860a908452e00107dae2a0813e960d42b0789d834130528f3e03e
-  data.tar.gz: 527eef2b88081ca1084a8e11646c7066060be65ccaa795559d40351f337768fa06e8d67d636e5180d822c31962322e258a64938d4b28ec6bd59643b2e1cfd809
+  metadata.gz: a8b66a8f86409186fbf2ed5fde7b6b7eb9f6e2fadf4ab33234df205fa4702cadae85021ef043ea096f5450e8735d6b81fade0d81530f2aae43a929dfa2ac8866
+  data.tar.gz: bc3475cace0ec33b3ffb983f8d5921e75b1695908b6f5386b716c3e90434e9ba69f18e38af2c8c0c35372887cec1cfa167ac45c9edb10294fe55cd1384d50ab8

data/README.md

@@ -493,6 +493,39 @@ as key:value.
 When parsing the value, the first colon divides key and value. All other
 colons are ignored.
 
+## Sensitive arguments
+
+Puppet's `Sensitive` data type can be used as long as it's configured in Hiera
+too. Given the following manifest:
+
+```puppet
+class example (
+  Sensitive[String[1]] $password,
+) {
+```
+
+Here the following Hiera configuration is needed:
+```yaml
+lookup_options:
+  example::password:
+    convert_to: "Sensitive"
+```
+
+This is based on [Puppet's documentation](https://puppet.com/docs/puppet/6/securing-sensitive-data.html).
+
+Note that to provide a default inside the manifest inheritance must be used.
+
+```puppet
+class example (
+  Sensitive[String[1]] $password = $example::params::password,
+) inherits example::params {
+}
+
+class example::params {
+  $password = Sensitive('supersecret')
+}
+```
+
 ## Default values
 
 Default values for parameters are read from the class definitions in the
@@ -816,6 +849,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/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
@@ -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_type.rb

@@ -130,4 +130,4 @@ require 'kafo/data_types/struct'
 require 'kafo/data_types/tuple'
 require 'kafo/data_types/type_reference'
 require 'kafo/data_types/undef'
-require 'kafo/data_types/variant'
+require 'kafo/data_types/wrapped_data_type'

data/lib/kafo/data_type_parser.rb

@@ -10,7 +10,7 @@ module Kafo
       @logger = KafoConfigure.logger
       @types = {}
       manifest.each_line do |line|
-        if (type = TYPE_DEFINITION.match(line))
+        if (type = TYPE_DEFINITION.match(line.force_encoding("UTF-8")))
           @types[type[1]] = type[2]
         end
       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/data_types/scalar.rb

@@ -7,7 +7,7 @@ module Kafo
       def_delegators :@inner_type, :condition_value, :dump_default, :multivalued?, :typecast, :valid?
 
       def initialize
-        @inner_type = DataTypes::Variant.new('Integer', 'Float', 'String', 'Boolean', 'Regexp')
+        @inner_type = DataTypes::WrappedDataType.new('Integer', 'Float', 'String', 'Boolean', 'Regexp')
       end
     end
 

data/lib/kafo/data_types/{variant.rb → wrapped_data_type.rb}

@@ -1,6 +1,6 @@
 module Kafo
   module DataTypes
-    class Variant < DataType
+    class WrappedDataType < DataType
       def initialize(*inner_types)
         @inner_types = inner_types.map { |t| DataType.new_from_string(t) }
       end
@@ -16,7 +16,7 @@ module Kafo
       end
 
       def multivalued?
-        @inner_types.any? { |t| t.multivalued? }
+        @inner_types.any?(&:multivalued?)
       end
 
       def to_s
@@ -33,7 +33,7 @@ module Kafo
         if type
           type.valid?(value, errors)
         else
-          errors << "#{value} is not one of #{to_s}"
+          errors << "#{value} is not one of #{self}"
           false
         end
       end
@@ -45,6 +45,7 @@ module Kafo
       end
     end
 
-    DataType.register_type('Variant', Variant)
+    DataType.register_type('Sensitive', WrappedDataType)
+    DataType.register_type('Variant', WrappedDataType)
   end
 end

data/lib/kafo/exceptions.rb

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

data/lib/kafo/fact_writer.rb

@@ -14,10 +14,9 @@ module Kafo
     end
 
     def self.wrapper
-      # Ruby 2.0 doesn't have <<~ heredocs
-      <<-WRAPPER
-      require 'yaml'
-      Facter.add(:kafo) { setcode { YAML.load_file(File.join(__dir__, '#{DATA_FILENAME}')) } }
+      <<~WRAPPER
+        require 'yaml'
+        Facter.add(:kafo) { setcode { YAML.load_file(File.join(__dir__, '#{DATA_FILENAME}')) } }
       WRAPPER
     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

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',
@@ -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,17 +516,17 @@ 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
 
               @progress_bar.update(line) if @progress_bar
             end
           rescue Errno::EIO # we reach end of input
-            exit_status = PTY.check(pid, true) if PTY.respond_to?(:check) # ruby >= 1.9.2
-            if exit_status.nil? # process is still running or we have old ruby so we don't know
+            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
@@ -511,7 +535,7 @@ HEREDOC
             end
           end
         end
-      rescue PTY::ChildExited => e # could be raised by Process.wait on older ruby or by PTY.check
+      rescue PTY::ChildExited => e # could be raised by PTY.check
         self.class.exit_handler.exit_code = e.status.exitstatus
       end
 
@@ -540,11 +564,7 @@ HEREDOC
     end
 
     def normalize_encoding(line)
-      if line.respond_to?(:encode) && line.respond_to?(:valid_encoding?)
-        line.valid_encoding? ? line : line.encode('UTF-16be', :invalid => :replace, :replace => '?').encode('UTF-8')
-      else  # Ruby 1.8.7, doesn't worry about invalid encodings
-        line
-      end
+      line.valid_encoding? ? line : line.encode('UTF-16be', :invalid => :replace, :replace => '?').encode('UTF-8')
     end
   end
 end

data/lib/kafo/logger.rb

@@ -13,7 +13,13 @@ module Kafo
 
     def log(level, *args, &block)
       if Logging.buffering?
-        Logging.to_buffer(@name, level, args, &block)
+        if block_given?
+          data = yield
+        else
+          data = args
+        end
+
+        Logging.to_buffer(@name, ::Logging::LogEvent.new(@name, ::Logging::LEVELS[level.to_s], data, false))
       else
         Logging.dump_buffer if Logging.dump_needed?
         @logger.send(level, *args, &block)

data/lib/kafo/logging.rb

@@ -118,7 +118,7 @@ module Kafo
 
       def dump_buffer
         @buffer.each do |log|
-          ::Logging.logger[log[0]].send(log[1], *([log[2]].flatten(2)), &log[3])
+          ::Logging.logger[log[0]].send(:log_event, log[1])
         end
         @buffer.clear
       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/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
@@ -80,7 +81,7 @@ module Kafo
 
       self
     rescue ConfigurationException => e
-      @logger.fatal "Unable to continue because of: #{e.message}"
+      @logger.fatal "Unable to parse #{manifest_path} because of: #{e.message}"
       KafoConfigure.exit(:manifest_error)
     end
 

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

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

data/lib/kafo/wizard.rb

@@ -15,7 +15,7 @@ module Kafo
     OK = utf_support? ? '✓' : 'y'
     NO = utf_support? ? '✗' : 'n'
 
-    def initialize(kafo, input=$stdin, output=$stdout)
+    def initialize(kafo, input = $stdin, output = $stdout)
       @kafo   = kafo
       @config = kafo.config
       @name   = @config.app[:name] || 'Kafo'

data/modules/kafo_configure/lib/puppet/functions/kafo_configure/dump_lookups.rb

@@ -10,6 +10,13 @@ Puppet::Functions.create_function(:'kafo_configure::dump_lookups') do
   end
 
   def dump_lookups(parameters)
-    Hash[parameters.map { |param| [param, call_function('lookup', [param], 'default_value' => nil)] }]
+    Hash[parameters.map { |param| [param, lookup(param)] }]
+  end
+
+  private
+
+  def lookup(param)
+    value = call_function('lookup', [param], 'default_value' => nil)
+    value.respond_to?(:unwrap) ? value.unwrap : value
   end
 end

data/modules/kafo_configure/lib/puppet/functions/kafo_configure/dump_variables.rb

@@ -8,6 +8,12 @@ Puppet::Functions.create_function(:'kafo_configure::dump_variables') do
 
   def dump_variables(variables)
     scope = closure_scope
-    Hash[variables.map { |var| [var, scope[var]] }]
+    Hash[variables.map { |var| [var, unwrap(scope[var])] }]
+  end
+
+  private
+
+  def unwrap(value)
+    value.respond_to?(:unwrap) ? value.unwrap : value
   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"
     }
   ]
 }

data/modules/kafo_configure/spec/fixtures/hiera/test.yaml

@@ -2,3 +2,8 @@
 classes:
   - dummy
 my_module::param: override
+my_module::password: batteryhorsestaple
+
+lookup_options:
+  my_module::password:
+    convert_to: "Sensitive"

data/modules/kafo_configure/spec/fixtures/modules/dummy/manifests/init.pp

@@ -1,5 +1,6 @@
 class dummy (
   String $first = $dummy::params::first,
   Optional[Integer] $second = undef,
+  Sensitive[String[1]] $password = $dummy::params::password,
 ) inherits dummy::params {
 }

data/modules/kafo_configure/spec/fixtures/modules/dummy/manifests/params.pp

@@ -1,3 +1,4 @@
 class dummy::params {
   $first = 'foo'
+  $password = Sensitive('supersecret')
 }

data/modules/kafo_configure/spec/functions/dump_lookups_spec.rb

@@ -4,4 +4,5 @@ describe 'kafo_configure::dump_lookups' do
   let(:hiera_config) { 'spec/fixtures/hiera/hiera.yaml' }
   it { is_expected.to run.with_params([]).and_return({}) }
   it { is_expected.to run.with_params(['my_module::param']).and_return({'my_module::param' => 'override'}) }
+  it { is_expected.to run.with_params(['my_module::password']).and_return({'my_module::password' => 'batteryhorsestaple'}) }
 end

data/modules/kafo_configure/spec/functions/dump_variables_spec.rb

@@ -6,5 +6,6 @@ describe 'kafo_configure::dump_variables' do
   context 'with values' do
     let(:pre_condition) { 'include dummy' }
     it { is_expected.to run.with_params(['dummy::first']).and_return({'dummy::first' => 'foo'}) }
+    it { is_expected.to run.with_params(['dummy::password']).and_return({'dummy::password' => 'supersecret'}) }
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kafo
 version: !ruby/object:Gem::Version
-  version: 6.2.1
+  version: 6.4.1
 platform: ruby
 authors:
 - Marek Hulan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2022-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -245,7 +245,7 @@ files:
 - lib/kafo/data_types/tuple.rb
 - lib/kafo/data_types/type_reference.rb
 - lib/kafo/data_types/undef.rb
-- lib/kafo/data_types/variant.rb
+- lib/kafo/data_types/wrapped_data_type.rb
 - lib/kafo/exceptions.rb
 - lib/kafo/execution_environment.rb
 - lib/kafo/exit_handler.rb
@@ -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
@@ -318,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.2.22
 signing_key:
 specification_version: 4
 summary: A gem for making installations based on puppet user friendly