bolt 1.49.0 → 2.0.0

data/lib/bolt/apply_target.rb

@@ -46,7 +46,7 @@ module Bolt
       end
 
       # Merge the config hash with inventory config
-      config = Bolt::Util.deep_merge(config, @config)
+      config = Bolt::Util.deep_merge(config, @config || {})
       transport = config['transport'] || 'ssh'
       t_conf = config['transports'][transport] || {}
       uri_obj = parse_uri(uri)

data/lib/bolt/bolt_option_parser.rb

@@ -6,7 +6,7 @@ require 'optparse'
 
 module Bolt
   class BoltOptionParser < OptionParser
-    OPTIONS = { inventory: %w[nodes targets query rerun description],
+    OPTIONS = { inventory: %w[targets query rerun description],
                 authentication: %w[user password password-prompt private-key host-key-check ssl ssl-verify],
                 escalation: %w[run-as sudo-password sudo-password-prompt sudo-executable],
                 run_context: %w[concurrency inventoryfile save-rerun],
@@ -67,7 +67,7 @@ module Bolt
           { flags: ACTION_OPTS + %w[params compile-concurrency tmpdir],
             banner: PLAN_RUN_HELP }
         when 'show'
-          { flags: OPTIONS[:global] + OPTIONS[:global_config_setters],
+          { flags: OPTIONS[:global] + OPTIONS[:global_config_setters] + %w[filter format],
             banner: PLAN_SHOW_HELP }
         else
           { flags: OPTIONS[:global],
@@ -130,7 +130,7 @@ module Bolt
           { flags: ACTION_OPTS + %w[params tmpdir noop],
             banner: TASK_RUN_HELP }
         when 'show'
-          { flags: OPTIONS[:global] + OPTIONS[:global_config_setters],
+          { flags: OPTIONS[:global] + OPTIONS[:global_config_setters] + %w[filter format],
             banner: TASK_SHOW_HELP }
         else
           { flags: OPTIONS[:global],
@@ -599,17 +599,11 @@ module Bolt
       @warnings = []
 
       separator "\nINVENTORY OPTIONS"
-      define('-n', '--nodes NODES',
-             'Alias for --targets',
-             'Deprecated in favor of --targets') do |nodes|
-        @options [:nodes] ||= []
-        @options[:nodes] << get_arg_input(nodes)
-      end
       define('-t', '--targets TARGETS',
              'Identifies the targets of command.',
              'Enter a comma-separated list of target URIs or group names.',
              "Or read a target list from an input file '@<file>' or stdin '-'.",
-             'Example: --targets localhost,node_group,ssh://nix.com:23,winrm://windows.puppet.com',
+             'Example: --targets localhost,target_group,ssh://nix.com:23,winrm://windows.puppet.com',
              'URI format is [protocol://]host[:port]',
              "SSH is the default protocol; may be #{TRANSPORTS.keys.join(', ')}",
              'For Windows targets, specify the winrm:// protocol if it has not be configured',
@@ -621,10 +615,10 @@ module Bolt
       define('-q', '--query QUERY', 'Query PuppetDB to determine the targets') do |query|
         @options[:query] = query
       end
-      define('--rerun FILTER', 'Retry on nodes from the last run',
-             "'all' all nodes that were part of the last run.",
-             "'failure' nodes that failed in the last run.",
-             "'success' nodes that succeeded in the last run.") do |rerun|
+      define('--rerun FILTER', 'Retry on targets from the last run',
+             "'all' all targets that were part of the last run.",
+             "'failure' targets that failed in the last run.",
+             "'success' targets that succeeded in the last run.") do |rerun|
         @options[:rerun] = rerun
       end
       define('--noop', 'See what changes Bolt will make without actually executing the changes') do |_|
@@ -650,18 +644,9 @@ module Bolt
       define('-u', '--user USER', 'User to authenticate as') do |user|
         @options[:user] = user
       end
-      define('-p', '--password [PASSWORD]',
+      define('-p', '--password PASSWORD',
              'Password to authenticate with') do |password|
-        if password.nil?
-          msg = "Optional parameter for --password is deprecated and will no longer prompt for password. " \
-                "Use the prompt plugin or --password-prompt instead to prompt for passwords."
-          @warnings << { option: 'password', msg: msg }
-          STDOUT.print "Please enter your password: "
-          @options[:password] = STDIN.noecho(&:gets).chomp
-          STDOUT.puts
-        else
-          @options[:password] = password
-        end
+        @options[:password] = password
       end
       define('--password-prompt', 'Prompt for user to input password') do |_password|
         STDERR.print "Please enter your password: "
@@ -685,18 +670,9 @@ module Bolt
       define('--run-as USER', 'User to run as using privilege escalation') do |user|
         @options[:'run-as'] = user
       end
-      define('--sudo-password [PASSWORD]',
+      define('--sudo-password PASSWORD',
              'Password for privilege escalation') do |password|
-        if password.nil?
-          msg = "Optional parameter for --sudo-password is deprecated and will no longer prompt for password. " \
-                "Use the prompt plugin or --sudo-password-prompt instead to prompt for passwords."
-          @warnings << { option: 'sudo-password', msg: msg }
-          STDOUT.print "Please enter your privilege escalation password: "
-          @options[:'sudo-password'] = STDIN.noecho(&:gets).chomp
-          STDOUT.puts
-        else
-          @options[:'sudo-password'] = password
-        end
+        @options[:'sudo-password'] = password
       end
       define('--sudo-password-prompt', 'Prompt for user to input escalation password') do |_password|
         STDERR.print "Please enter your privilege escalation password: "
@@ -753,7 +729,7 @@ module Bolt
       define('--connect-timeout TIMEOUT', Integer, 'Connection timeout (defaults vary)') do |timeout|
         @options[:'connect-timeout'] = timeout
       end
-      define('--[no-]tty', 'Request a pseudo TTY on nodes that support it') do |tty|
+      define('--[no-]tty', 'Request a pseudo TTY on targets that support it') do |tty|
         @options[:tty] = tty
       end
       define('--tmpdir DIR', 'The directory to upload and execute temporary files on the target') do |tmpdir|
@@ -761,6 +737,14 @@ module Bolt
       end
 
       separator "\nDISPLAY OPTIONS"
+      define('--filter FILTER', 'Filter tasks and plans by a matching substring') do |filter|
+        unless /^[a-z0-9_:]+$/.match(filter)
+          msg = "Illegal characters in filter string '#{filter}'. Filters must match a legal "\
+                "task or plan name."
+          raise Bolt::CLIError, msg
+        end
+        @options[:filter] = filter
+      end
       define('--format FORMAT', 'Output format to use: human or json') do |format|
         @options[:format] = format
       end

data/lib/bolt/catalog.rb

@@ -53,43 +53,26 @@ module Bolt
       end
     end
 
-    def setup_inventory(inventory)
-      config = Bolt::Config.default
-      config.overwrite_transport_data(inventory['config']['transport'],
-                                      Bolt::Util.symbolize_top_level_keys(inventory['config']['transports']))
-
-      Bolt::Inventory.new(inventory['data'],
-                          config,
-                          Bolt::Util.symbolize_top_level_keys(inventory['target_hash']))
-    end
-
     def compile_catalog(request)
       pal_main = request['code_ast'] || request['code_string']
       target = request['target']
       pdb_client = Bolt::PuppetDB::Client.new(Bolt::PuppetDB::Config.new(request['pdb_config']))
       options = request['puppet_config'] || {}
-
       with_puppet_settings(request['hiera_config']) do
         Puppet[:rich_data] = true
         Puppet[:node_name_value] = target['name']
         env_conf = { modulepath: request['modulepath'] || [],
                      facts: target['facts'] || {} }
-        env_conf[:variables] = request['future'] ? {} : target['variables']
+        env_conf[:variables] = {}
         Puppet::Pal.in_tmp_environment('bolt_catalog', env_conf) do |pal|
-          inv = if request['future']
-                  Bolt::ApplyInventory.new(request['config'])
-                else
-                  setup_inventory(request['inventory'])
-                end
+          inv = Bolt::ApplyInventory.new(request['config'])
           Puppet.override(bolt_pdb_client: pdb_client,
                           bolt_inventory: inv) do
             Puppet.lookup(:pal_current_node).trusted_data = target['trusted']
             pal.with_catalog_compiler do |compiler|
-              if request['future']
-                # This needs to happen inside the catalog compiler so loaders are initialized for loading
-                vars = Puppet::Pops::Serialization::FromDataConverter.convert(request['plan_vars'])
-                pal.send(:add_variables, compiler.send(:topscope), vars.merge(target['variables']))
-              end
+              # This needs to happen inside the catalog compiler so loaders are initialized for loading
+              vars = Puppet::Pops::Serialization::FromDataConverter.convert(request['plan_vars'])
+              pal.send(:add_variables, compiler.send(:topscope), target['variables'].merge(vars))
 
               # Configure language strictness in the CatalogCompiler. We want Bolt to be able
               # to compile most Puppet 4+ manifests, so we default to allowing deprecated functions.

data/lib/bolt/catalog/logging.rb

@@ -10,6 +10,6 @@ Puppet::Util::Log.newdesttype :stderr do
   def handle(msg)
     str = msg.respond_to?(:multiline) ? msg.multiline : msg.to_s
     str = msg.source == "Puppet" ? str : "#{msg.source}: #{str}"
-    warn({ msg.level => str }.to_json)
+    warn({ level: msg.level, message: str }.to_json)
   end
 end

data/lib/bolt/cli.rb

@@ -122,11 +122,6 @@ module Bolt
                   Bolt::Config.from_boltdir(boltdir, options)
                 end
 
-      # Set $future global if configured
-      # rubocop:disable Style/GlobalVars
-      $future = @config.future
-      # rubocop:enable Style/GlobalVars
-
       Bolt::Logger.configure(config.log, config.color)
 
       # Logger must be configured before checking path case, otherwise warnings will not display
@@ -135,7 +130,10 @@ module Bolt
       # Log the file paths for loaded config files
       config_loaded
 
+      # Display warnings created during parser and config initialization
       parser.warnings.each { |warning| @logger.warn(warning[:msg]) }
+      config.warnings.each { |warning| @logger.warn(warning[:msg]) }
+
       # After validation, initialize inventory and targets. Errors here are better to catch early.
       # After this step
       # options[:target_args] will contain a string/array version of the targetting options this is passed to plans
@@ -154,12 +152,6 @@ module Bolt
         options[:verbose] = options[:subcommand] != 'plan'
       end
 
-      # TODO: Remove deprecation warning
-      if options[:nodes]
-        @logger.warn("Deprecation Warning: The --nodes command line option has been " \
-                     "deprecated in favor of --targets.")
-      end
-
       warn_inventory_overrides_cli(options)
       options
     rescue Bolt::Error => e
@@ -168,23 +160,23 @@ module Bolt
     end
 
     def update_targets(options)
-      target_opts = options.keys.select { |opt| %i[query rerun nodes targets].include?(opt) }
-      target_string = "'--nodes', '--targets', '--rerun', or '--query'"
+      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
 
-      nodes = if options[:query]
-                query_puppetdb_nodes(options[:query])
-              elsif options[:rerun]
-                rerun.get_targets(options[:rerun])
-              else
-                options[:targets] || options[:nodes] || []
-              end
-      options[:target_args] = nodes
-      options[:targets] = inventory.get_targets(nodes)
+      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
 
     def validate(options)
@@ -453,7 +445,9 @@ module Bolt
     end
 
     def list_tasks
-      outputter.print_tasks(pal.list_tasks, pal.list_modulepath)
+      tasks = pal.list_tasks
+      tasks.select! { |task| task.first.include?(options[:filter]) } if options[:filter]
+      outputter.print_tasks(tasks, pal.list_modulepath)
     end
 
     def show_plan(plan_name)
@@ -461,7 +455,9 @@ module Bolt
     end
 
     def list_plans
-      outputter.print_plans(pal.list_plans, pal.list_modulepath)
+      plans = pal.list_plans
+      plans.select! { |plan| plan.first.include?(options[:filter]) } if options[:filter]
+      outputter.print_plans(plans, pal.list_modulepath)
     end
 
     def list_targets
@@ -584,27 +580,18 @@ module Bolt
     end
 
     def migrate_project
-      if inventory.version == 2
-        ok = true
-      else
-        inventory_file = config.inventoryfile || config.boltdir.inventory_file
-
-        begin
-          Bolt::Util.file_stat(inventory_file)
-        rescue Errno::ENOENT
-          raise Bolt::FileError.new("The inventory file '#{inventory_file}' does not exist", inventory_file)
-        end
+      inventory_file = config.inventoryfile || config.default_inventoryfile
+      data = Bolt::Util.read_yaml_hash(inventory_file, 'inventory')
 
-        inv = YAML.safe_load(File.open(inventory_file))
-        migrate_group(inv)
+      migrated = migrate_group(data)
+      ok = File.write(inventory_file, data.to_yaml) if migrated
 
-        ok = File.write(inventory_file, { 'version' => 2 }.merge(inv).to_yaml)
-      end
-
-      result = if ok
-                 "Successfully migrated Bolt project to latest version"
+      result = if migrated && ok
+                 "Successfully migrated Bolt project to latest version."
+               elsif !migrated
+                 "Bolt project already on latest version. Nothing to do."
                else
-                 "Could not migrate Bolt project to latest version"
+                 "Could not migrate Bolt project to latest version."
                end
       outputter.print_message result
 
@@ -615,7 +602,9 @@ module Bolt
     # and all 'name' keys nested in a 'targets' hash with 'uri' keys. Data is
     # modified in place.
     def migrate_group(group)
+      migrated = false
       if group.key?('nodes')
+        migrated = true
         targets = group['nodes'].map do |target|
           target['uri'] = target.delete('name') if target.is_a?(Hash)
           target
@@ -624,9 +613,9 @@ module Bolt
         group['targets'] = targets
       end
       (group['groups'] || []).each do |subgroup|
-        migrate_group(subgroup)
+        migrated ||= migrate_group(subgroup)
       end
-      nil
+      migrated
     end
 
     def install_puppetfile(config, puppetfile, modulepath)

data/lib/bolt/config.rb

@@ -34,10 +34,10 @@ module Bolt
   class Config
     attr_accessor :concurrency, :format, :trace, :log, :puppetdb, :color, :save_rerun,
                   :transport, :transports, :inventoryfile, :compile_concurrency, :boltdir,
-                  :puppetfile_config, :plugins, :plugin_hooks, :future, :trusted_external,
+                  :puppetfile_config, :plugins, :plugin_hooks, :trusted_external,
                   :apply_settings
     attr_writer :modulepath
-    attr_reader :config_files
+    attr_reader :config_files, :warnings
 
     OPTIONS = {
       "apply_settings"           => "A map of Puppet settings to use when applying Puppet code",
@@ -64,9 +64,7 @@ module Bolt
                                     "specified in the URL or inventory.",
       "trusted-external-command" => "The path to an executable on the Bolt controller that can produce "\
                                     "external trusted facts. **External trusted facts are experimental in both "\
-                                    "Puppet and Bolt and this API may change or be removed.**",
-      "future"                   => "Whether to use new, breaking changes. This allows testing if Bolt content "\
-                                    "is compatible with expected future behavior."
+                                    "Puppet and Bolt and this API may change or be removed.**"
     }.freeze
 
     DEFAULT_OPTIONS = {
@@ -77,8 +75,7 @@ module Bolt
       "hiera-config" => "Boltdir/hiera.yaml",
       "inventoryfile" => "Boltdir/inventory.yaml",
       "modulepath" => ["Boltdir/modules", "Boltdir/site-modules", "Boltdir/site"],
-      "save-rerun" => true,
-      "future" => false
+      "save-rerun" => true
     }.freeze
 
     PUPPETFILE_OPTIONS = {
@@ -170,6 +167,7 @@ module Bolt
       @plugins = {}
       @plugin_hooks = {}
       @apply_settings = {}
+      @warnings = []
 
       # add an entry for the default console logger
       @log = { 'console' => {} }
@@ -234,11 +232,7 @@ module Bolt
     def normalize_log(target)
       return target if target == 'console'
       target = target[5..-1] if target.start_with?('file:')
-      if @future
-        'file:' + File.expand_path(target, @boltdir.path)
-      else
-        'file:' + File.expand_path(target)
-      end
+      'file:' + File.expand_path(target, @boltdir.path)
     end
 
     def update_logs(logs)
@@ -260,7 +254,10 @@ module Bolt
     end
 
     def update_from_file(data)
-      @future = data['future'] == true
+      if data['future']
+        msg = "Configuration option 'future' no longer exposes future behavior."
+        @warnings << { option: 'future', msg: msg }
+      end
 
       if data['log'].is_a?(Hash)
         update_logs(data['log'])
@@ -351,11 +348,11 @@ module Bolt
       TRANSPORTS.each do |key, impl|
         if data[key.to_s]
           selected = impl.filter_options(data[key.to_s])
-          if @future
-            to_expand = %w[private-key cacert token-file] & selected.keys
-            to_expand.each do |opt|
-              selected[opt] = File.expand_path(selected[opt], @boltdir.path) if selected[opt].is_a?(String)
-            end
+
+          # Expand file paths relative to the Boltdir
+          to_expand = %w[private-key cacert token-file] & selected.keys
+          to_expand.each do |opt|
+            selected[opt] = File.expand_path(selected[opt], @boltdir.path) if selected[opt].is_a?(String)
           end
 
           @transports[key] = Bolt::Util.deep_merge(@transports[key], selected)

data/lib/bolt/error.rb

@@ -101,8 +101,8 @@ module Bolt
   end
 
   class ApplyError < Error
-    def initialize(target)
-      super("Apply failed to compile for #{target}", 'bolt/apply-error')
+    def initialize(target, msg)
+      super("Apply failed to compile for #{target}: #{msg}", 'bolt/apply-error')
     end
   end
 

data/lib/bolt/executor.rb

@@ -96,32 +96,30 @@ module Bolt
           # Pass this argument through to avoid retaining a reference to a
           # local variable that will change on the next iteration of the loop.
           @pool.post(batch_promises) do |result_promises|
-            begin
-              results = yield transport, batch
-              Array(results).each do |result|
-                result_promises[result.target].set(result)
-              end
-            # NotImplementedError can be thrown if the transport is not implemented improperly
-            rescue StandardError, NotImplementedError => e
-              result_promises.each do |target, promise|
-                # If an exception happens while running, the result won't be logged
-                # by the CLI. Log a warning, as this is probably a problem with the transport.
-                # If batch_* commands are used from the Base transport, then exceptions
-                # normally shouldn't reach here.
-                @logger.warn(e)
-                promise.set(Bolt::Result.from_exception(target, e))
-              end
-            ensure
-              # Make absolutely sure every promise gets a result to avoid a
-              # deadlock. Use whatever exception is causing this block to
-              # execute, or generate one if we somehow got here without an
-              # exception and some promise is still missing a result.
-              result_promises.each do |target, promise|
-                next if promise.fulfilled?
-                error = $ERROR_INFO || Bolt::Error.new("No result was returned for #{target.uri}",
-                                                       "puppetlabs.bolt/missing-result-error")
-                promise.set(Bolt::Result.from_exception(target, error))
-              end
+            results = yield transport, batch
+            Array(results).each do |result|
+              result_promises[result.target].set(result)
+            end
+          # NotImplementedError can be thrown if the transport is not implemented improperly
+          rescue StandardError, NotImplementedError => e
+            result_promises.each do |target, promise|
+              # If an exception happens while running, the result won't be logged
+              # by the CLI. Log a warning, as this is probably a problem with the transport.
+              # If batch_* commands are used from the Base transport, then exceptions
+              # normally shouldn't reach here.
+              @logger.warn(e)
+              promise.set(Bolt::Result.from_exception(target, e))
+            end
+          ensure
+            # Make absolutely sure every promise gets a result to avoid a
+            # deadlock. Use whatever exception is causing this block to
+            # execute, or generate one if we somehow got here without an
+            # exception and some promise is still missing a result.
+            result_promises.each do |target, promise|
+              next if promise.fulfilled?
+              error = $ERROR_INFO || Bolt::Error.new("No result was returned for #{target.uri}",
+                                                     "puppetlabs.bolt/missing-result-error")
+              promise.set(Bolt::Result.from_exception(target, error))
             end
           end
           batch_promises.values
@@ -286,16 +284,14 @@ module Bolt
       log_action(description, targets) do
         batch_execute(targets) do |transport, batch|
           with_node_logging('Waiting until available', batch) do
-            begin
-              wait_until(wait_time, retry_interval) { transport.batch_connected?(batch) }
-              batch.map { |target| Result.new(target) }
-            rescue TimeoutError => e
-              available, unavailable = batch.partition { |target| transport.batch_connected?([target]) }
-              (
-                available.map { |target| Result.new(target) } +
-                unavailable.map { |target| Result.from_exception(target, e) }
-              )
-            end
+            wait_until(wait_time, retry_interval) { transport.batch_connected?(batch) }
+            batch.map { |target| Result.new(target) }
+          rescue TimeoutError => e
+            available, unavailable = batch.partition { |target| transport.batch_connected?([target]) }
+            (
+              available.map { |target| Result.new(target) } +
+              unavailable.map { |target| Result.from_exception(target, e) }
+            )
           end
         end
       end
@@ -338,9 +334,5 @@ module Bolt
     ensure
       publish_event(type: :enable_default_output)
     end
-
-    def deprecation(msg)
-      @logger.warn msg
-    end
   end
 end