kafo 1.0.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 510b992ff3fbaf2166c54dbc84fe06c95ffa28e4
-  data.tar.gz: 39928764fca55a2390c670cb08d68bb2c9f4ce38
+  metadata.gz: 5e997beadceb5307a50757065a9b0feb0fcd7d35
+  data.tar.gz: a2460963b6539e91acecf021935e94bb329dcbab
 SHA512:
-  metadata.gz: b102ff1bfe985eee3436fbfa94323ed775828e63b8550118ea9568d7c1c51ee17006831d6af12e1cb94befc6c65d6f50eafab3c0fa54b7874d5a3f4b6f1a2da3
-  data.tar.gz: aaf516905b8330ecffe67c40f33e9122ae3e928ed37da976891c8145b3e030b1291e330f5caaf1f073057a711141ea7bede3bbd1ca4af585f0c6e5046022c94b
+  metadata.gz: bed514715b9f2913a85cdbeee6713f1f1d74d38a311014ebf38b2a3d42c9fc0bc0797656ad063e6346b1e62c4500d14e29ccb5bd3a32082ae63d5218627a2851
+  data.tar.gz: da303a516a27fb37c9a339198ff0e62a1bc8b3ecfc1f4068d49ef7e93ba6a3c9a4907ad52da45d931b8bf1cda98195eba8fa36c7214fb2abeb119f47d1bb34f0

data/config/kafo.yaml.example

@@ -36,9 +36,6 @@
 # :log_name: configure.log
 # :log_level: :info
 
-# Change if you want to debug default answers for you modules, this directory holds default answers
-# :default_values_dir: /tmp
-
 ## Advanced configuration - if not set it's ignored
 # :log_owner: root
 # :log_group: root

data/doc/kafo_run.uml

@@ -0,0 +1,109 @@
+/'Use PlantUML (http://plantuml.com/starting) to render this file to other formats like PNG, SVG, EPS'/
+@startuml
+  |initialize|
+  start
+  :scenario manager setup;
+  note right
+    * guess scenario dir
+    * detect last used scenario
+  end note
+  #LightGrey:--list-scenarios>
+  :get config file;
+  note right
+    One of the following in this order
+    # **CONFIG_FILE**
+    # **--scenario** or **-S** in installer arguments
+    # previous scenarios
+    # any available scenario if there is *just one*
+    # select scenario if installer is in interactive mode
+  end note
+
+  if (no config file?)
+    stop
+  endif
+
+  :load configuration;
+  note right
+    * load configuration
+    * merge defaults
+    * save configuration
+    * load answer file
+    * setup kafo dirs
+    * setup hooks
+    * setup key-value store
+  end note
+
+  #greenyellow:**pre_migrations**|
+  note right: here the 6.1 configs get turned into 6.2 scenarios
+
+  :load configuration;
+  note right: if migrations requested reload
+
+  :execute scenario migrations;
+
+  #LightGrey:--migrations-only>
+  :load configuration;
+  note right: if any migration was applied
+
+  if (previous scenario != current scenario) then (scenario\nchanged)
+    #LightGrey:--compare-scenarios>
+    :load previous scenario;
+    :run scenario migrations
+     on previous scenario;
+    :migrate data from previous scenario
+    configuration to the current one;
+    :load configuration;
+  endif
+
+  :clamp init;
+
+  #Greenyellow:**boot**|
+
+  :define installer options;
+  :pre-parse ARGV to finish installer configuration;
+
+  #Greenyellow:**init**|
+
+  :load defaults from puppet;
+  #Greenyellow:**pre_values**|
+  :load values from answer file;
+  :load values from previous answer file;
+  note right: if previous scenraio != current scenario
+
+  :update help with default values;
+  |execute|
+  :parse values from CLI arguments;
+
+  :init progress bar;
+
+  #LightBlue:**run system checks**>
+  #Greenyellow:**pre_validations**|
+
+  if (interactive?) then (yes)
+    :run wizard;
+  else
+    :run validations;
+  endif
+
+  #Greenyellow:**pre_commit**|
+
+  :save answers;
+  note right: unless noop or dont-save-answers
+  :save current scenario as the last used one;
+  note right: unless noop or dont-save-answers
+
+  #Greenyellow:**pre**|
+
+  :setup HieraConfigurer and save configs;
+
+  #Gold:run puppet;
+  repeat
+    :parse puppet output;
+    :update installer logs;
+    :update progress bar;
+  repeat while (puppet runs?)
+
+  #Greenyellow:**post**|
+
+  stop
+@enduml

data/lib/kafo/configuration.rb

@@ -24,7 +24,6 @@ module Kafo
         :answer_file          => './config/answers.yaml',
         :installer_dir        => '.',
         :module_dirs          => ['./modules'],
-        :default_values_dir   => '/tmp',
         :colors               => Kafo::ColorScheme.colors_possible?,
         :color_of_background  => :dark,
         :hook_dirs            => [],
@@ -52,9 +51,14 @@ module Kafo
 
     def save_configuration(configuration)
       return true unless @persist
-      FileUtils.touch @config_file
-      File.chmod 0600, @config_file
-      File.open(@config_file, 'w') { |file| file.write(format(YAML.dump(configuration))) }
+      begin
+        FileUtils.touch @config_file
+        File.chmod 0600, @config_file
+        File.open(@config_file, 'w') { |file| file.write(format(YAML.dump(configuration))) }
+      rescue Errno::EACCES
+        puts "Insufficient permissions to write to #{@config_file}, can not continue"
+        KafoConfigure.exit(:insufficient_permissions)
+      end
     end
 
     def configure_application
@@ -133,7 +137,7 @@ module Kafo
 
     def migrate_configuration(from_config, options={})
       keys_to_skip = options.fetch(:skip, [])
-      keys = [:log_dir, :log_name, :log_level, :no_prefix, :default_values_dir,
+      keys = [:log_dir, :log_name, :log_level, :no_prefix,
         :colors, :color_of_background, :custom, :password, :verbose_log_level]
       keys += options.fetch(:with, [])
       keys.each do |key|
@@ -145,15 +149,19 @@ module Kafo
 
     def params_default_values
       @params_default_values ||= begin
-        @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
 
+        dump_manifest = <<EOS
+          #{includes}
+          class { '::kafo_configure::dump_values':
+            lookups   => [#{param_lookups_to_dump}],
+            variables => [#{params_to_dump}],
+          }
+EOS
+
         @logger.info 'Loading default values from puppet modules...'
-        command = PuppetCommand.new("$temp_dir=\"#{temp_dir}\" #{includes} dump_values(#{params_to_dump})", [], puppetconf, self).append('2>&1').command
+        command = PuppetCommand.new(dump_manifest, [], puppetconf, self).append('2>&1').command
         result = `#{command}`
         @logger.debug result
         unless $?.exitstatus == 0
@@ -165,7 +173,8 @@ module Kafo
           KafoConfigure.exit(:defaults_error)
         end
         @logger.info "... finished"
-        load_yaml_file(File.join(temp_dir, 'default_values.yaml'))
+
+        load_yaml_from_output(result.split($/))
       end
     end
 
@@ -304,6 +313,10 @@ module Kafo
       params.select(&:dump_default_needed?).map(&:dump_default).join(',')
     end
 
+    def param_lookups_to_dump
+      params.select { |p| p.manifest_default.nil? }.map { |p| %{"#{p.identifier}"} }.join(',')
+    end
+
     def format(data)
       data.gsub('!ruby/sym ', ':')
     end
@@ -312,6 +325,18 @@ module Kafo
       YAML.load_file(filename)
     end
 
+    # Loads YAML from mixed output, finding the "---" and "..." document start/end delimiters
+    def load_yaml_from_output(lines)
+      start = lines.find_index { |l| l.start_with?('---') }
+      last = lines[start..-1].find_index("...")
+      if start.nil? || last.nil?
+        puts "Could not find default values in output"
+        @logger.error 'Could not find default values in Puppet output, cannot continue'
+        KafoConfigure.exit(:defaults_error)
+      end
+      YAML.load(lines[start,last].join($/))
+    end
+
     def register_data_types
       module_dirs.each do |module_dir|
         Dir[File.join(module_dir, '*', 'types', '**', '*.pp')].each do |type_file|

data/lib/kafo/exit_handler.rb

@@ -18,7 +18,8 @@ module Kafo
           :defaults_error => 25,
           :unset_scenario => 26,
           :scenario_error => 27,
-          :missing_argument => 28
+          :missing_argument => 28,
+          :insufficient_permissions => 29
       }
     end
 

data/lib/kafo/kafo_configure.rb

@@ -113,6 +113,14 @@ module Kafo
       self.class.logger
     end
 
+    def run(*args)
+      started_at = Time.now
+      logger.info("Running installer with args #{args.inspect}")
+      super
+    ensure
+      logger.info("Installer finished in #{Time.now - started_at} seconds")
+    end
+
     def execute
       parse_cli_arguments
 
@@ -306,8 +314,8 @@ module Kafo
       self.class.app_option ['-S', '--scenario'], 'SCENARIO', 'Use installation scenario'
       self.class.app_option ['--disable-scenario'], 'SCENARIO', 'Disable installation scenario'
       self.class.app_option ['--enable-scenario'], 'SCENARIO', 'Enable installation scenario'
-      self.class.app_option ['--list-scenarios'], :flag, 'List available installation scenaraios'
-      self.class.app_option ['--force'], :flag, 'Force change of installation scenaraio'
+      self.class.app_option ['--list-scenarios'], :flag, 'List available installation scenarios'
+      self.class.app_option ['--force'], :flag, 'Force change of installation scenario'
       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'
@@ -425,7 +433,7 @@ module Kafo
         'hiera_config' => hiera.config_path,
         'noop'         => !!noop?,
         'profile'      => !!profile?,
-        'show_diff'    => false
+        'show_diff'    => true
       )
       self.class.exit_handler.register_cleanup_path(puppetconf.config_path)
 

data/lib/kafo/param.rb

@@ -17,6 +17,10 @@ module Kafo
       @type   = DataType.new_from_string(type)
     end
 
+    def identifier
+      @module ? "#{@module.identifier}::#{name}" : name
+    end
+
     def groups
       @groups || []
     end
@@ -37,10 +41,10 @@ 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'.
+    # For literal default values, only use 'manifest_default'. For variable or values from a data
+    # lookup, use the value loaded back from the dump in 'default'.
     def default
-      @type.typecast(dump_default_needed? ? @default : manifest_default)
+      @type.typecast(dump_default_needed? || !@default.nil? ? @default : manifest_default)
     end
 
     def default=(default)
@@ -89,6 +93,8 @@ module Kafo
       # 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]
+      elsif defaults.has_key?(identifier)
+        self.default = defaults[identifier]
       end
     end
 

data/lib/kafo/version.rb

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

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

@@ -0,0 +1,14 @@
+# Find values via data lookups for class parameters
+#
+# Wraps the lookup() function for data lookups of class parameters without
+# inline defaults.
+#
+Puppet::Functions.create_function(:dump_lookups) do
+  dispatch :dump_lookups do
+    param 'Array[String]', :parameters
+  end
+
+  def dump_lookups(parameters)
+    Hash[parameters.map { |param| [param, call_function('lookup', [param], 'default_value' => nil)] }]
+  end
+end

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

@@ -1,18 +1,13 @@
 # Find default values for variables specified as args
 #
 module Puppet::Parser::Functions
-  newfunction(:dump_values) do |args|
+  newfunction(:dump_values, :type => :rvalue) do |args|
     options = []
     options<< false if Puppet::PUPPETVERSION.start_with?('2.6')
-    data = args.map do |arg|
+    data = args.flatten.map do |arg|
       found_value = lookupvar(arg, *options)
       [arg, found_value]
     end
-    data = Hash[data]
-
-    dump_dir = lookupvar('temp_dir')
-    file_name = "#{dump_dir}/default_values.yaml"
-
-    File.open(file_name, File::WRONLY|File::CREAT|File::EXCL, 0600) { |file| file.write(YAML.dump(data)) }
+    Hash[data]
   end
 end

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

@@ -0,0 +1,13 @@
+# Returns the given argument as a string containing YAML, with an end of
+# document marker.
+#
+module Puppet::Parser::Functions
+  newfunction(:to_yaml, :type => :rvalue) do |args|
+    dump = if args.all? { |a| a.is_a?(Hash) }
+             args.inject({}) { |m,a| m.merge(a) }
+           else
+             args.first
+           end
+    YAML.dump(dump) + "\n...\n"
+  end
+end

data/modules/kafo_configure/manifests/dump_values.pp

@@ -0,0 +1,21 @@
+# Outputs a YAML hash of variable to its value, for:
+#  - variables: a list of variables from params classes that have
+#               already been included
+#  - 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 = to_yaml($dumped_vars, $dumped_lookups)
+  } else {
+    $dumped = to_yaml($dumped_vars)
+  }
+
+  notice("\n${dumped}")
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kafo
 version: !ruby/object:Gem::Version
-  version: 1.0.6
+  version: 1.0.7
 platform: ruby
 authors:
 - Marek Hulan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-05 00:00:00.000000000 Z
+date: 2017-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -194,14 +194,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE.txt
-- README.md
-- Rakefile
 - bin/kafo-configure
 - bin/kafo-export-params
 - bin/kafofy
 - config/config_header.txt
 - config/kafo.yaml.example
+- doc/kafo_run.png
+- doc/kafo_run.uml
 - lib/kafo.rb
 - lib/kafo/color_scheme.rb
 - lib/kafo/condition.rb
@@ -262,10 +261,13 @@ files:
 - lib/kafo/validator.rb
 - lib/kafo/version.rb
 - lib/kafo/wizard.rb
+- modules/kafo_configure/lib/puppet/functions/dump_lookups.rb
 - 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/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
 homepage: https://github.com/theforeman/kafo
 licenses:

data/LICENSE.txt

@@ -1,11 +0,0 @@
-This program and entire repository is free software: you can redistribute it 
-and/or modify it under the terms of the GNU General Public License as 
-published by the Free Software Foundation, either version 3 of the License, 
-or any later version.
-
-This program is distributed in the hope that it will be useful, but WITHOUT 
-ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS 
-FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along with 
-this program. If not, see http://www.gnu.org/licenses/.