kafo 0.7.6 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 35bc59bbfe6e1ff266439493be2e8c8342c6a2d9
-  data.tar.gz: e3dd61d73c8799f13d66f5774c03d3b84d7a7196
+  metadata.gz: 6bce70ac2eb5590a3268fc61fa1d5b26eec0a231
+  data.tar.gz: 6c68b15f3208c75fd702601f5059c355d3e98383
 SHA512:
-  metadata.gz: 7f4247cd5325ec3c2b78008e92f9cc3e6b149f04a44280e619f8025b688387766a18228652acc47588a14e69652f3d3fdd072ec18d820f505ea963920e6647bc
-  data.tar.gz: 14109f9b4d7de650e88c601ea1b247b4eb85979b1445d39740fa80d023e75d764e844c73cd11fdba5c32301490c51615f96952f2d16688a3e9bfbeba3dd917eb
+  metadata.gz: a749d272c84c6a4ff863c9c67438e3f1e046b5949d4e4c491032d533d05fabe5f31c52e672bccd6d3c444bf056ca636894c878fcaf9dc0c745161a039a34f17a
+  data.tar.gz: 54587849902f34872edc974a28fa11a63adb20f5000dd7086b534d325681fb1af69b0fef0eaf11d7116a81496826d20240b6f8746a7e623fb5aa4c188f3fb256

data/README.md

@@ -190,6 +190,25 @@ disable saving answer by passing a ```--dont-save-answers``` argument (or -d for
 
 Note that running ```--noop``` implies ```--dont-save-answers```.
 
+## Executing Puppet with multiple versions
+
+Kafo calls the `puppet` binary during an installer run to both compute default
+parameter values and perform the actual installer changes. This relies on
+`puppet` being in the PATH environment variable or as fallback, in
+`/opt/puppetlabs/bin`.
+
+When using Puppet via a Gemfile, Bundler should set up PATH to point at the
+gem version. If using a system/packaged version, it will typically find and
+execute /usr/bin/puppet from the regular PATH.
+
+When using an AIO/PC1 packaged version of Puppet, other versions of Puppet from
+PATH will be preferred if they exist, so they should either be removed or PATH
+set to prefer /opt/puppetlabs/bin, i.e. `export PATH=/opt/puppetlabs/bin:$PATH`.
+Debug logs from Kafo should indicate the full path of the binary used.
+
+Note that Kafo parsers supports specific versions of Puppet, and may require
+extra modules (such as puppet-strings on Puppet 4+) to parse manifests.
+
 ## Parameters prefixes
 
 As a default every module parameter is prefixed by the module name.
@@ -317,6 +336,13 @@ Sample migration adding new module could look like as follows:
   EOF
 ```
 
+The migration can also call `facts`, which returns a hash of symbol fact names to values (from
+Facter), to help determine new parameter values.
+
+```ruby
+answers['module']['foo'] = 'bar' if facts[:osfamily] == 'Debian'
+```
+
 ### Enabling/disabling scenarios
 
 Scenarios that are deprecated or wanted to be hidden on the system can be disabled with:
@@ -631,11 +657,13 @@ If you use "params_path" for this purpose, "params_name" is ignored.
 ## Validations
 
 If you specify validations of parameters in your init.pp manifest they
-will be replaced with your values even before puppet is run. In order to do this
+will be replaced with your values even before Puppet is run. In order to do this
 you must follow a few rules however:
 
 * you must use standard validation functions (e.g. validate_array, validate_re, ...)
-* you must have stdlib in modules directory
+
+These functions are re-implemented in Kafo from common stdlib functions, so please
+contribute any missing ones.
 
 ## Enabling or disabling module
 

data/lib/kafo/configuration.rb

@@ -85,7 +85,7 @@ module Kafo
     end
 
     def modules
-      @modules ||= @data.keys.map { |mod| PuppetModule.new(mod, KafoParsers::PuppetModuleParser, self).parse }.sort
+      @modules ||= @data.keys.map { |mod| PuppetModule.new(mod, PuppetModule.find_parser, self).parse }.sort
     end
 
     def root_dir
@@ -109,7 +109,7 @@ module Kafo
     end
 
     def add_module(name)
-      mod = PuppetModule.new(name, KafoParsers::PuppetModuleParser, self).parse
+      mod = PuppetModule.new(name, PuppetModule.find_parser, self).parse
       unless modules.map(&:name).include?(mod.name)
         mod.enable
         @modules << mod
@@ -233,16 +233,8 @@ module Kafo
       File.join(app[:log_dir], app[:log_name])
     end
 
-    def log_files_pattern
-      log_file.sub(/(\.log)\Z/i) { |suffix| "{.[0-9]*,}#{suffix}" }
-    end
-
-    def log_files
-      Dir.glob(log_files_pattern)
-    end
-
     def log_exists?
-      log_files.any? { |f| File.size(f) > 0 }
+      File.exists?(log_file) && File.size(log_file) > 0
     end
 
     def answers
@@ -259,7 +251,6 @@ module Kafo
         migrations.store_applied
         @logger.info("#{migrations.migrations.count} migration/s were applied. Updated configuration was saved.")
       end
-      migrations.migrations.count
     end
 
     def migrations_dir

data/lib/kafo/exceptions.rb

@@ -6,6 +6,9 @@ module Kafo
   class ConditionError < StandardError
   end
 
+  class ParserError < StandardError
+  end
+
   class TypeError < StandardError
   end
 end

data/lib/kafo/kafo_configure.rb

@@ -57,9 +57,9 @@ module Kafo
       setup_config(config_file)
 
       self.class.hooking.execute(:pre_migrations)
-      reload_config
-      applied_total = self.class.config.run_migrations
-      request_config_reload if applied_total > 0
+
+      # run migrations
+      self.class.config.run_migrations
 
       if ARGV.include?('--migrations-only')
         self.class.verbose = (ARGV.include?('--verbose') || ARGV.include?('-v'))
@@ -68,7 +68,13 @@ module Kafo
         self.class.exit(0)
       end
 
-      reload_config
+      # reload config
+      if @config_reload_requested
+        scenario_manager = setup_scenario_manager
+        self.class.scenario_manager = scenario_manager
+        setup_config(self.class.config_file)
+        self.class.logger.info('Installer configuration was reloaded')
+      end
 
       if scenario_manager.configured?
         scenario_manager.check_scenario_change(self.class.config_file)
@@ -235,16 +241,6 @@ module Kafo
       self.class.hooking.kafo     = self
     end
 
-    def reload_config
-      if @config_reload_requested
-        scenario_manager = setup_scenario_manager
-        self.class.scenario_manager = scenario_manager
-        setup_config(self.class.config_file)
-        self.class.logger.info('Installer configuration was reloaded')
-        @config_reload_requested = false
-      end
-    end
-
     def setup_scenario_manager
       ScenarioManager.new((defined?(CONFIG_DIR) && CONFIG_DIR) || (defined?(CONFIG_FILE) && CONFIG_FILE))
     end

data/lib/kafo/logger.rb

@@ -105,7 +105,7 @@ module Kafo
 
     def self.dump_buffer(buffer)
       buffer.each do |log|
-        self.loggers.each { |logger| logger.send log[0], *([log[1]].flatten(1)), &log[2] }
+        self.loggers.each { |logger| logger.send log[0], *log[1], &log[2] }
       end
       buffer.clear
     end

data/lib/kafo/migration_context.rb

@@ -17,5 +17,21 @@ module Kafo
     def logger
       KafoConfigure.logger
     end
+
+    def facts
+      self.class.facts
+    end
+
+    private
+
+    def self.facts
+      @facts ||= begin
+        YAML.load(`#{facter_path} --yaml`).inject({}) { |facts,(k,v)| facts.update(k.to_sym => v) }
+      end
+    end
+
+    def self.facter_path
+      @facter_path ||= PuppetCommand.search_puppet_path('facter')
+    end
   end
 end

data/lib/kafo/param.rb

@@ -73,24 +73,20 @@ module Kafo
     end
 
     def valid?
-      validations = self.module.validations(self)
       # we get validations that can also run on other arguments, we need to take only current param
       # also we want to clone validations so we don't interfere
-      validations.map! do |v|
-        v = v.clone
-        if v.name == 'validate_re'
-          # validate_re does not take more variables as arguments, instead we need to pass all arguments
-          args = v.arguments
+      validations = self.module.validations(self).map do |v|
+        # These functions do not take more variables as arguments, instead we need to pass all arguments
+        if v.name == 'validate_re' || v.name == 'validate_integer'
+          args = v.arguments.to_a
         else
           args = v.arguments.select { |a| a.to_s == "$#{self.name}" }
         end
-        v.arguments = Puppet::Parser::AST::ASTArray.new :children => args
-        v
+        {:name => v.name, :arguments => interpret_validation_args(args)}
       end
 
-      validator = Validator.new([self])
-      validations.map! { |v| v.evaluate(validator) }
-      validations.all?
+      validator = Validator.new
+      validations.all? { |v| validator.send(v[:name], v[:arguments]) }
     end
 
     # To be overwritten in children
@@ -119,6 +115,24 @@ module Kafo
     def evaluate_condition(context = [])
       Condition.new(condition, context).evaluate
     end
+
+    def interpret_validation_args(args)
+      args.map do |arg|
+        if arg.to_s == "$#{self.name}"
+          self.value
+        elsif arg.class.name == 'Puppet::Parser::AST::ASTArray'
+          interpret_validation_args(arg.to_a)
+        elsif arg.class.name == 'Puppet::Parser::AST::Concat'
+          interpret_validation_args(arg.value).join
+        elsif arg.respond_to? :value
+          arg.value
+        else
+          arg
+        end
+      end.map do |arg|
+        arg == :undef ? nil : arg
+      end
+    end
   end
 end
 

data/lib/kafo/progress_bar.rb

@@ -13,6 +13,7 @@ module Kafo
       @lines                                    = 0
       @all_lines                                = 0
       @total                                    = :unknown
+      @term_width                               = HighLine::SystemExtensions.terminal_size[0]
       @bar                                      = PowerBar.new
       @bar.settings.tty.infinite.template.main  = infinite_template
       @bar.settings.tty.finite.template.main    = finite_template

data/lib/kafo/progress_bars/black_white.rb

@@ -5,7 +5,8 @@ module Kafo
       private
 
       def finite_template
-        'Installing'.ljust(22) + ' ${<msg>} [${<percent>%}] [${<bar>}]'
+        'Installing'.ljust(22) + ' ${<msg>} [${<percent>%}]' +
+        (@term_width >= 83 ? ' [${<bar>}]' : '')
       end
 
       def infinite_template

data/lib/kafo/progress_bars/colored.rb

@@ -16,7 +16,7 @@ module Kafo
         'Installing'.ljust(22) +
             ANSI::Code.yellow { ' ${<msg>}' } +
             ANSI::Code.green { ' [${<percent>%}]' } +
-            ' [${<bar>}]'
+            (@term_width >= 83 ? ' [${<bar>}]' : '')
       end
 
       def infinite_template

data/lib/kafo/puppet_command.rb

@@ -25,7 +25,7 @@ module Kafo
           "echo '$kafo_config_file=\"#{@configuration.config_file}\" #{custom_answer_file} #{add_progress} #{@command}'",
           '|',
           "RUBYLIB=#{["#{@configuration.gem_root}/modules", ::ENV['RUBYLIB']].join(File::PATH_SEPARATOR)}",
-          "puppet apply #{@options.join(' ')} #{@suffix}",
+          "#{puppet_path} apply #{@options.join(' ')} #{@suffix}",
       ].join(' ')
       @logger.debug result
       result
@@ -36,6 +36,13 @@ module Kafo
       self
     end
 
+    def self.search_puppet_path(bin_name)
+      bin_path = (::ENV['PATH'].split(File::PATH_SEPARATOR) + ['/opt/puppetlabs/bin']).find do |path|
+        File.executable?(File.join(path, bin_name))
+      end
+      File.join([bin_path, bin_name].compact)
+    end
+
     private
 
     def modules_path
@@ -44,5 +51,9 @@ module Kafo
           @configuration.kafo_modules_dir,
       ].flatten.join(':')
     end
+
+    def puppet_path
+      @puppet_path ||= self.class.search_puppet_path('puppet')
+    end
   end
 end

data/lib/kafo/puppet_module.rb

@@ -2,7 +2,7 @@
 require 'kafo/param'
 require 'kafo/param_builder'
 require 'kafo/parser_cache_reader'
-require 'kafo_parsers/puppet_module_parser'
+require 'kafo_parsers/parsers'
 require 'kafo/validator'
 
 module Kafo
@@ -12,7 +12,21 @@ module Kafo
     attr_reader :name, :identifier, :params, :dir_name, :class_name, :manifest_name, :manifest_path,
                 :groups, :params_path, :params_class_name, :configuration, :raw_data
 
-    def initialize(identifier, parser = KafoParsers::PuppetModuleParser, configuration = KafoConfigure.config)
+    def self.find_parser
+      @parser ||= begin
+        logger = KafoConfigure.logger
+        parser = KafoParsers::Parsers.find_available(:logger => logger)
+        if parser
+          logger.debug "Using Puppet module parser #{parser}"
+          parser
+        else
+          logger.debug "No available Puppet module parser found"
+          :none  # prevent continually re-checking
+        end
+      end
+    end
+
+    def initialize(identifier, parser = self.class.find_parser, configuration = KafoConfigure.config)
       @identifier        = identifier
       @configuration     = configuration
       @name              = get_name
@@ -49,9 +63,15 @@ module Kafo
     end
 
     def parse(builder_klass = ParamBuilder)
-      @params      = []
-      @raw_data    = @parser_cache.get(identifier, manifest_path) if @parser_cache
-      @raw_data  ||= @parser.parse(manifest_path)
+      @raw_data = @parser_cache.get(identifier, manifest_path) if @parser_cache
+      if @raw_data.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
+          @raw_data = @parser.parse(manifest_path)
+        end
+      end
+
       builder      = builder_klass.new(self, @raw_data)
       @validations = @raw_data[:validations]
 

data/lib/kafo/scenario_manager.rb

@@ -91,13 +91,10 @@ module Kafo
         (available_scenarios.keys.count == 1 && available_scenarios.keys.first) ||
         select_scenario_interactively
       if scenario.nil?
-        fail_now("No installation scenario was selected, the installer can not continue.\n" +
-          "       Even --help content is dependent on selected scenario.\n" +
-          "       Select scenario with --scenario SCENARIO or list available scenarios with --list-scenarios.", :unknown_scenario)
+        fail_now("Scenario was not selected, can not continue. Use --list-scenarios to list available options.", :unknown_scenario)
       elsif !scenario_enabled?(scenario)
-        fail_now("Selected scenario is DISABLED, can not continue.\n" +
-          "       Use --list-scenarios to list available options.\n" +
-          "       You can also --enable-scenario SCENARIO to make the selected scenario available.", :scenario_error)
+        fail_now("Selected scenario is DISABLED, can not continue. Use --list-scenarios to list available options." \
+	        " You can also --enable-scenario SCENARIO to make the selected scenario available.", :scenario_error)
       end
       scenario
     end

data/lib/kafo/validator.rb

@@ -2,79 +2,112 @@
 module Kafo
   class Validator
 
-    def self.prepare_functions
-      return true if @reset || !Puppet::Parser::Functions.respond_to?(:reset)
-      Puppet::Parser::Functions.reset
-      @reset = true
+    def initialize
+      @logger = KafoConfigure.logger
     end
 
-    def initialize(params)
-      self.class.prepare_functions
-      definitions = KafoConfigure.module_dirs.map do |dir|
-        validate_files = dir + '/*/lib/puppet/parser/functions/validate_*.rb'
-        is_function_files = dir + '/*/lib/puppet/parser/functions/is_*.rb'
-        Dir.glob(validate_files) + Dir.glob(is_function_files)
-      end.flatten
-
-      definitions.each do |file|
-        require File.expand_path(file)
+    def validate_absolute_path(args)
+      args.each do |arg|
+        unless arg.to_s.start_with?('/')
+          @logger.error "#{arg.inspect} is not an absolute path."
+          return false
+        end
       end
+      return true
+    end
 
-      @params = params
-      @logger = KafoConfigure.logger
+    def validate_array(args)
+      args.each do |arg|
+        unless arg.is_a?(Array)
+          @logger.error "#{arg.inspect} is not a valid array."
+          return false
+        end
+      end
+      return true
+    end
 
-      @cache ||= Hash.new do |hash, key|
-        @logger.debug "Looked for #{key}"
-        param     = @params.select { |p| p.name == key.to_s }.first
-        hash[key] = param.nil? ? nil : param.value
+    def validate_bool(args)
+      args.each do |arg|
+        unless arg.is_a?(TrueClass) || arg.is_a?(FalseClass)
+          @logger.error "#{arg.inspect} is not a valid boolean."
+          return false
+        end
       end
+      return true
     end
 
-    def lookupvar(name, options = {})
-      @cache[name]
+    def validate_hash(args)
+      args.each do |arg|
+        unless arg.is_a?(Hash)
+          @logger.error "#{arg.inspect} is not a valid hash."
+          return false
+        end
+      end
+      return true
     end
 
-    # for puppet >= 3
-    def include?(value)
-      true
+    def validate_integer(args)
+      value = args[0]
+      max = args[1]
+      min = args[2]
+      int = Integer(value.to_s)
+      if min && int < min.to_i
+        @logger.error "#{value} must be at least #{min}."
+        return false
+      end
+      if max && int > max.to_i
+        @logger.error "#{value} must be less than #{max}."
+        return false
+      end
+      return true
+    rescue TypeError, ArgumentError
+      @logger.error "#{value.inspect} is not a valid integer."
+      return false
     end
 
-    # for puppet >= 3
-    def [](value, *args)
-      lookupvar(value)
+    # Non-standard validation is from theforeman/foreman_proxy module
+    def validate_listen_on(args)
+      valid_values = ['http', 'https', 'both']
+      args.each do |arg|
+        unless valid_values.include?(arg)
+          @logger.error "#{arg.inspect} is not a valid value.  Valid values are: #{valid_values.join(", ")}"
+          return false
+        end
+      end
+      return true
     end
 
-    def method_missing(method, *args, &block)
-      method.to_s =~ /^function_(.*)$/
-      super unless $1
-      super unless Puppet::Parser::Functions.function($1)
-      # In odd circumstances, this might not end up defined by the previous
-      # method, so we might as well be certain.
-      if engine.respond_to? method
-        @logger.debug "calling #{method.inspect} with #{args.inspect}"
-        engine.send(method, *args)
-        true
+    def validate_re(args)
+      value = args[0]
+      regexes = args[1]
+      regexes = [regexes] unless regexes.is_a?(Array)
+      message = args[2] || "#{value.inspect} does not match the accepted inputs: #{regexes.join(", ")}"
+
+      if regexes.any? { |rx| value =~ Regexp.compile(rx) }
+        return true
       else
-        raise Puppet::DevError, "Function #{$1} not defined despite being loaded!"
+        @logger.error message
+        return false
       end
-    rescue Puppet::ParseError => e
-      @logger.error e.message
-      return false
     end
 
-    private
-
-    def engine
-      @engine ||= begin
-        klass = Class.new
-        env = Puppet::PUPPETVERSION.start_with?('2.') ? nil : lookup_current_environment
-        klass.send :include, Puppet::Parser::Functions.environment_module(env)
-        klass.new
+    def validate_string(args)
+      args.each do |arg|
+        unless arg.is_a?(String)
+          @logger.error "#{arg.inspect} is not a valid string."
+          return false
+        end
       end
+      return true
     end
 
-    def lookup_current_environment
-      @current_environment ||= Puppet.respond_to?(:lookup) ? Puppet.lookup(:current_environment) : Puppet::Node::Environment.current
+    def method_missing(method, *args, &block)
+      if method.to_s.start_with?('validate_')
+        @logger.debug "Skipping validation with #{method} as it's not implemented in Kafo"
+        return true
+      else
+        super
+      end
     end
   end
 end

data/lib/kafo/version.rb

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

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

@@ -6,7 +6,7 @@ module Puppet::Parser::Functions
     options<< false if Puppet::PUPPETVERSION.start_with?('2.6')
     data = args.map do |arg|
       found_value = lookupvar(arg, *options)
-      [arg, found_value.nil? ? arg : found_value]
+      [arg, found_value]
     end
     data = Hash[data]
 

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

@@ -9,7 +9,7 @@ module Puppet::Parser::Functions
       if value.is_a?(Hash)
         data[key] = function_convert([value])
       else
-        data[key] = value.nil? ? :undef : value
+        data[key] = value unless value.nil?
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kafo
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.8.0
 platform: ruby
 authors:
 - Marek Hulan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-20 00:00:00.000000000 Z
+date: 2016-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: puppet
   requirement: !ruby/object:Gem::Requirement
@@ -129,7 +129,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: 4.0.0
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -297,9 +297,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: If you write puppet modules for installing your software, you can use kafo
   to create powerful installer
 test_files: []
+has_rdoc: