Class: Bolt::CLI
- Inherits:
-
Object
- Object
- Bolt::CLI
- 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], '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
-
#config ⇒ Object
readonly
Returns the value of attribute config.
-
#options ⇒ Object
readonly
Returns the value of attribute options.
Instance Method Summary collapse
-
#add_project_module(name, project, config) ⇒ Object
Adds a single module to the project.
- #analytics ⇒ Object
- #apply_manifest(code, targets, filename = nil, noop = false) ⇒ Object
-
#assert_project_file(project) ⇒ Object
Asserts that there is a project configuration file.
- #bundled_content ⇒ Object
- #execute(options) ⇒ Object
-
#fatal_error(error) ⇒ Object
Mimicks the output from Outputter::Human#fatal_error.
-
#finalize_setup ⇒ Object
Completes the setup process by configuring Bolt and log messages.
-
#find_file(path, future_file_paths) ⇒ Object
Returns the path to a file.
- #generate_types ⇒ Object
-
#guides ⇒ Object
Collects the list of Bolt guides and maps them to their topics.
- #handle_parser_errors ⇒ Object
-
#incomplete_install? ⇒ Boolean
Gem installs include the aggregate, canary, and puppetdb_fact modules, while package installs include modules listed in the Bolt repo Puppetfile.
-
#initialize(argv) ⇒ CLI
constructor
A new instance of CLI.
-
#install_project_modules(project, config, force, resolve) ⇒ Object
Installs modules declared in the project configuration file.
-
#install_puppetfile(puppetfile_config, puppetfile, moduledir) ⇒ Object
Loads a Puppetfile and installs its modules.
- #list_groups ⇒ Object
- #list_modules ⇒ Object
- #list_plans ⇒ Object
- #list_targets ⇒ Object
- #list_tasks ⇒ Object
-
#list_topics ⇒ Object
Display the list of available Bolt guides.
-
#load_config ⇒ Object
Loads the project and configuration.
- #log_outputter ⇒ Object
-
#lookup(key, targets) ⇒ Object
Looks up a value with Hiera, using targets as the contexts to perform the look ups in.
- #outputter ⇒ Object
- #pal ⇒ Object
-
#parse ⇒ Object
Wrapper method that is called by the Bolt executable.
-
#parse_command ⇒ Object
Parses the command and validates options.
- #plugins ⇒ Object
- #puppetdb_client ⇒ Object
- #query_puppetdb_nodes(query) ⇒ Object
- #rerun ⇒ Object
- #run_plan(plan_name, plan_arguments, nodes, options) ⇒ Object
-
#show_guide(topic) ⇒ Object
Display a specific Bolt guide.
- #show_plan(plan_name) ⇒ Object
- #show_targets ⇒ Object
- #show_task(task_name) ⇒ Object
- #update_targets(options) ⇒ Object
- #validate(options) ⇒ Object
- #validate_file(type, path, allow_dir = false) ⇒ Object
- #warn_inventory_overrides_cli(opts) ⇒ Object
-
#welcome_message ⇒ Object
Prints a welcome message when users first install Bolt and run โbolt`, `bolt help` or `bolt โhelp`.
Constructor Details
Instance Attribute Details
#config ⇒ Object (readonly)
Returns the value of attribute config.
53 54 55 |
# File 'lib/bolt/cli.rb', line 53 def config @config end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
53 54 55 |
# File 'lib/bolt/cli.rb', line 53 def @options end |
Instance Method Details
#add_project_module(name, project, config) ⇒ Object
Adds a single module to the project.
866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 |
# File 'lib/bolt/cli.rb', line 866 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
1003 1004 1005 1006 1007 1008 1009 |
# File 'lib/bolt/cli.rb', line 1003 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
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 |
# File 'lib/bolt/cli.rb', line 783 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)) = "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", ) end executor = Bolt::Executor.new(config.concurrency, analytics, noop, config.modified_concurrency, config.future) executor.subscribe(outputter) if .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.
885 886 887 888 889 890 891 892 893 894 |
# File 'lib/bolt/cli.rb', line 885 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
1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 |
# File 'lib/bolt/cli.rb', line 1011 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?([:subcommand]) && [: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
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 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 |
# File 'lib/bolt/cli.rb', line 425 def execute() = nil handler = Signal.trap :INT do |signo| @logger.info( "Exiting after receiving SIG#{Signal.signame(signo)} signal.#{ ? ' ' + : ''}" ) 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[guide module project secret].include?([:subcommand]) || %w[convert new show].include?([:action]) update_targets() end screen = "#{[:subcommand]}_#{[:action]}" # submit a different screen for `bolt task show` and `bolt task show foo` if [:action] == 'show' && [: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 .key?(:targets) screen_view_fields.merge!(target_nodes: [: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 [:action] when 'show' case [:subcommand] when 'task' if [:object] show_task([:object]) else list_tasks end when 'plan' if [:object] show_plan([:object]) else list_plans end when 'inventory' if [:detail] show_targets else list_targets end when 'group' list_groups when 'module' list_modules end return 0 when 'convert' pal.convert_plan([:object]) return 0 end = 'There might be processes left executing on some nodes.' if %w[task plan].include?([:subcommand]) && [:task_options] && ![:params_parsed] && pal [:task_options] = pal.parse_params([:subcommand], [:object], [:task_options]) end case [:subcommand] when 'guide' code = if [:object] show_guide([:object]) else list_topics end when 'project' case [:action] when 'init' code = Bolt::ProjectManager.new(config, outputter, pal) .create(Dir.pwd, [:object], [:modules]) when 'migrate' code = Bolt::ProjectManager.new(config, outputter, pal).migrate end when 'lookup' code = lookup([:object], [:targets]) when 'plan' case [:action] when 'new' plan_name = [: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, [:puppet]) when 'run' code = run_plan([:object], [:task_options], [:target_args], ) end when 'module' case [:action] when 'add' code = add_project_module([:object], config.project, config.module_install) when 'install' code = install_project_modules(config.project, config.module_install, [:force], [:resolve]) when 'generate-types' code = generate_types end when 'secret' code = Bolt::Secret.execute(plugins, outputter, ) when 'apply' if [:object] validate_file('manifest', [:object]) [:code] = File.read(File.([:object])) end code = apply_manifest([:code], [:targets], [:object], [:noop]) else executor = Bolt::Executor.new(config.concurrency, analytics, [:noop], config.modified_concurrency, config.future) targets = [:targets] results = nil outputter.print_head elapsed_time = Benchmark.realtime do executor_opts = {} executor_opts[:env_vars] = [:env_vars] if .key?(:env_vars) executor.subscribe(outputter) executor.subscribe(log_outputter) results = case [:subcommand] when 'command' executor.run_command(targets, [:object], executor_opts) when 'script' script_path = find_file([:object], executor.future&.fetch('file_paths', false)) validate_file('script', script_path) executor.run_script(targets, script_path, [:leftovers], executor_opts) when 'task' pal.run_task([:object], targets, [:task_options], executor, inventory) when 'file' src = [:object] dest = [: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 [:action] when 'download' dest = File.(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.
1052 1053 1054 1055 1056 1057 1058 |
# File 'lib/bolt/cli.rb', line 1052 def fatal_error(error) if $stdout.isatty $stdout.puts("\033[31m#{error.}\033[0m") else $stdout.puts(error.) 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 [:clear_cache] && File.exist?(config.project.plugin_cache_file) FileUtils.rm(config.project.plugin_cache_file) end warn_inventory_overrides_cli() validate_ps_version 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.
973 974 975 976 977 978 979 980 981 982 983 984 985 |
# File 'lib/bolt/cli.rb', line 973 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.(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
831 832 833 834 835 |
# File 'lib/bolt/cli.rb', line 831 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.
919 920 921 922 923 924 925 926 927 928 929 930 931 932 |
# File 'lib/bolt/cli.rb', line 919 def guides @guides ||= begin root_path = File.(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.}: unable to load guides directory", root_path) end end |
#handle_parser_errors ⇒ Object
378 379 380 381 382 383 384 385 386 |
# File 'lib/bolt/cli.rb', line 378 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
1045 1046 1047 1048 |
# File 'lib/bolt/cli.rb', line 1045 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.
839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 |
# File 'lib/bolt/cli.rb', line 839 def install_project_modules(project, config, force, resolve) assert_project_file(project) if project.modules.empty? && resolve != false outputter.( "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.
898 899 900 901 902 903 904 905 906 |
# File 'lib/bolt/cli.rb', line 898 def install_puppetfile(puppetfile_config, puppetfile, moduledir) outputter.("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
694 695 696 |
# File 'lib/bolt/cli.rb', line 694 def list_groups outputter.print_groups(inventory.group_names.sort, inventory.source, config.default_inventoryfile) end |
#list_modules ⇒ Object
827 828 829 |
# File 'lib/bolt/cli.rb', line 827 def list_modules outputter.print_module_list(pal.list_modules) end |
#list_plans ⇒ Object
642 643 644 645 |
# File 'lib/bolt/cli.rb', line 642 def list_plans plans = filter_content(pal.list_plans_with_cache(filter_content: true), [:filter]) outputter.print_plans(plans, pal.user_modulepath) end |
#list_targets ⇒ Object
647 648 649 650 651 652 653 654 655 656 657 658 659 660 |
# File 'lib/bolt/cli.rb', line 647 def list_targets if .keys.any? { |key| TARGETING_OPTIONS.include?(key) } target_flag = true else [:targets] = 'all' end outputter.print_targets( group_targets_by_source, inventory.source, config.default_inventoryfile, target_flag ) end |
#list_tasks ⇒ Object
633 634 635 636 |
# File 'lib/bolt/cli.rb', line 633 def list_tasks tasks = filter_content(pal.list_tasks(filter_content: true), [:filter]) outputter.print_tasks(tasks, pal.user_modulepath) end |
#list_topics ⇒ Object
Display the list of available Bolt guides.
935 936 937 938 |
# File 'lib/bolt/cli.rb', line 935 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 [:project] dir = Pathname.new([: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, ) rescue Bolt::Error => e fatal_error(e) raise e end |
#log_outputter ⇒ Object
999 1000 1001 |
# File 'lib/bolt/cli.rb', line 999 def log_outputter @log_outputter ||= Bolt::Outputter::Logger.new([:verbose], config.trace) end |
#lookup(key, targets) ⇒ Object
Looks up a value with Hiera, using targets as the contexts to perform the look ups in.
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 726 727 728 |
# File 'lib/bolt/cli.rb', line 701 def lookup(key, targets) executor = Bolt::Executor.new( config.concurrency, analytics, [:noop], config.modified_concurrency, config.future ) executor.subscribe(outputter) if .fetch(:format, 'human') == 'human' executor.subscribe(log_outputter) executor.publish_event(type: :plan_start, plan: nil) results = outputter.spin do pal.lookup( key, targets, inventory, executor, config.concurrency ) end executor.shutdown outputter.print_result_set(results) results.ok ? 0 : 1 end |
#outputter ⇒ Object
991 992 993 994 995 996 997 |
# File 'lib/bolt/cli.rb', line 991 def outputter @outputter ||= Bolt::Outputter.for_format(config.format, config.color, [:verbose], config.trace, config.spinner) end |
#pal ⇒ Object
908 909 910 911 912 913 914 915 916 |
# File 'lib/bolt/cli.rb', line 908 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.
96 97 98 99 100 |
# File 'lib/bolt/cli.rb', line 96 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.
146 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 146 def parse_command parser = BoltOptionParser.new() # 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 [:subcommand] = nil unless COMMANDS.include?([:subcommand]) if Bolt::Util.first_run? FileUtils.mkdir_p(Bolt::Util.first_runs_free.dirname) FileUtils.touch(Bolt::Util.first_runs_free) if [:subcommand].nil? && $stdout.isatty raise Bolt::CLIExit end end # Update the parser for the subcommand (or lack thereof) parser.update puts parser.help raise Bolt::CLIExit end [:object] = remaining.shift # Handle reading a command from a file if [:subcommand] == 'command' && [:object] [:object] = Bolt::Util.get_arg_input([:object]) end # Only parse task_options for task or plan if %w[task plan].include?([:subcommand]) , remaining = remaining.partition { |s| s =~ /.+=/ } if [:task_options] unless .empty? raise Bolt::CLIError, "Parameters must be specified through either the --params " \ "option or param=value pairs, not both" end [:params_parsed] = true elsif .any? [:params_parsed] = false [:task_options] = Hash[.map { |a| a.split('=', 2) }] else [:params_parsed] = true [:task_options] = {} end end [:leftovers] = remaining # Default to verbose for everything except plans unless .key?(:verbose) [:verbose] = [:subcommand] != 'plan' end validate() rescue Bolt::Error => e fatal_error(e) raise e end |
#plugins ⇒ Object
392 393 394 |
# File 'lib/bolt/cli.rb', line 392 def plugins @plugins ||= Bolt::Plugin.setup(config, pal, analytics) end |
#puppetdb_client ⇒ Object
388 389 390 |
# File 'lib/bolt/cli.rb', line 388 def puppetdb_client plugins.puppetdb_client end |
#query_puppetdb_nodes(query) ⇒ Object
396 397 398 |
# File 'lib/bolt/cli.rb', line 396 def query_puppetdb_nodes(query) puppetdb_client.query_certnames(query) end |
#rerun ⇒ Object
987 988 989 |
# File 'lib/bolt/cli.rb', line 987 def rerun @rerun ||= Bolt::Rerun.new(config.rerunfile, config.save_rerun) end |
#run_plan(plan_name, plan_arguments, nodes, options) ⇒ Object
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 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 |
# File 'lib/bolt/cli.rb', line 730 def run_plan(plan_name, plan_arguments, nodes, ) 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, [:noop], config.modified_concurrency, config.future) if %w[human rainbow].include?(.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.
941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 |
# File 'lib/bolt/cli.rb', line 941 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.}: unable to load guide page", filepath) end outputter.print_guide(guide, topic) else analytics.event('Guide', 'unknown_topic', label: topic) outputter.("Did not find guide for topic '#{topic}'.\n\n") list_topics end 0 end |
#show_plan(plan_name) ⇒ Object
638 639 640 |
# File 'lib/bolt/cli.rb', line 638 def show_plan(plan_name) outputter.print_plan_info(pal.get_plan_info(plan_name)) end |
#show_targets ⇒ Object
662 663 664 665 666 667 668 669 670 671 672 673 674 675 |
# File 'lib/bolt/cli.rb', line 662 def show_targets if .keys.any? { |key| TARGETING_OPTIONS.include?(key) } target_flag = true else [:targets] = 'all' end outputter.print_target_info( group_targets_by_source, inventory.source, config.default_inventoryfile, target_flag ) end |
#show_task(task_name) ⇒ Object
622 623 624 |
# File 'lib/bolt/cli.rb', line 622 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() target_opts = .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? && [:subcommand] != 'plan' raise Bolt::CLIError, "Command requires a targeting option: #{target_string}" end targets = if [:query] query_puppetdb_nodes([:query]) elsif [:rerun] rerun.get_targets([:rerun]) else [:targets] || [] end [:target_args] = targets [: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 |
# File 'lib/bolt/cli.rb', line 287 def validate() unless COMMANDS.include?([:subcommand]) command = Bolt::Util.powershell? ? 'Get-Command -Module PuppetBolt' : 'bolt help' raise Bolt::CLIError, "'#{[:subcommand]}' is not a Bolt command. See '#{command}'." end actions = COMMANDS[[:subcommand]] if actions.any? if [:action].nil? raise Bolt::CLIError, "Expected an action of the form 'bolt #{[:subcommand]} <action>'" end unless actions.include?([:action]) raise Bolt::CLIError, "Expected action '#{[:action]}' to be one of " \ "#{actions.join(', ')}" end end if %w[task plan script].include?([:subcommand]) && [:action] == 'run' if [:object].nil? raise Bolt::CLIError, "Must specify a #{[:subcommand]} to run" end end # This may mean that we parsed a parameter as the object if %w[task plan].include?([:subcommand]) && [:action] == 'run' unless [:object] =~ /\A([a-z][a-z0-9_]*)?(::[a-z][a-z0-9_]*)*\Z/ raise Bolt::CLIError, "Invalid #{[:subcommand]} '#{[:object]}'" end end if [:subcommand] == 'apply' && ([:object] && [:code]) raise Bolt::CLIError, "--execute is unsupported when specifying a manifest file" end if [:subcommand] == 'apply' && (![:object] && ![:code]) raise Bolt::CLIError, "a manifest file or --execute is required" end if [:subcommand] == 'lookup' && ![:object] raise Bolt::CLIError, "Must specify a key to look up" end if [:subcommand] == 'command' && (![:object] || [:object].empty?) raise Bolt::CLIError, "Must specify a command to run" end if [:subcommand] == 'secret' && ([:action] == 'decrypt' || [:action] == 'encrypt') && ![:object] raise Bolt::CLIError, "Must specify a value to #{[:action]}" end if [:subcommand] == 'plan' && [:action] == 'new' && ![:object] raise Bolt::CLIError, "Must specify a plan name." end if [:subcommand] == 'module' && [:action] == 'add' && ![:object] raise Bolt::CLIError, "Must specify a module name." end if [:subcommand] == 'module' && [:action] == 'install' && [:object] command = Bolt::Util.powershell? ? 'Add-BoltModule -Module' : 'bolt module add' raise Bolt::CLIError, "Invalid argument '#{[:object]}'. To add a new module to "\ "the project, run '#{command} #{[:object]}'." end if [:subcommand] != 'file' && [:subcommand] != 'script' && ![:leftovers].empty? raise Bolt::CLIError, "Unknown argument(s) #{[:leftovers].join(', ')}" end if [:noop] && !([:subcommand] == 'task' && [:action] == 'run') && [:subcommand] != 'apply' raise Bolt::CLIError, "Option '--noop' can only be specified when running a task or applying manifest code" end if [:env_vars] unless %w[command script].include?([:subcommand]) && [: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
960 961 962 963 964 965 966 |
# File 'lib/bolt/cli.rb', line 960 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
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 |
# File 'lib/bolt/cli.rb', line 400 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]) = Set.new(opts.keys.map(&:to_s)).intersection(inventory_cli_opts) if inventory_source && .any? Bolt::Logger.warn( "cli_overrides", "CLI arguments #{.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`
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 103 def 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? = <<~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 end |