kafo 6.3.0 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d246040f3b21a35b8ec0091c61333fbd5b3ecc8af9fb7d6ed666de850a101bf9
-  data.tar.gz: 9ab7731a6e46877cebfdffffbd7b06e5c11951821be90ff2743aa726c889c418
+  metadata.gz: 4298932fae581df1967c430be034c621ed435954ac95acf7cf7b23c9b7692d40
+  data.tar.gz: 8ce698b286d5ec94c19adfcfc23e541c8b0599cb1399e689ee00b4413668552c
 SHA512:
-  metadata.gz: fb5d804b5c587646b9576f4ba6a67c9b0bd3702ddfad877750beb81b61710fd5b104db0fe36b7cf1cfd1f286d1548fb5b48acb9b778652df6c075600176df88d
-  data.tar.gz: 406667aac6a714122c3ec8d00a90ec630843bd6939167f23142e94bf465be51c8e098380815e869be64af9090b726a2e6a368542e18137a4fdb2493a52ed6246
+  metadata.gz: 769146a010f1007993961a0075a03b1cbf9c4055a59bd8259940379662eaa36003ad5a83b746452e8dd0b35ea47640eb1a3064516a7a776d6e8030c6403321a1
+  data.tar.gz: dd05194e14a17c54a205b5eacc35677b78fe4f036b8ab851972a8301c59b1e327555dd065772d82476a190d878d50226ed0253afe1c5dc129496ee316555bac3

data/README.md

@@ -816,6 +816,32 @@ if app_value(:reset_foreman_db) && !app_value(:noop)
 end
 ```
 
+Hooks can additionally be defined by combining all related stages into a single file
+known as a Multi-stage hook. Multi-stage hooks live in a special directory inside
+the hooks directory: ```$installer_dir/hooks/multi```. Taking the previous example:
+
+```ruby
+# hooks/multi/10-reset_option_feature.rb
+boot do
+  app_option '--reset-foreman-db', :flag, 'Drop foreman database first? You will lose all data!', :default => false
+end
+
+pre do
+  if app_value(:reset_foreman_db) && !app_value(:noop)
+    `which foreman-rake > /dev/null 2>&1`
+    if $?.success?
+      logger.info 'Dropping database!'
+      output = `foreman-rake db:drop 2>&1`
+      logger.debug output.to_s
+      unless $?.success?
+        logger.warn "Unable to drop DB, ignoring since it's not fatal, output was: '#{output}''"
+      end
+    else
+      logger.warn 'Foreman not installed yet, can not drop database!'
+    end
+  end
+end
+```
 
 If you want to add more directories to be search you can use the "hook_dirs" option
 in the installer configuration file.

data/lib/kafo/configuration.rb

@@ -130,7 +130,7 @@ module Kafo
     def modules
       @modules ||= begin
         register_data_types
-        @data.keys.map { |mod| PuppetModule.new(mod, PuppetModule.find_parser, self).parse }.sort
+        @data.keys.map { |mod| PuppetModule.new(mod, configuration: self).parse }.sort
       end
     end
 
@@ -159,7 +159,7 @@ module Kafo
     end
 
     def add_module(name)
-      mod = PuppetModule.new(name, PuppetModule.find_parser, self).parse
+      mod = PuppetModule.new(name, configuration: self).parse
       unless modules.map(&:name).include?(mod.name)
         mod.enable
         @modules << mod

data/lib/kafo/hook_context.rb

@@ -34,8 +34,8 @@ module Kafo
     #
     # @example
     #   app_option ['-n', '--noop'], :flag, 'Run puppet in noop mode?', :default => false
-    def app_option(*args)
-      self.kafo.class.app_option(*args)
+    def app_option(*args, &block)
+      self.kafo.class.app_option(*args, &block)
     end
 
     # Returns whether the given app option exists. This is useful when there's a conditional option that is

data/lib/kafo/hooking.rb

@@ -1,4 +1,5 @@
 require 'kafo/hook_context'
+require 'kafo/multi_stage_hook'
 
 module Kafo
   class Hooking
@@ -36,6 +37,14 @@ module Kafo
             register(hook_type, file, &hook_block)
           end
         end
+
+        # Multi stage hooks are special
+        Dir.glob(File.join(base_dir, 'multi', '*.rb')).sort.each do |file|
+          logger.debug "Loading multi stage hook #{file}"
+          hook = File.read(file)
+          MultiStageHook.new(file, self, TYPES).instance_eval(hook, file, 1)
+        end
+
         @loaded = true
       end
       self

data/lib/kafo/multi_stage_hook.rb

@@ -0,0 +1,13 @@
+module Kafo
+  class MultiStageHook
+    def initialize(name, registry, types)
+      default_name = name
+
+      types.each do |hook_type|
+        self.class.send(:define_method, hook_type) do |name=nil, &block|
+          registry.send(:register, hook_type, name || default_name, &block)
+        end
+      end
+    end
+  end
+end

data/lib/kafo/puppet_module.rb

@@ -25,7 +25,7 @@ module Kafo
       end
     end
 
-    def initialize(identifier, parser = self.class.find_parser, configuration = KafoConfigure.config)
+    def initialize(identifier, parser: nil, configuration: KafoConfigure.config)
       @identifier        = identifier
       @configuration     = configuration
       @name              = get_name
@@ -65,6 +65,7 @@ module Kafo
     def parse(builder_klass = ParamBuilder)
       @raw_data = @parser_cache.get(identifier, manifest_path) if @parser_cache
       if @raw_data.nil?
+        @parser = self.class.find_parser if @parser.nil?
         if @parser.nil? || @parser == :none
           raise ParserError.new("No Puppet module parser is installed and no cache of the file #{manifest_path} is available. Please check debug logs and install optional dependencies for the parser.")
         else

data/lib/kafo/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kafo
 version: !ruby/object:Gem::Version
-  version: 6.3.0
+  version: 6.4.0
 platform: ruby
 authors:
 - Marek Hulan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2021-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -262,6 +262,7 @@ files:
 - lib/kafo/logging.rb
 - lib/kafo/migration_context.rb
 - lib/kafo/migrations.rb
+- lib/kafo/multi_stage_hook.rb
 - lib/kafo/param.rb
 - lib/kafo/param_builder.rb
 - lib/kafo/param_group.rb
@@ -319,7 +320,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: A gem for making installations based on puppet user friendly