kafo 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 631c545585673f01f7e7887718b47ccf1b28166f
-  data.tar.gz: def948da2ad4fa1eda020e4d0a7e822fcfaa45b9
+  metadata.gz: 357f8e1980ad47e91e5c7d8320a8abab921bb1c8
+  data.tar.gz: cbd0e38cb265b461b1b37a7c4055b675263f41eb
 SHA512:
-  metadata.gz: ed6861706c4aee64ac86bf1cd9af46bdec15a43375fe66738af4b941a96a84f21a405e9215719c4b23865b0dfab8a9d8edf50b72703dee46d1d69121fdbb488d
-  data.tar.gz: f8d316dd8859f49d4ed8407c232337aa76782f1c767c9e4697f0caca046261f4e59338ccccaade0d9df51049d6da448b0e83f904527773a5ef616b619d39c5b6
+  metadata.gz: 929c44d536d597978e5cbc19989e496bed18386b254938d25c121046132a939f217b1c8393af8ede19f63d19756f3d2d0ea0f65c4c5e8091cdfad150fdd15c6f
+  data.tar.gz: 57167458f21fa390c7600879dcb9835264dfc931ac51b891213b8c9e99157864b2144b9666d64e40258770b11d097a45d67e4020d242658a8e82d685e0256e85

data/README.md

@@ -302,7 +302,7 @@ The installer stores names of applied migrations in `<config>/installer-scenario
 It is recommended to prefix the migration names with `date +%y%m%d%H%M%S` to avoid migration ordering issues.
 
 In a migration you can modify the scenario configuration as well as the answer file. The changed configs are stored immediately after all the migrations were applied.
-If you just want to apply the migrations you can use `--migrations-only` switch. 
+If you just want to apply the migrations you can use `--migrations-only` switch.
 Note that `--noop` and `--dont-save-answers` has no effect on migrations.
 
 Sample migration adding new module could look like as follows:
@@ -317,6 +317,20 @@ Sample migration adding new module could look like as follows:
   EOF
 ```
 
+### Enabling/disabling scenarios
+
+Scenarios that are deprecated or wanted to be hidden on the system can be disabled with:
+
+```bash
+  foreman-installer --disable-scenario deprecated-scenario
+  Scenario deprecated-scenario was disabled.
+```
+The disabled scenario is not shown in the scenario list and is prevented from being installed.
+It is not deleted from the file system however so the custom values in the answer file are preserved
+and e.g. migration to new scenario is still possible.
+
+Disabled scenario can be enabled back again with `foreman-installer --enable-scenario SCENARIO`.
+
 ## Documentation
 
 Every parameter that can be set by kafo *must* be documented. This means that
@@ -894,6 +908,22 @@ parameter `--skip-checks-i-know-better` (or `-s`). This will completely
 disable running all system check scripts. Note that this option is
 not persisted between runs.
 
+## Parser cache
+
+A cache of parsed Puppet modules and manifests can be created to skip the use
+of kafo_parsers at runtime. This is useful when kafo_parsers doesn't support the
+version of Puppet in use, and may also provide a small performance benefit.
+
+Create the cache with `kafo-export-params -f parsercache --no-parser-cache` and
+configure it in config/kafo.yaml with:
+
+```yaml
+:parser_cache_path: ./parser_cache.yaml
+```
+
+The cache will be skipped if the file modification time of the manifest is
+greater than the mtime recorded in the cache.
+
 ## Exit code
 
 Kafo can terminate either before or after puppet is run. If it is run with
@@ -913,7 +943,7 @@ Other exit codes that can be returned:
 * '24' means that your answer file asks for puppet module that you did not provide
 * '25' means that kafo could not get default values from puppet
 * '26' means that kafo could not find the specified scenario
-* '27' means that kafo found previous installation that has different scenario than is the specified scenario  
+* '27' means that kafo found found scenario configuration error that prevents installation from continuing  
 * '130' user interrupt (^C)
 
 ## Running Puppet Profiling

data/bin/kafo-export-params

@@ -3,12 +3,12 @@ require 'rubygems'
 require 'ostruct'
 require 'clamp'
 require 'logging'
-require 'kafo/string_helper'
+require 'kafo/configuration'
 require 'kafo/exceptions'
+require 'kafo/parser_cache_writer'
+require 'kafo/string_helper'
 require 'logger'
-
-$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'kafo'))
-require 'configuration'
+require 'yaml'
 
 KafoConfigure = OpenStruct.new
 def KafoConfigure.exit(code)
@@ -17,35 +17,53 @@ end
 
 module Kafo
   class KafoExportParams < Clamp::Command
-    TYPES = %w(md html asciidoc)
+    TYPES = %w(md html asciidoc parsercache)
 
     option ['-c', '--config'], 'FILE', 'Config file for which should we generate params',
            :required => true
 
     option ['-f', '--format'], 'FORMAT',
-           'Config file for which should we generate params', :default => 'md' do |format|
+           "Format parameters will be written in, valid options: #{TYPES.join(',')}", :default => 'md' do |format|
       format = format.downcase
       raise ArgumentError unless TYPES.include?(format)
       format
     end
 
+    option ['-o', '--output'], 'FILE', 'Output file to write parameters into', :default => '-'
+
+    option '--[no-]parser-cache', :flag, 'Enable or disable the parser cache, disable for fresh results', :default => true
+
     def execute
       c                         = Configuration.new(config, false)
+      c.app[:parser_cache_path] = nil unless parser_cache?
       KafoConfigure.config      = c
       KafoConfigure.root_dir    = File.expand_path(c.app[:installer_dir])
-      KafoConfigure.module_dirs = File.expand_path(c.app[:module_dirs])
-      KafoConfigure.logger      = Logger.new(STDOUT)
+      KafoConfigure.module_dirs = c.module_dirs
+      KafoConfigure.logger      = Logger.new(STDERR)
 
-      exporter = self.class.const_get(format.capitalize).new(c)
+      if output == '-'
+        file = STDOUT
+      else
+        file = File.open(output, 'w')
+      end
+
+      exporter = self.class.const_get(format.capitalize).new(c, file)
       exporter.print_out
     end
 
-    class Html
-      include StringHelper
-
-      def initialize(config)
+    class Writer
+      def initialize(config, file)
         @config = config
+        @file = file
+      end
+
+      def puts(*args)
+        @file.puts(*args)
       end
+    end
+
+    class Html < Writer
+      include StringHelper
 
       def print_out
         puts '<div id="installer-options">'
@@ -79,13 +97,9 @@ module Kafo
       end
     end
 
-    class Asciidoc
+    class Asciidoc < Writer
       include StringHelper
 
-      def initialize(config)
-        @config = config
-      end
-
       def print_out
         @config.modules.sort.each do |mod|
           puts "Parameters for '#{mod.name}':\n\n"
@@ -99,12 +113,12 @@ module Kafo
       end
     end
 
-    class Md
+    class Md < Writer
       include StringHelper
 
-      def initialize(config)
-        @config = config
-        @max    = max_description_length
+      def initialize(*args)
+        super
+        @max = max_description_length
       end
 
       def print_out
@@ -129,6 +143,12 @@ module Kafo
         doc_lengths.max
       end
     end
+
+    class Parsercache < Writer
+      def print_out
+        puts Kafo::ParserCacheWriter.write(@config.modules).to_yaml
+      end
+    end
   end
 end
 

data/config/kafo.yaml.example

@@ -16,6 +16,8 @@
 # :module_dirs: /usr/share/kafo/modules
 # Similar as modules_dir but for kafo internal modules, leave nil if you don't need to change it
 # :kafo_modules_dir:
+# Location of an optional cache of parsed module data, generate with kafo-export-params -f parsercache
+# :parser_cache_path: /usr/share/kafo/parser_cache.yaml
 # Enable colors? If you don't touch this, we'll autodetect terminal capabilities
 # :colors: true
 # Color scheme, we support :bright and :dark (first is better for white background, dark for black background)

data/lib/kafo/configuration.rb

@@ -12,6 +12,7 @@ module Kafo
     DEFAULT = {
         :name                 => '',
         :description          => '',
+        :enabled              => true,
         :log_dir              => '/var/log/kafo',
         :log_name             => 'configuration.log',
         :log_level            => 'info',
@@ -26,7 +27,8 @@ module Kafo
         :hook_dirs            => [],
         :custom               => {},
         :low_priority_modules => [],
-        :verbose_log_level    => 'info'
+        :verbose_log_level    => 'info',
+        :parser_cache_path    => './config/parser_cache.json'
     }
 
     def initialize(file, persist = true)
@@ -256,6 +258,12 @@ module Kafo
       @config_file.gsub(/\.yaml$/, '.migrations')
     end
 
+    def parser_cache
+      if app[:parser_cache_path]
+        @parser_cache ||= Kafo::ParserCacheReader.new_from_file(File.expand_path(app[:parser_cache_path]))
+      end
+    end
+
     private
 
     def custom_storage

data/lib/kafo/kafo_configure.rb

@@ -52,6 +52,8 @@ module Kafo
 
       # Handle --list-scenarios before we need them
       scenario_manager.list_available_scenarios if ARGV.include?('--list-scenarios')
+      scenario_manager.check_enable_scenario
+      scenario_manager.check_disable_scenario
       setup_config(config_file)
 
       self.class.hooking.execute(:pre_migrations)
@@ -76,7 +78,7 @@ module Kafo
 
       if scenario_manager.configured?
         scenario_manager.check_scenario_change(self.class.config_file)
-        if scenario_manager.scenario_changed?(self.class.config_file)
+        if scenario_manager.scenario_changed?(self.class.config_file) && !self.class.in_help_mode?
           prev_config = scenario_manager.load_configuration(scenario_manager.previous_scenario)
           prev_config.run_migrations
           self.class.config.migrate_configuration(prev_config, :skip => [:log_name])
@@ -164,6 +166,10 @@ module Kafo
       self.exit_handler.exit_code
     end
 
+    def self.in_help_mode?
+      ARGV.include?('--help') || ARGV.include?('--full-help') || ARGV.include?('-h')
+    end
+
     def exit_code
       self.class.exit_code
     end
@@ -270,6 +276,8 @@ module Kafo
       self.class.app_option ['-l', '--verbose-log-level'], 'LEVEL', 'Log level for verbose mode output',
                             :default => 'info'
       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 ['--compare-scenarios'], :flag, 'Show changes between last used scenario and the scenario specified with -S or --scenario argument'

data/lib/kafo/param_builder.rb

@@ -79,7 +79,7 @@ module Kafo
     end
 
     def get_type(type)
-      type = type.capitalize
+      type = (type || 'string').capitalize
       Params.const_defined?(type) ? Params.const_get(type) : raise(TypeError, "undefined parameter type '#{type}'")
     end
   end

data/lib/kafo/parser_cache_reader.rb

@@ -0,0 +1,47 @@
+module Kafo
+  class ParserCacheReader
+    def self.new_from_file(cache_path)
+      if cache_path.nil? || cache_path.empty?
+        logger.debug "No parser cache configured in :parser_cache_path, skipping setup"
+        return nil
+      end
+
+      unless File.exist?(cache_path)
+        logger.warn "Parser cache configured at #{cache_path} is missing, skipping setup"
+        return nil
+      end
+
+      parsed = YAML.load(File.read(cache_path))
+      if !parsed.is_a?(Hash) || parsed[:version] != 1 || !parsed[:files].is_a?(Hash)
+        logger.warn "Parser cache is from a different version of Kafo, skipping setup"
+        return nil
+      end
+
+      logger.debug "Using #{cache_path} cache with parsed modules"
+      new(parsed)
+    end
+
+    def self.logger
+      KafoConfigure.logger
+    end
+
+    def initialize(cache)
+      @cache = cache
+    end
+
+    def logger
+      KafoConfigure.logger
+    end
+
+    def get(key, manifest_path)
+      return nil unless @cache[:files].has_key?(key)
+
+      if @cache[:files][key][:mtime] && File.mtime(manifest_path).to_i > @cache[:files][key][:mtime]
+        logger.debug "Parser cache for #{manifest_path} is outdated, ignoring cache entry"
+        return nil
+      end
+
+      @cache[:files][key][:data]
+    end
+  end
+end

data/lib/kafo/parser_cache_writer.rb

@@ -0,0 +1,14 @@
+module Kafo
+  class ParserCacheWriter
+    def self.write(modules)
+      {
+        :version => 1,
+        :files => Hash[modules.sort.map { |m| write_module(m) }]
+      }
+    end
+
+    def self.write_module(mod)
+      [mod.identifier, {:data => mod.raw_data, :mtime => File.mtime(mod.manifest_path).to_i}]
+    end
+  end
+end

data/lib/kafo/puppet_module.rb

@@ -1,6 +1,7 @@
 # encoding: UTF-8
 require 'kafo/param'
 require 'kafo/param_builder'
+require 'kafo/parser_cache_reader'
 require 'kafo_parsers/puppet_module_parser'
 require 'kafo/validator'
 
@@ -9,7 +10,7 @@ module Kafo
     PRIMARY_GROUP_NAME = 'Parameters'
 
     attr_reader :name, :identifier, :params, :dir_name, :class_name, :manifest_name, :manifest_path,
-                :groups, :params_path, :params_class_name, :configuration
+                :groups, :params_path, :params_class_name, :configuration, :raw_data
 
     def initialize(identifier, parser = KafoParsers::PuppetModuleParser, configuration = KafoConfigure.config)
       @identifier        = identifier
@@ -27,6 +28,7 @@ module Kafo
       end
       @manifest_path     = File.join(module_dir, module_manifest_path)
       @parser            = parser
+      @parser_cache      = @configuration.parser_cache
       @validations       = []
       @logger            = KafoConfigure.logger
       @groups            = {}
@@ -48,9 +50,10 @@ module Kafo
 
     def parse(builder_klass = ParamBuilder)
       @params      = []
-      raw_data     = @parser.parse(manifest_path)
-      builder      = builder_klass.new(self, raw_data)
-      @validations = raw_data[:validations]
+      @raw_data    = @parser_cache.get(identifier, manifest_path) if @parser_cache
+      @raw_data  ||= @parser.parse(manifest_path)
+      builder      = builder_klass.new(self, @raw_data)
+      @validations = @raw_data[:validations]
 
       builder.validate
       @params = builder.build_params

data/lib/kafo/scenario_manager.rb

@@ -17,7 +17,7 @@ module Kafo
       @available_scenarios ||= Dir.glob(File.join(config_dir, '*.yaml')).reject { |f| f =~ /#{last_scenario_link}$/ }.inject({}) do |scns, scn_file|
         begin
           content = YAML.load_file(scn_file)
-          if content.is_a?(Hash) && content.has_key?(:answer_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)
             scns[scn_file] = content
@@ -76,14 +76,13 @@ module Kafo
       !!(defined?(CONFIG_DIR) && CONFIG_DIR)
     end
 
-    def scenario_from_args
+    def scenario_from_args(arg_name='--scenario|-S')
       # try scenario provided in the args via -S or --scenario
-      parsed = ARGV.join(" ").match /(--scenario|-S)(\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)
-        KafoConfigure.logger.fatal "Scenario (#{scenario_file}) was not found, can not continue"
-        KafoConfigure.exit(:unknown_scenario)
+        fail_now("Scenario (#{scenario_file}) was not found, can not continue", :unknown_scenario)
       end
     end
 
@@ -93,20 +92,13 @@ module Kafo
         select_scenario_interactively
       if scenario.nil?
         fail_now("Scenario was not selected, can not continue. Use --list-scenarios to list available options.", :unknown_scenario)
+      elsif !scenario_enabled?(scenario)
+        fail_now("Selected scenario is DISABLED, can not continue. Use --list-scenarios to list available options." \
+	        " You can also --enable-scenario SCENARIO to make the selected scenario available.", :scenario_error)
       end
       scenario
     end
 
-    def scenario_from_args
-      # try scenario provided in the args via -S or --scenario
-      parsed = ARGV.join(" ").match /(--scenario|-S)(\s+|[=]?)(\S+)/
-      if parsed
-        scenario_file = File.join(config_dir, "#{parsed[3]}.yaml")
-        return scenario_file if File.exists?(scenario_file)
-        fail_now("Scenario (#{scenario_file}) was not found, can not continue", :unknown_scenario)
-      end
-    end
-
     def show_scenario_diff(prev_scenario, new_scenario)
       say ::HighLine.color("Scenarios are being compared, that may take a while...", :info)
       prev_conf = load_and_setup_configuration(prev_scenario)
@@ -126,27 +118,48 @@ module Kafo
       end
     end
 
+    def check_enable_scenario
+      scenario = scenario_from_args('--enable-scenario')
+      set_scenario_availability(scenario, true) if scenario
+    end
+
+    def check_disable_scenario
+      scenario = scenario_from_args('--disable-scenario')
+      set_scenario_availability(scenario, false) if scenario
+    end
+
+    def set_scenario_availability(scenario, available)
+      cfg = load_configuration(scenario)
+      cfg.app[:enabled] = available
+      cfg.save_configuration(cfg.app)
+      say "Scenario #{File.basename(scenario, ".yaml")} was #{available ? "enabled" : "disabled"}"
+      KafoConfigure.exit(0)
+    end
+
+    def scenario_enabled?(scenario)
+      load_configuration(scenario).app[:enabled]
+    end
+
     def confirm_scenario_change(new_scenario)
-      unless ARGV.include?('--force')
-        if (ARGV & ['--interactive', '-i']).any?
-          show_scenario_diff(@previous_scenario, new_scenario)
-
-          wizard = KafoWizards.wizard(:cli, 'Confirm installation scenario selection',
-            :description => "You are trying to replace existing installation with different scenario. This may lead to unpredictable states. Please confirm that you want to proceed.")
-          wizard.entries << wizard.factory.button(:proceed, :label => 'Proceed with selected installation scenario', :default => false)
-          wizard.entries << wizard.factory.button(:cancel, :label => 'Cancel Installation', :default => true)
-          result = wizard.run
-          if result == :cancel
-            say 'Installation was cancelled by user'
-            dump_log_and_exit(0)
-          end
-        else
-          message = "You are trying to replace existing installation with different scenario. This may lead to unpredictable states. " +
-          "Use --force to override. You can use --compare-scenarios to see the differences"
-          KafoConfigure.logger.error(message)
-          dump_log_and_exit(:scenario_error)
+      if (ARGV & ['--interactive', '-i']).any?
+        show_scenario_diff(@previous_scenario, new_scenario)
+
+        wizard = KafoWizards.wizard(:cli, 'Confirm installation scenario selection',
+          :description => "You are trying to replace existing installation with different scenario. This may lead to unpredictable states. Please confirm that you want to proceed.")
+        wizard.entries << wizard.factory.button(:proceed, :label => 'Proceed with selected installation scenario', :default => false)
+        wizard.entries << wizard.factory.button(:cancel, :label => 'Cancel Installation', :default => true)
+        result = wizard.run
+        if result == :cancel
+          say 'Installation was cancelled by user'
+          dump_log_and_exit(0)
         end
+      elsif !ARGV.include?('--force') && !KafoConfigure.in_help_mode?
+        message = "You are trying to replace existing installation with different scenario. This may lead to unpredictable states. " +
+        "Use --force to override. You can use --compare-scenarios to see the differences"
+        KafoConfigure.logger.error(message)
+        dump_log_and_exit(:scenario_error)
       end
+      true
     end
 
     def print_scenario_diff(prev_conf, new_conf)

data/lib/kafo/system_checker.rb

@@ -3,7 +3,7 @@
 module Kafo
   class SystemChecker
     def self.check
-      KafoConfigure.check_dirs.each do |dir|
+      KafoConfigure.check_dirs.all? do |dir|
         new(File.join(dir, '*')).check
       end
     end

data/lib/kafo/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kafo
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - Marek Hulan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-23 00:00:00.000000000 Z
+date: 2016-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +28,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 11.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 11.0.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -241,6 +241,8 @@ files:
 - lib/kafo/params/integer.rb
 - lib/kafo/params/password.rb
 - lib/kafo/params/string.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