kafo 2.1.0 → 3.0.0

data/lib/kafo/hook_context.rb

@@ -34,7 +34,7 @@ module Kafo
     #   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
     def app_option(*args)
-      self.kafo.class.app_option *args
+      self.kafo.class.app_option(*args)
     end
 
     # examples:
@@ -68,7 +68,8 @@ module Kafo
     # examples:
     #   module_enabled?('example')
     def module_enabled?(module_name)
-      self.kafo.module(module_name).enabled?
+      mod = self.kafo.module(module_name)
+      !mod.nil? && mod.enabled?
     end
 
     # You can trigger installer exit by this method. You must specify exit code as a first

data/lib/kafo/kafo_configure.rb

@@ -161,7 +161,7 @@ module Kafo
 
     def self.run
       return super
-    rescue SystemExit => e
+    rescue SystemExit
       self.exit_handler.exit(self.exit_code) # fail in initialize
     end
 
@@ -429,12 +429,13 @@ module Kafo
       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
+        'color'           => false,
+        'evaltrace'       => !!@progress_bar,
+        'hiera_config'    => hiera.config_path,
+        'noop'            => !!noop?,
+        'profile'         => !!profile?,
+        'show_diff'       => true,
+        'environmentpath' => hiera.temp_dir,
       )
       self.class.exit_handler.register_cleanup_path(puppetconf.config_path)
 
@@ -505,7 +506,7 @@ module Kafo
     end
 
     def self.preset_color_scheme
-      match = ARGV.join(' ').match /--color-of-background[ =](\w+)/
+      match = ARGV.join(' ').match(/--color-of-background[ =](\w+)/)
       background = match && match[1]
       ColorScheme.new(:background => background, :colors => use_colors?).setup
     end

data/lib/kafo/logger.rb

@@ -47,7 +47,7 @@ module Kafo
     def self.setup
       begin
         FileUtils.mkdir_p(KafoConfigure.config.app[:log_dir], :mode => 0750)
-      rescue Errno::EACCES => e
+      rescue Errno::EACCES
         puts "No permissions to create log dir #{KafoConfigure.config.app[:log_dir]}"
       end
 
@@ -61,7 +61,7 @@ module Kafo
         )
         # set owner and group (it's ignored if attribute is nil)
         FileUtils.chown KafoConfigure.config.app[:log_owner], KafoConfigure.config.app[:log_group], filename
-      rescue ArgumentError => e
+      rescue ArgumentError
         puts "File #{filename} not writeable, won't log anything to file!"
       end
 

data/lib/kafo/param.rb

@@ -1,7 +1,6 @@
 # encoding: UTF-8
 require 'kafo/condition'
 require 'kafo/data_type'
-require 'kafo/validator'
 
 module Kafo
   class Param
@@ -15,6 +14,10 @@ module Kafo
       @name   = name
       @module = builder
       @type   = DataType.new_from_string(type)
+      @default = nil
+      @value_set = false
+      @groups = nil
+      @validation_errors = []
     end
 
     def identifier
@@ -104,22 +107,7 @@ module Kafo
     end
 
     def valid?
-      # 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 = 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
-        {:name => v.name, :arguments => interpret_validation_args(args)}
-      end
-
-      # run old style validation functions
-      @validator = Validator.new
-      validations.each { |v| @validator.send(v[:name], v[:arguments]) }
-      @validation_errors = @validator.errors.dup
+      @validation_errors = []
 
       # run data type based validations, append errors
       @type.valid?(value, @validation_errors)
@@ -128,7 +116,7 @@ module Kafo
     end
 
     def validation_errors
-      @validation_errors || []
+      @validation_errors
     end
 
     def multivalued?
@@ -189,5 +177,3 @@ module Kafo
     end
   end
 end
-
-require 'kafo/params/password'

data/lib/kafo/param_builder.rb

@@ -52,14 +52,7 @@ module Kafo
     end
 
     def build(name, data)
-      data_type = data[:types][name] || 'Data'
-      if data_type == 'password'
-        type = Params::Password
-        data_type = 'String'
-      else
-        type = Param
-      end
-      param                  = type.new(@module, name, data_type)
+      param                  = Param.new(@module, name, data[:types][name] || 'Data')
       param.manifest_default = data[:values][name]
       param.doc              = data[:docs][name]
       param.groups           = data[:groups][name]

data/lib/kafo/progress_bar.rb

@@ -49,7 +49,7 @@ module Kafo
         end
       end
 
-      if (line_end = EVALTRACE_END.match(line)) && @lines < @total
+      if (line_end = EVALTRACE_END.match(line)) && @total != :unknown && @lines < @total
         if (known_resource = find_known_resource(line_end[1]))
           @resources.delete(known_resource)  # ensure it's only counted once
           @lines += 1

data/lib/kafo/puppet_command.rb

@@ -10,6 +10,7 @@ module Kafo
       @options.push("--config=#{puppet_config.config_path}") if puppet_config
       @logger  = KafoConfigure.logger
       @puppet_version_check = !configuration.app[:skip_puppet_version_check]
+      @suffix = nil
     end
 
     def command
@@ -48,7 +49,7 @@ module Kafo
     end
 
     def add_progress
-      %{$kafo_add_progress="#{!KafoConfigure.verbose}"}
+      %{$kafo_add_progress=#{!KafoConfigure.verbose}}
     end
 
     def generate_version_checks
@@ -67,27 +68,9 @@ module Kafo
     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}
-          }
+        kafo_configure::puppet_version_semver { "#{id}":
+          requirement => "#{version_req}",
         }
       EOS
     end

data/lib/kafo/puppet_module.rb

@@ -3,7 +3,6 @@ require 'kafo/param'
 require 'kafo/param_builder'
 require 'kafo/parser_cache_reader'
 require 'kafo_parsers/parsers'
-require 'kafo/validator'
 
 module Kafo
   class PuppetModule
@@ -43,11 +42,12 @@ module Kafo
       @manifest_path     = File.join(module_dir, module_manifest_path)
       @parser            = parser
       @parser_cache      = @configuration.parser_cache
-      @validations       = []
       @logger            = KafoConfigure.logger
       @groups            = {}
       @params_path       = get_params_path
       @params_class_name = get_params_class_name
+      @raw_data          = nil
+      @enabled           = nil
     end
 
     def enabled?
@@ -73,7 +73,6 @@ module Kafo
       end
 
       builder      = builder_klass.new(self, @raw_data)
-      @validations = @raw_data[:validations]
 
       builder.validate
       @params = builder.build_params
@@ -93,16 +92,6 @@ module Kafo
       @groups.select { |g| g.formatted_name != PRIMARY_GROUP_NAME }
     end
 
-    def validations(param = nil)
-      if param.nil?
-        @validations
-      else
-        @validations.select do |validation|
-          validation.arguments.map(&:to_s).include?("$#{param.name}")
-        end
-      end
-    end
-
     def params_hash
       Hash[params.map { |param| [param.name, param.value] }]
     end

data/lib/kafo/scenario_manager.rb

@@ -9,7 +9,7 @@ module Kafo
     def initialize(config, last_scenario_link_name='last_scenario.yaml')
       @config_dir = File.file?(config) ? File.dirname(config) : config
       @last_scenario_link = File.join(config_dir, last_scenario_link_name)
-      @previous_scenario = Pathname.new(last_scenario_link).realpath.to_s if File.exists?(last_scenario_link)
+      @previous_scenario = File.exist?(last_scenario_link) ? Pathname.new(last_scenario_link).realpath.to_s : nil
     end
 
     def available_scenarios
@@ -78,10 +78,10 @@ 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+)/
+      parsed = ARGV.join(" ").match(/(#{arg_name})(\s+|[=]?)(\S+)/)
       if parsed
         scenario_file = File.join(config_dir, "#{parsed[3]}.yaml")
-        return scenario_file if File.exists?(scenario_file)
+        return scenario_file if File.exist?(scenario_file)
         fail_now("Scenario (#{scenario_file}) was not found, can not continue", :unset_scenario)
       end
     end
@@ -197,9 +197,9 @@ module Kafo
 
     def link_last_scenario(config_file)
       link_path = last_scenario_link
-      if last_scenario_link
-        File.delete(last_scenario_link) if File.symlink?(last_scenario_link)
-        File.symlink(File.basename(config_file), last_scenario_link)
+      if link_path
+        File.delete(link_path) if File.symlink?(link_path)
+        File.symlink(File.basename(config_file), link_path)
       end
     end
 

data/lib/kafo/version.rb

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

data/modules/kafo_configure/Rakefile

@@ -0,0 +1 @@
+require 'puppetlabs_spec_helper/rake_tasks'

data/modules/kafo_configure/lib/puppet/functions/{dump_lookups.rb → kafo_configure/dump_lookups.rb}

@@ -3,9 +3,10 @@
 # Wraps the lookup() function for data lookups of class parameters without
 # inline defaults.
 #
-Puppet::Functions.create_function(:dump_lookups) do
+Puppet::Functions.create_function(:'kafo_configure::dump_lookups') do
   dispatch :dump_lookups do
     param 'Array[String]', :parameters
+    return_type 'Hash[String, Any]'
   end
 
   def dump_lookups(parameters)

data/modules/kafo_configure/lib/puppet/functions/kafo_configure/dump_variables.rb

@@ -0,0 +1,13 @@
+# Find default values for variables specified as args
+#
+Puppet::Functions.create_function(:'kafo_configure::dump_variables') do
+  dispatch :dump_variables do
+    param 'Array[String]', :variables
+    return_type 'Hash[String, Any]'
+  end
+
+  def dump_variables(variables)
+    scope = closure_scope
+    Hash[variables.map { |var| [var, scope[var]] }]
+  end
+end

data/modules/kafo_configure/lib/puppet/functions/kafo_configure/to_yaml.rb

@@ -0,0 +1,15 @@
+# Returns the given argument as a string containing YAML, with an end of
+# document marker.
+#
+Puppet::Functions.create_function(:'kafo_configure::to_yaml') do
+  dispatch :to_yaml do
+    param 'Hash', :variables
+    param 'Hash', :lookups
+    return_type 'String'
+  end
+
+  def to_yaml(variables, lookups)
+    dump = variables.merge(lookups)
+    YAML.dump(dump) + "\n...\n"
+  end
+end

data/modules/kafo_configure/manifests/dump_values.pp

@@ -4,18 +4,17 @@
 #  - lookups: a list of variables to find through lookup()
 #
 # The result will be merged together into one hash.
-class kafo_configure::dump_values($variables, $lookups) {
-  $dumped_vars = dump_values($variables)
-
-  # Data lookups are only supported on Puppet 4 or higher, however depend on
-  # 4.5.0 which fixes PUP-6230 where missing data correctly returns the
-  # default/undef instead of an empty hash.
-  if versioncmp($::puppetversion, '4.5') >= 0 {
-    $dumped_lookups = dump_lookups($lookups)
-    $dumped = foreman_to_yaml($dumped_vars, $dumped_lookups)
-  } else {
-    $dumped = foreman_to_yaml($dumped_vars)
-  }
+#
+#  @param variables a list of variables from params classes that have
+#                   already been included
+#  @param lookups a list of variables to find through lookup()
+class kafo_configure::dump_values(
+  Array[String] $variables = [],
+  Array[String] $lookups = [],
+) {
+  $dumped_vars = kafo_configure::dump_variables($variables)
+  $dumped_lookups = kafo_configure::dump_lookups($lookups)
+  $dumped = kafo_configure::to_yaml($dumped_vars, $dumped_lookups)
 
   notice("\n${dumped}")
 }

data/modules/kafo_configure/manifests/init.pp

@@ -4,12 +4,14 @@
 #   $modulepath/config/answers.yaml
 #   /etc/kafo-configure/answers.yaml
 #
-class kafo_configure {
-
-  if $kafo_add_progress == 'true' {
+# @param add_progress
+#   Whether to add a progress bar. Only works on Puppet < 6.
+class kafo_configure(
+  Boolean $add_progress = $::kafo_add_progress,
+) {
+  if $add_progress and SemVer($facts['puppetversion']) =~ SemVerRange('< 6.0.0') {
     add_progress()
   }
 
-  $password = load_kafo_password()
-  hiera_include('classes')
+  lookup('classes', {merge => unique}).include
 }

data/modules/kafo_configure/manifests/puppet_version_semver.pp

@@ -1,5 +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)")
+    fail("kafo_configure::puppet_version_failure: Puppet ${facts['puppetversion']} does not meet requirements for ${title} (${requirement})")
   }
 }

data/modules/kafo_configure/metadata.json

@@ -0,0 +1,15 @@
+{
+  "name": "theforeman-kafo_configure",
+  "version": "1.0.0",
+  "author": "theforeman",
+  "license": "GPL-3.0+",
+  "summary": "An internal module to kafo",
+  "source": "https://github.com/theforeman/kafo",
+  "dependencies": [],
+  "requirements": [
+    {
+      "name": "puppet",
+      "version_requirement": ">= 4.5.0 < 7.0.0"
+    }
+  ]
+}

data/modules/kafo_configure/spec/classes/dump_values_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+describe 'kafo_configure::dump_values' do
+  context 'without parameters' do
+    let(:params) do
+      {
+        variables: [],
+        lookups: [],
+      }
+    end
+    it { is_expected.to compile.with_all_deps }
+  end
+
+  context 'with values' do
+    let(:hiera_config) { 'spec/fixtures/hiera/hiera.yaml' }
+    let(:params) do
+      {
+        variables: ['dummy:first', 'dummy::second'],
+        lookups: ['my_module::param'],
+      }
+    end
+    it { is_expected.to compile.with_all_deps }
+  end
+end

data/modules/kafo_configure/spec/classes/init_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe 'kafo_configure' do
+  let(:hiera_config) { 'spec/fixtures/hiera/hiera.yaml' }
+  let(:facts) { { puppetversion: Puppet.version } }
+
+  context 'without parameters' do
+    let(:params) { {add_progress: false} }
+    it { is_expected.to compile.with_all_deps }
+    it { is_expected.to contain_class('dummy') }
+  end
+
+  context 'with progress' do
+    let(:params) { {add_progress: true} }
+    it { is_expected.to compile.with_all_deps }
+  end
+end