bolt 2.31.0 → 2.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b9f29b79c8544029c9a69f6dc76b083857a87e178c9aae0359e49c59ce3cfdb
-  data.tar.gz: 02166a6dda2dc381365b7556f506a419e2717267e88f6015af430f7f725d75d0
+  metadata.gz: d05af3f780d500b91be547a73123d24c2da041a8ef60ba14114921358b120800
+  data.tar.gz: e8534835e69d1e5e57a353ff89a7d2667cf6d0894e8a07c1e5812282ed85b2cd
 SHA512:
-  metadata.gz: 3a282194ca9ccf988e7282afc3a3a0b57b4edc16bb5bf61790fb0eb0ef234e0c7a76c0ea6cd44915047a99e6d423311be1307f435d8000c568d0552268f6afa6
-  data.tar.gz: 957e6be1a72af03bd448fe070e6f9bb0b78aa1bb65e90a8bda251ef0f6c56e5ffaa8ff64aa0c5852963d9fecb87144b61ffd24494fe0aabcbdff43ecde9947a3
+  metadata.gz: 97b3faac5a1e423dcebf8e4fa92f55bbc36bd1c9735fc38332db40a2bb0db0e1ddc8e1e815aa29f31f9eb3601972a8d6e07b39d0c5dc6cd2762ea87a91ddec92
+  data.tar.gz: 15963b1bb77ee04a1db4f54996964b32e599e4a0cc422dc77892151b221c1a17df9e6a1c74f160a30e9146402d48819b07b3b9d2ee9c96d7e763bba97389ccc8

data/Puppetfile

@@ -6,16 +6,16 @@ moduledir File.join(File.dirname(__FILE__), 'modules')
 
 # Core modules used by 'apply'
 mod 'puppetlabs-service', '1.3.0'
-mod 'puppetlabs-puppet_agent', '4.1.1'
-mod 'puppetlabs-facts', '1.1.0'
+mod 'puppetlabs-puppet_agent', '4.2.0'
+mod 'puppetlabs-facts', '1.2.0'
 
 # Core types and providers for Puppet 6
 mod 'puppetlabs-augeas_core', '1.1.1'
 mod 'puppetlabs-host_core', '1.0.3'
 mod 'puppetlabs-scheduled_task', '2.2.1'
-mod 'puppetlabs-sshkeys_core', '2.1.0'
-mod 'puppetlabs-zfs_core', '1.1.0'
-mod 'puppetlabs-cron_core', '1.0.4'
+mod 'puppetlabs-sshkeys_core', '2.2.0'
+mod 'puppetlabs-zfs_core', '1.2.0'
+mod 'puppetlabs-cron_core', '1.0.5'
 mod 'puppetlabs-mount_core', '1.0.4'
 mod 'puppetlabs-selinux_core', '1.0.4'
 mod 'puppetlabs-yumrepo_core', '1.0.7'
@@ -34,8 +34,9 @@ mod 'puppetlabs-stdlib', '6.5.0'
 mod 'puppetlabs-aws_inventory', '0.5.2'
 mod 'puppetlabs-azure_inventory', '0.4.1'
 mod 'puppetlabs-gcloud_inventory', '0.1.3'
-mod 'puppetlabs-http_request', '0.1.0'
+mod 'puppetlabs-http_request', '0.2.0'
 mod 'puppetlabs-pkcs7', '0.1.1'
+mod 'puppetlabs-secure_env_vars', '0.1.0'
 mod 'puppetlabs-terraform', '0.5.0'
 mod 'puppetlabs-vault', '0.3.0'
 mod 'puppetlabs-yaml', '0.2.0'
@@ -44,4 +45,3 @@ mod 'puppetlabs-yaml', '0.2.0'
 mod 'canary', local: true
 mod 'aggregate', local: true
 mod 'puppetdb_fact', local: true
-mod 'secure_env_vars', local: true

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

@@ -44,9 +44,7 @@ Puppet::Functions.create_function(:catch_errors) do
       yield
     rescue Puppet::PreformattedError => e
       if e.cause.is_a?(Bolt::Error)
-        if error_types.nil?
-          e.cause.to_puppet_error
-        elsif error_types.include?(e.cause.to_h['kind'])
+        if error_types.nil? || error_types.include?(e.cause.to_h['kind'])
           e.cause.to_puppet_error
         else
           raise e

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

@@ -110,14 +110,25 @@ Puppet::Functions.create_function(:download_file, Puppet::Functions::InternalFun
     targets = inventory.get_targets(targets)
     if targets.empty?
       call_function('debug', "Simulating file download of '#{source}' - no targets given - no action taken")
-      r = Bolt::ResultSet.new([])
+      Bolt::ResultSet.new([])
     else
-      r = executor.download_file(targets, source, destination, options)
-    end
+      r = if executor.in_parallel
+            require 'concurrent'
+            require 'fiber'
+            future = Concurrent::Future.execute do
+              executor.download_file(targets, source, destination, options, Puppet::Pops::PuppetStack.top_of_stack)
+            end
+
+            Fiber.yield('unfinished') while future.incomplete?
+            future.value || future.reason
+          else
+            executor.download_file(targets, source, destination, options, Puppet::Pops::PuppetStack.top_of_stack)
+          end
 
-    if !r.ok && !options[:catch_errors]
-      raise Bolt::RunFailure.new(r, 'download_file', source)
+      if !r.ok && !options[:catch_errors]
+        raise Bolt::RunFailure.new(r, 'download_file', source)
+      end
+      r
     end
-    r
   end
 end

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

@@ -3,6 +3,12 @@
 require 'bolt/error'
 
 # Returns the facts hash for a target.
+#
+# Using the `facts` function does not automatically collect facts for a target,
+# and will only return facts that are currently set in the inventory. To collect
+# facts from a target and set them in the inventory, run the
+# [facts](writing_plans.md#collect-facts-from-targets) plan or
+# [puppetdb_fact](writing_plans.md#collect-facts-from-puppetdb) plan.
 Puppet::Functions.create_function(:facts) do
   # @param target A target.
   # @return The target's facts.

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

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'bolt/yarn'
+
+# Map a code block onto an array, where each array element executes in parallel.
+# This function is experimental.
+#
+# > **Note:** Not available in apply block.
+Puppet::Functions.create_function(:parallelize, Puppet::Functions::InternalFunction) do
+  # Map a block onto an array, where each array element executes in parallel.
+  # This function is experimental.
+  # @param data The array to apply the block to.
+  # @return [Array] An array of PlanResult objects. Each input from the input
+  #   array returns a corresponding PlanResult object.
+  # @example Execute two tasks on multiple targets. Once the task finishes on one
+  #   target, that target can move to the next step without waiting for the task
+  #   to finish on the second target.
+  # $targets = get_targets(["host1", "host2"])
+  # $result = parallelize ($targets) |$t| {
+  #   run_task('a', $t)
+  #   run_task('b', $t)
+  # }
+  dispatch :parallelize do
+    scope_param
+    param 'Array[Any]', :data
+    block_param 'Callable[Any]', :block
+    return_type 'Array[Boltlib::PlanResult]'
+  end
+
+  def parallelize(scope, data, &block)
+    unless Puppet[:tasks]
+      raise Puppet::ParseErrorWithIssue
+        .from_issue_and_stack(Bolt::PAL::Issues::PLAN_OPERATION_NOT_SUPPORTED_WHEN_COMPILING, action: 'parallelize')
+    end
+
+    executor = Puppet.lookup(:bolt_executor)
+    executor.report_function_call(self.class.name)
+
+    skein = data.each_with_index.map do |object, index|
+      executor.create_yarn(scope, block, object, index)
+    end
+
+    result = executor.round_robin(skein)
+
+    failed_indices = result.each_index.select do |i|
+      result[i].is_a?(Bolt::Error)
+    end
+
+    # TODO: Inner catch errors block?
+    if failed_indices.any?
+      raise Bolt::ParallelFailure.new(result, failed_indices)
+    end
+
+    result
+  end
+end

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

@@ -2,12 +2,12 @@
 
 require 'bolt/error'
 
-# Makes a query to {https://puppet.com/docs/puppetdb/latest/index.html puppetdb}
+# Makes a query to [puppetdb](https://puppet.com/docs/puppetdb/latest/index.html)
 # using Bolt's PuppetDB client.
 Puppet::Functions.create_function(:puppetdb_query) do
   # rubocop:disable Layout/LineLength
   # @param query A PQL query.
-  #   {https://puppet.com/docs/puppetdb/latest/api/query/tutorial-pql.html Learn more about Puppet's query language, PQL}
+  #   Learn more about [Puppet's query language](https://puppet.com/docs/puppetdb/latest/api/query/tutorial-pql.html), PQL.
   # @return Results of the PuppetDB query.
   # @example Request certnames for all nodes
   #   puppetdb_query('nodes[certname] {}')

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

@@ -67,14 +67,32 @@ Puppet::Functions.create_function(:run_command) do
 
     if targets.empty?
       call_function('debug', "Simulating run_command('#{command}') - no targets given - no action taken")
-      r = Bolt::ResultSet.new([])
+      Bolt::ResultSet.new([])
     else
-      r = executor.run_command(targets, command, options)
-    end
+      r = if executor.in_parallel
+            require 'concurrent'
+            require 'fiber'
+            future = Concurrent::Future.execute do
+              executor.run_command(targets,
+                                   command,
+                                   options,
+                                   Puppet::Pops::PuppetStack.top_of_stack)
+            end
+
+            Fiber.yield('unfinished') while future.incomplete?
+            future.value || future.reason
+          else
+            executor.run_command(targets,
+                                 command,
+                                 options,
+                                 Puppet::Pops::PuppetStack.top_of_stack)
+          end
+
+      if !r.ok && !options[:catch_errors]
+        raise Bolt::RunFailure.new(r, 'run_command', command)
+      end
 
-    if !r.ok && !options[:catch_errors]
-      raise Bolt::RunFailure.new(r, 'run_command', command)
+      r
     end
-    r
   end
 end

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

@@ -84,15 +84,34 @@ Puppet::Functions.create_function(:run_script, Puppet::Functions::InternalFuncti
     # Ensure that given targets are all Target instances)
     targets = inventory.get_targets(targets)
 
-    r = if targets.empty?
-          Bolt::ResultSet.new([])
-        else
-          executor.run_script(targets, found, arguments, options)
-        end
+    if targets.empty?
+      Bolt::ResultSet.new([])
+    else
+      r = if executor.in_parallel
+            require 'concurrent'
+            require 'fiber'
+            future = Concurrent::Future.execute do
+              executor.run_script(targets,
+                                  found,
+                                  arguments,
+                                  options,
+                                  Puppet::Pops::PuppetStack.top_of_stack)
+            end
 
-    if !r.ok && !options[:catch_errors]
-      raise Bolt::RunFailure.new(r, 'run_script', script)
+            Fiber.yield('unfinished') while future.incomplete?
+            future.value || future.reason
+          else
+            executor.run_script(targets,
+                                found,
+                                arguments,
+                                options,
+                                Puppet::Pops::PuppetStack.top_of_stack)
+          end
+
+      if !r.ok && !options[:catch_errors]
+        raise Bolt::RunFailure.new(r, 'run_script', script)
+      end
+      r
     end
-    r
   end
 end

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

@@ -133,7 +133,27 @@ Puppet::Functions.create_function(:run_task) do
     if targets.empty?
       Bolt::ResultSet.new([])
     else
-      result = executor.run_task(targets, task, params, options)
+      result = if executor.in_parallel
+                 require 'concurrent'
+                 require 'fiber'
+                 future = Concurrent::Future.execute do
+                   executor.run_task(targets,
+                                     task,
+                                     params,
+                                     options,
+                                     Puppet::Pops::PuppetStack.top_of_stack)
+                 end
+
+                 Fiber.yield('unfinished') while future.incomplete?
+                 future.value || future.reason
+               else
+                 executor.run_task(targets,
+                                   task,
+                                   params,
+                                   options,
+                                   Puppet::Pops::PuppetStack.top_of_stack)
+               end
+
       if !result.ok && !options[:catch_errors]
         raise Bolt::RunFailure.new(result, 'run_task', task_name)
       end

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

@@ -180,7 +180,24 @@ Puppet::Functions.create_function(:run_task_with) do
     else
       # Combine the results from the task run with any failing results that were
       # generated earlier when creating the target mapping
-      task_result = executor.run_task_with(target_mapping, task, options)
+      task_result = if executor.in_parallel
+                      require 'concurrent'
+                      require 'fiber'
+                      future = Concurrent::Future.execute do
+                        executor.run_task_with(target_mapping,
+                                               task,
+                                               options,
+                                               Puppet::Pops::PuppetStack.top_of_stack)
+                      end
+
+                      Fiber.yield('unfinished') while future.incomplete?
+                      future.value || future.reason
+                    else
+                      executor.run_task_with(target_mapping,
+                                             task,
+                                             options,
+                                             Puppet::Pops::PuppetStack.top_of_stack)
+                    end
       result = Bolt::ResultSet.new(task_result.results + error_set)
 
       if !result.ok && !options[:catch_errors]

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

@@ -81,14 +81,32 @@ Puppet::Functions.create_function(:upload_file, Puppet::Functions::InternalFunct
     targets = inventory.get_targets(targets)
     if targets.empty?
       call_function('debug', "Simulating file upload of '#{found}' - no targets given - no action taken")
-      r = Bolt::ResultSet.new([])
+      Bolt::ResultSet.new([])
     else
-      r = executor.upload_file(targets, found, destination, options)
-    end
+      r = if executor.in_parallel
+            require 'concurrent'
+            require 'fiber'
+            future = Concurrent::Future.execute do
+              executor.upload_file(targets,
+                                   found,
+                                   destination,
+                                   options,
+                                   Puppet::Pops::PuppetStack.top_of_stack)
+            end
 
-    if !r.ok && !options[:catch_errors]
-      raise Bolt::RunFailure.new(r, 'upload_file', source)
+            Fiber.yield('unfinished') while future.incomplete?
+            future.value || future.reason
+          else
+            executor.upload_file(targets,
+                                 found,
+                                 destination,
+                                 options,
+                                 Puppet::Pops::PuppetStack.top_of_stack)
+          end
+      if !r.ok && !options[:catch_errors]
+        raise Bolt::RunFailure.new(r, 'upload_file', source)
+      end
+      r
     end
-    r
   end
 end

data/bolt-modules/out/lib/puppet/functions/out/message.rb

@@ -26,8 +26,51 @@ Puppet::Functions.create_function(:'out::message') do
     # Send Analytics Report
     executor.report_function_call(self.class.name)
 
-    executor.publish_event(type: :message, message: message)
+    executor.publish_event(type: :message, message: stringify(message))
 
     nil
   end
+
+  def stringify(message)
+    formatted = format_message(message)
+    if formatted.is_a?(Hash) || formatted.is_a?(Array)
+      ::JSON.pretty_generate(formatted)
+    else
+      formatted
+    end
+  end
+
+  def format_message(message)
+    case message
+    when Array
+      message.map { |item| format_message(item) }
+    when Bolt::ApplyResult
+      format_apply_result(message)
+    when Bolt::Result, Bolt::ResultSet
+      # This is equivalent to to_s, but formattable
+      message.to_data
+    when Bolt::RunFailure
+      formatted_resultset = message.result_set.to_data
+      message.to_h.merge('result_set' => formatted_resultset)
+    when Hash
+      message.each_with_object({}) do |(k, v), h|
+        h[format_message(k)] = format_message(v)
+      end
+    when Integer, Float, NilClass
+      message
+    else
+      message.to_s
+    end
+  end
+
+  def format_apply_result(result)
+    logs = result.resource_logs&.map do |log|
+      # Omit low-level info/debug messages
+      next if %w[info debug].include?(log['level'])
+      indent(2, format_log(log))
+    end
+    hash = result.to_data
+    hash['logs'] = logs unless logs.empty?
+    hash
+  end
 end

data/bolt-modules/prompt/lib/puppet/functions/prompt.rb

@@ -9,11 +9,14 @@ Puppet::Functions.create_function(:prompt) do
   # @param prompt The prompt to display.
   # @param options A hash of additional options.
   # @option options [Boolean] sensitive Disable echo back and mark the response as sensitive.
+  #   The returned value will be wrapped by the `Sensitive` data type. To access the raw
+  #   value, use the `unwrap` function (i.e. `$sensitive_value.unwrap`).
   # @return The response to the prompt.
   # @example Prompt the user if plan execution should continue
   #   $response = prompt('Continue executing plan? [Y\N]')
   # @example Prompt the user for sensitive information
   #   $password = prompt('Enter your password', 'sensitive' => true)
+  #   out::message("Password is: ${password.unwrap}")
   dispatch :prompt do
     param 'String', :prompt
     optional_param 'Hash[String[1], Any]', :options

data/guides/logging.txt

@@ -0,0 +1,18 @@
+TOPIC
+    logging
+
+DESCRIPTION
+    Bolt prints messages both to the console and to log files. Messages can
+    either come from Bolt's 'outputter', which logs user-facing messages like
+    progress and results, or from the 'logger', which logs warnings, errors, and
+    log-structured output to log files. Both of these message streams are
+    configurable.
+
+    By default, Bolt logs to the console at 'warn' level and writes a log file to
+    '<project>/bolt-debug.log' at 'debug' level. Unless you are running a plan,
+    Bolt runs in verbose mode by default.
+
+    To learn more about projects, see the 'project' guide.
+
+DOCUMENTATION
+    https://pup.pt/bolt-logging