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 new],
'file' => %w[download upload],
'puppetfile' => %w[install show-modules generate-types],
'secret' => %w[encrypt decrypt createkeys],
'inventory' => %w[show],
'group' => %w[show],
'project' => %w[init migrate],
'apply' => %w[],
'guide' => %w[] }.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(argv) ⇒ CLI

Returns a new instance of CLI.



47
48
49
50
51
52
 
# File 'lib/bolt/cli.rb', line 47

def initialize(argv)
  Bolt::Logger.initialize_logging
  @logger = Bolt::Logger.logger(self)
  @argv = argv
  @options = {}
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



45
46
47
 
# File 'lib/bolt/cli.rb', line 45

def config
  @config
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



45
46
47
 
# File 'lib/bolt/cli.rb', line 45

def options
  @options
end

Instance Method Details

#analytics ⇒ Object 



1017
1018
1019
1020
1021
1022
1023
 
# File 'lib/bolt/cli.rb', line 1017

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 



727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
 
# File 'lib/bolt/cli.rb', line 727

def apply_manifest(code, targets, filename = nil, noop = false)
  Puppet[:tasks] = false
  ast = pal.parse_manifest(code, filename)

  if defined?(ast.body) &&
     (ast.body.is_a?(Puppet::Pops::Model::HostClassDefinition) ||
     ast.body.is_a?(Puppet::Pops::Model::ResourceTypeDefinition))
    message = "Manifest only contains definitions and will result in no changes on the targets. "\
              "Definitions must be declared for their resources to be applied. You can read more "\
              "about defining and declaring classes and types in the Puppet documentation at "\
              "https://puppet.com/docs/puppet/latest/lang_classes.html and "\
              "https://puppet.com/docs/puppet/latest/lang_defined_types.html"
    @logger.warn(message)
  end

  executor = Bolt::Executor.new(config.concurrency, analytics, noop, config.modified_concurrency)
  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 



1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
 
# File 'lib/bolt/cli.rb', line 1025

def bundled_content
  # If the bundled content directory is empty, Bolt is likely installed as a gem.
  if ENV['BOLT_GEM'].nil? && incomplete_install?
    msg = <<~MSG.chomp
      Bolt may be installed as a gem. To use Bolt reliably and with all of its
      dependencies, uninstall the 'bolt' gem and install Bolt as a package:
      https://puppet.com/docs/bolt/latest/bolt_installing.html

      If you meant to install Bolt as a gem and want to disable this warning,
      set the BOLT_GEM environment variable.
    MSG

    @logger.warn(msg)
  end

  # 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

#execute(options) ⇒ Object 



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
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
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
459
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
487
488
489
490
491
492
493
494
495
496
497
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
 
# File 'lib/bolt/cli.rb', line 343

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

  # Initialize inventory and targets. Errors here are better to catch early.
  # 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 %w[project puppetfile secret guide].include?(options[:subcommand]) ||
         %w[convert new show].include?(options[:action])
    update_targets(options)
  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,
    # For continuity
    boltdir_type: config.project.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)

  case options[:action]
  when 'show'
    case options[:subcommand]
    when 'task'
      if options[:object]
        show_task(options[:object])
      else
        list_tasks
      end
    when 'plan'
      if options[:object]
        show_plan(options[:object])
      else
        list_plans
      end
    when 'inventory'
      if options[:detail]
        show_targets
      else
        list_targets
      end
    when 'group'
      list_groups
    end
    return 0
  when 'show-modules'
    list_modules
    return 0
  when 'convert'
    pal.convert_plan(options[:object])
    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 'guide'
    code = if options[:object]
             show_guide(options[:object])
           else
             list_topics
           end
  when 'project'
    case options[:action]
    when 'init'
      code = initialize_project
    when 'migrate'
      inv = config.inventoryfile
      path = config.project.path
      code = Bolt::ProjectMigrate.new(path, outputter, inv).migrate_project
    end
  when 'plan'
    case options[:action]
    when 'new'
      code = new_plan(options[:object])
    when 'run'
      code = run_plan(options[:object], options[:task_options], options[:target_args], options)
    end
  when 'puppetfile'
    case options[:action]
    when 'generate-types'
      code = generate_types
    when '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], config.modified_concurrency)
    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_opts[:env_vars] = options[:env_vars] if options.key?(:env_vars)
      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 src.nil?
            raise Bolt::CLIError, "A source path must be specified"
          end

          if dest.nil?
            raise Bolt::CLIError, "A destination path must be specified"
          end

          case options[:action]
          when 'download'
            dest = File.expand_path(dest, Dir.pwd)
            executor.download_file(targets, src, dest, executor_opts)
          when 'upload'
            validate_file('source file', src, true)
            executor.upload_file(targets, src, dest, executor_opts)
          end
        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

#fatal_error(error) ⇒ Object

Mimicks the output from Outputter::Human#fatal_error. This should be used to print errors prior to config being loaded, as the outputter relies on config being loaded.



1065
1066
1067
1068
1069
1070
1071
 
# File 'lib/bolt/cli.rb', line 1065

def fatal_error(error)
  if $stdout.isatty
    $stdout.puts("\033[31m#{error.message}\033[0m")
  else
    $stdout.puts(error.message)
  end
end

#finalize_setup ⇒ Object

Completes the setup process by configuring Bolt and log messages



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/bolt/cli.rb', line 171

def finalize_setup
  Bolt::Logger.configure(config.log, config.color)
  Bolt::Logger.analytics = analytics

  # Logger must be configured before checking path case and project file, otherwise logs will not display
  config.check_path_case('modulepath', config.modulepath)
  config.project.check_deprecated_file

  # Log messages created during parser and config initialization
  config.logs.each { |log| @logger.send(log.keys[0], log.values[0]) }
  @parser_deprecations.each { |dep| Bolt::Logger.deprecation_warning(dep[:type], dep[:msg]) }
  config.deprecations.each { |dep| Bolt::Logger.deprecation_warning(dep[:type], dep[:msg]) }

  warn_inventory_overrides_cli(options)

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

#generate_types ⇒ Object 



771
772
773
774
775
 
# File 'lib/bolt/cli.rb', line 771

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

#guides ⇒ Object

Collects the list of Bolt guides and maps them to their topics.



956
957
958
959
960
961
962
963
964
965
966
967
968
969
 
# File 'lib/bolt/cli.rb', line 956

def guides
  @guides ||= begin
                root_path = File.expand_path(File.join(__dir__, '..', '..', 'guides'))
                files     = Dir.children(root_path).sort

                files.each_with_object({}) do |file, guides|
                  next if file !~ /\.txt\z/
                  topic = File.basename(file, '.txt')
                  guides[topic] = File.join(root_path, file)
                end
              rescue SystemCallError => e
                raise Bolt::FileError.new("#{e.message}: unable to load guides directory", root_path)
              end
end

#handle_parser_errors ⇒ Object 



294
295
296
297
298
299
300
301
302
 
# File 'lib/bolt/cli.rb', line 294

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

#incomplete_install? ⇒ Boolean

Gem installs include the aggregate, canary, and puppetdb_fact modules, while package installs include modules listed in the Bolt repo Puppetfile

Returns:

  • (Boolean) 


1059
1060
1061
 
# File 'lib/bolt/cli.rb', line 1059

def incomplete_install?
  (Dir.children(Bolt::PAL::MODULES_PATH) - %w[aggregate canary puppetdb_fact]).empty?
end

#initialize_project ⇒ Object

Initializes a specified directory as a Bolt project and installs any modules specified by the user, along with their dependencies



779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
 
# File 'lib/bolt/cli.rb', line 779

def initialize_project
  # Dir.pwd will return backslashes on Windows, but Pathname always uses
  # forward slashes to concatenate paths. This results in paths like
  # C:\User\Administrator/modules, which fail module install. This ensure
  # forward slashes in the cwd path.
  dir = File.expand_path(Dir.pwd)
  name = options[:object] || File.basename(dir)
  if name !~ Bolt::Module::MODULE_NAME_REGEX
    if options[:object]
      raise Bolt::ValidationError, "The provided project name '#{name}' is invalid; "\
        "project name must begin with a lowercase letter and can include lowercase "\
        "letters, numbers, and underscores."
    else
      raise Bolt::ValidationError, "The current directory name '#{name}' is an invalid "\
        "project name. Please specify a name using 'bolt project init <name>'."
    end
  end

  project    = Pathname.new(dir)
  old_config = project + 'bolt.yaml'
  config     = project + 'bolt-project.yaml'
  puppetfile = project + 'Puppetfile'
  modulepath = [project + 'modules']

  # If modules were specified, first check if there is already a Puppetfile at the project
  # directory, erroring if there is. If there is no Puppetfile, generate the Puppetfile
  # content by resolving the specified modules and all their dependencies.
  # We generate the Puppetfile first so that any errors in resolving modules and their
  # dependencies are caught early and do not create a project directory.
  if options[:modules]
    if puppetfile.exist?
      raise Bolt::CLIError,
            "Found existing Puppetfile at #{puppetfile}, unable to initialize project with "\
            "#{options[:modules].join(', ')}"
    else
      puppetfile_specs = resolve_puppetfile_specs
    end
  end

  # Warn the user if the project directory already exists. We don't error here since users
  # might not have installed any modules yet.
  # If both bolt.yaml and bolt-project.yaml exist, this will just warn
  # about bolt-project.yaml and subsequent Bolt actions will warn about
  # both files existing
  if config.exist?
    @logger.warn "Found existing project directory at #{project}. Skipping file creation."
  # This won't get called if bolt-project.yaml exists
  elsif old_config.exist?
    @logger.warn "Found existing #{old_config.basename} at #{project}. "\
      "#{old_config.basename} is deprecated, please rename to #{config.basename}."
  # Bless the project directory as a...wait for it...project
  else
    begin
      content = { 'name' => name }
      File.write(config.to_path, content.to_yaml)
      outputter.print_message "Successfully created Bolt project at #{project}"
    rescue StandardError => e
      raise Bolt::FileError.new("Could not create bolt-project.yaml at #{project}: #{e.message}", nil)
    end
  end

  # Write the generated Puppetfile to the fancy new project
  if puppetfile_specs
    File.write(puppetfile, puppetfile_specs.join("\n"))
    outputter.print_message "Successfully created Puppetfile at #{puppetfile}"
    # Install the modules from our shiny new Puppetfile
    if install_puppetfile({}, puppetfile, modulepath)
      outputter.print_message "Successfully installed #{options[:modules].join(', ')}"
    else
      raise Bolt::CLIError, "Could not install #{options[:modules].join(', ')}"
    end
  end

  0
end

#install_puppetfile(config, puppetfile, modulepath) ⇒ Object 



913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/bolt/cli.rb', line 913

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 



560
561
562
563
 
# File 'lib/bolt/cli.rb', line 560

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

#list_modules ⇒ Object 



767
768
769
 
# File 'lib/bolt/cli.rb', line 767

def list_modules
  outputter.print_module_list(pal.list_modules)
end

#list_plans ⇒ Object 



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

def list_plans
  plans = pal.list_plans
  plans.select! { |plan| plan.first.include?(options[:filter]) } if options[:filter]
  plans.select! { |plan| config.project.plans.include?(plan.first) } unless config.project.plans.nil?
  outputter.print_plans(plans, pal.user_modulepath)
end

#list_targets ⇒ Object 



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

def list_targets
  update_targets(options)
  outputter.print_targets(options[:targets])
end

#list_tasks ⇒ Object 



532
533
534
535
536
537
 
# File 'lib/bolt/cli.rb', line 532

def list_tasks
  tasks = pal.list_tasks
  tasks.select! { |task| task.first.include?(options[:filter]) } if options[:filter]
  tasks.select! { |task| config.project.tasks.include?(task.first) } unless config.project.tasks.nil?
  outputter.print_tasks(tasks, pal.user_modulepath)
end

#list_topics ⇒ Object

Display the list of available Bolt guides.



972
973
974
975
 
# File 'lib/bolt/cli.rb', line 972

def list_topics
  outputter.print_topics(guides.keys)
  0
end

#load_config ⇒ Object

Loads the project and configuration. All errors that are raised here are not handled by the outputter, as it relies on config being loaded.



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/bolt/cli.rb', line 146

def load_config
  @config = if ENV['BOLT_PROJECT']
              project = Bolt::Project.create_project(ENV['BOLT_PROJECT'], 'environment')
              Bolt::Config.from_project(project, options)
            elsif options[:configfile]
              Bolt::Config.from_file(options[:configfile], options)
            else
              project = if options[:boltdir]
                          dir = Pathname.new(options[:boltdir])
                          if (dir + Bolt::Project::BOLTDIR_NAME).directory?
                            Bolt::Project.create_project(dir + Bolt::Project::BOLTDIR_NAME)
                          else
                            Bolt::Project.create_project(dir)
                          end
                        else
                          Bolt::Project.find_boltdir(Dir.pwd)
                        end
              Bolt::Config.from_project(project, options)
            end
rescue Bolt::Error => e
  fatal_error(e)
  raise e
end

#log_outputter ⇒ Object 



1013
1014
1015
 
# File 'lib/bolt/cli.rb', line 1013

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

#new_plan(plan_name) ⇒ Object 



565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'lib/bolt/cli.rb', line 565

def new_plan(plan_name)
  @logger.warn("Command 'bolt plan new' is experimental and subject to changes.")

  if config.project.name.nil?
    raise Bolt::Error.new(
      "Project directory '#{config.project.path}' is not a named project. Unable to create "\
      "a project-level plan. To name a project, set the 'name' key in the 'bolt-project.yaml' "\
      "configuration file.",
      "bolt/unnamed-project-error"
    )
  end

  if plan_name !~ Bolt::Module::CONTENT_NAME_REGEX
    message = <<~MESSAGE.chomp
      Invalid plan name '#{plan_name}'. Plan names are composed of one or more name segments
      separated by double colons '::'.
      
      Each name segment must begin with a lowercase letter, and may only include lowercase
      letters, digits, and underscores.
      
      Examples of valid plan names:
          - #{config.project.name}
          - #{config.project.name}::my_plan
    MESSAGE

    raise Bolt::ValidationError, message
  end

  prefix, *name_segments, basename = plan_name.split('::')

  # If the plan name is just the project name, then create an 'init' plan.
  # Otherwise, use the last name segment for the plan's filename.
  basename ||= 'init'

  unless prefix == config.project.name
    message = "First segment of plan name '#{plan_name}' must match project name '#{config.project.name}'. "\
              "Did you mean '#{config.project.name}::#{plan_name}'?"

    raise Bolt::ValidationError, message
  end

  dir_path = config.project.plans_path.join(*name_segments)

  %w[pp yaml].each do |ext|
    next unless (path = config.project.plans_path + "#{basename}.#{ext}").exist?
    raise Bolt::Error.new(
      "A plan with the name '#{plan_name}' already exists at '#{path}', nothing to do.",
      'bolt/existing-plan-error'
    )
  end

  begin
    FileUtils.mkdir_p(dir_path)
  rescue Errno::EEXIST => e
    raise Bolt::Error.new(
      "#{e.message}; unable to create plan directory '#{dir_path}'",
      'bolt/existing-file-error'
    )
  end

  plan_path = dir_path + "#{basename}.yaml"

  plan_template = <<~PLAN
    # This is the structure of a simple plan. To learn more about writing
    # YAML plans, see the documentation: http://pup.pt/bolt-yaml-plans

    # The description sets the description of the plan that will appear
    # in 'bolt plan show' output.
    description: A plan created with bolt plan new

    # The parameters key defines the parameters that can be passed to
    # the plan.
    parameters:
      targets:
        type: TargetSpec
        description: A list of targets to run actions on
        default: localhost

    # The steps key defines the actions the plan will take in order.
    steps:
      - message: Hello from #{plan_name}
      - name: command_step
        command: whoami
        targets: $targets

    # The return key sets the return value of the plan.
    return: $command_step
  PLAN

  begin
    File.write(plan_path, plan_template)
  rescue Errno::EACCES => e
    raise Bolt::FileError.new(
      "#{e.message}; unable to create plan",
      plan_path
    )
  end

  output = <<~OUTPUT
    Created plan '#{plan_name}' at '#{plan_path}'

    Show this plan with:
        bolt plan show #{plan_name}
    Run this plan with:
        bolt plan run #{plan_name}
  OUTPUT

  outputter.print_message(output)

  0
end

#outputter ⇒ Object 



1009
1010
1011
 
# File 'lib/bolt/cli.rb', line 1009

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

#pal ⇒ Object 



945
946
947
948
949
950
951
952
953
 
# File 'lib/bolt/cli.rb', line 945

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

#parse ⇒ Object

Wrapper method that is called by the Bolt executable. Parses the command and then loads the project and config. Once config is loaded, it completes the setup process by configuring Bolt and logging messages.

This separation is needed since the Bolt::Outputter class that normally handles printing errors relies on config being loaded. All setup that happens before config is loaded will have errors printed directly to stdout, while all errors raised after config is loaded are handled by the outputter.



88
89
90
91
92
 
# File 'lib/bolt/cli.rb', line 88

def parse
  parse_command
  load_config
  finalize_setup
end

#parse_command ⇒ Object

Parses the command and validates options. All errors that are raised here are not handled by the outputter, as it relies on config being loaded.



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
 
# File 'lib/bolt/cli.rb', line 96

def parse_command
  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
    elsif task_options.any?
      options[:params_parsed] = false
      options[:task_options] = Hash[task_options.map { |a| a.split('=', 2) }]
    else
      options[:params_parsed] = true
      options[:task_options] = {}
    end
  end
  options[:leftovers] = remaining

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

  validate(options)

  # Deprecation warnings can't be issued until after config is loaded, so
  # store them for later.
  @parser_deprecations = parser.deprecations
rescue Bolt::Error => e
  fatal_error(e)
  raise e
end

#plugins ⇒ Object 



308
309
310
 
# File 'lib/bolt/cli.rb', line 308

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

#puppetdb_client ⇒ Object 



304
305
306
 
# File 'lib/bolt/cli.rb', line 304

def puppetdb_client
  plugins.puppetdb_client
end

#query_puppetdb_nodes(query) ⇒ Object 



312
313
314
 
# File 'lib/bolt/cli.rb', line 312

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

#rerun ⇒ Object 



1005
1006
1007
 
# File 'lib/bolt/cli.rb', line 1005

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

#resolve_puppetfile_specs ⇒ Object

Resolves Puppetfile specs from user-specified modules and dependencies resolved by the puppetfile-resolver gem.



857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
 
# File 'lib/bolt/cli.rb', line 857

def resolve_puppetfile_specs
  require 'puppetfile-resolver'

  # Build the document model from the module names, defaulting to the latest version of each module
  model = PuppetfileResolver::Puppetfile::Document.new('')
  options[:modules].each do |mod_name|
    model.add_module(
      PuppetfileResolver::Puppetfile::ForgeModule.new(mod_name).tap { |mod| mod.version = :latest }
    )
  end

  # Make sure the Puppetfile model is valid
  unless model.valid?
    raise Bolt::ValidationError,
          "Unable to resolve dependencies for #{options[:modules].join(', ')}"
  end

  # Create the resolver using the Puppetfile model. nil disables Puppet version restrictions.
  resolver = PuppetfileResolver::Resolver.new(model, nil)

  # Configure and resolve the dependency graph
  result = resolver.resolve(
    cache:                 nil,
    ui:                    nil,
    module_paths:          [],
    allow_missing_modules: true
  )

  # Validate that the modules exist
  missing_graph = result.specifications.select do |_name, spec|
    spec.instance_of? PuppetfileResolver::Models::MissingModuleSpecification
  end

  if missing_graph.any?
    titles = model.modules.each_with_object({}) do |mod, acc|
      acc[mod.name] = mod.title
    end

    names = titles.values_at(*missing_graph.keys)
    plural = names.count == 1 ? '' : 's'

    raise Bolt::ValidationError,
          "Unknown module name#{plural} #{names.join(', ')}"
  end

  # Filter the dependency graph to only include module specifications
  spec_graph = result.specifications.select do |_name, spec|
    spec.instance_of? PuppetfileResolver::Models::ModuleSpecification
  end

  # Map specification models to a Puppetfile specification
  spec_graph.values.map do |spec|
    "mod '#{spec.owner}-#{spec.name}', '#{spec.version}'"
  end
end

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



677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
 
# File 'lib/bolt/cli.rb', line 677

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

    plan_params = pal.get_plan_info(plan_name)['parameters']
    target_param = plan_params.dig('targets', 'type') =~ /TargetSpec/
    node_param = plan_params.include?('nodes')

    if node_param && target_param
      msg = "Plan parameters include both 'nodes' and 'targets' with type 'TargetSpec', " \
            "neither will populated with the value for --nodes or --targets."
      @logger.warn(msg)
    elsif node_param
      plan_arguments['nodes'] = nodes.join(',')
    elsif target_param
      plan_arguments['targets'] = nodes.join(',')
    end
  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], config.modified_concurrency)
  if %w[human rainbow].include?(options.fetch(:format, '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_guide(topic) ⇒ Object

Display a specific Bolt guide.



978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
 
# File 'lib/bolt/cli.rb', line 978

def show_guide(topic)
  if guides[topic]
    analytics.event('Guide', 'known_topic', label: topic)

    begin
      guide = File.read(guides[topic])
    rescue SystemCallError => e
      raise Bolt::FileError("#{e.message}: unable to load guide page", filepath)
    end

    outputter.print_guide(guide, topic)
  else
    analytics.event('Guide', 'unknown_topic', label: topic)
    outputter.print_message("Did not find guide for topic '#{topic}'.\n\n")
    list_topics
  end
  0
end

#show_plan(plan_name) ⇒ Object 



539
540
541
 
# File 'lib/bolt/cli.rb', line 539

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

#show_targets ⇒ Object 



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

def show_targets
  update_targets(options)
  outputter.print_target_info(options[:targets])
end

#show_task(task_name) ⇒ Object 



528
529
530
 
# File 'lib/bolt/cli.rb', line 528

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

#update_targets(options) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/bolt/cli.rb', line 192

def update_targets(options)
  target_opts = options.keys.select { |opt| %i[query rerun targets].include?(opt) }
  target_string = "'--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

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

#validate(options) ⇒ Object 



212
213
214
215
216
217
218
219
220
221
222
223
224
225
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
256
257
258
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
 
# File 'lib/bolt/cli.rb', line 212

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', '--project', 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[:env_vars]
    unless %w[command script].include?(options[:subcommand]) && options[:action] == 'run'
      raise Bolt::CLIError,
            "Option '--env-var' may only be specified when running a command or script"
    end
  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

  if options[:subcommand] == 'secret' &&
     (options[:action] == 'decrypt' || options[:action] == 'encrypt') &&
     !options[:object]
    raise Bolt::CLIError, "Must specify a value to #{options[:action]}"
  end

  if options[:subcommand] == 'plan' && options[:action] == 'new' && !options[:object]
    raise Bolt::CLIError, "Must specify a plan name."
  end

  if options.key?(:debug) && options.key?(:log)
    raise Bolt::CLIError, "Only one of '--debug' or '--log-level' may be specified"
  end
end

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



997
998
999
1000
1001
1002
1003
 
# File 'lib/bolt/cli.rb', line 997

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

#warn_inventory_overrides_cli(opts) ⇒ Object 



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
 
# File 'lib/bolt/cli.rb', line 316

def warn_inventory_overrides_cli(opts)
  inventory_source = if ENV[Bolt::Inventory::ENVIRONMENT_VAR]
                       Bolt::Inventory::ENVIRONMENT_VAR
                     elsif config.inventoryfile && Bolt::Util.file_stat(config.inventoryfile)
                       config.inventoryfile
                     else
                       begin
                         Bolt::Util.file_stat(config.default_inventoryfile)
                         config.default_inventoryfile
                       rescue Errno::ENOENT
                         nil
                       end
                     end

  inventory_cli_opts = %i[authentication escalation transports].each_with_object([]) do |key, acc|
    acc.concat(Bolt::BoltOptionParser::OPTIONS[key])
  end

  inventory_cli_opts.concat(%w[no-host-key-check no-ssl no-ssl-verify no-tty])

  conflicting_options = Set.new(opts.keys.map(&:to_s)).intersection(inventory_cli_opts)

  if inventory_source && conflicting_options.any?
    @logger.warn("CLI arguments #{conflicting_options.to_a} may be overridden by Inventory: #{inventory_source}")
  end
end