bolt 2.38.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33e89c3fc601a61c1da47fe1f0c7773d54643738e959c297f34e5fe4096ef2b5
-  data.tar.gz: 0edc4e35b500bb08315ef5d6064563d7dad0cbaecd88d3aac03dc4cf43572b33
+  metadata.gz: e265544847cf9e2086949db52ee887dc05e8b0aab953728742982f9cd8965779
+  data.tar.gz: 616156a11d84daa9b28328b1c19f6c5bc23ca6036741c4898cc7dc9e891ca81d
 SHA512:
-  metadata.gz: f2d3a5675a1560203dc0236cdd7b5a9367728b6b1decdfc85a99136488ab2ed1a10bc492996b2aa5b2681fdba8f2029f9e092a3011d8be4d5bfb2395358ffb6a
-  data.tar.gz: 79b4418d6628573320b1db7740d8196ddb73f55d93f299a68a3c5f436c5986fc9382e48bd5d2e14903d18e3bf648b47493041a9ad0196983e1fb7a06ff9cf4bd
+  metadata.gz: bc271dc6f2e7dd536ff60b4af94f48757fda48794808f4a2ea055a064c6627c01f832c3a64a430927879206b8aa1aaee94ac7075caed65580a06fa3402304bb4
+  data.tar.gz: 6ca3af874edf3c165766c8a48070b130defb611d0fa98ee92393bf44e524182341a8812c3730c3d4094aecbb99d7fd52201b9cf6f6e262afa75849042737cdde

data/Puppetfile

@@ -5,14 +5,14 @@ forge "http://forge.puppetlabs.com"
 moduledir File.join(File.dirname(__FILE__), 'modules')
 
 # Core modules used by 'apply'
-mod 'puppetlabs-service', '1.3.0'
-mod 'puppetlabs-puppet_agent', '4.2.0'
-mod 'puppetlabs-facts', '1.2.0'
+mod 'puppetlabs-service', '1.4.0'
+mod 'puppetlabs-puppet_agent', '4.4.0'
+mod 'puppetlabs-facts', '1.4.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-scheduled_task', '2.3.1'
 mod 'puppetlabs-sshkeys_core', '2.2.0'
 mod 'puppetlabs-zfs_core', '1.2.0'
 mod 'puppetlabs-cron_core', '1.0.5'
@@ -22,23 +22,23 @@ mod 'puppetlabs-yumrepo_core', '1.0.7'
 mod 'puppetlabs-zone_core', '1.0.3'
 
 # Useful additional modules
-mod 'puppetlabs-package', '1.3.0'
-mod 'puppetlabs-puppet_conf', '0.6.0'
-mod 'puppetlabs-python_task_helper', '0.4.3'
-mod 'puppetlabs-reboot', '3.0.0'
-mod 'puppetlabs-ruby_task_helper', '0.5.1'
-mod 'puppetlabs-ruby_plugin_helper', '0.1.0'
-mod 'puppetlabs-stdlib', '6.5.0'
+mod 'puppetlabs-package', '1.4.0'
+mod 'puppetlabs-puppet_conf', '0.8.0'
+mod 'puppetlabs-python_task_helper', '0.5.0'
+mod 'puppetlabs-reboot', '3.2.0'
+mod 'puppetlabs-ruby_task_helper', '0.6.0'
+mod 'puppetlabs-ruby_plugin_helper', '0.2.0'
+mod 'puppetlabs-stdlib', '6.6.0'
 
 # Plugin modules
-mod 'puppetlabs-aws_inventory', '0.5.2'
-mod 'puppetlabs-azure_inventory', '0.4.1'
-mod 'puppetlabs-gcloud_inventory', '0.1.3'
+mod 'puppetlabs-aws_inventory', '0.6.0'
+mod 'puppetlabs-azure_inventory', '0.5.0'
+mod 'puppetlabs-gcloud_inventory', '0.2.0'
 mod 'puppetlabs-http_request', '0.2.1'
 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-secure_env_vars', '0.2.0'
+mod 'puppetlabs-terraform', '0.6.1'
+mod 'puppetlabs-vault', '0.4.0'
 mod 'puppetlabs-yaml', '0.2.0'
 
 # If we don't list these modules explicitly, r10k will purge them

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'bolt/logger'
 require 'bolt/task'
 
 # Installs the `puppet-agent` package on targets if needed, then collects facts,
@@ -131,10 +132,20 @@ Puppet::Functions.create_function(:apply_prep) do
         task = applicator.custom_facts_task
         arguments = { 'plugins' => Puppet::Pops::Types::PSensitiveType::Sensitive.new(plugins) }
         results = executor.run_task(targets, task, arguments)
+
         # TODO: Standardize RunFailure type with error above
         raise Bolt::RunFailure.new(results, 'run_task', task.name) unless results.ok?
 
         results.each do |result|
+          # Log a warning if the client version is < 6
+          if unsupported_puppet?(result['clientversion'])
+            Bolt::Logger.deprecate(
+              "unsupported_puppet",
+              "Detected unsupported Puppet agent version #{result['clientversion']} on target "\
+              "#{result.target}. Bolt supports Puppet agent 6.0.0 and higher."
+            )
+          end
+
           inventory.add_facts(result.target, result.value)
         end
       end
@@ -143,4 +154,18 @@ Puppet::Functions.create_function(:apply_prep) do
     # Return nothing
     nil
   end
+
+  # Returns true if the client's major version is < 6.
+  #
+  private def unsupported_puppet?(client_version)
+    if client_version.nil?
+      false
+    else
+      begin
+        Integer(client_version.split('.').first) < 6
+      rescue StandardError
+        false
+      end
+    end
+  end
 end

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

@@ -12,14 +12,12 @@ Puppet::Functions.create_function(:parallelize, Puppet::Functions::InternalFunct
   # @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)
-  # }
+  # @example Execute two tasks on two targets.
+  #   $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

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

@@ -2,7 +2,11 @@
 
 require 'bolt/util'
 
-# Wait until all targets accept connections.
+# Wait until all targets accept connections. This function allows a plan execution to wait for a customizable
+# amount of time via the `wait_time` option until a target connection can be reestablished. The plan proceeds
+# to the next step if the connection fails to reconnect in the time specified (default: 120 seconds). A typical
+# use case for this function is if your plan reboots a remote host and the plan needs to wait for the host to reconnect
+# before it continues to the next step.
 #
 # > **Note:** Not available in apply block
 Puppet::Functions.create_function(:wait_until_available) do
@@ -10,8 +14,8 @@ Puppet::Functions.create_function(:wait_until_available) do
   # @param targets A pattern identifying zero or more targets. See {get_targets} for accepted patterns.
   # @param options A hash of additional options.
   # @option options [String] description A description for logging. (default: 'wait until available')
-  # @option options [Numeric] wait_time The time to wait. (default: 120)
-  # @option options [Numeric] retry_interval The interval to wait before retrying. (default: 1)
+  # @option options [Numeric] wait_time The time to wait, in seconds. (default: 120)
+  # @option options [Numeric] retry_interval The interval to wait before retrying, in seconds. (default: 1)
   # @option options [Boolean] _catch_errors Whether to catch raised errors.
   # @return A list of results, one entry per target. Successful results have no value.
   # @example Wait for targets

data/lib/bolt/analytics.rb

@@ -78,7 +78,7 @@ module Bolt
         Bolt::Util.read_optional_yaml_hash(filename, 'analytics')
       else
         unless ENV['BOLT_DISABLE_ANALYTICS']
-          Bolt::Logger.warn_once('analytics_opt_out', <<~ANALYTICS)
+          msg = <<~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 :
@@ -86,7 +86,8 @@ module Bolt
 
             Read more about what data Bolt collects and why here:
               https://puppet.com/docs/bolt/latest/bolt_installing.html#analytics-data-collection
-            ANALYTICS
+          ANALYTICS
+          Bolt::Logger.warn_once('analytics_opt_out', msg)
         end
 
         {}

data/lib/bolt/applicator.rb

@@ -125,7 +125,16 @@ module Bolt
           @logger.send(bolt_level, "#{target.name}: #{message}")
         end
       end
-      raise ApplyError.new(target.name, result['message']) unless stat.success?
+
+      unless stat.success?
+        message = if @apply_settings['trace'] && result['backtrace']
+                    ([result['message']] + result['backtrace']).join("\n  ")
+                  else
+                    result['message']
+                  end
+        raise ApplyError.new(target.name, message)
+      end
+
       result
     end
 
@@ -236,6 +245,7 @@ module Bolt
                           else
                             Bolt::ApplyError.new(batch_target, future.reason.message)
                           end
+
                   result = Bolt::ApplyResult.new(batch_target, error: error.to_h)
                   @executor.publish_event(type: :node_result, result: result)
                   result

data/lib/bolt/bolt_option_parser.rb

@@ -6,15 +6,15 @@ require 'optparse'
 
 module Bolt
   class BoltOptionParser < OptionParser
-    PROJECT_PATHS = %w[project configfile boltdir].freeze
-    OPTIONS = { inventory: %w[targets query rerun description],
+    PROJECT_PATHS = %w[project].freeze
+    OPTIONS = { inventory: %w[targets query rerun],
                 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 cleanup],
                 global_config_setters: PROJECT_PATHS + %w[modulepath],
                 transports: %w[transport connect-timeout tty native-ssh ssh-command copy-command],
                 display: %w[format color verbose trace],
-                global: %w[help version debug log-level clear-cache] }.freeze
+                global: %w[help version log-level clear-cache] }.freeze
 
     ACTION_OPTS = OPTIONS.values.flatten.freeze
 
@@ -114,21 +114,6 @@ module Bolt
           { flags: OPTIONS[:global],
             banner: PROJECT_HELP }
         end
-      when 'puppetfile'
-        case action
-        when 'install'
-          { flags: OPTIONS[:global] + OPTIONS[:global_config_setters] + %w[puppetfile],
-            banner: PUPPETFILE_INSTALL_HELP }
-        when 'show-modules'
-          { flags: OPTIONS[:global] + OPTIONS[:global_config_setters],
-            banner: PUPPETFILE_SHOWMODULES_HELP }
-        when 'generate-types'
-          { flags: OPTIONS[:global] + OPTIONS[:global_config_setters],
-            banner: PUPPETFILE_GENERATETYPES_HELP }
-        else
-          { flags: OPTIONS[:global],
-            banner: PUPPETFILE_HELP }
-        end
       when 'script'
         case action
         when 'run'
@@ -192,7 +177,6 @@ module Bolt
           module            Manage Bolt project modules
           plan              Convert, create, show, and run Bolt plans
           project           Create and migrate Bolt projects
-          puppetfile        Install and list modules and generate type references
           script            Upload a local script and run it remotely
           secret            Create encryption keys and encrypt and decrypt values
           task              Show and run Bolt tasks
@@ -576,55 +560,6 @@ module Bolt
           Migrate a Bolt project to use current best practices and the latest version of configuration files.
     HELP
 
-    PUPPETFILE_HELP = <<~HELP
-      NAME
-          puppetfile
-
-      USAGE
-          bolt puppetfile <action> [options]
-
-      DESCRIPTION
-          Install and list modules and generate type references
-
-      ACTIONS
-          generate-types        Generate type references to register in plans
-          install               Install modules from a Puppetfile into a project
-          show-modules          List modules available to the Bolt project
-    HELP
-
-    PUPPETFILE_GENERATETYPES_HELP = <<~HELP
-      NAME
-          generate-types
-
-      USAGE
-          bolt puppetfile generate-types [options]
-
-      DESCRIPTION
-          Generate type references to register in plans.
-    HELP
-
-    PUPPETFILE_INSTALL_HELP = <<~HELP
-      NAME
-          install
-
-      USAGE
-          bolt puppetfile install [options]
-
-      DESCRIPTION
-          Install modules from a Puppetfile into a project
-    HELP
-
-    PUPPETFILE_SHOWMODULES_HELP = <<~HELP
-      NAME
-          show-modules
-
-      USAGE
-          bolt puppetfile show-modules [options]
-
-      DESCRIPTION
-          List modules available to the Bolt project.
-    HELP
-
     SCRIPT_HELP = <<~HELP
       NAME
           script
@@ -760,13 +695,10 @@ module Bolt
             bolt task show canary
     HELP
 
-    attr_reader :deprecations
-
     def initialize(options)
       super()
 
       @options = options
-      @deprecations = []
 
       separator "\nINVENTORY OPTIONS"
       define('-t', '--targets TARGETS',
@@ -794,13 +726,6 @@ module Bolt
       define('--noop', 'See what changes Bolt will make without actually executing the changes') do |_|
         @options[:noop] = true
       end
-      define('--description DESCRIPTION',
-             'Deprecated. Description to use for the job') do |description|
-        msg = "Command line option '--description' is deprecated, and will be "\
-          "removed in Bolt 3.0."
-        @deprecations << { type: 'Using --description', msg: msg }
-        @options[:description] = description
-      end
       define('--params PARAMETERS',
              "Parameters to a task or plan as json, a json file '@<file>', or on stdin '-'") do |params|
         @options[:task_options] = parse_params(params)
@@ -878,27 +803,10 @@ module Bolt
           File.expand_path(moduledir)
         end
       end
-      define('--boltdir PATH',
-             'Deprecated. Specify what project to load config from (default:',
-             'autodiscovered from current working dir)') do |path|
-        msg = "Command line option '--boltdir' is deprecated, use '--project' instead."
-        @deprecations << { type: 'Using --boltdir', msg: msg }
-        @options[:boltdir] = path
-      end
       define('--project PATH',
              'Path to load the Bolt project from (default: autodiscovered from current dir)') do |path|
         @options[:project] = path
       end
-      define('--configfile PATH',
-             'Deprecated. Specify where to load config from (default:',
-             '~/.puppetlabs/bolt/bolt.yaml). Directory containing bolt.yaml will be',
-             'used as the project directory.') do |path|
-        msg = "Command line option '--configfile' is deprecated, and " \
-          "will be removed in Bolt 3.0. Use '--project' and provide the "\
-          "directory path instead."
-        @deprecations << { type: 'Using --configfile', msg: msg }
-        @options[:configfile] = path
-      end
       define('--hiera-config PATH',
              'Specify where to load Hiera config from (default: ~/.puppetlabs/bolt/hiera.yaml)') do |path|
         @options[:'hiera-config'] = File.expand_path(path)
@@ -910,17 +818,6 @@ module Bolt
         end
         @options[:inventoryfile] = File.expand_path(path)
       end
-      define('--puppetfile PATH',
-             'Deprecated. Specify a Puppetfile to use when installing modules.',
-             ' (default: ~/.puppetlabs/bolt/Puppetfile)',
-             'Modules are installed in the current project.') do |path|
-        command = Bolt::Util.powershell? ? 'Update-BoltProject' : 'bolt project migrate'
-        msg = "Command line option '--puppetfile' is deprecated, and will be removed "\
-          "in Bolt 3.0. You can migrate to using the new module management "\
-          "workflow using '#{command}'."
-        @deprecations << { type: 'Using --puppetfile', msg: msg }
-        @options[:puppetfile_path] = File.expand_path(path)
-      end
       define('--[no-]save-rerun', 'Whether to update the rerun file after this command.') do |save|
         @options[:'save-rerun'] = save
       end
@@ -1013,13 +910,6 @@ module Bolt
         puts Bolt::VERSION
         raise Bolt::CLIExit
       end
-      define('--debug', 'Display debug logging') do |_|
-        @options[:debug] = true
-        # We don't actually set '--log-level debug' here, but once the options are evaluated by
-        # the config class the end result is the same.
-        msg = "Command line option '--debug' is deprecated, set '--log-level debug' instead."
-        @deprecations << { type: 'Using --debug instead of --log-level debug', msg: msg }
-      end
       define('--log-level LEVEL',
              "Set the log level for the console. Available options are",
              "trace, debug, info, warn, error, fatal, any.") do |level|

data/lib/bolt/catalog.rb

@@ -76,31 +76,27 @@ module Bolt
       # is the only way to log a message that will make it back to Bolt
       # to be printed.
       target = request['target']
-      plan_vars = shadow_vars('plan', request['plan_vars'], target['facts'])
-      target_vars = shadow_vars('target', target['variables'], target['facts'])
 
-      # Merge plan vars with target vars, while maintaining the order of the plan
-      # vars. It's critical that the order of plan vars is not changed, as Puppet
-      # will deserialize the variables in the order they appear. Variables may
-      # contain local references to variables that appear earlier in a plan. If
-      # these variables are moved before the variable they reference, Puppet will
-      # be unable to deserialize the data and raise an error.
-      topscope_vars = target_vars.reject { |k, _v| plan_vars.key?(k) }.merge(plan_vars)
+      variables = {
+        variables:        request['plan_vars'],
+        target_variables: target['variables']
+      }
 
-      env_conf = { modulepath: request['modulepath'],
-                   facts: target['facts'],
-                   variables: topscope_vars }
+      env_conf = {
+        modulepath: request['modulepath'],
+        facts:      target['facts']
+      }
 
       puppet_settings = {
         node_name_value: target['name'],
-        hiera_config: request['hiera_config']
+        hiera_config:    request['hiera_config']
       }
 
       with_puppet_settings(puppet_settings) do
         Puppet::Pal.in_tmp_environment('bolt_catalog', **env_conf) do |pal|
           Puppet.override(puppet_overrides) do
             Puppet.lookup(:pal_current_node).trusted_data = target['trusted']
-            pal.with_catalog_compiler do |compiler|
+            pal.with_catalog_compiler(**variables) do |compiler|
               options = request['puppet_config'] || {}
               # 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.
@@ -119,21 +115,6 @@ module Bolt
       end
     end
 
-    # Warn and remove variables that will be shadowed by facts of the same
-    # name, which are set in scope earlier.
-    def shadow_vars(type, vars, facts)
-      collisions, valid = vars.partition do |k, _|
-        facts.include?(k)
-      end
-      if collisions.any?
-        names = collisions.map { |k, _| "$#{k}" }.join(', ')
-        plural = collisions.length == 1 ? '' : 's'
-        Puppet.warning("#{type.capitalize} variable#{plural} #{names} will be overridden by fact#{plural} " \
-                       "of the same name in the apply block")
-      end
-      valid.to_h
-    end
-
     def build_program(code)
       ast = Puppet::Pops::Serialization::FromDataConverter.convert(code)