kafo 6.0.0 → 6.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5cb69151feb9aff8869369e3c3d16b1899bd51248ab4cb8a2cf08f862d78c72
-  data.tar.gz: f7760b031fb5f00e4ad853d8ac7c139555cc0606dcbd40ba542f340bfbe08135
+  metadata.gz: 03c5d65cf1a7ca3fa3676c6a36a7d0c374f24d06c16cebcb4be5f307f1a39695
+  data.tar.gz: 295369c378adab5c4587f1177ac87eed3b7c5c8f829118ac7c3e7593e43c4d89
 SHA512:
-  metadata.gz: 27baf9be9b11280cd352cc418b62955473396b9d4b3245bc558e9e335e353d209c904acce90936644a9b023e82f60b5fba78ab902eb1aafd8068ae92d34e14ea
-  data.tar.gz: aa2ff036cca2d1d24fa11003272ffecaa51d1a8a03a482471a2074adf92edbbe94b17b82e998a79134635f207e611056d9e91187a6a4ce88191f36836588dbd1
+  metadata.gz: 02e645d54f620a69ff7be17bea01af6d05496a92d1a26e60956d671c7342ccce5382db92552860a908452e00107dae2a0813e960d42b0789d834130528f3e03e
+  data.tar.gz: 527eef2b88081ca1084a8e11646c7066060be65ccaa795559d40351f337768fa06e8d67d636e5180d822c31962322e258a64938d4b28ec6bd59643b2e1cfd809

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

@@ -170,7 +170,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]

data/lib/kafo/hooking.rb

@@ -47,13 +47,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,7 @@ 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])
+      Logging.setup(verbose: config.app[:verbose]) unless ARGV.any? { |option| ['--help', '--full-help'].include? option }
       self.class.set_color_scheme
 
       self.class.hooking.execute(:init)
@@ -365,9 +365,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
 
@@ -459,13 +459,13 @@ module Kafo
       execution_env.store_answers
       puppetconf = execution_env.configure_puppet(
         'color'     => false,
-        'evaltrace' => !!@progress_bar,
+        'evaltrace' => true,
         'noop'      => !!noop?,
         'profile'   => !!profile?,
         'show_diff' => true,
       )
 
-      exit_code   = 0
+      self.class.exit_handler.exit_code = 0
       exit_status = nil
       options     = [
           '--verbose',
@@ -476,7 +476,14 @@ module Kafo
         command = PuppetCommand.new('include kafo_configure', options, puppetconf).command
         log_parser = PuppetLogParser.new
         logger = Logger.new('configure')
-        logger.notice("Starting system configuration")
+
+        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)
 
         PTY.spawn(*PuppetCommand.format_command(command)) do |stdin, stdout, pid|
           begin
@@ -484,6 +491,13 @@ module Kafo
               line = normalize_encoding(line)
               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.")
+                end
+              end
+
               @progress_bar.update(line) if @progress_bar
             end
           rescue Errno::EIO # we reach end of input
@@ -493,16 +507,16 @@ module Kafo
                 Process.wait(pid)
               rescue Errno::ECHILD # process could exit meanwhile so we rescue
               end
-              exit_code = $?.exitstatus
+              self.class.exit_handler.exit_code = $?.exitstatus
             end
           end
         end
       rescue PTY::ChildExited => e # could be raised by Process.wait on older ruby or by PTY.check
-        exit_code = e.status.exitstatus
+        self.class.exit_handler.exit_code = e.status.exitstatus
       end
 
       @progress_bar.close if @progress_bar
-      logger.notice "Puppet has finished, bye!"
+      logger.notice "System configuration has finished."
 
       self.class.hooking.execute(:post)
       self.class.exit(exit_code)

data/lib/kafo/logging.rb

@@ -46,7 +46,8 @@ module Kafo
             level: log_level,
             filename: filename,
             layout: layout(color: false),
-            truncate: true
+            truncate: true,
+            roll_by: 'date'
           )
 
           FileUtils.chown(

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_command.rb

@@ -43,8 +43,15 @@ module Kafo
       File.join([bin_path, bin_name].compact)
     end
 
+    def self.is_aio_puppet?
+      puppet_command = search_puppet_path('puppet')
+      File.realpath(puppet_command).start_with?('/opt/puppetlabs')
+    rescue Errno::ENOENT
+      false
+    end
+
     def self.format_command(command)
-      if search_puppet_path('puppet').start_with?('/opt/puppetlabs')
+      if is_aio_puppet?
         [clean_env_vars, command, :unsetenv_others => true]
       else
         [::ENV, command, :unsetenv_others => false]

data/lib/kafo/puppet_module.rb

@@ -96,16 +96,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/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.0.0"
+  VERSION = "6.2.1"
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kafo
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 6.2.1
 platform: ruby
 authors:
 - Marek Hulan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-28 00:00:00.000000000 Z
+date: 2021-01-22 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
@@ -217,7 +217,6 @@ files:
 - config/kafo.yaml.example
 - doc/kafo_run.png
 - doc/kafo_run.uml
-- doc/plantuml.jar
 - lib/kafo.rb
 - lib/kafo/app_option/declaration.rb
 - lib/kafo/app_option/definition.rb
@@ -294,7 +293,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
@@ -305,7 +303,7 @@ homepage: https://github.com/theforeman/kafo
 licenses:
 - GPL-3.0+
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -321,7 +319,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.4
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A gem for making installations based on puppet user friendly
 test_files: []