kafo 0.8.1 → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7f465dd70caa686f0ecd2259d8a5accdddcc616
-  data.tar.gz: 5eb7cf114773117e01350bab8793a543aca5ca0c
+  metadata.gz: 13fc7c4d5d0d30aa719d2af9047ed92bf5a6c93c
+  data.tar.gz: cc7e5c57c7e3f5e888c8db5e963d43bdb505dc01
 SHA512:
-  metadata.gz: f7469af81693f8f61e36a0a7aa54bf9e8ff3ee00cda2298f2c46ae0827a64fa768673f5de79681148c3536ea374a82605e6d65c483312cf7a32d513eea4cf289
-  data.tar.gz: 0313549df4f32927870c1a55a91a37a0b43b897be9c364f80435d086380bd4faefa6f51ea7aa7e2b4984dbf3b86de6cc97aafb368565132c8f41aead30b510a1
+  metadata.gz: 0065c3f73debd2dc8056185c91bc5a48c822b5baaa31e47f84d9758e59ceca260c735953060bc5628188ecb14d9ece380709c695483faaa32954e21cc45eef6d
+  data.tar.gz: c58bf1204a85e7bd5c9273baec1a93e5f6f5a8ced3bbc2bfc027f54840d42930cb891720a9e182fd5e57a17c0020f1f10d471893f27d3b8af54c645147bfc2c9

data/README.md

@@ -507,6 +507,25 @@ as key:value.
 When parsing the value, the first colon divides key and value. All other
 colons are ignored.
 
+## Resetting an argument
+
+Existing stored parameters can be reset back to their default value from the
+command line or interactive mode.  This deletes the stored value in the answers
+file and stores the default from the Puppet manifest in its place.
+
+The default value is the value set in, or computed by the Puppet params
+manifest. This will _not_ reset to any defaults specified in the answers file
+before running the Kafo-based installer, they are not kept.
+
+Using the CLI, a --reset option is available for every parameter, e.g.
+
+```bash
+bin/foreman-installer --reset-puppet-server-git-branch-map
+```
+
+The parameter can also be reset to the default in interactive mode, via the
+reset parameters sub-menu under each module.
+
 ## Grouping in interactive mode
 
 If your module has too many parameters you may find the grouping feature useful.

data/lib/kafo/configuration.rb

@@ -139,7 +139,7 @@ module Kafo
         temp_dir = Dir.mktmpdir(nil, app[:default_values_dir])
         KafoConfigure.exit_handler.register_cleanup_path temp_dir
         @logger.info 'Loading default values from puppet modules...'
-        command = PuppetCommand.new("$temp_dir=\"#{temp_dir}\" #{includes} dump_values(#{params_to_dump})", ['--noop'], self).append('2>&1').command
+        command = PuppetCommand.new("$temp_dir=\"#{temp_dir}\" #{includes} dump_values(#{params_to_dump})", ['--noop', '--reports='], self).append('2>&1').command
         result = `#{command}`
         @logger.debug result
         unless $?.exitstatus == 0

data/lib/kafo/help_builders/base.rb

@@ -82,7 +82,11 @@ module Kafo
       end
 
       def parametrization
-        @parametrization ||= Hash[@params.map { |p| [parametrize(p), p] }]
+        @parametrization ||= begin
+          @params.inject({}) do |h,p|
+            h.update(parametrize(p) => p, parametrize(p, 'reset-') => p)
+          end
+        end
       end
     end
   end

data/lib/kafo/help_builders/basic.rb

@@ -4,9 +4,15 @@ module Kafo
   module HelpBuilders
     class Basic < Base
       def add_module(name, items)
-        data = by_parameter_groups(items)
+        data = by_parameter_groups(except_resets(items))
         add_list(module_header(name), data['Basic'])
       end
+
+      private
+
+      def except_resets(items)
+        items.select { |i| !i.help.first.strip.start_with?('--reset-') || !i.help.last.strip.end_with?('to the default value') }
+      end
     end
   end
 end

data/lib/kafo/kafo_configure.rb

@@ -301,6 +301,8 @@ module Kafo
         doc = param.doc.nil? ? 'UNDOCUMENTED' : param.doc.join("\n")
         self.class.option parametrize(param), '', doc,
                           :default => param.value, :multivalued => param.multivalued?
+        self.class.option parametrize(param, 'reset-'), :flag,
+                          "Reset #{param.name} to the default value"
       end
     end
 
@@ -345,8 +347,11 @@ module Kafo
       # enable/disable modules according to CLI
       config.modules.each { |mod| send("enable_#{mod.name}?") ? mod.enable : mod.disable }
 
-      # set values coming from CLI arguments
+      # set and reset values coming from CLI arguments
       params.each do |param|
+        if send("reset_#{u(with_prefix(param))}?")
+          param.unset_value
+        end
         variable_name = u(with_prefix(param))
         variable_name += '_list' if param.multivalued?
         cli_value     = instance_variable_get("@#{variable_name}")
@@ -380,6 +385,7 @@ module Kafo
           '--color=false',
           '--show_diff',
           '--detailed-exitcodes',
+          '--reports=',
       ]
       options.push '--noop' if noop?
       options.push '--profile' if profile?

data/lib/kafo/param.rb

@@ -23,9 +23,15 @@ module Kafo
 
     def value=(value)
       @value_set = true
+      value      = value.to_s if value.is_a?(::HighLine::String)  # don't persist highline extensions
       @value     = value == 'UNDEF' ? nil : value
     end
 
+    def unset_value
+      @value_set = false
+      @value     = nil
+    end
+
     def dump_default
       default
     end
@@ -40,7 +46,7 @@ module Kafo
 
     def set_default(defaults)
       if default == 'UNSET'
-        self.value = nil
+        self.default = nil
       else
         if defaults.has_key?(default)
           value = defaults[default]
@@ -48,21 +54,19 @@ module Kafo
             when :undef
               # value can be set to :undef if value is not defined
               # (e.g. puppetmaster = $::puppetmaster which is not defined yet)
-              self.value = nil
+              self.default = nil
             when :undefined
               # in puppet 2.7 :undefined means that it's param which value is
               # not set by another parameter (e.g. foreman_group = 'something')
               # which means, default is sensible unlike dumped default
               # newer puppet has default dump in format 'value' => 'value' so
               # it's handled correctly by else branch
-              self.value = self.default
             else
-              self.value = value
+              self.default = value
           end
-          # if we don't have default value from dump (can happen for modules added from hooks)
-          # we fallback to their own default values which must be sensible
-        else
-          self.value = self.default
+          # if we don't have default value from dump (can happen for modules added from hooks,
+          # or without using a params class), the existing default value from the manifest will
+          # be used. On calling #value, the default will be returned if no overriding value is set.
         end
       end
     end

data/lib/kafo/string_helper.rb

@@ -18,8 +18,8 @@ module Kafo
       "#{prefix}#{d(param.name)}"
     end
 
-    def parametrize(param)
-      "--#{with_prefix(param)}"
+    def parametrize(param, prefix='')
+      "--#{prefix}#{with_prefix(param)}"
     end
   end
 end

data/lib/kafo/version.rb

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

data/lib/kafo/wizard.rb

@@ -87,6 +87,7 @@ END
             others.each do |group|
               menu.choice("Configure #{group.formatted_name}") { configure_group(group) }
             end
+            menu.choice("Reset a parameter to its default value") { reset_module_params(mod) }
           end
           menu.choice("Back to main menu") { go_back = true }
         end
@@ -153,6 +154,26 @@ END
       agree("Enable #{mod.name} module? (y/n) ") ? mod.enable : mod.disable
     end
 
+    def reset_module_params(mod)
+      go_back = false
+      until go_back
+        say "\n" + HighLine.color("Resetting parameters of module #{mod.name}", :headline)
+        choose do |menu|
+          mod.params.each do |param|
+            menu.choice "Reset #{HighLine.color(param.name, :important)}, current value: #{HighLine.color(param.value.to_s, :info)}, default value: #{HighLine.color(param.default.to_s, :info)}" do
+              reset(param)
+            end if param.visible?(@kafo.params)
+          end
+          menu.choice("Back to parent menu") { go_back = true }
+        end
+      end
+    end
+
+    def reset(param)
+      param.unset_value
+      say "\n" + HighLine.color("Value for #{param.name} reset to default", :important)
+    end
+
     def setup_terminal
       $terminal         = HighLine.new
       data              = HighLine::SystemExtensions.terminal_size

data/modules/kafo_configure/lib/kafo/puppet/report_wrapper.rb

@@ -1,3 +1,5 @@
+require 'set'
+
 module Kafo
   module Puppet
     class ReportWrapper
@@ -7,6 +9,7 @@ module Kafo
         @transaction     = transaction
         @report          = report
         @supported       = true
+        @resources_seen  = Set.new
       end
 
       # Needed to fool Puppet's logging framework
@@ -16,8 +19,9 @@ module Kafo
 
       def add_resource_status(status, *args, &block)
         if @supported && report.respond_to?(:resource_statuses) && report.resource_statuses.is_a?(Hash)
-          if transaction.in_main_catalog && report.resource_statuses[status.resource.to_s] && transaction.is_interesting?(status.resource)
+          if transaction.in_main_catalog && report.resource_statuses[status.resource.to_s] && transaction.tracked_resources.include?(status.resource) && !@resources_seen.include?(status.resource)
             ::Puppet.info "RESOURCE #{status.resource}"
+            @resources_seen << status.resource
           end
           report.add_resource_status(status, *args, &block)
         else

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

@@ -2,33 +2,36 @@ require 'kafo_configure/lib/kafo/puppet/report_wrapper'
 
 module Puppet::Parser::Functions
   newfunction(:add_progress) do |args|
-    supported = %w(2.6. 2.7. 3.0. 3.1. 3.2. 3.3. 3.4. 3.5. 3.6. 3.7. 3.8.)
-    if supported.any? { |version| Puppet::PUPPETVERSION.start_with?(version) }
-      # Monkey patch the transaction to put our wrapper around the report object
+    loaded = false
+    begin
       require 'puppet/transaction'
+      loaded = true
+    rescue LoadError
+      ::Puppet.warning 'Unable to load puppet/transaction for progress bar support, this version may not be supported'
+    end
+
+    if loaded
+      # Monkey patch the transaction to put our wrapper around the report object
       class Puppet::Transaction
         attr_accessor :in_main_catalog
 
         def is_interesting?(resource)
-          ![:schedule, :class, :stage, :filebucket].include?(resource.to_s.split('[')[0].downcase.to_sym)
+          ![:schedule, :class, :stage, :filebucket, :anchor, :'kafo_configure::yaml_to_class'].include?(resource.to_s.split('[')[0].downcase.to_sym)
         end
 
-        def resource_count
-          catalog.vertices.select { |resource| is_interesting?(resource) }.size
+        def tracked_resources
+          @tracked_resources ||= catalog.vertices.select { |resource| is_interesting?(resource) }.map(&:to_s)
         end
 
         def evaluate_with_trigger(*args, &block)
           if catalog.version
             self.in_main_catalog = true
-            ::Puppet.info "START #{resource_count}"
+            ::Puppet.info "START #{tracked_resources.size}"
           end
           evaluate_without_trigger(*args, &block)
           self.in_main_catalog = false if catalog.version
         end
 
-        alias_method :evaluate_without_trigger, :evaluate
-        alias_method :evaluate, :evaluate_with_trigger
-
         def report_with_wrapper
           unless @report_wrapper
             @report_wrapper = Kafo::Puppet::ReportWrapper.new(self, report_without_wrapper)
@@ -36,11 +39,15 @@ module Puppet::Parser::Functions
           @report_wrapper
         end
 
-        alias_method :report_without_wrapper, :report
-        alias_method :report, :report_with_wrapper
+        if method_defined?(:evaluate) && method_defined?(:report)
+          alias_method :evaluate_without_trigger, :evaluate
+          alias_method :evaluate, :evaluate_with_trigger
+          alias_method :report_without_wrapper, :report
+          alias_method :report, :report_with_wrapper
+        else
+          ::Puppet.warning 'Unable to patch Puppet transactions for progress bar support, this version may not be supported'
+        end
       end
-    else
-      ::Puppet.warning 'Your puppet version does not support progress bar'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kafo
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
 platform: ruby
 authors:
 - Marek Hulan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-06 00:00:00.000000000 Z
+date: 2016-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler