kafo 3.0.0 → 5.0.1

data/lib/kafo/hook_context.rb

@@ -6,14 +6,7 @@ module Kafo
     attr_reader :kafo
 
     def self.execute(kafo, &hook)
-      # TODO can be removed in 0.6, is DEPRECATED since 0.5
-      # instance_exec can be later changed to instance eval when people stop using |kafo| in their hooks
-      # and rely only on hook context DSL
-      if hook.arity > 0
-        kafo.logger.warn "Hook '#{name}' is using block with arguments which is DEPRECATED, access to kafo instance is " +
-                        "provided by hook DSL, please remove |kafo| from your hook block"
-      end
-      new(kafo).instance_exec(kafo, &hook)
+      new(kafo).instance_eval(&hook)
     end
 
     def initialize(kafo)
@@ -29,7 +22,7 @@ module Kafo
     end
 
     # if you want to add new app_option be sure to do as soon as possible (usually boot hook)
-    # otherwise it may be to late (e.g. when displaying help)
+    # otherwise it may be too late (e.g. when displaying help)
     # examples:
     #   app_option '--log-level', 'LEVEL', 'Log level for log file output', :default => config.app[:log_level]:
     #   app_option ['-n', '--noop'], :flag, 'Run puppet in noop mode?', :default => false
@@ -37,6 +30,12 @@ module Kafo
       self.kafo.class.app_option(*args)
     end
 
+    # Returns whether the given app option exists. This is useful when there's a conditional option that is
+    # determined during boot; this helper can be used in later hooks to determine whether the option exists.
+    def app_option?(option)
+      self.kafo.config.app.key?(option.to_sym)
+    end
+
     # examples:
     #   app_value(:log_level)
     # note the dash to underscore convention
@@ -72,6 +71,14 @@ module Kafo
       !mod.nil? && mod.enabled?
     end
 
+    # Check if a module is present in the current configuration.
+    # examples:
+    #   module_present?('example')
+    def module_present?(module_name)
+      mod = self.kafo.module(module_name)
+      !mod.nil?
+    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).
@@ -93,14 +100,33 @@ module Kafo
       self.kafo.config.set_custom(key, value)
     end
 
+    # Load a custom fact from the custom fact storage as saved by store_custom_fact
+    def get_custom_fact(key)
+      self.kafo.config.get_custom_fact(key)
+    end
+
+    # Store a any custom fact. This will show up as kafo.scenario.custom.your_fact.
+    # It is possible to use structures such as arrays and hashes besides the
+    # obvious ones such as strings, integers, booleans.
+    #
+    # These facts can also be used in Hiera hierachy definitions.
+    def store_custom_fact(key, value)
+      self.kafo.config.set_custom_fact(key, value)
+    end
+
+    # Return the id of the current scenario
+    def scenario_id
+      self.kafo.config.scenario_id
+    end
+
     # Return the path to the current scenario
     def scenario_path
-      self.kafo.class.scenario_manager.select_scenario
+      self.kafo.config.config_file
     end
 
     # Return the actual data in the current scenario
     def scenario_data
-      YAML.load(File.read(scenario_path))
+      self.kafo.config.app
     end
   end
 end

data/lib/kafo/kafo_configure.rb

@@ -26,8 +26,7 @@ require 'kafo/progress_bar'
 require 'kafo/hooking'
 require 'kafo/exit_handler'
 require 'kafo/scenario_manager'
-require 'kafo/hiera_configurer'
-require 'kafo/puppet_configurer'
+require 'kafo/execution_environment'
 
 module Kafo
   class KafoConfigure < Clamp::Command
@@ -424,33 +423,29 @@ module Kafo
     def run_installation
       self.class.hooking.execute(:pre)
 
-      hiera = HieraConfigurer.new(config.app[:hiera_config], config.modules, config.app[:order])
-      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'       => true,
-        'environmentpath' => hiera.temp_dir,
+      execution_env = ExecutionEnvironment.new(config)
+      self.class.exit_handler.register_cleanup_path(execution_env.directory)
+
+      execution_env.store_answers
+      puppetconf = execution_env.configure_puppet(
+        'color'     => false,
+        'evaltrace' => !!@progress_bar,
+        'noop'      => !!noop?,
+        'profile'   => !!profile?,
+        'show_diff' => true,
       )
-      self.class.exit_handler.register_cleanup_path(puppetconf.config_path)
 
       exit_code   = 0
       exit_status = nil
       options     = [
           '--verbose',
           '--debug',
-          '--trace',
           '--detailed-exitcodes',
       ]
       begin
         command = PuppetCommand.new('include kafo_configure', options, puppetconf).command
         log_parser = PuppetLogParser.new
-        PTY.spawn(command) do |stdin, stdout, pid|
+        PTY.spawn(*PuppetCommand.format_command(command)) do |stdin, stdout, pid|
           begin
             stdin.each do |line|
               line = normalize_encoding(line)

data/lib/kafo/puppet_command.rb

@@ -6,8 +6,12 @@ module Kafo
       @command = command
       @puppet_config = puppet_config
 
-      @options = options.push("--modulepath #{modules_path.join(':')}")
-      @options.push("--config=#{puppet_config.config_path}") if puppet_config
+      if puppet_config
+        puppet_config['basemodulepath'] = modules_path.join(':')
+        @options = options.push("--config=#{puppet_config.config_path}")
+      else
+        @options = options.push("--modulepath #{modules_path.join(':')}")
+      end
       @logger  = KafoConfigure.logger
       @puppet_version_check = !configuration.app[:skip_puppet_version_check]
       @suffix = nil
@@ -31,12 +35,32 @@ module Kafo
     end
 
     def self.search_puppet_path(bin_name)
+      # Find the location of the puppet executable and use that to
+      # determine the path of all executables
       bin_path = (::ENV['PATH'].split(File::PATH_SEPARATOR) + ['/opt/puppetlabs/bin']).find do |path|
-        File.executable?(File.join(path, bin_name))
+        File.executable?(File.join(path, 'puppet')) && File.executable?(File.join(path, bin_name))
       end
       File.join([bin_path, bin_name].compact)
     end
 
+    def self.format_command(command)
+      if search_puppet_path('puppet').start_with?('/opt/puppetlabs')
+        [clean_env_vars, command, :unsetenv_others => true]
+      else
+        [::ENV, command, :unsetenv_others => false]
+      end
+    end
+
+    def self.clean_env_vars
+      # Cleaning ENV vars and keeping required vars only because,
+      # When using SCL it adds GEM_HOME and GEM_PATH ENV vars.
+      whitelisted_vars = %w[HOME USER LANG]
+
+      cleaned_env = ::ENV.select { |var| whitelisted_vars.include?(var) || var.start_with?('LC_') }
+      cleaned_env['PATH'] = '/sbin:/bin:/usr/sbin:/usr/bin:/opt/puppetlabs/bin'
+      cleaned_env
+    end
+
     private
 
     def manifest

data/lib/kafo/puppet_configurer.rb

@@ -2,16 +2,12 @@ require 'tempfile'
 
 module Kafo
   class PuppetConfigurer
-    attr_reader :logger
+    attr_reader :logger, :config_path
 
-    def initialize(settings = {})
+    def initialize(config_path, settings = {})
+      @config_path = config_path
       @settings = {'reports' => ''}.merge(settings)
       @logger = KafoConfigure.logger
-      @temp_file = Tempfile.new(['kafo_puppet', '.conf'])
-    end
-
-    def config_path
-      @temp_file.path
     end
 
     def [](key)
@@ -23,15 +19,13 @@ module Kafo
     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]}"
+      @logger.debug("Writing Puppet config file at #{config_path}")
+      File.open(config_path, 'w') do |file|
+        file.puts '[main]'
+        @settings.keys.sort.each do |key|
+          file.puts "#{key} = #{@settings[key]}"
+        end
       end
-    ensure
-      @temp_file.close
     end
   end
 end

data/lib/kafo/puppet_module.rb

@@ -160,7 +160,7 @@ module Kafo
     end
 
     def default_params_path
-      "#{dir_name}/manifests/#{get_params_name}.pp"
+      "#{dir_name}/manifests/#{class_to_name(get_params_name)}.pp"
     end
 
     def default_manifest_name
@@ -179,5 +179,9 @@ module Kafo
       name.gsub('/', '::')
     end
 
+    def class_to_name(name)
+      name.gsub('::', '/')
+    end
+
   end
 end

data/lib/kafo/scenario_manager.rb

@@ -19,7 +19,7 @@ module Kafo
           content = YAML.load_file(scn_file)
           if content.is_a?(Hash) && content.has_key?(:answer_file) && content.fetch(:enabled, true)
             # add scenario name for legacy configs
-            content[:name] = File.basename(scn_file, '.yaml') unless content.has_key?(:name)
+            content[:name] = Configuration.get_scenario_id(scn_file) unless content.has_key?(:name)
             scns[scn_file] = content
           end
         rescue Psych::SyntaxError => e
@@ -78,12 +78,19 @@ module Kafo
 
     def scenario_from_args(arg_name='--scenario|-S')
       # try scenario provided in the args via -S or --scenario
-      parsed = ARGV.join(" ").match(/(#{arg_name})(\s+|[=]?)(\S+)/)
-      if parsed
-        scenario_file = File.join(config_dir, "#{parsed[3]}.yaml")
-        return scenario_file if File.exist?(scenario_file)
-        fail_now("Scenario (#{scenario_file}) was not found, can not continue", :unset_scenario)
+      ARGV.each_with_index do |arg, index|
+        parsed = arg.match(/^(#{arg_name})($|=(?<scenario>\S+))/)
+        if parsed
+          scenario = parsed[:scenario] || ARGV[index + 1]
+          next unless scenario
+
+          scenario_file = File.join(config_dir, "#{scenario}.yaml")
+          return scenario_file if File.exist?(scenario_file)
+          fail_now("Scenario (#{scenario_file}) was not found, can not continue", :unset_scenario)
+        end
       end
+
+      nil
     end
 
     def select_scenario

data/lib/kafo/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kafo
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 5.0.1
 platform: ruby
 authors:
 - Marek Hulan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-12 00:00:00.000000000 Z
+date: 2020-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,7 +59,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -73,19 +73,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ci_reporter_minitest
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: kafo_wizards
   requirement: !ruby/object:Gem::Requirement
@@ -149,6 +149,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -156,6 +159,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.6.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.3.1
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
@@ -239,7 +245,9 @@ files:
 - lib/kafo/data_types/undef.rb
 - lib/kafo/data_types/variant.rb
 - lib/kafo/exceptions.rb
+- lib/kafo/execution_environment.rb
 - lib/kafo/exit_handler.rb
+- lib/kafo/fact_writer.rb
 - lib/kafo/help_builder.rb
 - lib/kafo/help_builders/advanced.rb
 - lib/kafo/help_builders/base.rb
@@ -256,7 +264,6 @@ files:
 - lib/kafo/param_group.rb
 - lib/kafo/parser_cache_reader.rb
 - lib/kafo/parser_cache_writer.rb
-- lib/kafo/password_manager.rb
 - lib/kafo/progress_bar.rb
 - lib/kafo/progress_bars/black_white.rb
 - lib/kafo/progress_bars/colored.rb
@@ -283,6 +290,7 @@ 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
@@ -308,8 +316,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A gem for making installations based on puppet user friendly

data/lib/kafo/password_manager.rb

@@ -1,47 +0,0 @@
-# encoding: UTF-8
-require 'securerandom'
-require 'digest/sha2'
-require 'openssl'
-require 'base64'
-
-module Kafo
-  class PasswordManager
-    # generate a random password of lenght n
-    #
-    # on ruby >= 1.9 we use builtin method urlsafe_base64, on olders we use our own
-    # implementation (inspired by urlsafe_base64)
-    #
-    # the result may contain A-Z, a-z, 0-9, “-” and “_”. “=”
-    def password(n = 32)
-      return SecureRandom.urlsafe_base64(n) if SecureRandom.respond_to?(:urlsafe_base64)
-
-      s = [SecureRandom.random_bytes(n)].pack("m*")
-      s.delete!("\n")
-      s.tr!("+/", "-_")
-      s.delete!("=")
-      s
-    end
-
-    def aes_encrypt(text, passphrase)
-      cipher = OpenSSL::Cipher::Cipher.new("aes-256-cbc")
-      cipher.encrypt
-      cipher.key = Digest::SHA2.hexdigest(passphrase)
-      cipher.iv  = Digest::SHA2.hexdigest(passphrase + passphrase)
-
-      encrypted = cipher.update(text)
-      encrypted << cipher.final
-      Base64.encode64(encrypted)
-    end
-
-    def aes_decrypt(text, passphrase)
-      cipher = OpenSSL::Cipher::Cipher.new("aes-256-cbc")
-      cipher.decrypt
-      cipher.key = Digest::SHA2.hexdigest(passphrase)
-      cipher.iv  = Digest::SHA2.hexdigest(passphrase + passphrase)
-
-      decrypted = cipher.update(Base64.decode64(text))
-      decrypted << cipher.final
-      decrypted
-    end
-  end
-end