kafo 0.5.5 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc890988e785b3514243e664fcd8ab858f74b6ef
-  data.tar.gz: 4b84e1e6f28d24c5dac79ca85755c148cb173d8d
+  metadata.gz: 1cc4327a27559f176db6c995f84dc34e424f925a
+  data.tar.gz: 1c63544e953e0fa5925781976140869a0bbc71ab
 SHA512:
-  metadata.gz: 109405f2e35a020736882fab93fa4bb682ded92035942bb44687a7c9c8898485ac189a8effb5ef5d1aa22e02a66722059399b35ab65431659d80a3b7d3a8ef5d
-  data.tar.gz: 31ed272c0a8600d1dd77a99811be8e4aed0f974c3c0f59722d7919bef70eaefe0b1f2627ebc2db030156c78777f4f188825c5c87e2df77636527694f60392027
+  metadata.gz: 5e41350fd8bc174f1be04dfeef37c270e1f36daa8495ca4c5c0ef7fabcb9347c28152ad98e87119b62e076bc95c88f50c594f46f8c6a780bff6dbf61f78cb729
+  data.tar.gz: 8b6635f0ac9c160f26357e5750eb19cb4555b2151cbb4a9b4a1afa8b0dfaed4b03c05c0abb7b1276423e9faf1228172671ce085826aeaf94bef36d90580dd83c

data/README.md

@@ -498,6 +498,7 @@ several hooks.
 * boot - before kafo is ready to work, useful for adding new installer arguments, logger won't work yet
 * init - just after hooking is initialized and kafo is configured, parameters have no values yet
 * pre_values - just before value from CLI is set to parameters (they already have default values)
+* pre_validations - just after system checks and before validations are executed (and before interactive wizard is started), at this point all parameter values are already set but not yet stored in answer file
 * pre  - just before puppet is executed to converge system
 * post  - just after puppet is executed to converge system
 
@@ -538,8 +539,10 @@ new installer option using ```app_option```. These option values can be accessed
 using ```param('module name', 'parameter name')``` accessor. You can register your own module
 that is not specified in answer file using ```add_module```. Custom mapping is also supported.
 This is useful if you need to add some module to existing installer based on kafo but you don't
-have control over it's source code. Last but not least you have access to logger.
-For more details, see [hook_context.rb](https://github.com/theforeman/kafo/blob/master/lib/kafo/hook_context.rb).
+have control over its source code. You can use custom config storage which persists among
+kafo runs using ```get_custom_config``` and ```store_custom_config```.
+Last but not least you have access to logger. For more details, see
+[hook_context.rb](https://github.com/theforeman/kafo/blob/master/lib/kafo/hook_context.rb).
 
 If you don't want to modify you installer script you can place your hooks into
 hooks directory. By default hooks dir is searched for ruby files in subdirectories
@@ -582,6 +585,8 @@ in installer configuration file.
 You can register as many hooks as you need. The order of execution for particular hook type 
 is based on hook file name.
 
+If you want to cancel installation you can use ```exit``` method and specify an exit code.
+
 ## Colors
 
 Everybody loves colors right? In case you don't you can disable them using ```--no-colors``` 

data/config/kafo.yaml.example

@@ -42,3 +42,8 @@
 # when you specify your directory, it will be search for $yourdir/$type/*.rb
 # :hook_dirs:
 # - /opt/hooks
+
+# 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: {}

data/lib/kafo/configuration.rb

@@ -24,7 +24,8 @@ module Kafo
         :default_values_dir  => '/tmp',
         :colors              => Configuration.colors_possible?,
         :color_of_background => :dark,
-        :hook_dirs           => []
+        :hook_dirs           => [],
+        :custom              => {}
     }
 
     def initialize(file, persist = true)
@@ -71,6 +72,14 @@ module Kafo
       end
     end
 
+    def get_custom(key)
+      custom_storage[key.to_sym]
+    end
+
+    def set_custom(key, value)
+      custom_storage[key.to_sym] = value
+    end
+
     def modules
       @modules ||= @data.keys.map { |mod| PuppetModule.new(mod).parse }
     end
@@ -92,7 +101,7 @@ module Kafo
       @params_default_values ||= begin
         @logger.debug "Creating tmp dir within #{app[:default_values_dir]}..."
         temp_dir = Dir.mktmpdir(nil, app[:default_values_dir])
-        KafoConfigure.register_cleanup_path temp_dir
+        KafoConfigure.exit_handler.register_cleanup_path temp_dir
         @logger.info "Parsing default values from puppet modules..."
         command = PuppetCommand.new("$temp_dir=\"#{temp_dir}\" #{includes} dump_values(#{params})").append('2>&1').command
         @logger.debug `#{command}`
@@ -134,6 +143,10 @@ module Kafo
 
     private
 
+    def custom_storage
+      app[:custom]
+    end
+
     def includes
       modules.map do |mod|
         params_file = File.join(KafoConfigure.modules_dir, mod.params_path)

data/lib/kafo/exit_handler.rb

@@ -0,0 +1,53 @@
+module Kafo
+  class ExitHandler
+    attr_accessor :cleanup_paths, :exit_code, :logger
+
+    def initialize
+      @cleanup_paths = []
+      @exit_code = 0
+      @logger = KafoConfigure.logger
+    end
+
+    def error_codes
+      @error_codes ||= {
+          :invalid_system => 20,
+          :invalid_values => 21,
+          :manifest_error => 22,
+          :no_answer_file => 23,
+          :unknown_module => 24,
+          :defaults_error => 25
+      }
+    end
+
+    def exit(code, &block)
+      @exit_code = translate_exit_code(code)
+      block.call if block
+      KafoConfigure.logger.debug "Exit with status code: #{@exit_code} (signal was #{code})"
+      KafoConfigure.logger.dump_errors
+      cleanup
+      Kernel.exit(@exit_code)
+    end
+
+    def translate_exit_code(code)
+      return code if code.is_a?(Fixnum)
+      if error_codes.has_key?(code)
+        return error_codes[code]
+      else
+        raise "Unknown code #{code}"
+      end
+    end
+
+    def cleanup
+      # make sure default values are removed from /tmp
+      (self.cleanup_paths + ['/tmp/default_values.yaml']).each do |file|
+        logger.debug "Cleaning #{file}"
+        FileUtils.rm_rf(file)
+      end
+    end
+
+    def register_cleanup_path(path)
+      self.cleanup_paths<< path
+    end
+
+  end
+end

data/lib/kafo/hook_context.rb

@@ -60,5 +60,26 @@ module Kafo
       self.kafo.config.add_mapping(module_name, mapping) if mapping
       self.kafo.add_module(module_name)
     end
+
+    # You can trigger installer exit by this method. You must specify exit code as a first
+    # argument. You can also specify a symbol alias which is built-in (see exit_handler.rb
+    # for more details).
+    # examples:
+    #   exit(0)
+    #   exit(:manifest_error)
+    def exit(code)
+      self.kafo.exit(code)
+    end
+
+    # You can load a custom config value that has been saved using store_custom_config
+    def get_custom_config(key)
+      self.kafo.config.get_custom(key)
+    end
+
+    # You can save any value into kafo configuration file, this is useful if you need to
+    # share a value between more hooks and persist the values for next run
+    def store_custom_config(key, value)
+      self.kafo.config.set_custom(key, value)
+    end
   end
 end

data/lib/kafo/hooking.rb

@@ -5,9 +5,10 @@ module Kafo
     # boot - before kafo is ready to work, useful for adding new app arguments, logger won't work yet
     # init - just after hooking is initialized and kafo is configured, parameters have no values yet
     # pre_values - just before value from CLI is set to parameters (they already have default values)
+    # pre_validations - just after system checks and before validations are executed (and before interactive wizard is started), at this point all parameter values are already set but not yet stored in answer file
     # pre - just before puppet is executed to converge system
     # post - just after puppet is executed to converge system
-    TYPES = [:boot, :init, :pre, :post, :pre_values]
+    TYPES = [:boot, :init, :pre, :post, :pre_values, :pre_validations]
 
     attr_accessor :hooks, :kafo
 
@@ -62,6 +63,10 @@ module Kafo
       register(:pre_values, name, &block)
     end
 
+    def register_pre_validations(name, &block)
+      register(:pre_validations, name, &block)
+    end
+
     def register_pre(name, &block)
       register(:pre, name, &block)
     end

data/lib/kafo/kafo_configure.rb

@@ -20,6 +20,7 @@ require 'kafo/system_checker'
 require 'kafo/puppet_command'
 require 'kafo/progress_bar'
 require 'kafo/hooking'
+require 'kafo/exit_handler'
 
 module Kafo
   class KafoConfigure < Clamp::Command
@@ -27,13 +28,10 @@ module Kafo
 
     class << self
       attr_accessor :config, :root_dir, :config_file, :gem_root, :temp_config_file,
-                    :modules_dir, :kafo_modules_dir, :verbose, :app_options, :logger
+                    :modules_dir, :kafo_modules_dir, :verbose, :app_options, :logger,
+                    :exit_handler
       attr_writer :hooking
 
-      def cleanup_paths
-        @cleanup_paths ||= []
-      end
-
       def hooking
         @hooking ||= Hooking.new
       end
@@ -41,6 +39,7 @@ module Kafo
 
     def initialize(*args)
       self.class.logger           = Logger.new
+      self.class.exit_handler     = ExitHandler.new
       self.class.config_file      = config_file
       self.class.config           = Configuration.new(self.class.config_file)
       self.class.root_dir         = File.expand_path(self.class.config.app[:installer_dir])
@@ -77,97 +76,60 @@ module Kafo
     end
 
     def execute
-      catch :exit do
-        parse_cli_arguments
+      parse_cli_arguments
 
-        if (self.class.verbose = verbose?)
-          Logger.setup_verbose
-        else
-          @progress_bar = self.class.config.app[:colors] ? ProgressBars::Colored.new : ProgressBars::BlackWhite.new
-        end
+      if (self.class.verbose = !!verbose?)
+        Logger.setup_verbose
+      else
+        @progress_bar = self.class.config.app[:colors] ? ProgressBars::Colored.new : ProgressBars::BlackWhite.new
+      end
 
-        unless SystemChecker.check
-          puts "Your system does not meet configuration criteria"
-          exit(:invalid_system)
-        end
+      unless SystemChecker.check
+        puts "Your system does not meet configuration criteria"
+        self.class.exit(:invalid_system)
+      end
 
-        if interactive?
-          wizard = Wizard.new(self)
-          wizard.run
-        else
-          unless validate_all
-            puts "Error during configuration, exiting"
-            exit(:invalid_values)
-          end
+      self.class.hooking.execute(:pre_validations)
+      if interactive?
+        wizard = Wizard.new(self)
+        wizard.run
+      else
+        unless validate_all
+          puts "Error during configuration, exiting"
+          self.class.exit(:invalid_values)
         end
+      end
 
-        if dont_save_answers?
-          self.class.temp_config_file = temp_config_file
-          store_params(temp_config_file)
-        else
-          store_params
-        end
-        run_installation
+      if dont_save_answers?
+        self.class.temp_config_file = temp_config_file
+        store_params(temp_config_file)
+      else
+        store_params
       end
+      run_installation
+      return self
+    rescue SystemExit
       return self
     end
 
     def self.run
-      catch :exit do
-        return super
-      end
-      Kernel.exit(self.exit_code) # fail in initialize
-    end
-
-    def exit_code
-      self.class.exit_code
+      return super
+    rescue SystemExit => e
+      self.exit_handler.exit(self.exit_code) # fail in initialize
     end
 
     def self.exit(code, &block)
-      @exit_code = translate_exit_code(code)
-      block.call if block
-      cleanup
-      throw :exit
+      exit_handler.exit(code, &block)
     end
 
     def self.exit_code
-      @exit_code ||= 0
-    end
-
-    def self.translate_exit_code(code)
-      return code if code.is_a? Fixnum
-      error_codes = { :invalid_system => 20,
-                      :invalid_values => 21,
-                      :manifest_error => 22,
-                      :no_answer_file => 23,
-                      :unknown_module => 24,
-                      :defaults_error => 25 }
-      if error_codes.has_key? code
-        return error_codes[code]
-      else
-        raise "Unknown code #{code}"
-      end
-    end
-
-    def self.cleanup
-      # make sure default values are removed from /tmp
-      (self.cleanup_paths + ['/tmp/default_values.yaml']).each do |file|
-        logger.debug "Cleaning #{file}"
-        FileUtils.rm_rf(file)
-      end
+      self.exit_handler.exit_code
     end
 
-    def self.register_cleanup_path(path)
-      self.cleanup_paths<< path
+    def exit_code
+      self.class.exit_code
     end
 
-    def register_cleanup_path(path)
-      self.class.register_cleanup_path(path)
-    end
-
-    def cleanup_paths
-      self.class.cleanup_paths
-    end
 
     def help
       self.class.help(invocation_path, self)
@@ -190,7 +152,7 @@ module Kafo
       @params ||= modules.map(&:params).flatten
     rescue KafoParsers::ModuleName => e
       puts e
-      exit(:unknown_module)
+      self.class.exit(:unknown_module)
     end
 
     def reset_params_cache
@@ -218,10 +180,6 @@ module Kafo
 
     private
 
-    def exit(code, &block)
-      self.class.exit(code, &block)
-    end
-
     def set_parameters
       # set values based on default_values
       params.each do |param|
@@ -377,7 +335,7 @@ module Kafo
       @progress_bar.close if @progress_bar
       logger.info "Puppet has finished, bye!"
       FileUtils.rm(temp_config_file, :force => true)
-      exit(exit_code) do
+      self.class.exit(exit_code) do
         self.class.hooking.execute(:post)
       end
     end

data/lib/kafo/logger.rb

@@ -8,7 +8,15 @@ module Kafo
       attr_writer :loggers
 
       def loggers
-        @loggers || []
+        @loggers ||= []
+      end
+
+      def buffer
+        @buffer ||= []
+      end
+
+      def error_buffer
+        @error_buffer ||= []
       end
     end
 
@@ -68,10 +76,56 @@ module Kafo
       self.loggers<< logger
     end
 
-    %w(fatal error warn info debug).each do |name|
-      define_method(name) do |*args, &block|
+    def self.buffering?
+      KafoConfigure.verbose.nil? || ((KafoConfigure.verbose && !loggers.detect {|l| l.name == 'verbose'}) || self.loggers.empty?)
+    end
+
+    def self.dump_needed?
+      !self.buffer.empty?
+    end
+
+    def self.to_buffer(buffer, *args)
+      buffer << args
+    end
+
+    def self.dump_errors
+      unless self.error_buffer.empty?
+        loggers.each { |logger| logger.error 'Repeating errors encountered during run:' }
+        self.dump_buffer(self.error_buffer)
+      end
+    end
+
+    def dump_errors
+      self.class.dump_errors
+    end
+
+    def self.dump_buffer(buffer)
+      buffer.each do |log|
+        self.loggers.each { |logger| logger.send log[0], *log[1], &log[2] }
+      end
+      buffer.clear
+    end
+
+    def log(name, *args, &block)
+      if self.class.buffering?
+        self.class.to_buffer(self.class.buffer, name, args, &block)
+      else
+        self.class.dump_buffer(self.class.buffer) if self.class.dump_needed?
         self.class.loggers.each { |logger| logger.send name, *args, &block }
       end
     end
+
+    %w(warn info debug).each do |name|
+      define_method(name) do |*args, &block|
+        self.log(name, *args, &block)
+      end
+    end
+
+    %w(fatal error).each do |name|
+      define_method(name) do |*args, &block|
+        self.class.to_buffer(self.class.error_buffer, name, *args, &block)
+        self.log(name, *args, &block)
+      end
+    end
   end
 end

data/lib/kafo/param.rb

@@ -42,12 +42,19 @@ module Kafo
       if default == 'UNSET'
         self.value = nil
       else
-        self.value = (value = defaults[default]) == :undef ? nil : value
+        # if we don't have default value from dump (can happen for modules added from hooks)
+        # we fallback to their own default values
+        if defaults.has_key?(default)
+          value = defaults[default]
+          self.value = (value == :undef ? nil : value)
+        else
+          self.value = self.default
+        end
       end
     end
 
     def set_value_by_config(config)
-      base       = config[module_name]
+      base       = config[self.module.class_name]
       self.value = base[name] if base.has_key?(name)
     end
 

data/lib/kafo/version.rb

@@ -1,4 +1,4 @@
 # encoding: UTF-8
 module Kafo
-  VERSION = "0.5.5"
+  VERSION = "0.6.0"
 end

data/lib/kafo/wizard.rb

@@ -34,7 +34,7 @@ END
       main_menu
     rescue Interrupt
       puts "Got interrupt, exiting"
-      exit(0)
+      KafoConfigure.exit(0)
     end
 
     private
@@ -60,7 +60,8 @@ END
             finished = true
           end
           menu.choice HighLine.color('Cancel run without Saving', :cancel) do
-            say("Bye!"); exit 0
+            say("Bye!")
+            KafoConfigure.exit(0)
           end
         end
       end

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

@@ -2,7 +2,7 @@ require 'kafo_configure/lib/kafo/puppet/report_wrapper'
 
 module Puppet::Parser::Functions
   newfunction(:add_progress) do |args|
-    supported = %w(2.6. 2.7. 3.0. 3.1. 3.2. 3.3. 3.4. 3.5.)
+    supported = %w(2.6. 2.7. 3.0. 3.1. 3.2. 3.3. 3.4. 3.5. 3.6.)
     if supported.any? { |version| Puppet::PUPPETVERSION.start_with?(version) }
       # Monkey patch the transaction to put our wrapper around the report object
       require 'puppet/transaction'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kafo
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.6.0
 platform: ruby
 authors:
 - Marek Hulan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-13 00:00:00.000000000 Z
+date: 2014-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -197,6 +197,7 @@ files:
 - lib/kafo/puppet_module.rb
 - lib/kafo/password_manager.rb
 - lib/kafo/configuration.rb
+- lib/kafo/exit_handler.rb
 - lib/kafo/validator.rb
 - lib/kafo/exceptions.rb
 - lib/kafo/system_checker.rb