Class: Bolt::PAL

Inherits:
Object
  • Object
show all
Defined in:
lib/bolt/pal.rb,
lib/bolt/pal/issues.rb,
lib/bolt/pal/yaml_plan.rb,
lib/bolt/pal/yaml_plan/step.rb,
lib/bolt/pal/yaml_plan/loader.rb,
lib/bolt/pal/yaml_plan/evaluator.rb,
lib/bolt/pal/yaml_plan/parameter.rb,
lib/bolt/pal/yaml_plan/step/eval.rb,
lib/bolt/pal/yaml_plan/step/plan.rb,
lib/bolt/pal/yaml_plan/step/task.rb,
lib/bolt/pal/yaml_plan/transpiler.rb,
lib/bolt/pal/yaml_plan/step/script.rb,
lib/bolt/pal/yaml_plan/step/upload.rb,
lib/bolt/pal/yaml_plan/step/command.rb,
lib/bolt/pal/yaml_plan/step/resources.rb

Defined Under Namespace

Modules: Issues Classes: PALError, YamlPlan

Constant Summary collapse

BOLTLIB_PATH = 
File.expand_path('../../bolt-modules', __dir__)
MODULES_PATH = 
File.expand_path('../../modules', __dir__)

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(modulepath, hiera_config, max_compiles = Etc.nprocessors) ⇒ PAL

Returns a new instance of PAL.



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/bolt/pal.rb', line 42

def initialize(modulepath, hiera_config, max_compiles = Etc.nprocessors)
  # Nothing works without initialized this global state. Reinitializing
  # is safe and in practice only happens in tests
  self.class.load_puppet

  @original_modulepath = modulepath
  @modulepath = [BOLTLIB_PATH, *modulepath, MODULES_PATH]
  @hiera_config = hiera_config
  @max_compiles = max_compiles

  @logger = Logging.logger[self]
  if modulepath && !modulepath.empty?
    @logger.info("Loading modules from #{@modulepath.join(File::PATH_SEPARATOR)}")
  end

  @loaded = false
end

Instance Attribute Details

#modulepath ⇒ Object (readonly)

Returns the value of attribute modulepath.



40
41
42
 
# File 'lib/bolt/pal.rb', line 40

def modulepath
  @modulepath
end

Class Method Details

.configure_logging ⇒ Object

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



61
62
63
64
65
66
67
 
# File 'lib/bolt/pal.rb', line 61

def self.configure_logging
  Puppet::Util::Log.destinations.clear
  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 



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/bolt/pal.rb', line 69

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 'puppet_pal'
  rescue LoadError
    raise Bolt::Error.new("Puppet must be installed to execute tasks", "bolt/puppet-missing")
  end

  require 'bolt/pal/logging'
  require 'bolt/pal/issues'
  require 'bolt/pal/yaml_plan/loader'
  require 'bolt/pal/yaml_plan/transpiler'

  # 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”.



108
109
110
111
 
# File 'lib/bolt/pal.rb', line 108

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

#convert_plan(plan_path) ⇒ Object 



318
319
320
321
322
 
# File 'lib/bolt/pal.rb', line 318

def convert_plan(plan_path)
  Puppet[:tasks] = true
  transpiler = YamlPlan::Transpiler.new
  transpiler.transpile(plan_path)
end

#get_plan_info(plan_name) ⇒ Object 



304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/bolt/pal.rb', line 304

def get_plan_info(plan_name)
  plan_info = in_bolt_compiler do |compiler|
    plan = compiler.plan_signature(plan_name)
    hash = plan_hash(plan_name, plan) if plan
    hash['module'] = plan.instance_variable_get(:@plan_func).loader.parent.path if plan
    hash
  end

  if plan_info.nil?
    raise Bolt::Error.unknown_plan(plan_name)
  end
  plan_info
end

#get_task_info(task_name) ⇒ Object 



263
264
265
266
267
268
269
270
271
 
# File 'lib/bolt/pal.rb', line 263

def get_task_info(task_name)
  task = task_signature(task_name)

  if task.nil?
    raise Bolt::Error.unknown_task(task_name)
  end

  task.task_hash.reject { |k, _| k == 'parameters' }
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.



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/bolt/pal.rb', line 116

def in_bolt_compiler
  # TODO: If we always call this inside a bolt_executor we can remove this here
  setup
  r = Puppet::Pal.in_tmp_environment('bolt', modulepath: @modulepath, facts: {}) do |pal|
    pal.with_script_compiler do |compiler|
      alias_types(compiler)
      begin
        Puppet.override(yaml_plan_instantiator: Bolt::PAL::YamlPlan::Loader) do
          yield compiler
        end
      rescue Bolt::Error => e
        e
      rescue Puppet::PreformattedError => e
        PALError.from_preformatted_error(e)
      rescue StandardError => e
        PALError.from_preformatted_error(e)
      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, applicator = nil) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/bolt/pal.rb', line 165

def in_plan_compiler(executor, inventory, pdb_client, applicator = nil)
  with_bolt_executor(executor, inventory, pdb_client, applicator) 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 



178
179
180
181
182
183
184
 
# File 'lib/bolt/pal.rb', line 178

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

#list_modulepath ⇒ Object 



222
223
224
 
# File 'lib/bolt/pal.rb', line 222

def list_modulepath
  @modulepath - [BOLTLIB_PATH, MODULES_PATH]
end

#list_modules ⇒ Hash{String => Array<Hash{Symbol => String,nil}>}

Returns a mapping of all modules available to the Bolt compiler

Returns:

  • (Hash{String => Array<Hash{Symbol => String,nil}>}) —

    A hash that associates each directory on the module path with an array containing a hash of information for each module in that directory. The information hash provides the name, version, and a string indicating whether the module belongs to an internal module group.



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/bolt/pal.rb', line 331

def list_modules
  internal_module_groups = { BOLTLIB_PATH => 'Plan Language Modules',
                             MODULES_PATH => 'Packaged Modules' }

  in_bolt_compiler do
    # NOTE: Can replace map+to_h with transform_values when Ruby 2.4
    #       is the minimum supported version.
    Puppet.lookup(:current_environment).modules_by_path.map do |path, modules|
      module_group = internal_module_groups[path]

      values = modules.map do |mod|
        mod_info = { name: (mod.forge_name || mod.name),
                     version: mod.version }
        mod_info[:internal_module_group] = module_group unless module_group.nil?

        mod_info
      end

      [path, values]
    end.to_h
  end
end

#list_plans ⇒ Object 



273
274
275
276
277
278
279
280
281
282
 
# File 'lib/bolt/pal.rb', line 273

def list_plans
  in_bolt_compiler do |compiler|
    errors = []
    plans = compiler.list_plans(nil, errors).map { |plan| [plan.name] }.sort
    errors.each do |error|
      @logger.warn(error.details['original_error'])
    end
    plans
  end
end

#list_tasks ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/bolt/pal.rb', line 210

def list_tasks
  in_bolt_compiler do |compiler|
    tasks = compiler.list_tasks
    tasks.map(&:name).sort.each_with_object([]) do |task_name, data|
      task_sig = compiler.task_signature(task_name)
      unless task_sig.task_hash['metadata']['private']
        data << [task_name, task_sig.task_hash['metadata']['description']]
      end
    end
  end
end

#parse_manifest(code, filename) ⇒ Object

Parses a snippet of Puppet manifest code and returns the AST represented in JSON.



203
204
205
206
207
208
 
# File 'lib/bolt/pal.rb', line 203

def parse_manifest(code, filename)
  setup
  Puppet::Pops::Parser::EvaluatingParser.new.parse_string(code, filename)
rescue Puppet::Error => e
  raise Bolt::PAL::PALError, "Failed to parse manifest: #{e}"
end

#parse_params(type, object_name, params) ⇒ Object 



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/bolt/pal.rb', line 226

def parse_params(type, object_name, params)
  in_bolt_compiler do |compiler|
    if type == 'task'
      param_spec = compiler.task_signature(object_name)&.task_hash&.dig('parameters')
    elsif type == 'plan'
      plan = compiler.plan_signature(object_name)
      param_spec = plan.params_type.elements&.each_with_object({}) { |t, h| h[t.name] = t.value_type } if plan
    end
    param_spec ||= {}

    params.each_with_object({}) do |(name, str), acc|
      type = param_spec[name]
      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

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



361
362
363
364
365
366
367
368
 
# File 'lib/bolt/pal.rb', line 361

def run_plan(plan_name, params, executor = nil, inventory = nil, pdb_client = nil, applicator = nil)
  in_plan_compiler(executor, inventory, pdb_client, applicator) 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) ⇒ Object 



354
355
356
357
358
359
 
# File 'lib/bolt/pal.rb', line 354

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

#setup ⇒ Object 



93
94
95
96
97
98
99
100
101
102
 
# File 'lib/bolt/pal.rb', line 93

def setup
  unless @loaded
    # This is slow so don't do it until we have to
    Bolt::PAL.load_puppet

    # Make sure we don't create the puppet directories
    with_puppet_settings { |_| nil }
    @loaded = true
  end
end

#task_signature(task_name) ⇒ Object 



257
258
259
260
261
 
# File 'lib/bolt/pal.rb', line 257

def task_signature(task_name)
  in_bolt_compiler do |compiler|
    compiler.task_signature(task_name)
  end
end

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



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/bolt/pal.rb', line 143

def with_bolt_executor(executor, inventory, pdb_client = nil, applicator = nil, &block)
  setup
  opts = {
    bolt_executor: executor,
    bolt_inventory: inventory,
    bolt_pdb_client: pdb_client,
    apply_executor: applicator || Applicator.new(
      inventory,
      executor,
      @modulepath,
      # Skip syncing built-in plugins, since we vendor some Puppet 6
      # versions of "core" types, which are already present on the agent,
      # but may cause issues on Puppet 5 agents.
      @original_modulepath,
      pdb_client,
      @hiera_config,
      @max_compiles
    )
  }
  Puppet.override(opts, &block)
end

#with_puppet_settings ⇒ Object

TODO: PUP-8553 should replace this



187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/bolt/pal.rb', line 187

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)
    Puppet::GettextConfig.create_default_text_domain
    self.class.configure_logging
    yield
  end
end