kafo 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 442ba70002fba70bca91ba81955e85c7a6205c50
-  data.tar.gz: 35cb1e2184a1381bbea5af20a12186df94c86c4e
+  metadata.gz: bb73eb4c71ae5aad0d0c3dc4b891a0ef33af1c8a
+  data.tar.gz: a63a799798654d67bc245630d0f95cc52b379b64
 SHA512:
-  metadata.gz: dd7e866ea43f64da01f75085328350f011ee88c3062626a0b0116007c439c43c7e151203aa967752278491b90df95f533db4172d06147db5af82baa879abb8d2
-  data.tar.gz: e6f21ddca839a279544d842cf6beb6bde61de0b3584c41ba2ec24c127b2c780b0d55ad567ab0b944367e63de0b29e6858ae65f51f422e1ab968b1697160e9f23
+  metadata.gz: 819bf86e16679ab8fbc15015bf8562cd415ad9f854ceb031503facf9f6dcd0ea1e978071c69de011e7e9b68bb9a8d20a56bc92ac73ed4e96407e2669c253cef1
+  data.tar.gz: 9e82f85dabf51876b18f8306de913ac93342c3b0ce4ad257dbde7f65ada6de27fcaf529abe870c843f66c1fdf28900181bbb3d2e338482d9d07c7c46a3718386

data/README.md

@@ -1125,6 +1125,7 @@ Other exit codes that can be returned:
 * '27' means that kafo found found scenario configuration error that prevents installation from continuing
 * '28' means that a value is missing for a parameter given on the command line
 * '29' means that effective user that ran the installer does not have permission to update the answer file
+* '30' means that the version of Puppet is incompatible with a module, according to its [metadata.json](https://docs.puppet.com/puppet/latest/modules_metadata.html)
 * '130' user interrupt (^C)
 
 ## Running Puppet Profiling

data/lib/kafo/base_context.rb

@@ -0,0 +1,35 @@
+module Kafo
+  class BaseContext
+    def facts
+      self.class.facts
+    end
+
+    private
+
+    def self.symbolize(data)
+      case data
+      when Hash
+        Hash[data.map { |key, value| [key.to_sym, symbolize(value)] }]
+      when Array
+        data.map { |v| symbolize(v) }
+      else
+        data
+      end
+    end
+
+    def self.clear_caches
+      @facts = nil
+      @facter_path = nil
+    end
+
+    def self.facts
+      @facts ||= begin
+        symbolize(JSON.load(`#{facter_path} --json`) || {})
+      end
+    end
+
+    def self.facter_path
+      @facter_path ||= PuppetCommand.search_puppet_path('facter')
+    end
+  end
+end

data/lib/kafo/configuration.rb

@@ -29,7 +29,8 @@ module Kafo
         :hook_dirs            => [],
         :custom               => {},
         :low_priority_modules => [],
-        :verbose_log_level    => 'info'
+        :verbose_log_level    => 'info',
+        :skip_puppet_version_check => false
     }
 
     def initialize(file, persist = true)
@@ -166,11 +167,19 @@ EOS
         @logger.debug result
         unless $?.exitstatus == 0
           log = app[:log_dir] + '/' + app[:log_name]
-          puts "Could not get default values, check log file at #{log} for more information"
-          @logger.error command
-          @logger.error result
-          @logger.error 'Could not get default values, cannot continue'
-          KafoConfigure.exit(:defaults_error)
+          if (version_mismatch = /kafo_configure::puppet_version_failure: (.+?\))/.match(result))
+            puts version_mismatch[1]
+            puts "Cannot continue due to incompatible version of Puppet. Use --skip-puppet-version-check to disable this check."
+            @logger.error version_mismatch[1]
+            @logger.error 'Incompatible version of Puppet used, cannot continue'
+            KafoConfigure.exit(:puppet_version_error)
+          else
+            puts "Could not get default values, check log file at #{log} for more information"
+            @logger.error command
+            @logger.error result
+            @logger.error 'Could not get default values, cannot continue'
+            KafoConfigure.exit(:defaults_error)
+          end
         end
         @logger.info "... finished"
 

data/lib/kafo/exit_handler.rb

@@ -19,7 +19,8 @@ module Kafo
           :unset_scenario => 26,
           :scenario_error => 27,
           :missing_argument => 28,
-          :insufficient_permissions => 29
+          :insufficient_permissions => 29,
+          :puppet_version_error => 30
       }
     end
 
@@ -33,7 +34,7 @@ module Kafo
     end
 
     def translate_exit_code(code)
-      return code if code.is_a?(Fixnum)
+      return code if code.is_a?(Integer)
       if error_codes.has_key?(code)
         return error_codes[code]
       else

data/lib/kafo/hook_context.rb

@@ -1,7 +1,8 @@
 require 'kafo/data_type'
+require 'kafo/base_context'
 
 module Kafo
-  class HookContext
+  class HookContext < BaseContext
     attr_reader :kafo
 
     def self.execute(kafo, &hook)
@@ -77,7 +78,7 @@ module Kafo
     #   exit(0)
     #   exit(:manifest_error)
     def exit(code)
-      self.kafo.exit(code)
+      self.kafo.class.exit(code)
     end
 
     # You can load a custom config value that has been saved using store_custom_config
@@ -90,5 +91,15 @@ module Kafo
     def store_custom_config(key, value)
       self.kafo.config.set_custom(key, value)
     end
+
+    # Return the path to the current scenario
+    def scenario_path
+      self.kafo.class.scenario_manager.select_scenario
+    end
+
+    # Return the actual data in the current scenario
+    def scenario_data
+      YAML.load(File.read(scenario_path))
+    end
   end
 end

data/lib/kafo/hooking.rb

@@ -24,7 +24,7 @@ module Kafo
     end
 
     def load
-      base_dirs = [File.join([KafoConfigure.root_dir, 'hooks']), KafoConfigure.config.app[:hook_dirs]]
+      base_dirs = [File.join([KafoConfigure.root_dir, 'hooks']), KafoConfigure.config.app[:hook_dirs]].flatten
       base_dirs.each do |base_dir|
         TYPES.each do |hook_type|
           dir = File.join(base_dir, hook_type.to_s)

data/lib/kafo/kafo_configure.rb

@@ -308,6 +308,7 @@ module Kafo
       self.class.app_option ['-p', '--profile'], :flag, 'Run puppet in profile mode?',
                             :default => false
       self.class.app_option ['-s', '--skip-checks-i-know-better'], :flag, 'Skip all system checks', :default => false
+      self.class.app_option ['--skip-puppet-version-check'], :flag, 'Skip check for compatible Puppet versions', :default => false
       self.class.app_option ['-v', '--verbose'], :flag, 'Display log on STDOUT instead of progressbar'
       self.class.app_option ['-l', '--verbose-log-level'], 'LEVEL', 'Log level for verbose mode output',
                             :default => 'info'

data/lib/kafo/migration_context.rb

@@ -1,5 +1,7 @@
+require 'kafo/base_context'
+
 module Kafo
-  class MigrationContext
+  class MigrationContext < BaseContext
 
     attr_accessor :scenario, :answers
 
@@ -17,21 +19,5 @@ 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/puppet_command.rb

@@ -6,22 +6,16 @@ module Kafo
       @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 = options.push("--modulepath #{modules_path.join(':')}")
       @options.push("--config=#{puppet_config.config_path}") if puppet_config
       @logger  = KafoConfigure.logger
-    end
-
-    def add_progress
-      %{$kafo_add_progress="#{!KafoConfigure.verbose}"}
+      @puppet_version_check = !configuration.app[:skip_puppet_version_check]
     end
 
     def command
       @puppet_config.write_config if @puppet_config
       result = [
-          "echo '$kafo_config_file=\"#{@configuration.config_file}\" #{add_progress} #{@command}'",
+          manifest,
           '|',
           "RUBYLIB=#{[@configuration.kafo_modules_dir, ::ENV['RUBYLIB']].join(File::PATH_SEPARATOR)}",
           "#{puppet_path} apply #{@options.join(' ')} #{@suffix}",
@@ -44,11 +38,65 @@ module Kafo
 
     private
 
+    def manifest
+      %{echo '
+        $kafo_config_file="#{@configuration.config_file}"
+        #{add_progress}
+        #{generate_version_checks.join("\n") if @puppet_version_check}
+        #{@command}
+      '}
+    end
+
+    def add_progress
+      %{$kafo_add_progress="#{!KafoConfigure.verbose}"}
+    end
+
+    def generate_version_checks
+      checks = []
+      modules_path.each do |modulepath|
+        Dir[File.join(modulepath, '*', 'metadata.json')].sort.each do |metadata_json|
+          metadata = JSON.load(File.read(metadata_json))
+          next unless metadata['requirements'] && metadata['requirements'].is_a?(Array)
+
+          metadata['requirements'].select { |req| req['name'] == 'puppet' && req['version_requirement'] }.each do |req|
+            checks << versioncmp(metadata['name'], req['version_requirement'])
+          end
+        end
+      end
+      checks
+    end
+
+    def versioncmp(id, version_req)
+      # Parse the common ">= x.y < x.y" version requirement to support pre-Puppet 4.5
+      # checks with versioncmp. Newer versions use SemVerRange for full support.
+      if (version_match = /\A>=\s*([0-9\.]+)(?:\s+<\s*([0-9\.]+))?/.match(version_req))
+        minimum = %{minimum => "#{version_match[1]}",}
+        maximum = version_match[2] ? %{maximum => "#{version_match[2]}",} : ''
+      else
+        minimum = ''
+        maximum = ''
+      end
+
+      # SemVerRange is isolated inside a defined type to prevent parse errors on old versions
+      <<-EOS
+        if versioncmp($::puppetversion, "4.5.0") >= 0 {
+          kafo_configure::puppet_version_semver { "#{id}":
+            requirement => "#{version_req}",
+          }
+        } else {
+          kafo_configure::puppet_version_versioncmp { "#{id}":
+            #{minimum}
+            #{maximum}
+          }
+        }
+      EOS
+    end
+
     def modules_path
       [
           @configuration.module_dirs,
           @configuration.kafo_modules_dir,
-      ].flatten.join(':')
+      ].flatten
     end
 
     def puppet_path

data/lib/kafo/scenario_manager.rb

@@ -217,7 +217,7 @@ module Kafo
     private
 
     def fail_now(message, exit_code)
-      say "ERROR: #{message}"
+      $stderr.puts "ERROR: #{message}"
       KafoConfigure.logger.error message
       KafoConfigure.exit(exit_code)
     end

data/lib/kafo/version.rb

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

data/modules/kafo_configure/lib/puppet/parser/functions/{to_yaml.rb → foreman_to_yaml.rb}

@@ -2,7 +2,7 @@
 # document marker.
 #
 module Puppet::Parser::Functions
-  newfunction(:to_yaml, :type => :rvalue) do |args|
+  newfunction(:foreman_to_yaml, :type => :rvalue) do |args|
     dump = if args.all? { |a| a.is_a?(Hash) }
              args.inject({}) { |m,a| m.merge(a) }
            else

data/modules/kafo_configure/manifests/dump_values.pp

@@ -12,9 +12,9 @@ class kafo_configure::dump_values($variables, $lookups) {
   # default/undef instead of an empty hash.
   if versioncmp($::puppetversion, '4.5') >= 0 {
     $dumped_lookups = dump_lookups($lookups)
-    $dumped = to_yaml($dumped_vars, $dumped_lookups)
+    $dumped = foreman_to_yaml($dumped_vars, $dumped_lookups)
   } else {
-    $dumped = to_yaml($dumped_vars)
+    $dumped = foreman_to_yaml($dumped_vars)
   }
 
   notice("\n${dumped}")

data/modules/kafo_configure/manifests/puppet_version_semver.pp

@@ -0,0 +1,5 @@
+define kafo_configure::puppet_version_semver($requirement) {
+  unless SemVer($facts['puppetversion']) =~ SemVerRange($requirement) {
+    fail("kafo_configure::puppet_version_failure: Puppet ${facts['puppetversion']} does not meet requirements for ${title} ($requirement)")
+  }
+}

data/modules/kafo_configure/manifests/puppet_version_versioncmp.pp

@@ -0,0 +1,9 @@
+define kafo_configure::puppet_version_versioncmp($minimum = undef, $maximum = undef) {
+  if $minimum and versioncmp($minimum, $::puppetversion) > 0 {
+    fail("kafo_configure::puppet_version_failure: Puppet ${puppetversion} does not meet minimum requirement for ${title} (version $minimum)")
+  }
+
+  if $maximum and versioncmp($maximum, $::puppetversion) < 0 {
+    fail("kafo_configure::puppet_version_failure: Puppet ${puppetversion} does not meet maximum requirement for ${title} (version $maximum)")
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kafo
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Marek Hulan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-28 00:00:00.000000000 Z
+date: 2017-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -205,6 +205,7 @@ files:
 - doc/kafo_run.png
 - doc/kafo_run.uml
 - lib/kafo.rb
+- lib/kafo/base_context.rb
 - lib/kafo/color_scheme.rb
 - lib/kafo/condition.rb
 - lib/kafo/configuration.rb
@@ -268,10 +269,12 @@ files:
 - modules/kafo_configure/lib/puppet/parser/functions/add_progress.rb
 - modules/kafo_configure/lib/puppet/parser/functions/decrypt.rb
 - modules/kafo_configure/lib/puppet/parser/functions/dump_values.rb
+- modules/kafo_configure/lib/puppet/parser/functions/foreman_to_yaml.rb
 - modules/kafo_configure/lib/puppet/parser/functions/load_kafo_password.rb
-- modules/kafo_configure/lib/puppet/parser/functions/to_yaml.rb
 - modules/kafo_configure/manifests/dump_values.pp
 - modules/kafo_configure/manifests/init.pp
+- modules/kafo_configure/manifests/puppet_version_semver.pp
+- modules/kafo_configure/manifests/puppet_version_versioncmp.pp
 homepage: https://github.com/theforeman/kafo
 licenses:
 - GPLv3+
@@ -292,7 +295,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: If you write puppet modules for installing your software, you can use kafo