bolt 1.33.0 → 1.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8529a13b894e496846dd0720d8980e98b4fa6146216089e7792e30ece43e7e17
-  data.tar.gz: 319d8cfe5375164d4c94868131a8b5a048d3b8b7b95e45e892e79a470ec4b8d9
+  metadata.gz: 37db36042df92f069108154b4a08d21095a1c84f2403b454a9a2ebf74c73fef2
+  data.tar.gz: ede33892ae497dd185eba5c45d4f2ca7fafb0c5c607aa6c8d50f1fb9b70d267a
 SHA512:
-  metadata.gz: 12b4179334e1849115a5648148193c7aab3da768061ce17b4694c35fa836ccb7184258dca2a3376e0a7bca8c9edbe1439d49f5a1f3e3a30929bd67a7ea5e0930
-  data.tar.gz: b57dc487c0ae46c76206a51f9ed27a1791595e8eab63aa9701f1dcc0785e2b52dc051900109b7f3a74d4a7d9ba1b507b879f5fca4a6b9611737e0e092588dc88
+  metadata.gz: a5e2af615b54b7f116c47b3b78c16776882e086f8a41cf3520336ff6e3cd0f670a3ff9e36083d2cecdc60ab9d2df14be424e57cac3a275113e1f4dddb73b2c54
+  data.tar.gz: 90cc1192bba5fc7e8b7b9314c05b4dc37c867fd55f2d69e09a33d8f4c9330207da8f8a646c279f956a72def157ff875991605778923c93df009351b6b9afd03b

data/bolt-modules/boltlib/lib/puppet/datatypes/result.rb

@@ -10,6 +10,7 @@ Puppet::DataTypes.create_type('Result') do
       error => Callable[[], Optional[Error]],
       message => Callable[[], Optional[String]],
       action => Callable[[], String],
+      status => Callable[[], String],
       to_data => Callable[[], Hash],
       ok => Callable[[], Boolean],
       '[]' => Callable[[String[1]], Data]

data/bolt-modules/boltlib/lib/puppet/functions/add_facts.rb

@@ -8,13 +8,13 @@ require 'bolt/error'
 Puppet::Functions.create_function(:add_facts) do
   # @param target A target.
   # @param facts A hash of fact names to values that may include structured facts.
-  # @return The target's new facts.
+  # @return The target's new facts or a `Target` object if the `future` flag is set to true
   # @example Adding facts to a target
   #   add_facts($target, { 'os' => { 'family' => 'windows', 'name' => 'windows' } })
   dispatch :add_facts do
     param 'Target', :target
     param 'Hash', :facts
-    return_type 'Hash[String, Data]'
+    return_type 'Variant[Target, Hash[String, Data]]'
   end
 
   def add_facts(target, facts)

data/bolt-modules/boltlib/lib/puppet/functions/apply_prep.rb

@@ -100,8 +100,9 @@ Puppet::Functions.create_function(:apply_prep) do
 
             hooks = need_install_targets.map do |t|
               begin
-                opts = t.plugin_hooks&.fetch('puppet_library')
-                hook = inventory.plugins.get_hook(opts['plugin'], :puppet_library)
+                opts = t.plugin_hooks&.fetch('puppet_library').dup
+                plugin_name = opts.delete('plugin')
+                hook = inventory.plugins.get_hook(plugin_name, :puppet_library)
                 { 'target' => t,
                   'hook_proc' => hook.call(opts, t, self) }
               rescue StandardError => e

data/bolt-modules/boltlib/lib/puppet/functions/run_plan.rb

@@ -2,7 +2,7 @@
 
 require 'bolt/error'
 
-# Runs the `plan` referenced by its name. A plan is autoloaded from `<moduleroot>/plans`.
+# Runs the `plan` referenced by its name. A plan is autoloaded from `$MODULEROOT/plans`.
 #
 # **NOTE:** Not available in apply block
 Puppet::Functions.create_function(:run_plan, Puppet::Functions::InternalFunction) do

data/bolt-modules/boltlib/lib/puppet/functions/run_script.rb

@@ -7,7 +7,7 @@
 Puppet::Functions.create_function(:run_script, Puppet::Functions::InternalFunction) do
   # Run a script.
   # @param script Path to a script to run on target. May be an absolute path or a modulename/filename selector for a
-  #               file in <moduleroot>/files.
+  #               file in $MODULEROOT/files.
   # @param targets A pattern identifying zero or more targets. See {get_targets} for accepted patterns.
   # @param options Specify an array of arguments to the 'arguments' key to be passed to the script.
   #                Additional options: '_catch_errors', '_run_as'.
@@ -26,7 +26,7 @@ Puppet::Functions.create_function(:run_script, Puppet::Functions::InternalFuncti
 
   # Run a script, logging the provided description.
   # @param script Path to a script to run on target. May be an absolute path or a modulename/filename selector for a
-  #               file in <moduleroot>/files.
+  #               file in $MODULEROOT/files.
   # @param targets A pattern identifying zero or more targets. See {get_targets} for accepted patterns.
   # @param description A description to be output when calling this function.
   # @param options Specify an array of arguments to the 'arguments' key to be passed to the script.

data/bolt-modules/boltlib/lib/puppet/functions/run_task.rb

@@ -12,7 +12,7 @@ Puppet::Functions.create_function(:run_task) do
   # Run a task.
   # @param task_name The task to run.
   # @param targets A pattern identifying zero or more targets. See {get_targets} for accepted patterns.
-  # @param args Arguments to the plan. Can also include additional options: '_catch_errors', '_run_as'.
+  # @param args Arguments to the plan. Can also include additional options: '_catch_errors', '_run_as', '_noop'.
   # @return A list of results, one entry per target.
   # @example Run a task as root
   #   run_task('facts', $targets, '_run_as' => 'root')
@@ -27,7 +27,7 @@ Puppet::Functions.create_function(:run_task) do
   # @param task_name The task to run.
   # @param targets A pattern identifying zero or more targets. See {get_targets} for accepted patterns.
   # @param description A description to be output when calling this function.
-  # @param args Arguments to the plan. Can also include additional options: '_catch_errors', '_run_as'.
+  # @param args Arguments to the plan. Can also include additional options: '_catch_errors', '_run_as', '_noop'.
   # @return A list of results, one entry per target.
   # @example Run a task
   #   run_task('facts', $targets, 'Gather OS facts')
@@ -108,7 +108,9 @@ Puppet::Functions.create_function(:run_task) do
       end
     end
 
-    if executor.noop
+    # executor.noop is set when run task is called from the CLI
+    # options[:noop] is set when it's called from a plan
+    if executor.noop || options[:noop]
       if task.supports_noop
         params['_noop'] = true
       else

data/bolt-modules/boltlib/lib/puppet/functions/upload_file.rb

@@ -9,7 +9,7 @@ require 'bolt/error'
 Puppet::Functions.create_function(:upload_file, Puppet::Functions::InternalFunction) do
   # Upload a file or directory.
   # @param source A source path, either an absolute path or a modulename/filename selector for a
-  #               file or directory in <moduleroot>/files.
+  #               file or directory in $MODULEROOT/files.
   # @param destination An absolute path on the target(s).
   # @param targets A pattern identifying zero or more targets. See {get_targets} for accepted patterns.
   # @param options Additional options: '_catch_errors', '_run_as'.
@@ -29,7 +29,7 @@ Puppet::Functions.create_function(:upload_file, Puppet::Functions::InternalFunct
 
   # Upload a file or directory, logging the provided description.
   # @param source A source path, either an absolute path or a modulename/filename selector for a
-  #               file or directory in <moduleroot>/files.
+  #               file or directory in $MODULEROOT/files.
   # @param destination An absolute path on the target(s).
   # @param targets A pattern identifying zero or more targets. See {get_targets} for accepted patterns.
   # @param description A description to be output when calling this function.

data/lib/bolt/bolt_option_parser.rb

@@ -31,6 +31,9 @@ module Bolt
       when 'inventory'
         { flags: OPTIONS[:inventory] + OPTIONS[:global] + %w[format inventoryfile boltdir configfile],
           banner: INVENTORY_HELP }
+      when 'group'
+        { flags: OPTIONS[:global] + %w[format inventoryfile boltdir configfile],
+          banner: GROUP_HELP }
       when 'plan'
         case action
         when 'convert'
@@ -117,6 +120,7 @@ module Bolt
         bolt secret encrypt <plaintext>  Encrypt a value
         bolt secret decrypt <encrypted>  Decrypt a value
         bolt inventory show              Show the list of targets an action would run on
+        bolt group show                  Show the list of groups in the inventory
 
       Run `bolt <subcommand> --help` to view specific examples.
 
@@ -297,6 +301,15 @@ module Bolt
       Available options are:
     INVENTORY_HELP
 
+    GROUP_HELP = <<~GROUP_HELP
+      Usage: bolt group <action>
+
+      Available actions are:
+        show                     Show the list of groups in the inventory
+
+      Available options are:
+    GROUP_HELP
+
     def initialize(options)
       super()
 

data/lib/bolt/cli.rb

@@ -36,6 +36,7 @@ module Bolt
                  'puppetfile' => %w[install show-modules generate-types],
                  'secret' => %w[encrypt decrypt createkeys],
                  'inventory' => %w[show],
+                 'group' => %w[show],
                  'apply' => %w[] }.freeze
 
     attr_reader :config, :options
@@ -117,6 +118,11 @@ 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
@@ -302,6 +308,8 @@ module Bolt
           end
         elsif options[:subcommand] == 'inventory'
           list_targets
+        elsif options[:subcommand] == 'group'
+          list_groups
         end
         return 0
       elsif options[:action] == 'show-modules'
@@ -408,6 +416,11 @@ module Bolt
       outputter.print_targets(options)
     end
 
+    def list_groups
+      groups = inventory.group_names
+      outputter.print_groups(groups)
+    end
+
     def run_plan(plan_name, plan_arguments, nodes, options)
       unless nodes.empty?
         if plan_arguments['nodes']
@@ -419,9 +432,8 @@ module Bolt
         plan_arguments['nodes'] = nodes.join(',')
       end
 
-      params = options[:noop] ? plan_arguments.merge('_noop' => true) : plan_arguments
       plan_context = { plan_name: plan_name,
-                       params: params }
+                       params: plan_arguments }
       plan_context[:description] = options[:description] if options[:description]
 
       executor = Bolt::Executor.new(config.concurrency, analytics, options[:noop])

data/lib/bolt/config.rb

@@ -33,7 +33,7 @@ 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
+                  :puppetfile_config, :plugins, :plugin_hooks, :future
     attr_writer :modulepath
 
     TRANSPORT_OPTIONS = %i[password run-as sudo-password extensions
@@ -164,6 +164,8 @@ module Bolt
       @plugins = data['plugins'] if data.key?('plugins')
       @plugin_hooks.merge!(data['plugin_hooks']) if data.key?('plugin_hooks')
 
+      @future = data['future'] == true
+
       %w[concurrency format puppetdb color transport].each do |key|
         send("#{key}=", data[key]) if data.key?(key)
       end

data/lib/bolt/inventory.rb

@@ -149,7 +149,10 @@ module Bolt
 
     def add_facts(target, new_facts = {})
       @logger.warn("No facts to add") if new_facts.empty?
-      set_facts(target.name, new_facts)
+      facts = set_facts(target.name, new_facts)
+      # rubocop:disable Style/GlobalVars
+      $future ? target : facts
+      # rubocop:enable Style/GlobalVars
     end
 
     def facts(target)

data/lib/bolt/inventory/inventory2.rb

@@ -145,7 +145,7 @@ module Bolt
         conf.validate
 
         # Recompute the target cached state with the merged data
-        update_target_state(target, conf.transport_conf, data)
+        update_target_state(target, conf, data)
 
         unless target.transport.nil? || Bolt::TRANSPORTS.include?(target.transport.to_sym)
           raise Bolt::UnknownTransportError.new(target.transport, target.uri)
@@ -312,7 +312,9 @@ module Bolt
       def add_facts(target, new_facts = {})
         @targets[target.name]['facts'] = Bolt::Util.deep_merge(@targets[target.name]['facts'], new_facts)
         update_target(target)
-        facts(target)
+        # rubocop:disable Style/GlobalVars
+        $future ? target : facts(target)
+        # rubocop:enable Style/GlobalVars
       end
 
       def facts(target)
@@ -357,8 +359,8 @@ module Bolt
       private :build_config_hash
 
       def update_target_state(target, conf, merged_data)
-        @targets[target.name]['protocol'] = conf[:transport]
-        t_conf = conf[:transports][target.transport.to_sym] || {}
+        @targets[target.name]['protocol'] = conf.transport_conf[:transport]
+        t_conf = conf.transport_conf[:transports][target.transport.to_sym] || {}
         @targets[target.name]['user'] = t_conf['user']
         @targets[target.name]['password'] = t_conf['password']
         @targets[target.name]['port'] = t_conf['port']
@@ -381,7 +383,8 @@ module Bolt
 
         target_plugin_hooks = @targets[target.name]['plugin_hooks'] || {}
         new_plugin_hooks = merged_data['plugin_hooks'] || {}
-        @targets[target.name]['cached_state']['plugin_hooks'] = new_plugin_hooks.merge(target_plugin_hooks)
+        plugin_hooks_from_inv = new_plugin_hooks.merge(target_plugin_hooks)
+        @targets[target.name]['cached_state']['plugin_hooks'] = conf.plugin_hooks.merge(plugin_hooks_from_inv)
       end
       private :update_target_state
     end

data/lib/bolt/outputter/human.rb

@@ -318,6 +318,12 @@ module Bolt
         @stream.puts colorize(:green, count)
       end
 
+      def print_groups(groups)
+        count = "#{groups.count} group#{'s' unless groups.count == 1}"
+        @stream.puts groups.join("\n")
+        @stream.puts colorize(:green, count)
+      end
+
       # @param [Bolt::ResultSet] apply_result A ResultSet object representing the result of a `bolt apply`
       def print_apply_result(apply_result, elapsed_time)
         print_summary(apply_result, elapsed_time)

data/lib/bolt/outputter/json.rb

@@ -96,6 +96,12 @@ module Bolt
                        "count": count }.to_json)
       end
 
+      def print_groups(groups)
+        count = groups.count
+        @stream.puts({ "groups": groups,
+                       "count": count }.to_json)
+      end
+
       def fatal_error(err)
         @stream.puts "],\n" if @items_open
         @stream.puts '"_error": ' if @object_open

data/lib/bolt/plugin/module.rb

@@ -220,14 +220,12 @@ module Bolt
       end
 
       def puppet_library(opts, target, apply_prep)
-        tasksig = @hook_map[:puppet_library]
+        task = @hook_map[:puppet_library]['task']
 
-        # this also validates
-        params, meta_params = process_params(tasksig, opts)
+        params, meta_params = process_params(task, opts)
 
         # our metaparams are meant for the task not the executor
         params = params.merge(meta_params)
-        task = Bolt::Task.new(tasksig)
 
         proc do
           apply_prep.run_task([target], task, params).first

data/lib/bolt/result.rb

@@ -92,12 +92,15 @@ module Bolt
 
     def status_hash
       # DEPRECATION: node in status hashes is deprecated and should be removed in 2.0
-      { node: @target.name,
+      base = {
         target: @target.name,
         action: action,
         object: object,
-        status: ok? ? 'success' : 'failure',
-        result: @value }
+        status: status
+      }
+      # rubocop:disable Style/GlobalVars
+      $future ? base.merge(value: @value) : base.merge(result: @value, node: @target.name)
+      # rubocop:enable Style/GlobalVars
     end
 
     def generic_value
@@ -132,6 +135,10 @@ module Bolt
       Bolt::Util.walk_keys(status_hash, &:to_s)
     end
 
+    def status
+      ok? ? 'success' : 'failure'
+    end
+
     def ok?
       error_hash.nil?
     end

data/lib/bolt/target.rb

@@ -14,7 +14,7 @@ module Bolt
     end
 
     # Target.new from a plan with just a uri
-    # rubocop:disable UnusedMethodArgument
+    # rubocop:disable Lint/UnusedMethodArgument
     def self.from_asserted_args(uri = nil,
                                 name = nil,
                                 target_alias = nil,
@@ -38,7 +38,7 @@ module Bolt
                    plugin_hooks = nil)
       @name = name
     end
-    # rubocop:enable UnusedMethodArgument
+    # rubocop:enable Lint/UnusedMethodArgument
 
     # Used for munging target + group data
     def target_data_hash

data/lib/bolt/transport/docker/connection.rb

@@ -12,6 +12,7 @@ module Bolt
           @target = target
           @logger = Logging.logger[target.safe_name]
           @docker_host = @target.options['service-url']
+          @logger.debug("Initializing docker connection to #{@target.safe_name}")
         end
 
         def connect

data/lib/bolt/transport/ssh/connection.rb

@@ -32,6 +32,7 @@ module Bolt
 
           @logger = Logging.logger[@target.safe_name]
           @transport_logger = transport_logger
+          @logger.debug("Initializing ssh connection to #{@target.safe_name}")
 
           if target.options['private-key']&.instance_of?(String)
             begin

data/lib/bolt/transport/winrm/connection.rb

@@ -24,6 +24,7 @@ module Bolt
           @extensions = DEFAULT_EXTENSIONS.to_set.merge(extensions)
 
           @logger = Logging.logger[@target.safe_name]
+          logger.debug("Initializing winrm connection to #{@target.safe_name}")
           @transport_logger = transport_logger
         end
 

data/lib/bolt/util.rb

@@ -29,10 +29,12 @@ module Bolt
           logger.debug(msg)
           nil
         end
-      rescue Psych::Exception
-        raise Bolt::FileError.new("Could not parse #{file_name} file: #{path}", path)
-      rescue IOError, SystemCallError
-        raise Bolt::FileError.new("Could not read #{file_name} file: #{path}", path)
+      rescue Psych::Exception => e
+        raise Bolt::FileError.new("Could not parse #{file_name} file: #{path}\n"\
+                                  "Error at line #{e.line} column #{e.column}", path)
+      rescue IOError, SystemCallError => e
+        raise Bolt::FileError.new("Could not read #{file_name} file: #{path}\n"\
+                                  "error: #{e}", path)
       end
 
       # Accepts a path with either 'plans' or 'tasks' in it and determines

data/lib/bolt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bolt
-  VERSION = '1.33.0'
+  VERSION = '1.34.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 1.33.0
+  version: 1.34.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-10 00:00:00.000000000 Z
+date: 2019-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable