bolt 2.32.0 → 2.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b010e9146d3269d88005be58db6b788f57ea3046f96f28756641b0c7266eec2
-  data.tar.gz: ce8d15031143acabc664a7025ef004c69211c25316f9691783388ba74e61dec9
+  metadata.gz: 1881e4097a89e606b9326f93e2e6fd9d934a7db1eb8609e6f9a09ffa322ac7c4
+  data.tar.gz: '02509b1919e57f137bf4e868332be3b73238d22d83251680dc29c7c93ef90a19'
 SHA512:
-  metadata.gz: b45657eb2b985f8e97c59ff4603ad049fd17ee6585292463a57bde3b5c7ca55451883b5e88cb0f61e55c05f1d5415cbde3874320ae446124d646a3d3e8ffa812
-  data.tar.gz: 673e3f3310bf4f22602153bf8300851fa3a832db8e73abc9352874bea7c0b1fd50a5baa42d18474885caea7ec9fad4aa50c25f44aa27974097e10ea03b31e07e
+  metadata.gz: 1fc1215430ac99b765c24c87ee210afb03a247a6c0baac9af3b00e34d56cfb58bacb2140dcfafbe197fd655602713463e2697c2df5083c259b66c8d8cd7bc112
+  data.tar.gz: 445a5f77a5beaf8a1a3c4cb2193e973ada23cb4a7a5f3a8caba2ccc47be4fc8a8fdef3ba797e082c0df3b9553c2f2e67c06084f2c2b2684347d2b9a86e45bde0

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'
@@ -36,6 +36,7 @@ mod 'puppetlabs-azure_inventory', '0.4.1'
 mod 'puppetlabs-gcloud_inventory', '0.1.3'
 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/datatypes/applyresult.rb

@@ -12,6 +12,7 @@ Puppet::DataTypes.create_type('ApplyResult') do
       message => Callable[[], Optional[String]],
       action => Callable[[], String],
       to_data => Callable[[], Hash],
+      value => Callable[[], Hash]
     }
   PUPPET
 

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

data/lib/bolt/analytics.rb

@@ -2,6 +2,7 @@
 
 require 'bolt/util'
 require 'bolt/version'
+require 'find'
 require 'json'
 require 'logging'
 require 'securerandom'
@@ -23,14 +24,16 @@ module Bolt
       plan_steps: :cd8,
       return_type: :cd9,
       inventory_version: :cd10,
-      boltdir_type: :cd11
+      boltdir_type: :cd11,
+      puppet_plan_count: :cd12,
+      yaml_plan_count: :cd13
     }.freeze
 
     def self.build_client
       logger = Bolt::Logger.logger(self)
       begin
-        config_file = config_path(logger)
-        config = load_config(config_file, logger)
+        config_file = config_path
+        config = load_config(config_file)
       rescue ArgumentError
         config = { 'disabled' => true }
       end
@@ -51,7 +54,7 @@ module Bolt
       NoopClient.new
     end
 
-    def self.config_path(logger)
+    def self.config_path
       path     = File.expand_path(File.join('~', '.puppetlabs', 'etc', 'bolt', 'analytics.yaml'))
       old_path = File.expand_path(File.join('~', '.puppetlabs', 'bolt', 'analytics.yaml'))
 
@@ -59,7 +62,7 @@ module Bolt
         if File.exist?(old_path)
           message = "Detected analytics configuration files at '#{old_path}' and '#{path}'. Loading "\
                     "analytics configuration from '#{path}'."
-          logger.warn(message)
+          Bolt::Logger.warn_once('duplicate_analytics', message)
         end
 
         path
@@ -70,12 +73,12 @@ module Bolt
       end
     end
 
-    def self.load_config(filename, logger)
+    def self.load_config(filename)
       if File.exist?(filename)
         Bolt::Util.read_optional_yaml_hash(filename, 'analytics')
       else
         unless ENV['BOLT_DISABLE_ANALYTICS']
-          logger.warn <<~ANALYTICS
+          Bolt::Logger.warn_once('analytics_opt_out', <<~ANALYTICS)
             Bolt collects data about how you use it. You can opt out of providing this data.
 
             To disable analytics data collection, add this line to ~/.puppetlabs/etc/bolt/analytics.yaml :
@@ -134,11 +137,23 @@ module Bolt
       end
 
       def report_bundled_content(mode, name)
-        if bundled_content[mode.split(' ').first]&.include?(name)
+        if bundled_content[mode.split.first]&.include?(name)
           event('Bundled Content', mode, label: name)
         end
       end
 
+      def plan_counts(plans_path)
+        pp_count, yaml_count = if File.exist?(plans_path)
+                                 %w[pp yaml].map do |extension|
+                                   Find.find(plans_path.to_s).grep(/.*\.#{extension}/).length
+                                 end
+                               else
+                                 [0, 0]
+                               end
+
+        { puppet_plan_count: pp_count, yaml_plan_count: yaml_count }
+      end
+
       def event(category, action, label: nil, value: nil, **kwargs)
         custom_dimensions = Bolt::Util.walk_keys(kwargs) do |k|
           CUSTOM_DIMENSIONS[k] || raise("Unknown analytics key '#{k}'")
@@ -224,6 +239,10 @@ module Bolt
 
       def report_bundled_content(mode, name); end
 
+      def plan_counts(_)
+        {}
+      end
+
       def event(category, action, **_kwargs)
         @logger.trace "Skipping submission of '#{category} #{action}' event because analytics is disabled"
       end