kafo 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbf3ef253f9a74761e7ef0c3d46ea5bd1f614348
-  data.tar.gz: 543e582caf1cb8e46a994c3abb715d1164ab61a3
+  metadata.gz: 510b992ff3fbaf2166c54dbc84fe06c95ffa28e4
+  data.tar.gz: 39928764fca55a2390c670cb08d68bb2c9f4ce38
 SHA512:
-  metadata.gz: c0ba6eaad2fc7396046fae8ca7ec19b6a4cdca1aa139a550f88cfd2303603f4b6e987c9ebef5198ab60d46873bb2a3dd288ec8961f944b9555c0a6e422ae278e
-  data.tar.gz: e4a91446ae30920ee6eec8893592821a881cfeefe88078aa798b1e3258a6cc13af5c06c47ca4831d153eb35321eea63a16b71a93bcaff84945391a306d8aaf10
+  metadata.gz: b102ff1bfe985eee3436fbfa94323ed775828e63b8550118ea9568d7c1c51ee17006831d6af12e1cb94befc6c65d6f50eafab3c0fa54b7874d5a3f4b6f1a2da3
+  data.tar.gz: aaf516905b8330ecffe67c40f33e9122ae3e928ed37da976891c8145b3e030b1291e330f5caaf1f073057a711141ea7bede3bbd1ca4af585f0c6e5046022c94b

data/README.md

@@ -1034,7 +1034,8 @@ configure it in config/kafo.yaml with:
 ```
 
 The cache will be skipped if the file modification time of the manifest is
-greater than the mtime recorded in the cache.
+greater than the mtime recorded in the cache. Using `--parser-cache` will force
+the use of an outdated cache, but this should be used with caution.
 
 ## Configuring Hiera
 

data/bin/kafo-export-params

@@ -31,15 +31,18 @@ module Kafo
 
     option ['-o', '--output'], 'FILE', 'Output file to write parameters into', :default => '-'
 
-    option '--[no-]parser-cache', :flag, 'Enable or disable the parser cache, disable for fresh results', :default => true
+    option '--[no-]parser-cache', :flag, 'Enable or disable the parser cache, disable for fresh results'
 
     def execute
+      KafoConfigure.logger      = Logger.new(STDERR)
       c                         = Configuration.new(config, false)
-      c.app[:parser_cache_path] = nil unless parser_cache?
       KafoConfigure.config      = c
+      if KafoConfigure.config.parser_cache
+        KafoConfigure.config.parser_cache.force = true if ARGV.include?('--parser-cache')
+        KafoConfigure.config.parser_cache.force = false if ARGV.include?('--no-parser-cache')
+      end
       KafoConfigure.root_dir    = File.expand_path(c.app[:installer_dir])
       KafoConfigure.module_dirs = c.module_dirs
-      KafoConfigure.logger      = Logger.new(STDERR)
 
       if output == '-'
         file = STDOUT

data/lib/kafo/configuration.rb

@@ -5,6 +5,7 @@ require 'kafo/puppet_module'
 require 'kafo/password_manager'
 require 'kafo/color_scheme'
 require 'kafo/data_type_parser'
+require 'kafo/puppet_configurer'
 
 module Kafo
   class Configuration
@@ -147,8 +148,12 @@ module Kafo
         @logger.debug "Creating tmp dir within #{app[:default_values_dir]}..."
         temp_dir = Dir.mktmpdir(nil, app[:default_values_dir])
         KafoConfigure.exit_handler.register_cleanup_path temp_dir
+
+        puppetconf = PuppetConfigurer.new('noop' => true)
+        KafoConfigure.exit_handler.register_cleanup_path puppetconf.config_path
+
         @logger.info 'Loading default values from puppet modules...'
-        command = PuppetCommand.new("$temp_dir=\"#{temp_dir}\" #{includes} dump_values(#{params_to_dump})", ['--noop', '--reports='], self).append('2>&1').command
+        command = PuppetCommand.new("$temp_dir=\"#{temp_dir}\" #{includes} dump_values(#{params_to_dump})", [], puppetconf, self).append('2>&1').command
         result = `#{command}`
         @logger.debug result
         unless $?.exitstatus == 0
@@ -201,7 +206,7 @@ module Kafo
     def preset_defaults_from_puppet
       # set values based on default_values
       params.each do |param|
-        param.set_default(params_default_values)
+        param.set_default_from_dump(params_default_values)
       end
     end
 
@@ -296,8 +301,7 @@ module Kafo
     end
 
     def params_to_dump
-      parameters = params.select { |p| p.default != 'UNSET' }
-      parameters.map { |param| "#{param.dump_default}" }.join(',')
+      params.select(&:dump_default_needed?).map(&:dump_default).join(',')
     end
 
     def format(data)

data/lib/kafo/data_type.rb

@@ -39,7 +39,16 @@ module Kafo
     end
 
     def self.split_arguments(input)
-      input.scan(%r{\s*["'/]?([\w:]+(?:\[.+\])?|.+?)["'/]?\s*(?:,|$)}m).flatten
+      input.scan(%r{
+        \s*
+          (?:
+            ["'/](.*?)["'/] # quoted string, or regexp argument
+            |
+            ([\w:]+ (?:\[.+\])?) # bare words, or Type::Name, or Type::Name[args..]
+          )
+        \s*
+        (?:,|$) # match to end of comma-separated arg, or the last arg
+      }mx).flatten.compact
     end
 
     def self.parse_hash(input)

data/lib/kafo/help_builders/basic.rb

@@ -8,10 +8,14 @@ module Kafo
         add_list(module_header(name), data['Basic'])
       end
 
+      def string
+        super + "\nOnly commonly used options have been displayed.\nUse --full-help to view the complete list."
+      end
+
       private
 
       def except_resets(items)
-        items.select { |i| !i.help.first.strip.start_with?('--reset-') || !i.help.last.strip.end_with?('to the default value') }
+        items.select { |i| !i.help.first.strip.start_with?('--reset-') || !i.help.last.include?('to the default value (') }
       end
     end
   end

data/lib/kafo/kafo_configure.rb

@@ -27,6 +27,7 @@ require 'kafo/hooking'
 require 'kafo/exit_handler'
 require 'kafo/scenario_manager'
 require 'kafo/hiera_configurer'
+require 'kafo/puppet_configurer'
 
 module Kafo
   class KafoConfigure < Clamp::Command
@@ -234,6 +235,12 @@ module Kafo
     def setup_config(conf_file)
       self.class.config_file      = conf_file
       self.class.config           = Configuration.new(self.class.config_file)
+
+      if self.class.config.parser_cache
+        self.class.config.parser_cache.force = true if ARGV.include?('--parser-cache')
+        self.class.config.parser_cache.force = false if ARGV.include?('--no-parser-cache')
+      end
+
       self.class.root_dir         = self.class.config.root_dir
       self.class.check_dirs       = self.class.config.check_dirs
       self.class.module_dirs      = self.class.config.module_dirs
@@ -303,6 +310,7 @@ module Kafo
       self.class.app_option ['--force'], :flag, 'Force change of installation scenaraio'
       self.class.app_option ['--compare-scenarios'], :flag, 'Show changes between last used scenario and the scenario specified with -S or --scenario argument'
       self.class.app_option ['--migrations-only'], :flag, 'Apply migrations to a selected scenario and exit'
+      self.class.app_option ['--[no-]parser-cache'], :flag, 'Force use or bypass of Puppet module parser cache'
     end
 
     def set_options
@@ -320,10 +328,10 @@ module Kafo
 
       params.sort.each do |param|
         doc = param.doc.nil? ? 'UNDOCUMENTED' : param.doc.join("\n")
-        self.class.option parametrize(param), '', doc,
-                          :default => param.value, :multivalued => param.multivalued?
+        self.class.option parametrize(param), '', doc + " (current: #{param.value_to_s})",
+                          :multivalued => param.multivalued?
         self.class.option parametrize(param, 'reset-'), :flag,
-                          "Reset #{param.name} to the default value"
+                          "Reset #{param.name} to the default value (#{param.default_to_s})"
       end
     end
 
@@ -411,23 +419,26 @@ module Kafo
       hiera.write_configs
       self.class.exit_handler.register_cleanup_path(hiera.temp_dir)
 
+      puppetconf = PuppetConfigurer.new(
+        'color'        => false,
+        'evaltrace'    => !!@progress_bar,
+        'hiera_config' => hiera.config_path,
+        'noop'         => !!noop?,
+        'profile'      => !!profile?,
+        'show_diff'    => false
+      )
+      self.class.exit_handler.register_cleanup_path(puppetconf.config_path)
+
       exit_code   = 0
       exit_status = nil
       options     = [
           '--verbose',
           '--debug',
           '--trace',
-          '--color=false',
-          '--show_diff',
           '--detailed-exitcodes',
-          '--reports=',
-          "--hiera_config=#{hiera.config_path}",
       ]
-      options.push '--evaltrace' if @progress_bar
-      options.push '--noop' if noop?
-      options.push '--profile' if profile?
       begin
-        command = PuppetCommand.new('include kafo_configure', options).command
+        command = PuppetCommand.new('include kafo_configure', options, puppetconf).command
         log_parser = PuppetLogParser.new
         PTY.spawn(command) do |stdin, stdout, pid|
           begin

data/lib/kafo/param.rb

@@ -5,8 +5,10 @@ require 'kafo/validator'
 
 module Kafo
   class Param
-    attr_reader :name, :module, :type
-    attr_accessor :default, :doc, :value_set, :condition
+    UNSET_VALUES = ['UNSET', :undef]
+
+    attr_reader :name, :module, :type, :manifest_default
+    attr_accessor :doc, :value_set, :condition
     attr_writer :groups
 
     def initialize(builder, name, type)
@@ -20,8 +22,9 @@ module Kafo
     end
 
     # we use @value_set flag because even nil can be valid value
+    # Order of descending precedence: @value, @default (from dump), @manifest_default
     def value
-      @type.typecast(@value_set ? @value : default)
+      @value_set ? @type.typecast(@value) : default
     end
 
     def value=(value)
@@ -34,8 +37,34 @@ module Kafo
       @value     = nil
     end
 
+    # For literal default values, only use 'manifest_default'. For variable values, use the value
+    # loaded back from the dump in 'default'.
+    def default
+      @type.typecast(dump_default_needed? ? @default : manifest_default)
+    end
+
+    def default=(default)
+      default = nil if UNSET_VALUES.include?(default)
+      @default = default
+    end
+
+    # manifest_default may be a variable ($foo::params::bar) and need dumping from Puppet to get
+    # the actual default value
+    def dump_default_needed?
+      manifest_default.to_s.start_with?('$')
+    end
+
     def dump_default
-      @type.dump_default(default)
+      @type.dump_default(manifest_default_params_variable)
+    end
+
+    def manifest_default=(default)
+      default = nil if UNSET_VALUES.include?(default)
+      @manifest_default = default
+    end
+
+    def manifest_default_params_variable
+      manifest_default[1..-1] if dump_default_needed?
     end
 
     def module_name
@@ -46,28 +75,20 @@ module Kafo
       "#<#{self.class}:#{self.object_id} @name=#{name.inspect} @default=#{default.inspect} @value=#{value.inspect} @type=#{@type}>"
     end
 
-    def set_default(defaults)
-      if default == 'UNSET'
-        self.default = nil
-      else
-        # if we don't have default value from dump (can happen for modules added from hooks,
-        # or without using a params class), the existing default value from the manifest will
-        # be used. On calling #value, the default will be returned if no overriding value is set.
-        value = defaults.has_key?(default) ? defaults[default] : default
-        case value
-          when :undef
-            # value can be set to :undef if value is not defined
-            # (e.g. puppetmaster = $::puppetmaster which is not defined yet)
-            self.default = nil
-          when :undefined
-            # in puppet 2.7 :undefined means that it's param which value is
-            # not set by another parameter (e.g. foreman_group = 'something')
-            # which means, default is sensible unlike dumped default
-            # newer puppet has default dump in format 'value' => 'value' so
-            # it's handled correctly by else branch
-          else
-            self.default = value
-        end
+    def default_to_s
+      internal_value_to_s(default)
+    end
+
+    def value_to_s
+      internal_value_to_s(value)
+    end
+
+    def set_default_from_dump(defaults)
+      # if we don't have default value from dump (can happen for modules added from hooks,
+      # or without using a params class), the existing default value from the manifest will
+      # be used. On calling #value, the default will be returned if no overriding value is set.
+      if dump_default_needed? && defaults.has_key?(manifest_default_params_variable)
+        self.default = defaults[manifest_default_params_variable]
       end
     end
 
@@ -156,6 +177,10 @@ module Kafo
           value
       end
     end
+
+    def internal_value_to_s(value)
+      value.nil? ? 'UNDEF' : value.inspect
+    end
   end
 end
 

data/lib/kafo/param_builder.rb

@@ -59,11 +59,11 @@ module Kafo
       else
         type = Param
       end
-      param           = type.new(@module, name, data_type)
-      param.default   = data[:values][name]
-      param.doc       = data[:docs][name]
-      param.groups    = data[:groups][name]
-      param.condition = data[:conditions][name]
+      param                  = type.new(@module, name, data_type)
+      param.manifest_default = data[:values][name]
+      param.doc              = data[:docs][name]
+      param.groups           = data[:groups][name]
+      param.condition        = data[:conditions][name]
       param
     end
 

data/lib/kafo/params/password.rb

@@ -46,6 +46,15 @@ module Kafo
         @module.configuration.app[:password]
       end
 
+      def internal_value_to_s(value)
+        if value.nil?
+          super
+        elsif value.empty?
+          ''.inspect
+        else
+          'REDACTED'
+        end
+      end
     end
   end
 end

data/lib/kafo/parser_cache_reader.rb

@@ -2,6 +2,8 @@ require 'kafo/version'
 
 module Kafo
   class ParserCacheReader
+    attr_accessor :force
+
     def self.new_from_file(cache_paths)
       cache_paths = [cache_paths].compact unless cache_paths.is_a?(Array)
       if cache_paths.empty?
@@ -38,8 +40,9 @@ module Kafo
       KafoConfigure.logger
     end
 
-    def initialize(cache)
+    def initialize(cache, options = {})
       @cache = cache
+      @force = options[:force]
     end
 
     def logger
@@ -47,11 +50,20 @@ module Kafo
     end
 
     def get(key, manifest_path)
+      if @force == false
+        logger.debug "Skipping parser cache for #{manifest_path}, forced off"
+        return nil
+      end
+
       return nil unless @cache[:files].has_key?(key)
 
       if @cache[:files][key][:mtime] && File.mtime(manifest_path).to_i > @cache[:files][key][:mtime]
-        logger.debug "Parser cache for #{manifest_path} is outdated, ignoring cache entry"
-        return nil
+        if @force
+          logger.warn "Parser cache for #{manifest_path} is outdated, forced to use it anyway"
+        else
+          logger.debug "Parser cache for #{manifest_path} is outdated, ignoring cache entry"
+          return nil
+        end
       end
 
       @cache[:files][key][:data]

data/lib/kafo/puppet_command.rb

@@ -1,14 +1,16 @@
 # encoding: UTF-8
 module Kafo
   class PuppetCommand
-    def initialize(command, options = [], configuration = KafoConfigure.config)
+    def initialize(command, options = [], puppet_config = nil, configuration = KafoConfigure.config)
       @configuration = configuration
       @command = command
+      @puppet_config = puppet_config
 
       # Expand the modules_path to work around the fact that Puppet doesn't
       # allow modulepath to contain relative (i.e ..) directory references as
       # of 2.7.23.
       @options = options.push("--modulepath #{File.expand_path(modules_path)}")
+      @options.push("--config=#{puppet_config.config_path}") if puppet_config
       @logger  = KafoConfigure.logger
     end
 
@@ -17,6 +19,7 @@ module Kafo
     end
 
     def command
+      @puppet_config.write_config if @puppet_config
       result = [
           "echo '$kafo_config_file=\"#{@configuration.config_file}\" #{add_progress} #{@command}'",
           '|',

data/lib/kafo/puppet_configurer.rb

@@ -0,0 +1,37 @@
+require 'tempfile'
+
+module Kafo
+  class PuppetConfigurer
+    attr_reader :logger
+
+    def initialize(settings = {})
+      @settings = {'reports' => ''}.merge(settings)
+      @logger = KafoConfigure.logger
+      @temp_file = Tempfile.new(['kafo_puppet', '.conf'])
+    end
+
+    def config_path
+      @temp_file.path
+    end
+
+    def [](key)
+      @settings[key]
+    end
+
+    def []=(key, value)
+      @settings[key] = value
+    end
+
+    def write_config
+      @logger.debug("Writing Puppet config file at #{@temp_file.path}")
+      @temp_file.open
+      @temp_file.truncate(0)
+      @temp_file.puts '[main]'
+      @settings.keys.sort.each do |key|
+        @temp_file.puts "#{key} = #{@settings[key]}"
+      end
+    ensure
+      @temp_file.close
+    end
+  end
+end

data/lib/kafo/version.rb

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

data/lib/kafo/wizard.rb

@@ -114,7 +114,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, :info)}" 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 +141,13 @@ END
     end
 
     def configure_single(param)
-      say "\ncurrent value: #{HighLine.color(param.value.to_s, :info)}"
+      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', :info)
-      say "\ncurrent value: #{HighLine.color(param.value.to_s, :info)} %>"
+      say "\ncurrent value: #{HighLine.color(param.value_to_s, :info)} %>"
       ask("new value:") do |q|
         q.gather = ""
       end
@@ -164,7 +164,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, :info)}, default value: #{HighLine.color(param.default.to_s, :info)}" 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kafo
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Marek Hulan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-23 00:00:00.000000000 Z
+date: 2017-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.6
 - !ruby/object:Gem::Dependency
   name: logging
   requirement: !ruby/object:Gem::Requirement
@@ -252,6 +252,7 @@ files:
 - lib/kafo/progress_bars/black_white.rb
 - lib/kafo/progress_bars/colored.rb
 - lib/kafo/puppet_command.rb
+- lib/kafo/puppet_configurer.rb
 - lib/kafo/puppet_log_parser.rb
 - lib/kafo/puppet_module.rb
 - lib/kafo/scenario_manager.rb