Class: Bolt::CLI

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

Constant Summary collapse

COMMANDS = 
{
  'apply'     => %w[],
  'command'   => %w[run],
  'file'      => %w[download upload],
  'group'     => %w[show],
  'guide'     => %w[],
  'inventory' => %w[show],
  'lookup'    => %w[],
  'module'    => %w[add generate-types install show],
  'plan'      => %w[show run convert new],
  'plugin'    => %w[show],
  'project'   => %w[init migrate],
  'script'    => %w[run],
  'secret'    => %w[encrypt decrypt createkeys],
  'task'      => %w[show run]
}.freeze
TARGETING_OPTIONS = 
%i[query rerun targets].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(argv) ⇒ CLI

Returns a new instance of CLI.



56
57
58
59
60
61
 
# File 'lib/bolt/cli.rb', line 56

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.



54
55
56
 
# File 'lib/bolt/cli.rb', line 54

def config
  @config
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



54
55
56
 
# File 'lib/bolt/cli.rb', line 54

def options
  @options
end

Instance Method Details

#add_project_module(name, project, config) ⇒ Object

Adds a single module to the project.



894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
 
# File 'lib/bolt/cli.rb', line 894

def add_project_module(name, project, config)
  assert_project_file(project)

  installer = Bolt::ModuleInstaller.new(outputter, pal)

  ok = outputter.spin do
    installer.add(name,
                  project.modules,
                  project.puppetfile,
                  project.managed_moduledir,
                  project.project_file,
                  config)
  end

  ok ? 0 : 1
end

#analytics ⇒ Object 



1031
1032
1033
1034
1035
1036
1037
 
# File 'lib/bolt/cli.rb', line 1031

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

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



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

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"
    Bolt::Logger.warn("empty_manifest", message)
  end

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

#assert_project_file(project) ⇒ Object

Asserts that there is a project configuration file.



913
914
915
916
917
918
919
920
921
922
 
# File 'lib/bolt/cli.rb', line 913

def assert_project_file(project)
  unless project.project_file?
    command = Bolt::Util.powershell? ? 'New-BoltProject' : 'bolt project init'

    msg = "Could not find project configuration file #{project.project_file}, unable "\
          "to install modules. To create a Bolt project, run '#{command}'."

    raise Bolt::Error.new(msg, 'bolt/missing-project-config-error')
  end
end

#bundled_content ⇒ Object 



1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
 
# File 'lib/bolt/cli.rb', line 1039

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 might 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

    Bolt::Logger.warn("gem_install", 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(Bolt::Config::Modulepath.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 



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
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
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
 
# File 'lib/bolt/cli.rb', line 431

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 targeting options this is passed to plans
  # options[:targets] will contain a resolved set of Target objects
  unless %w[guide module project secret].include?(options[:subcommand]) ||
         %w[convert new show].include?(options[:action]) ||
         options[:plan_hierarchy]
    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
  }.merge!(analytics.plan_counts(config.project.plans_path))

  # 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
    when 'module'
      list_modules
    when 'plugin'
      list_plugins
    end
    return 0
  when 'convert'
    pal.convert_plan(options[:object])
    return 0
  end

  message = 'There might 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 = Bolt::ProjectManager.new(config, outputter, pal)
                                 .create(Dir.pwd, options[:object], options[:modules])
    when 'migrate'
      code = Bolt::ProjectManager.new(config, outputter, pal).migrate
    end
  when 'lookup'
    plan_vars = Hash[options[:leftovers].map { |a| a.split('=', 2) }]
    # Validate functions verifies one of these was passed
    if options[:targets]
      code = lookup(options[:object], options[:targets], plan_vars: plan_vars)
    elsif options[:plan_hierarchy]
      code = plan_lookup(options[:object], plan_vars: plan_vars)
    end
  when 'plan'
    case options[:action]
    when 'new'
      plan_name = options[:object]

      # If this passes validation, it will return the path to the plan to create
      Bolt::PlanCreator.validate_input(config.project, plan_name)
      code = Bolt::PlanCreator.create_plan(config.project.plans_path,
                                           plan_name,
                                           outputter,
                                           options[:puppet])
    when 'run'
      code = run_plan(options[:object], options[:task_options], options[:target_args], options)
    end
  when 'module'
    case options[:action]
    when 'add'
      code = add_project_module(options[:object], config.project, config.module_install)
    when 'install'
      code = install_project_modules(config.project, config.module_install, options[:force], options[:resolve])
    when 'generate-types'
      code = generate_types
    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,
                                  config.future)
    targets = options[:targets]

    results = nil
    outputter.print_head

    elapsed_time = Benchmark.realtime do
      executor_opts = {}
      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_path = find_file(options[:object], executor.future&.fetch('file_paths', false))
          validate_file('script', script_path)
          executor.run_script(targets, script_path, options[:leftovers], executor_opts)
        when 'task'
          pal.run_task(options[:object],
                       targets,
                       options[:task_options],
                       executor,
                       inventory)
        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'
            src_path = find_file(src, executor.future&.fetch('file_paths', false))
            validate_file('source file', src_path, true)
            executor.upload_file(targets, src_path, 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.



1080
1081
1082
1083
1084
1085
1086
 
# File 'lib/bolt/cli.rb', line 1080

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



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/bolt/cli.rb', line 231

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

  # 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

  if options[:clear_cache] && File.exist?(config.project.plugin_cache_file)
    FileUtils.rm(config.project.plugin_cache_file)
  end

  warn_inventory_overrides_cli(options)
  validate_ps_version

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

#find_file(path, future_file_paths) ⇒ Object

Returns the path to a file. If the path is an absolute or relative to a file, and the file exists, returns the path as-is. Otherwise, checks if the path is a Puppet file path and looks for the file in a module’s files directory.



1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
 
# File 'lib/bolt/cli.rb', line 1001

def find_file(path, future_file_paths)
  return path if File.exist?(path) || Pathname.new(path).absolute?
  modulepath = Bolt::Config::Modulepath.new(config.modulepath)
  modules    = Bolt::Module.discover(modulepath.full_modulepath, config.project)
  mod, file = path.split(File::SEPARATOR, 2)

  if modules[mod]
    @logger.debug("Did not find file at #{File.expand_path(path)}, checking in module '#{mod}'")
    found = Bolt::Util.find_file_in_module(modules[mod].path, file || "", future_file_paths)
    path = found.nil? ? File.join(modules[mod].path, 'files', file) : found
  end
  path
end

#generate_types ⇒ Object 



859
860
861
862
863
 
# File 'lib/bolt/cli.rb', line 859

def generate_types
  # generate_types will surface a nice error with helpful message if it fails
  pal.generate_types(cache: true)
  0
end

#guides ⇒ Object

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



947
948
949
950
951
952
953
954
955
956
957
958
959
960
 
# File 'lib/bolt/cli.rb', line 947

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 



384
385
386
387
388
389
390
391
392
 
# File 'lib/bolt/cli.rb', line 384

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) 


1073
1074
1075
1076
 
# File 'lib/bolt/cli.rb', line 1073

def incomplete_install?
  builtin_module_list = %w[aggregate canary puppetdb_fact secure_env_vars puppet_connect]
  (Dir.children(Bolt::Config::Modulepath::MODULES_PATH) - builtin_module_list).empty?
end

#install_project_modules(project, config, force, resolve) ⇒ Object

Installs modules declared in the project configuration file.



867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
 
# File 'lib/bolt/cli.rb', line 867

def install_project_modules(project, config, force, resolve)
  assert_project_file(project)

  if project.modules.empty? && resolve != false
    outputter.print_message(
      "Project configuration file #{project.project_file} does not "\
      "specify any module dependencies. Nothing to do."
    )
    return 0
  end

  installer = Bolt::ModuleInstaller.new(outputter, pal)

  ok = outputter.spin do
    installer.install(project.modules,
                      project.puppetfile,
                      project.managed_moduledir,
                      config,
                      force: force,
                      resolve: resolve)
  end

  ok ? 0 : 1
end

#install_puppetfile(puppetfile_config, puppetfile, moduledir) ⇒ Object

Loads a Puppetfile and installs its modules.



926
927
928
929
930
931
932
933
934
 
# File 'lib/bolt/cli.rb', line 926

def install_puppetfile(puppetfile_config, puppetfile, moduledir)
  outputter.print_message("Installing modules from Puppetfile")
  installer = Bolt::ModuleInstaller.new(outputter, pal)
  ok = outputter.spin do
    installer.install_puppetfile(puppetfile, moduledir, puppetfile_config)
  end

  ok ? 0 : 1
end

#list_groups ⇒ Object 



709
710
711
 
# File 'lib/bolt/cli.rb', line 709

def list_groups
  outputter.print_groups(inventory.group_names.sort, inventory.source, config.default_inventoryfile)
end

#list_modules ⇒ Object 



851
852
853
 
# File 'lib/bolt/cli.rb', line 851

def list_modules
  outputter.print_module_list(pal.list_modules)
end

#list_plans ⇒ Object 



657
658
659
660
 
# File 'lib/bolt/cli.rb', line 657

def list_plans
  plans = filter_content(pal.list_plans_with_cache(filter_content: true), options[:filter])
  outputter.print_plans(plans, pal.user_modulepath)
end

#list_plugins ⇒ Object 



855
856
857
 
# File 'lib/bolt/cli.rb', line 855

def list_plugins
  outputter.print_plugin_list(plugins.list_plugins, pal.user_modulepath)
end

#list_targets ⇒ Object 



662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'lib/bolt/cli.rb', line 662

def list_targets
  if options.keys.any? { |key| TARGETING_OPTIONS.include?(key) }
    target_flag = true
  else
    options[:targets] = 'all'
  end

  outputter.print_targets(
    group_targets_by_source,
    inventory.source,
    config.default_inventoryfile,
    target_flag
  )
end

#list_tasks ⇒ Object 



648
649
650
651
 
# File 'lib/bolt/cli.rb', line 648

def list_tasks
  tasks = filter_content(pal.list_tasks_with_cache(filter_content: true), options[:filter])
  outputter.print_tasks(tasks, pal.user_modulepath)
end

#list_topics ⇒ Object

Display the list of available Bolt guides.



963
964
965
966
 
# File 'lib/bolt/cli.rb', line 963

def list_topics
  outputter.print_topics(guides.keys - ['guide'])
  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.



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/bolt/cli.rb', line 211

def load_config
  project = if ENV['BOLT_PROJECT']
              Bolt::Project.create_project(ENV['BOLT_PROJECT'], 'environment')
            elsif options[:project]
              dir = Pathname.new(options[:project])
              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
  @config = Bolt::Config.from_project(project, options)
rescue Bolt::Error => e
  fatal_error(e)
  raise e
end

#log_outputter ⇒ Object 



1027
1028
1029
 
# File 'lib/bolt/cli.rb', line 1027

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

#lookup(key, targets, plan_vars: {}) ⇒ Object

Looks up a value with Hiera, using targets as the contexts to perform the look ups in. This should return the same value as a lookup in an apply block.



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

def lookup(key, targets, plan_vars: {})
  executor = Bolt::Executor.new(
    config.concurrency,
    analytics,
    options[:noop],
    config.modified_concurrency,
    config.future
  )

  executor.subscribe(outputter) if config.format == 'human'
  executor.subscribe(log_outputter)
  executor.publish_event(type: :plan_start, plan: nil)

  results = outputter.spin do
    pal.lookup(
      key,
      targets,
      inventory,
      executor,
      plan_vars: plan_vars
    )
  end

  executor.shutdown
  outputter.print_result_set(results)

  results.ok ? 0 : 1
end

#outputter ⇒ Object 



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

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

#pal ⇒ Object 



936
937
938
939
940
941
942
943
944
 
# File 'lib/bolt/cli.rb', line 936

def pal
  @pal ||= Bolt::PAL.new(Bolt::Config::Modulepath.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.



97
98
99
100
101
 
# File 'lib/bolt/cli.rb', line 97

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.



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
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
195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/bolt/cli.rb', line 147

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)
    # If the subcommand is not enabled, display the default
    # help text
    options[:subcommand] = nil unless COMMANDS.include?(options[:subcommand])

    if Bolt::Util.first_run?
      FileUtils.touch(Bolt::Util.first_runs_free)

      if options[:subcommand].nil? && $stdout.isatty
        welcome_message
        raise Bolt::CLIExit
      end
    end

    # Update the parser for the subcommand (or lack thereof)
    parser.update
    puts parser.help
    raise Bolt::CLIExit
  end

  options[:object] = remaining.shift

  # Handle reading a command from a file
  if options[:subcommand] == 'command' && options[:object]
    options[:object] = Bolt::Util.get_arg_input(options[:object])
  end

  # 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)
rescue Bolt::Error => e
  fatal_error(e)
  raise e
end

#plan_lookup(key, plan_vars: {}) ⇒ Object

Looks up a value with Hiera as if in a plan outside an apply block, using provided variable values for interpolations



716
717
718
719
720
 
# File 'lib/bolt/cli.rb', line 716

def plan_lookup(key, plan_vars: {})
  result = pal.plan_hierarchy_lookup(key, plan_vars: plan_vars)
  outputter.print_plan_lookup(result)
  0
end

#plugins ⇒ Object 



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

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

#puppetdb_client ⇒ Object 



394
395
396
 
# File 'lib/bolt/cli.rb', line 394

def puppetdb_client
  plugins.puppetdb_client
end

#query_puppetdb_nodes(query) ⇒ Object 



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

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

#rerun ⇒ Object 



1015
1016
1017
 
# File 'lib/bolt/cli.rb', line 1015

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

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



754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
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
 
# File 'lib/bolt/cli.rb', line 754

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 can 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."
      Bolt::Logger.warn("nodes_targets_parameters", 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 }

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



969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
 
# File 'lib/bolt/cli.rb', line 969

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 



653
654
655
 
# File 'lib/bolt/cli.rb', line 653

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

#show_targets ⇒ Object 



677
678
679
680
681
682
683
684
685
686
687
688
689
690
 
# File 'lib/bolt/cli.rb', line 677

def show_targets
  if options.keys.any? { |key| TARGETING_OPTIONS.include?(key) }
    target_flag = true
  else
    options[:targets] = 'all'
  end

  outputter.print_target_info(
    group_targets_by_source,
    inventory.source,
    config.default_inventoryfile,
    target_flag
  )
end

#show_task(task_name) ⇒ Object 



637
638
639
 
# File 'lib/bolt/cli.rb', line 637

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

#update_targets(options) ⇒ Object 



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/bolt/cli.rb', line 267

def update_targets(options)
  target_opts = options.keys.select { |opt| TARGETING_OPTIONS.include?(opt) }
  target_string = "'--targets', '--rerun', or '--query'"
  if target_opts.length > 1
    raise Bolt::CLIError, "Only one targeting option #{target_string} can 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 



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

def validate(options)
  unless COMMANDS.include?(options[:subcommand])
    command = Bolt::Util.powershell? ? 'Get-Command -Module PuppetBolt' : 'bolt help'
    raise Bolt::CLIError,
          "'#{options[:subcommand]}' is not a Bolt command. See '#{command}'."
  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 %w[task plan script].include?(options[:subcommand]) && options[:action] == 'run'
    if options[:object].nil?
      raise Bolt::CLIError, "Must specify a #{options[:subcommand]} to run"
    end
  end

  # This may mean that we parsed a parameter as the object
  if %w[task plan].include?(options[:subcommand]) && options[:action] == 'run'
    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[: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] == 'lookup' && !options[:object]
    raise Bolt::CLIError, "Must specify a key to look up"
  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[:subcommand] == 'module' && options[:action] == 'add' && !options[:object]
    raise Bolt::CLIError, "Must specify a module name."
  end

  if options[:subcommand] == 'module' && options[:action] == 'install' && options[:object]
    command = Bolt::Util.powershell? ? 'Add-BoltModule -Module' : 'bolt module add'
    raise Bolt::CLIError, "Invalid argument '#{options[:object]}'. To add a new module to "\
                          "the project, run '#{command} #{options[:object]}'."
  end

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

  target_opts = options.keys.select { |opt| TARGETING_OPTIONS.include?(opt) }
  if options[:subcommand] == 'lookup' &&
     target_opts.any? && options[:plan_hierarchy]
    raise Bolt::CLIError, "The 'lookup' command accepts either targeting option OR --plan-hierarchy."
  end

  if options[:noop] &&
     !(options[:subcommand] == 'task' && options[:action] == 'run') && options[:subcommand] != 'apply'
    raise Bolt::CLIError,
          "Option '--noop' can 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' can only be specified when running a command or script"
    end
  end
end

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



988
989
990
991
992
993
994
 
# File 'lib/bolt/cli.rb', line 988

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 



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/bolt/cli.rb', line 406

def warn_inventory_overrides_cli(opts)
  inventory_source = if ENV[Bolt::Inventory::ENVIRONMENT_VAR]
                       Bolt::Inventory::ENVIRONMENT_VAR
                     elsif config.inventoryfile
                       config.inventoryfile
                     elsif File.exist?(config.default_inventoryfile)
                       config.default_inventoryfile
                     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?
    Bolt::Logger.warn(
      "cli_overrides",
      "CLI arguments #{conflicting_options.to_a} might be overridden by Inventory: #{inventory_source}"
    )
  end
end

#welcome_message ⇒ Object

Prints a welcome message when users first install Bolt and run ‘bolt`, `bolt help` or `bolt –help`



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

def welcome_message
  bolt = <<~BOLT
               `.::-`
          `.-:///////-.`
       `-:////:.  `-:///:-  /ooo.                        .ooo/
   `.-:///::///:-`   `-//:  ymmm-                        :mmmy  .---.
  :///:-.   `.:////.  -//:  ymmm-                        :mmmy  +mmm+
  ://.          ///.  -//:  ymmm--/++/-       `-/++/:`   :mmmy-:smmms::-
  ://.          ://. .://:  ymmmdmmmmmmdo`  .smmmmmmmmh: :mmmysmmmmmmmms
  ://.          ://:///:-.  ymmmh/--/hmmmy -mmmd/-.:hmmm+:mmmy.-smmms--.
  ://:.`      .-////:-`     ymmm-     ymmm:hmmm-    `dmmm/mmmy  +mmm+
  `-:///:-..:///:-.`        ymmm-     ommm/dmmm`     hmmm+mmmy  +mmm+
     `.-:////:-`            ymmm+    /mmmm.ommms`   /mmmh:mmmy  +mmmo
         `-.`               ymmmmmhhmmmmd:  ommmmhydmmmy`:mmmy  -mmmmdhd
                            oyyy+shddhs/`    .+shddhy+-  -yyyo   .ohddhs


  BOLT
  example_cmd = if Bolt::Util.windows?
                  "Invoke-BoltCommand -Command 'hostname' -Targets localhost"
                else
                  "bolt command run 'hostname' --target localhost"
                end
  prev_cmd = String.new("bolt")
  prev_cmd << " #{@argv[0]}" unless @argv.empty?

  message = <<~MSG
  🎉 Welcome to Bolt #{VERSION}
  😌 We're here to help bring order to the chaos
  📖 Find our documentation at https://bolt.guide
  🙋 Ask a question in #bolt on https://slack.puppet.com/
  🔩 Contribute at https://github.com/puppetlabs/bolt/
  💡 Not sure where to start? Try "#{example_cmd}"

  We only print this message once. Run "#{prev_cmd}" again for help text.
  MSG

  $stdout.print "\033[36m#{bolt}\033[0m"
  $stdout.print message
end