Class: Bolt::CLI

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

Constant Summary collapse

COMMANDS = 
{ 'command' => %w[run],
'script' => %w[run],
'task' => %w[show run],
'plan' => %w[show run convert],
'file' => %w[upload],
'puppetfile' => %w[install show-modules generate-types],
'secret' => %w[encrypt decrypt createkeys],
'inventory' => %w[show],
'group' => %w[show],
'apply' => %w[] }.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(argv) ⇒ CLI

Returns a new instance of CLI.



44
45
46
47
48
49
50
 
# File 'lib/bolt/cli.rb', line 44

def initialize(argv)
  Bolt::Logger.initialize_logging
  @logger = Logging.logger[self]
  @argv = argv
  @config = Bolt::Config.default
  @options = {}
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



42
43
44
 
# File 'lib/bolt/cli.rb', line 42

def config
  @config
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



42
43
44
 
# File 'lib/bolt/cli.rb', line 42

def options
  @options
end

Instance Method Details

#analytics ⇒ Object 



561
562
563
564
565
566
567
 
# File 'lib/bolt/cli.rb', line 561

def analytics
  @analytics ||= begin
                   client = Bolt::Analytics.build_client
                   client.bundled_content = bundled_content
                   client
                 end
end

#apply_manifest(code, targets, filename = nil, noop = false) ⇒ Object 



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
 
# File 'lib/bolt/cli.rb', line 460

def apply_manifest(code, targets, filename = nil, noop = false)
  ast = pal.parse_manifest(code, filename)

  executor = Bolt::Executor.new(config.concurrency, analytics, noop)
  executor.subscribe(outputter) if options.fetch(:format, 'human') == 'human'
  executor.subscribe(log_outputter)
  # apply logging looks like plan logging, so tell the outputter we're in a
  # plan even though we're not
  executor.publish_event(type: :plan_start, plan: nil)

  results = nil
  elapsed_time = Benchmark.realtime do
    pal.in_plan_compiler(executor, inventory, puppetdb_client) do |compiler|
      compiler.call_function('apply_prep', targets)
    end

    results = pal.with_bolt_executor(executor, inventory, puppetdb_client) do
      Puppet.lookup(:apply_executor).apply_ast(ast, targets, catch_errors: true, noop: noop)
    end
  end

  executor.shutdown
  outputter.print_apply_result(results, elapsed_time)
  rerun.update(results)

  results.ok ? 0 : 1
end

#bundled_content ⇒ Object 



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
# File 'lib/bolt/cli.rb', line 569

def bundled_content
  # We only need to enumerate bundled content when running a task or plan
  content = { 'Plan' => [],
              'Task' => [],
              'Plugin' => Bolt::Plugin::BUILTIN_PLUGINS }
  if %w[plan task].include?(options[:subcommand]) && options[:action] == 'run'
    default_content = Bolt::PAL.new([], nil, nil)
    content['Plan'] = default_content.list_plans.each_with_object([]) do |iter, col|
      col << iter&.first
    end
    content['Task'] = default_content.list_tasks.each_with_object([]) do |iter, col|
      col << iter&.first
    end
  end

  content
end

#convert_plan(plan) ⇒ Object 



537
538
539
 
# File 'lib/bolt/cli.rb', line 537

def convert_plan(plan)
  pal.convert_plan(plan)
end

#execute(options) ⇒ Object 



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/bolt/cli.rb', line 259

def execute(options)
  message = nil

  handler = Signal.trap :INT do |signo|
    @logger.info(
      "Exiting after receiving SIG#{Signal.signame(signo)} signal.#{message ? ' ' + message : ''}"
    )
    exit!
  end

  if options[:action] == 'convert'
    convert_plan(options[:object])
    return 0
  end

  screen = "#{options[:subcommand]}_#{options[:action]}"
  # submit a different screen for `bolt task show` and `bolt task show foo`
  if options[:action] == 'show' && options[:object]
    screen += '_object'
  end

  screen_view_fields = {
    output_format: config.format,
    boltdir_type: config.boltdir.type
  }

  # Only include target and inventory info for commands that take a targets
  # list. This avoids loading inventory for commands that don't need it.
  if options.key?(:targets)
    screen_view_fields.merge!(target_nodes: options[:targets].count,
                              inventory_nodes: inventory.node_names.count,
                              inventory_groups: inventory.group_names.count,
                              inventory_version: inventory.version)
  end

  analytics.screen_view(screen, screen_view_fields)

  if options[:action] == 'show'
    if options[:subcommand] == 'task'
      if options[:object]
        show_task(options[:object])
      else
        list_tasks
      end
    elsif options[:subcommand] == 'plan'
      if options[:object]
        show_plan(options[:object])
      else
        list_plans
      end
    elsif options[:subcommand] == 'inventory'
      list_targets
    elsif options[:subcommand] == 'group'
      list_groups
    end
    return 0
  elsif options[:action] == 'show-modules'
    list_modules
    return 0
  end

  message = 'There may be processes left executing on some nodes.'

  if %w[task plan].include?(options[:subcommand]) && options[:task_options] && !options[:params_parsed] && pal
    options[:task_options] = pal.parse_params(options[:subcommand], options[:object], options[:task_options])
  end

  case options[:subcommand]
  when 'plan'
    code = run_plan(options[:object], options[:task_options], options[:target_args], options)
  when 'puppetfile'
    if options[:action] == 'generate-types'
      code = generate_types
    elsif options[:action] == 'install'
      code = install_puppetfile(@config.puppetfile_config, @config.puppetfile, @config.modulepath)
    end
  when 'secret'
    code = Bolt::Secret.execute(plugins, outputter, options)
  when 'apply'
    if options[:object]
      validate_file('manifest', options[:object])
      options[:code] = File.read(File.expand_path(options[:object]))
    end
    code = apply_manifest(options[:code], options[:targets], options[:object], options[:noop])
  else
    executor = Bolt::Executor.new(config.concurrency, analytics, options[:noop])
    targets = options[:targets]

    results = nil
    outputter.print_head

    elapsed_time = Benchmark.realtime do
      executor_opts = {}
      executor_opts[:description] = options[:description] if options.key?(:description)
      executor.subscribe(outputter)
      executor.subscribe(log_outputter)
      results =
        case options[:subcommand]
        when 'command'
          executor.run_command(targets, options[:object], executor_opts)
        when 'script'
          script = options[:object]
          validate_file('script', script)
          executor.run_script(targets, script, options[:leftovers], executor_opts)
        when 'task'
          pal.run_task(options[:object],
                       targets,
                       options[:task_options],
                       executor,
                       inventory,
                       options[:description])
        when 'file'
          src = options[:object]
          dest = options[:leftovers].first

          if dest.nil?
            raise Bolt::CLIError, "A destination path must be specified"
          end
          validate_file('source file', src, true)
          executor.upload_file(targets, src, dest, executor_opts)
        end
    end

    executor.shutdown
    rerun.update(results)

    outputter.print_summary(results, elapsed_time)
    code = results.ok ? 0 : 2
  end
  code
rescue Bolt::Error => e
  outputter.fatal_error(e)
  raise e
ensure
  # restore original signal handler
  Signal.trap :INT, handler if handler
  analytics&.finish
end

#generate_types ⇒ Object 



492
493
494
495
496
 
# File 'lib/bolt/cli.rb', line 492

def generate_types
  # generate_types will surface a nice error with helpful message if it fails
  pal.generate_types
  0
end

#handle_parser_errors ⇒ Object 



235
236
237
238
239
240
241
242
243
 
# File 'lib/bolt/cli.rb', line 235

def handle_parser_errors
  yield
rescue OptionParser::MissingArgument => e
  raise Bolt::CLIError, "Option '#{e.args.first}' needs a parameter"
rescue OptionParser::InvalidArgument => e
  raise Bolt::CLIError, "Invalid parameter specified for option '#{e.args.first}': #{e.args[1]}"
rescue OptionParser::InvalidOption, OptionParser::AmbiguousOption => e
  raise Bolt::CLIError, "Unknown argument '#{e.args.first}'"
end

#install_puppetfile(config, puppetfile, modulepath) ⇒ Object 



498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'lib/bolt/cli.rb', line 498

def install_puppetfile(config, puppetfile, modulepath)
  require 'r10k/cli'
  require 'bolt/r10k_log_proxy'

  if puppetfile.exist?
    moduledir = modulepath.first.to_s
    r10k_opts = {
      root: puppetfile.dirname.to_s,
      puppetfile: puppetfile.to_s,
      moduledir: moduledir
    }

    settings = R10K::Settings.global_settings.evaluate(config)
    R10K::Initializers::GlobalInitializer.new(settings).call
    install_action = R10K::Action::Puppetfile::Install.new(r10k_opts, nil)

    # Override the r10k logger with a proxy to our own logger
    R10K::Logging.instance_variable_set(:@outputter, Bolt::R10KLogProxy.new)

    ok = install_action.call
    outputter.print_puppetfile_result(ok, puppetfile, moduledir)
    # Automatically generate types after installing modules
    pal.generate_types

    ok ? 0 : 1
  else
    raise Bolt::FileError.new("Could not find a Puppetfile at #{puppetfile}", puppetfile)
  end
rescue R10K::Error => e
  raise PuppetfileError, e
end

#list_groups ⇒ Object 



419
420
421
422
 
# File 'lib/bolt/cli.rb', line 419

def list_groups
  groups = inventory.group_names
  outputter.print_groups(groups)
end

#list_modules ⇒ Object 



488
489
490
 
# File 'lib/bolt/cli.rb', line 488

def list_modules
  outputter.print_module_list(pal.list_modules)
end

#list_plans ⇒ Object 



410
411
412
 
# File 'lib/bolt/cli.rb', line 410

def list_plans
  outputter.print_plans(pal.list_plans, pal.list_modulepath)
end

#list_targets ⇒ Object 



414
415
416
417
 
# File 'lib/bolt/cli.rb', line 414

def list_targets
  update_targets(options)
  outputter.print_targets(options)
end

#list_tasks ⇒ Object 



402
403
404
 
# File 'lib/bolt/cli.rb', line 402

def list_tasks
  outputter.print_tasks(pal.list_tasks, pal.list_modulepath)
end

#log_outputter ⇒ Object 



557
558
559
 
# File 'lib/bolt/cli.rb', line 557

def log_outputter
  @log_outputter ||= Bolt::Outputter::Logger.new(options[:verbose], config.trace)
end

#outputter ⇒ Object 



553
554
555
 
# File 'lib/bolt/cli.rb', line 553

def outputter
  @outputter ||= Bolt::Outputter.for_format(config.format, config.color, options[:verbose], config.trace)
end

#pal ⇒ Object 



530
531
532
533
534
535
 
# File 'lib/bolt/cli.rb', line 530

def pal
  @pal ||= Bolt::PAL.new(config.modulepath,
                         config.hiera_config,
                         config.boltdir.resource_types,
                         config.compile_concurrency)
end

#parse ⇒ Object 



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
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
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/bolt/cli.rb', line 78

def parse
  parser = BoltOptionParser.new(options)
  # This part aims to handle both `bolt <mode> --help` and `bolt help <mode>`.
  remaining = handle_parser_errors { parser.permute(@argv) } unless @argv.empty?
  if @argv.empty? || help?(remaining)
    # Update the parser for the subcommand (or lack thereof)
    parser.update
    puts parser.help
    raise Bolt::CLIExit
  end

  options[:object] = remaining.shift

  # Only parse task_options for task or plan
  if %w[task plan].include?(options[:subcommand])
    task_options, remaining = remaining.partition { |s| s =~ /.+=/ }
    if options[:task_options]
      unless task_options.empty?
        raise Bolt::CLIError,
              "Parameters must be specified through either the --params " \
              "option or param=value pairs, not both"
      end
      options[:params_parsed] = true
    else
      options[:params_parsed] = false
      options[:task_options] = Hash[task_options.map { |a| a.split('=', 2) }]
    end
  end
  options[:leftovers] = remaining

  validate(options)

  @config = if options[:configfile]
              Bolt::Config.from_file(options[:configfile], options)
            else
              boltdir = if options[:boltdir]
                          Bolt::Boltdir.new(options[:boltdir])
                        else
                          Bolt::Boltdir.find_boltdir(Dir.pwd)
                        end
              Bolt::Config.from_boltdir(boltdir, options)
            end

  # Set $future global if configured
  # rubocop:disable Style/GlobalVars
  $future = @config.future
  # rubocop:enable Style/GlobalVars

  Bolt::Logger.configure(config.log, config.color)

  # Logger must be configured before checking path case, otherwise warnings will not display
  @config.check_path_case('modulepath', @config.modulepath)

  # After validation, initialize inventory and targets. Errors here are better to catch early.
  # After this step
  # options[:target_args] will contain a string/array version of the targetting options this is passed to plans
  # options[:targets] will contain a resolved set of Target objects
  unless options[:subcommand] == 'puppetfile' ||
         options[:subcommand] == 'secret' ||
         options[:action] == 'show' ||
         options[:action] == 'convert'

    update_targets(options)
  end

  unless options.key?(:verbose)
    # Default to verbose for everything except plans
    options[:verbose] = options[:subcommand] != 'plan'
  end

  options
rescue Bolt::Error => e
  outputter.fatal_error(e)
  raise e
end

#plugins ⇒ Object 



251
252
253
 
# File 'lib/bolt/cli.rb', line 251

def plugins
  @plugins ||= Bolt::Plugin.setup(config, pal, puppetdb_client, analytics)
end

#puppetdb_client ⇒ Object 



245
246
247
248
249
 
# File 'lib/bolt/cli.rb', line 245

def puppetdb_client
  return @puppetdb_client if @puppetdb_client
  puppetdb_config = Bolt::PuppetDB::Config.load_config(nil, config.puppetdb)
  @puppetdb_client = Bolt::PuppetDB::Client.new(puppetdb_config)
end

#query_puppetdb_nodes(query) ⇒ Object 



255
256
257
 
# File 'lib/bolt/cli.rb', line 255

def query_puppetdb_nodes(query)
  puppetdb_client.query_certnames(query)
end

#rerun ⇒ Object 



549
550
551
 
# File 'lib/bolt/cli.rb', line 549

def rerun
  @rerun ||= Bolt::Rerun.new(@config.rerunfile, @config.save_rerun)
end

#run_plan(plan_name, plan_arguments, nodes, options) ⇒ Object 



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/bolt/cli.rb', line 424

def run_plan(plan_name, plan_arguments, nodes, options)
  unless nodes.empty?
    if plan_arguments['nodes']
      raise Bolt::CLIError,
            "A plan's 'nodes' parameter may be specified using the --nodes option, but in that " \
            "case it must not be specified as a separate nodes=<value> parameter nor included " \
            "in the JSON data passed in the --params option"
    end
    plan_arguments['nodes'] = nodes.join(',')
  end

  plan_context = { plan_name: plan_name,
                   params: plan_arguments }
  plan_context[:description] = options[:description] if options[:description]

  executor = Bolt::Executor.new(config.concurrency, analytics, options[:noop])
  if options.fetch(:format, 'human') == 'human'
    executor.subscribe(outputter)
  else
    # Only subscribe to out::message events for JSON outputter
    executor.subscribe(outputter, [:message])
  end

  executor.subscribe(log_outputter)
  executor.start_plan(plan_context)
  result = pal.run_plan(plan_name, plan_arguments, executor, inventory, puppetdb_client)

  # If a non-bolt exception bubbles up the plan won't get finished
  executor.finish_plan(result)
  executor.shutdown
  rerun.update(result)

  outputter.print_plan_result(result)
  result.ok? ? 0 : 1
end

#show_plan(plan_name) ⇒ Object 



406
407
408
 
# File 'lib/bolt/cli.rb', line 406

def show_plan(plan_name)
  outputter.print_plan_info(pal.get_plan_info(plan_name))
end

#show_task(task_name) ⇒ Object 



398
399
400
 
# File 'lib/bolt/cli.rb', line 398

def show_task(task_name)
  outputter.print_task_info(pal.get_task_info(task_name))
end

#update_targets(options) ⇒ Object 



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/bolt/cli.rb', line 154

def update_targets(options)
  target_opts = options.keys.select { |opt| %i[query rerun nodes targets].include?(opt) }
  target_string = "'--nodes', '--targets', '--rerun', or '--query'"
  if target_opts.length > 1
    raise Bolt::CLIError, "Only one targeting option #{target_string} may be specified"
  elsif target_opts.empty? && options[:subcommand] != 'plan'
    raise Bolt::CLIError, "Command requires a targeting option: #{target_string}"
  end

  nodes = if options[:query]
            query_puppetdb_nodes(options[:query])
          elsif options[:rerun]
            rerun.get_targets(options[:rerun])
          else
            options[:targets] || options[:nodes] || []
          end
  options[:target_args] = nodes
  options[:targets] = inventory.get_targets(nodes)
end

#validate(options) ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/bolt/cli.rb', line 174

def validate(options)
  unless COMMANDS.include?(options[:subcommand])
    raise Bolt::CLIError,
          "Expected subcommand '#{options[:subcommand]}' to be one of " \
          "#{COMMANDS.keys.join(', ')}"
  end

  actions = COMMANDS[options[:subcommand]]
  if actions.any?
    if options[:action].nil?
      raise Bolt::CLIError,
            "Expected an action of the form 'bolt #{options[:subcommand]} <action>'"
    end

    unless actions.include?(options[:action])
      raise Bolt::CLIError,
            "Expected action '#{options[:action]}' to be one of " \
            "#{actions.join(', ')}"
    end
  end

  if options[:subcommand] != 'file' && options[:subcommand] != 'script' &&
     !options[:leftovers].empty?
    raise Bolt::CLIError,
          "Unknown argument(s) #{options[:leftovers].join(', ')}"
  end

  if %w[task plan].include?(options[:subcommand]) && options[:action] == 'run'
    if options[:object].nil?
      raise Bolt::CLIError, "Must specify a #{options[:subcommand]} to run"
    end
    # This may mean that we parsed a parameter as the object
    unless options[:object] =~ /\A([a-z][a-z0-9_]*)?(::[a-z][a-z0-9_]*)*\Z/
      raise Bolt::CLIError,
            "Invalid #{options[:subcommand]} '#{options[:object]}'"
    end
  end

  if options[:boltdir] && options[:configfile]
    raise Bolt::CLIError, "Only one of '--boltdir' or '--configfile' may be specified"
  end

  if options[:noop] &&
     !(options[:subcommand] == 'task' && options[:action] == 'run') && options[:subcommand] != 'apply'
    raise Bolt::CLIError,
          "Option '--noop' may only be specified when running a task or applying manifest code"
  end

  if options[:subcommand] == 'apply' && (options[:object] && options[:code])
    raise Bolt::CLIError, "--execute is unsupported when specifying a manifest file"
  end

  if options[:subcommand] == 'apply' && (!options[:object] && !options[:code])
    raise Bolt::CLIError, "a manifest file or --execute is required"
  end

  if options[:subcommand] == 'command' && (!options[:object] || options[:object].empty?)
    raise Bolt::CLIError, "Must specify a command to run"
  end
end

#validate_file(type, path, allow_dir = false) ⇒ Object 



541
542
543
544
545
546
547
 
# File 'lib/bolt/cli.rb', line 541

def validate_file(type, path, allow_dir = false)
  if path.nil?
    raise Bolt::CLIError, "A #{type} must be specified"
  end

  Bolt::Util.validate_file(type, path, allow_dir)
end