kafo 6.2.1 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03c5d65cf1a7ca3fa3676c6a36a7d0c374f24d06c16cebcb4be5f307f1a39695
-  data.tar.gz: 295369c378adab5c4587f1177ac87eed3b7c5c8f829118ac7c3e7593e43c4d89
+  metadata.gz: d246040f3b21a35b8ec0091c61333fbd5b3ecc8af9fb7d6ed666de850a101bf9
+  data.tar.gz: 9ab7731a6e46877cebfdffffbd7b06e5c11951821be90ff2743aa726c889c418
 SHA512:
-  metadata.gz: 02e645d54f620a69ff7be17bea01af6d05496a92d1a26e60956d671c7342ccce5382db92552860a908452e00107dae2a0813e960d42b0789d834130528f3e03e
-  data.tar.gz: 527eef2b88081ca1084a8e11646c7066060be65ccaa795559d40351f337768fa06e8d67d636e5180d822c31962322e258a64938d4b28ec6bd59643b2e1cfd809
+  metadata.gz: fb5d804b5c587646b9576f4ba6a67c9b0bd3702ddfad877750beb81b61710fd5b104db0fe36b7cf1cfd1f286d1548fb5b48acb9b778652df6c075600176df88d
+  data.tar.gz: 406667aac6a714122c3ec8d00a90ec630843bd6939167f23142e94bf465be51c8e098380815e869be64af9090b726a2e6a368542e18137a4fdb2493a52ed6246

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)
@@ -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/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,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/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.3.0"
 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/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.2.1
+  version: 6.3.0
 platform: ruby
 authors:
 - Marek Hulan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2021-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -275,6 +275,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