Class: Bolt::PAL

Inherits:
Object
  • Object
show all
Defined in:
lib/bolt/pal.rb

Defined Under Namespace

Classes: PALError

Constant Summary collapse

BOLTLIB_PATH = 
File.join(__FILE__, '../../../bolt-modules')
MODULES_PATH = 
File.join(__FILE__, '../../../modules')

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ PAL

Returns a new instance of PAL.



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/bolt/pal.rb', line 38

def initialize(config)
  # Nothing works without initialized this global state. Reinitializing
  # is safe and in practice only happen in tests
  self.class.load_puppet

  # This makes sure we don't accidentally create puppet dirs
  with_puppet_settings { |_| nil }

  @config = config
end

Class Method Details

.configure_logging ⇒ Object

Puppet logging is global so this is class method to avoid confusion



50
51
52
53
54
55
 
# File 'lib/bolt/pal.rb', line 50

def self.configure_logging
  Puppet::Util::Log.newdestination(Logging.logger['Puppet'])
  # Defer all log level decisions to the Logging library by telling Puppet
  # to log everything
  Puppet.settings[:log_level] = 'debug'
end

.load_puppet ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/bolt/pal.rb', line 57

def self.load_puppet
  if Bolt::Util.windows?
    # Windows 'fix' for openssl behaving strangely. Prevents very slow operation
    # of random_bytes later when establishing winrm connections from a Windows host.
    # See https://github.com/rails/rails/issues/25805 for background.
    require 'openssl'
    OpenSSL::Random.random_bytes(1)
  end

  begin
    require_relative '../../vendored/require_vendored'
    require 'puppet_pal'
  rescue LoadError
    raise Bolt::Error.new("Puppet must be installed to execute tasks", "bolt/puppet-missing")
  end

  require 'bolt/pal/logging'

  # Now that puppet is loaded we can include puppet mixins in data types
  Bolt::ResultSet.include_iterable
end

Instance Method Details

#alias_types(compiler) ⇒ Object

Create a top-level alias for TargetSpec and PlanResult so that users don’t have to namespace it with Boltlib, which is just an implementation detail. This allows them to feel like a built-in type in bolt, rather than something has been, no pun intended, “bolted on”.



83
84
85
86
 
# File 'lib/bolt/pal.rb', line 83

def alias_types(compiler)
  compiler.evaluate_string('type TargetSpec = Boltlib::TargetSpec')
  compiler.evaluate_string('type PlanResult = Boltlib::PlanResult')
end

#full_modulepath(modulepath) ⇒ Object 



88
89
90
 
# File 'lib/bolt/pal.rb', line 88

def full_modulepath(modulepath)
  [BOLTLIB_PATH, *modulepath, MODULES_PATH]
end

#get_plan_info(plan_name) ⇒ Object 



229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/bolt/pal.rb', line 229

def get_plan_info(plan_name)
  plan_info = in_bolt_compiler do |compiler|
    plan = compiler.plan_signature(plan_name)
    plan_hash(plan_name, plan) if plan
  end

  if plan_info.nil?
    raise Bolt::Error.new(Bolt::Error.unknown_plan(plan_name), 'bolt/unknown-plan')
  end
  plan_info
end

#get_task_info(task_name) ⇒ Object 



196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/bolt/pal.rb', line 196

def get_task_info(task_name)
  task = in_bolt_compiler do |compiler|
    compiler.task_signature(task_name)
  end

  if task.nil?
    raise Bolt::Error.new(Bolt::Error.unknown_task(task_name), 'bolt/unknown-task')
  end

  task.task_hash
end

#in_bolt_compiler ⇒ Object

Runs a block in a PAL script compiler configured for Bolt. Catches exceptions thrown by the block and re-raises them ensuring they are Bolt::Errors since the script compiler block will squash all exceptions.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/bolt/pal.rb', line 95

def in_bolt_compiler
  r = Puppet::Pal.in_tmp_environment('bolt', modulepath: full_modulepath(@config[:modulepath]), facts: {}) do |pal|
    pal.with_script_compiler do |compiler|
      alias_types(compiler)
      begin
        yield compiler
      rescue Puppet::PreformattedError => err
        PALError.from_preformatted_error(err)
      rescue StandardError => err
        PALError.from_preformatted_error(err)
      end
    end
  end

  # Plans may return PuppetError but nothing should be throwing them
  if r.is_a?(StandardError) && !r.is_a?(Bolt::PuppetError)
    raise r
  end
  r
end

#in_plan_compiler(executor, inventory, pdb_client) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/bolt/pal.rb', line 120

def in_plan_compiler(executor, inventory, pdb_client)
  with_bolt_executor(executor, inventory, pdb_client) do
    # TODO: remove this call and see if anything breaks when
    # settings dirs don't actually exist. Plans shouldn't
    # actually be using them.
    with_puppet_settings do
      in_bolt_compiler do |compiler|
        yield compiler
      end
    end
  end
end

#in_task_compiler(executor, inventory) ⇒ Object 



133
134
135
136
137
138
139
 
# File 'lib/bolt/pal.rb', line 133

def in_task_compiler(executor, inventory)
  with_bolt_executor(executor, inventory) do
    in_bolt_compiler do |compiler|
      yield compiler
    end
  end
end

#list_plans ⇒ Object 



208
209
210
211
212
 
# File 'lib/bolt/pal.rb', line 208

def list_plans
  in_bolt_compiler do |compiler|
    compiler.list_plans.map { |plan| [plan.name] }.sort
  end
end

#list_tasks ⇒ Object 



155
156
157
158
159
160
161
162
163
 
# File 'lib/bolt/pal.rb', line 155

def list_tasks
  in_bolt_compiler do |compiler|
    tasks = compiler.list_tasks
    tasks.map(&:name).sort.map do |task_name|
      task_sig = compiler.task_signature(task_name)
      [task_name, task_sig.task.description]
    end
  end
end

#parse_params(type, object_name, params) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/bolt/pal.rb', line 165

def parse_params(type, object_name, params)
  in_bolt_compiler do |compiler|
    if type == 'task'
      param_spec = compiler.task_signature(object_name)&.task_hash
    elsif type == 'plan'
      plan = compiler.plan_signature(object_name)
      param_spec = plan_hash(object_name, plan) if plan
    end
    param_spec ||= {}

    params.each_with_object({}) do |(name, str), acc|
      type = param_spec.dig('parameters', name, 'type')
      begin
        parsed = JSON.parse(str, quirks_mode: true)
        # The type may not exist if the module is remote on orch or if a task
        # defines no parameters. Since we treat no parameters as Any we
        # should parse everything in this case
        acc[name] = if type && !type.instance?(parsed)
                      str
                    else
                      parsed
                    end
      rescue JSON::ParserError
        # This value may not be assignable in which case run_* will error
        acc[name] = str
      end
      acc
    end
  end
end

#plan_hash(plan_name, plan) ⇒ Object

This converts a plan signature object into a format approximating the task_hash of a task_signature. Must be called from within bolt compiler to pickup type aliases used in the plan signature.



217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/bolt/pal.rb', line 217

def plan_hash(plan_name, plan)
  elements = plan.params_type.elements || []
  parameters = elements.each_with_object({}) do |param, acc|
    acc[param.name] = { 'type' => param.value_type }
    acc[param.name]['default_value'] = nil if param.key_type.is_a?(Puppet::Pops::Types::POptionalType)
  end
  {
    'name' => plan_name,
    'parameters' => parameters
  }
end

#run_plan(plan_name, params, executor = nil, inventory = nil, pdb_client = nil) ⇒ Object 



248
249
250
251
252
253
254
255
 
# File 'lib/bolt/pal.rb', line 248

def run_plan(plan_name, params, executor = nil, inventory = nil, pdb_client = nil)
  in_plan_compiler(executor, inventory, pdb_client) do |compiler|
    r = compiler.call_function('run_plan', plan_name, params.merge('_bolt_api_call' => true))
    Bolt::PlanResult.from_pcore(r, 'success')
  end
rescue Bolt::Error => e
  Bolt::PlanResult.new(e, 'failure')
end

#run_task(task_name, targets, params, executor, inventory, description = nil, &eventblock) ⇒ Object 



241
242
243
244
245
246
 
# File 'lib/bolt/pal.rb', line 241

def run_task(task_name, targets, params, executor, inventory, description = nil, &eventblock)
  in_task_compiler(executor, inventory) do |compiler|
    params = params.merge('_bolt_api_call' => true)
    compiler.call_function('run_task', task_name, targets, description, params, &eventblock)
  end
end

#with_bolt_executor(executor, inventory, pdb_client = nil, &block) ⇒ Object 



116
117
118
 
# File 'lib/bolt/pal.rb', line 116

def with_bolt_executor(executor, inventory, pdb_client = nil, &block)
  Puppet.override({ bolt_executor: executor, bolt_inventory: inventory, bolt_pdb_client: pdb_client }, &block)
end

#with_puppet_settings ⇒ Object

TODO: PUP-8553 should replace this



142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/bolt/pal.rb', line 142

def with_puppet_settings
  Dir.mktmpdir('bolt') do |dir|
    cli = []
    Puppet::Settings::REQUIRED_APP_SETTINGS.each do |setting|
      cli << "--#{setting}" << dir
    end
    Puppet.settings.send(:clear_everything_for_tests)
    Puppet.initialize_settings(cli)
    self.class.configure_logging
    yield
  end
end