Class: Kafo::HookContext
- Inherits:
-
Object
- Object
- Kafo::HookContext
- Defined in:
- lib/kafo/hook_context.rb
Instance Attribute Summary collapse
-
#kafo ⇒ Object
readonly
Returns the value of attribute kafo.
Class Method Summary collapse
Instance Method Summary collapse
-
#add_module(module_name, mapping = nil) ⇒ Object
You can add custom modules not explicitly enabled in answer file.
-
#app_option(*args) ⇒ Object
if you want to add new app_option be sure to do as soon as possible (usually boot hook) otherwise it may be to late (e.g. when displaying help) examples: app_option ‘–log-level’, ‘LEVEL’, ‘Log level for log file output’, :default => config.app: app_option [‘-n’, ‘–noop’], :flag, ‘Run puppet in noop mode?’, :default => false.
-
#app_value(option) ⇒ Object
examples: app_value(:log_level) note the dash to underscore convention.
-
#exit(code) ⇒ Object
You can trigger installer exit by this method.
-
#get_custom_config(key) ⇒ Object
You can load a custom config value that has been saved using store_custom_config.
-
#initialize(kafo) ⇒ HookContext
constructor
A new instance of HookContext.
-
#logger ⇒ Object
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”.
-
#param(module_name, parameter_name) ⇒ Object
examples: param(‘foreman’, ‘interface’).value = ‘eth0’ param(‘foreman’, ‘interface’).value = app_option(‘bind_on_interface’).
-
#store_custom_config(key, value) ⇒ Object
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.
Constructor Details
#initialize(kafo) ⇒ HookContext
Returns a new instance of HookContext.
16 17 18 |
# File 'lib/kafo/hook_context.rb', line 16 def initialize(kafo) @kafo = kafo end |
Instance Attribute Details
#kafo ⇒ Object (readonly)
Returns the value of attribute kafo.
3 4 5 |
# File 'lib/kafo/hook_context.rb', line 3 def kafo @kafo end |
Class Method Details
.execute(kafo, &hook) ⇒ Object
5 6 7 8 9 10 11 12 13 14 |
# File 'lib/kafo/hook_context.rb', line 5 def self.execute(kafo, &hook) # TODO can be removed in 0.6, is DEPRECATED since 0.5 # instance_exec can be later changed to instance eval when people stop using |kafo| in their hooks # and rely only on hook context DSL if hook.arity > 0 kafo.logger.warn "Hook '#{name}' is using block with arguments which is DEPRECATED, access to kafo instance is " + "provided by hook DSL, please remove |kafo| from your hook block" end new(kafo).instance_exec(kafo, &hook) end |
Instance Method Details
#add_module(module_name, mapping = nil) ⇒ Object
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'})
59 60 61 62 |
# File 'lib/kafo/hook_context.rb', line 59 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) ⇒ Object
if you want to add new app_option be sure to do as soon as possible (usually boot hook) otherwise it may be to 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
33 34 35 |
# File 'lib/kafo/hook_context.rb', line 33 def app_option(*args) self.kafo.class.app_option *args end |
#app_value(option) ⇒ Object
examples:
app_value(:log_level)
note the dash to underscore convention
40 41 42 |
# File 'lib/kafo/hook_context.rb', line 40 def app_value(option) self.kafo.config.app[option.to_sym] end |
#exit(code) ⇒ Object
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)
70 71 72 |
# File 'lib/kafo/hook_context.rb', line 70 def exit(code) self.kafo.exit(code) end |
#get_custom_config(key) ⇒ Object
You can load a custom config value that has been saved using store_custom_config
75 76 77 |
# File 'lib/kafo/hook_context.rb', line 75 def get_custom_config(key) self.kafo.config.get_custom(key) end |
#logger ⇒ Object
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"
24 25 26 |
# File 'lib/kafo/hook_context.rb', line 24 def logger self.kafo.logger end |
#param(module_name, parameter_name) ⇒ Object
examples:
param('foreman', 'interface').value = 'eth0'
param('foreman', 'interface').value = app_option('bind_on_interface')
47 48 49 |
# File 'lib/kafo/hook_context.rb', line 47 def param(module_name, parameter_name) self.kafo.param(module_name, parameter_name) end |
#store_custom_config(key, value) ⇒ Object
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
81 82 83 |
# File 'lib/kafo/hook_context.rb', line 81 def store_custom_config(key, value) self.kafo.config.set_custom(key, value) end |