class Kafo::HookContext

Attributes

kafo[R]

Public Class Methods

execute(kafo, &hook) click to toggle source
# File lib/kafo/hook_context.rb, line 8
def self.execute(kafo, &hook)
  new(kafo).instance_eval(&hook)
end
new(kafo) click to toggle source
# File lib/kafo/hook_context.rb, line 12
def initialize(kafo)
  @kafo = kafo
end

Public Instance Methods

add_module(module_name, mapping = nil) click to toggle source

You can add custom modules not explicitly enabled in answer file. This is especially useful if you want to add your plugin to existing installer. This module will become part of answer file so it also preserves parameter values between runs. It also list its options in help output. You can also specify mapping for this module as a second parameter. examples:

add_module('my_module')
add_module('foreman::plugin::staypuft', {:dir_name => 'foreman', :manifest_name => 'plugin/staypuft'})
# File lib/kafo/hook_context.rb, line 61
def add_module(module_name, mapping = nil)
  self.kafo.config.add_mapping(module_name, mapping) if mapping
  self.kafo.add_module(module_name)
end
app_option(*args) click to toggle source

if you want to add new #app_option be sure to do as soon as possible (usually boot hook) otherwise it may be too late (e.g. when displaying help) examples:

app_option '--log-level', 'LEVEL', 'Log level for log file output', :default => config.app[:log_level]:
app_option ['-n', '--noop'], :flag, 'Run puppet in noop mode?', :default => false
# File lib/kafo/hook_context.rb, line 29
def app_option(*args)
  self.kafo.class.app_option(*args)
end
app_option?(option) click to toggle source

Returns whether the given app option exists. This is useful when there's a conditional option that is determined during boot; this helper can be used in later hooks to determine whether the option exists.

# File lib/kafo/hook_context.rb, line 35
def app_option?(option)
  self.kafo.config.app.key?(option.to_sym)
end
app_value(option) click to toggle source

examples:

app_value(:log_level)

note the dash to underscore convention

# File lib/kafo/hook_context.rb, line 42
def app_value(option)
  self.kafo.config.app[option.to_sym]
end
exit(code) click to toggle source

You can trigger installer exit by this method. You must specify exit code as a first argument. You can also specify a symbol alias which is built-in (see exit_handler.rb for more details). examples:

exit(0)
exit(:manifest_error)
# File lib/kafo/hook_context.rb, line 88
def exit(code)
  self.kafo.class.exit(code)
end
get_custom_config(key) click to toggle source

You can load a custom config value that has been saved using #store_custom_config

# File lib/kafo/hook_context.rb, line 93
def get_custom_config(key)
  self.kafo.config.get_custom(key)
end
get_custom_fact(key) click to toggle source

Load a custom fact from the custom fact storage as saved by #store_custom_fact

# File lib/kafo/hook_context.rb, line 104
def get_custom_fact(key)
  self.kafo.config.get_custom_fact(key)
end
logger() click to toggle source

some of hooks won't print any message because logger is not yet configured configuration of logger depends on application configration (log level etc.) examples:

logger.warn "this combindation of parameters is untested"
# File lib/kafo/hook_context.rb, line 20
def logger
  self.kafo.logger
end
module_enabled?(module_name) click to toggle source

Check if a module is enabled in the current configuration. examples:

module_enabled?('example')
# File lib/kafo/hook_context.rb, line 69
def module_enabled?(module_name)
  mod = self.kafo.module(module_name)
  !mod.nil? && mod.enabled?
end
module_present?(module_name) click to toggle source

Check if a module is present in the current configuration. examples:

module_present?('example')
# File lib/kafo/hook_context.rb, line 77
def module_present?(module_name)
  mod = self.kafo.module(module_name)
  !mod.nil?
end
param(module_name, parameter_name) click to toggle source

examples:

param('foreman', 'interface').value = 'eth0'
param('foreman', 'interface').value = app_option('bind_on_interface')
# File lib/kafo/hook_context.rb, line 49
def param(module_name, parameter_name)
  self.kafo.param(module_name, parameter_name)
end
scenario_data() click to toggle source

Return the actual data in the current scenario

# File lib/kafo/hook_context.rb, line 128
def scenario_data
  self.kafo.config.app
end
scenario_id() click to toggle source

Return the id of the current scenario

# File lib/kafo/hook_context.rb, line 118
def scenario_id
  self.kafo.config.scenario_id
end
scenario_path() click to toggle source

Return the path to the current scenario

# File lib/kafo/hook_context.rb, line 123
def scenario_path
  self.kafo.config.config_file
end
store_custom_config(key, value) click to toggle source

You can save any value into kafo configuration file, this is useful if you need to share a value between more hooks and persist the values for next run

# File lib/kafo/hook_context.rb, line 99
def store_custom_config(key, value)
  self.kafo.config.set_custom(key, value)
end
store_custom_fact(key, value) click to toggle source

Store a any custom fact. This will show up as kafo.scenario.custom.your_fact. It is possible to use structures such as arrays and hashes besides the obvious ones such as strings, integers, booleans.

These facts can also be used in Hiera hierachy definitions.

# File lib/kafo/hook_context.rb, line 113
def store_custom_fact(key, value)
  self.kafo.config.set_custom_fact(key, value)
end