class Kafo::Hooking
Constants
- TYPES
-
pre_migrations - just after kafo reads its configuration - useful for config file updates. Only in this stage it is posible to request config reload (`Kafo.request_config_reload`) to get in our changes
-
boot - before kafo is ready to work, useful for adding new app arguments, logger won't work yet
-
init - just after hooking is initialized and kafo is configured, parameters have no values yet
-
pre_values - just before value from CLI is set to parameters (they already have default values)
-
pre_validations - just after system checks and before validations are executed (and before interactive wizard is started), at this point all parameter values are already set but not yet stored in answer file
-
pre_commit - after validations or interactive wizard have completed, all parameter values are set but not yet stored in the answer file
-
pre - just before puppet is executed to converge system
-
post - just after puppet is executed to converge system
-
pre_exit - happens during exit handling, before exit is completed
-
Attributes
Public Class Methods
# File lib/kafo/hooking.rb, line 18 def initialize self.hooks = Hash.new { |h, k| h[k] = {} } @loaded = false end
Public Instance Methods
# File lib/kafo/hooking.rb, line 48 def execute(group, log_stage: true) logger = Logger.new(group) logger.notice "Executing hooks in group #{group}" if log_stage self.hooks[group].keys.sort_by(&:to_s).each do |name| hook = self.hooks[group][name] result = HookContext.execute(self.kafo, logger, &hook) logger.debug "Hook #{name} returned #{result.inspect}" end logger.notice "All hooks in group #{group} finished" if log_stage @group = nil end
# File lib/kafo/hooking.rb, line 27 def load base_dirs = [File.join([KafoConfigure.root_dir, 'hooks']), KafoConfigure.config.app[:hook_dirs]].flatten base_dirs.each do |base_dir| TYPES.each do |hook_type| dir = File.join(base_dir, hook_type.to_s) Dir.glob(dir + "/*.rb").sort.each do |file| logger.debug "Loading hook #{file}" hook = File.read(file) hook_block = proc { instance_eval(hook, file, 1) } register(hook_type, file, &hook_block) end end @loaded = true end self end
# File lib/kafo/hooking.rb, line 44 def loaded? @loaded end
# File lib/kafo/hooking.rb, line 23 def logger KafoConfigure.logger end
# File lib/kafo/hooking.rb, line 64 def register_boot(name, &block) register(:boot, name, &block) end
# File lib/kafo/hooking.rb, line 68 def register_init(name, &block) register(:init, name, &block) end
# File lib/kafo/hooking.rb, line 88 def register_post(name, &block) register(:post, name, &block) end
# File lib/kafo/hooking.rb, line 84 def register_pre(name, &block) register(:pre, name, &block) end
# File lib/kafo/hooking.rb, line 80 def register_pre_commit(name, &block) register(:pre_commit, name, &block) end
# File lib/kafo/hooking.rb, line 92 def register_pre_exit(name, &block) register(:pre_exit, name, &block) end
# File lib/kafo/hooking.rb, line 60 def register_pre_migrations(name, &block) register(:pre_migrations, name, &block) end
# File lib/kafo/hooking.rb, line 76 def register_pre_validations(name, &block) register(:pre_validations, name, &block) end
# File lib/kafo/hooking.rb, line 72 def register_pre_values(name, &block) register(:pre_values, name, &block) end
Private Instance Methods
# File lib/kafo/hooking.rb, line 98 def register(group, name, &block) self.hooks[group][name] = block end