bolt 2.37.0 → 2.44.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cbd90e42181c76bad4eee913ee67369202296852cfa5153a1f5490def4e77d3
-  data.tar.gz: 87ac43d10edeebefaa31f581f49cbcf9f729e25f5d7efec583e09dcf04f97be6
+  metadata.gz: aa7f2db70ebfda5de9128554d289d3506ad0c922dac4042e80e29ad691b04447
+  data.tar.gz: b0eedc91174b14a594352d3033a27c13f4f29dbd038679345568e39bea486bc4
 SHA512:
-  metadata.gz: 392f0d453c49a536852692e873e5c5f55807294fa0bd914593722c26d39459e494b83453a3b995319b04b8f2e6f3a1f04f7661400841192bdffc56df47e4170e
-  data.tar.gz: 750cd8e9c29008e8bb4dfc7350d52a268c01d91fa088e9007ff241648e31a90e76d9cabfef9f1db5675d33f6b82b2898a54f758bc21c17c18d888919d0441807
+  metadata.gz: 1d5620a57dbf4ba82778704296116f53b162a469557162f766c208a5ca5d01e52fbdb219c8e9e965823dca7224dfd1dec507cb432d0d64fa29604fc117a1930f
+  data.tar.gz: 0fdf98e91e30c49960caf5b67bca32d6698c3df18ce1d75db98831cfc0694ac1ba444c08691e809ba3ecca76d702b16e46154ed5fc65a59db432f27355bf57a0

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-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.5.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-http_request', '0.2.0'
+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/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/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

@@ -760,13 +760,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',
@@ -796,9 +793,11 @@ module Bolt
       end
       define('--description DESCRIPTION',
              'Deprecated. Description to use for the job') do |description|
-        msg = "Command line option '--description' is deprecated, and will be "\
+        Bolt::Logger.deprecate(
+          "description_cli_option",
+          "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',
@@ -881,8 +880,10 @@ module Bolt
       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 }
+        Bolt::Logger.deprecate(
+          "boltdir_cli_option",
+          "Command line option '--boltdir' is deprecated, use '--project' instead."
+        )
         @options[:boltdir] = path
       end
       define('--project PATH',
@@ -893,10 +894,12 @@ module Bolt
              '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 " \
+        Bolt::Logger.deprecate(
+          "configfile_cli_option",
+          "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',
@@ -915,10 +918,12 @@ module Bolt
              ' (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 "\
+        Bolt::Logger.deprecate(
+          "puppetfile_cli_option",
+          "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|
@@ -1017,8 +1022,10 @@ module Bolt
         @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 }
+        Bolt::Logger.deprecate(
+          "debug_cli_option",
+          "Command line option '--debug' is deprecated, set '--log-level debug' instead."
+        )
       end
       define('--log-level LEVEL',
              "Set the log level for the console. Available options are",

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)
 

data/lib/bolt/cli.rb

@@ -147,10 +147,6 @@ module Bolt
       end
 
       validate(options)
-
-      # Deprecation warnings can't be issued until after config is loaded, so
-      # store them for later.
-      @parser_deprecations = parser.deprecations
     rescue Bolt::Error => e
       fatal_error(e)
       raise e
@@ -185,20 +181,16 @@ module Bolt
 
     # Completes the setup process by configuring Bolt and log messages
     def finalize_setup
-      Bolt::Logger.configure(config.log, config.color)
+      Bolt::Logger.configure(config.log, config.color, config.disable_warnings)
       Bolt::Logger.analytics = analytics
+      Bolt::Logger.flush_queue
 
       # Logger must be configured before checking path case and project file, otherwise logs will not display
       config.check_path_case('modulepath', config.modulepath)
       config.project.check_deprecated_file
 
-      # Log messages created during parser and config initialization
-      config.logs.each { |log| @logger.send(log.keys[0], log.values[0]) }
-      @parser_deprecations.each { |dep| Bolt::Logger.deprecation_warning(dep[:type], dep[:msg]) }
-      config.deprecations.each { |dep| Bolt::Logger.deprecation_warning(dep[:type], dep[:msg]) }
-
-      if options[:clear_cache] && File.exist?(config.project.cache_file)
-        FileUtils.rm(config.project.cache_file)
+      if options[:clear_cache] && File.exist?(config.project.plugin_cache_file)
+        FileUtils.rm(config.project.plugin_cache_file)
       end
 
       warn_inventory_overrides_cli(options)
@@ -212,12 +204,15 @@ module Bolt
 
     private def validate_ps_version
       if Bolt::Util.powershell?
-        target = inventory.get_target('localhost')
-        Bolt::Transport::Local.new.with_connection(target) do |conn|
-          # This will automatically validate the powershell version on the Bolt
-          # controller
-          Bolt::Shell::Powershell.new(target, conn)
-        end
+        command = "powershell.exe -NoProfile -NonInteractive -NoLogo -ExecutionPolicy "\
+                  "Bypass -Command $PSVersionTable.PSVersion.Major"
+        stdout, _stderr, _status = Open3.capture3(command)
+
+        return unless !stdout.empty? && stdout.to_i < 3
+
+        msg = "Detected PowerShell 2 on controller. PowerShell 2 is deprecated and "\
+              "support will be removed in Bolt 3.0."
+        Bolt::Logger.deprecate("powershell_2_controller", msg)
       end
     end
 
@@ -373,7 +368,10 @@ module Bolt
       conflicting_options = Set.new(opts.keys.map(&:to_s)).intersection(inventory_cli_opts)
 
       if inventory_source && conflicting_options.any?
-        @logger.warn("CLI arguments #{conflicting_options.to_a} may be overridden by Inventory: #{inventory_source}")
+        Bolt::Logger.warn(
+          "cli_overrides",
+          "CLI arguments #{conflicting_options.to_a} may be overridden by Inventory: #{inventory_source}"
+        )
       end
     end
 
@@ -491,9 +489,9 @@ module Bolt
       when 'module'
         case options[:action]
         when 'add'
-          code = add_project_module(options[:object], config.project)
+          code = add_project_module(options[:object], config.project, config.module_install)
         when 'install'
-          code = install_project_modules(config.project, options[:force], options[:resolve])
+          code = install_project_modules(config.project, config.module_install, options[:force], options[:resolve])
         when 'generate-types'
           code = generate_types
         end
@@ -604,7 +602,7 @@ module Bolt
     end
 
     def list_plans
-      plans = filter_content(pal.list_plans(filter_content: true), options[:filter])
+      plans = filter_content(pal.list_plans_with_cache(filter_content: true), options[:filter])
       outputter.print_plans(plans, pal.user_modulepath)
     end
 
@@ -656,7 +654,7 @@ module Bolt
         if node_param && target_param
           msg = "Plan parameters include both 'nodes' and 'targets' with type 'TargetSpec', " \
                 "neither will populated with the value for --nodes or --targets."
-          @logger.warn(msg)
+          Bolt::Logger.warn("nodes_targets_parameters", msg)
         elsif node_param
           plan_arguments['nodes'] = nodes.join(',')
         elsif target_param
@@ -701,7 +699,7 @@ module Bolt
                   "about defining and declaring classes and types in the Puppet documentation at "\
                   "https://puppet.com/docs/puppet/latest/lang_classes.html and "\
                   "https://puppet.com/docs/puppet/latest/lang_defined_types.html"
-        @logger.warn(message)
+        Bolt::Logger.warn("empty_manifest", message)
       end
 
       executor = Bolt::Executor.new(config.concurrency, analytics, noop, config.modified_concurrency)
@@ -737,13 +735,13 @@ module Bolt
     def generate_types
       assert_puppetfile_or_module_command(config.project.modules)
       # generate_types will surface a nice error with helpful message if it fails
-      pal.generate_types
+      pal.generate_types(cache: true)
       0
     end
 
     # Installs modules declared in the project configuration file.
     #
-    def install_project_modules(project, force, resolve)
+    def install_project_modules(project, config, force, resolve)
       assert_project_file(project)
       assert_puppetfile_or_module_command(project.modules)
 
@@ -753,30 +751,39 @@ module Bolt
         return 0
       end
 
+      modules   = project.modules || []
       installer = Bolt::ModuleInstaller.new(outputter, pal)
 
-      ok = installer.install(project.modules,
-                             project.puppetfile,
-                             project.managed_moduledir,
-                             force: force,
-                             resolve: resolve)
+      ok = outputter.spin do
+        installer.install(modules,
+                          project.puppetfile,
+                          project.managed_moduledir,
+                          config,
+                          force: force,
+                          resolve: resolve)
+      end
+
       ok ? 0 : 1
     end
 
     # Adds a single module to the project.
     #
-    def add_project_module(name, project)
+    def add_project_module(name, project, config)
       assert_project_file(project)
       assert_puppetfile_or_module_command(project.modules)
 
       modules   = project.modules || []
       installer = Bolt::ModuleInstaller.new(outputter, pal)
 
-      ok = installer.add(name,
-                         modules,
-                         project.puppetfile,
-                         project.managed_moduledir,
-                         project.project_file)
+      ok = outputter.spin do
+        installer.add(name,
+                      modules,
+                      project.puppetfile,
+                      project.managed_moduledir,
+                      project.project_file,
+                      config)
+      end
+
       ok ? 0 : 1
     end
 
@@ -805,7 +812,10 @@ module Bolt
 
       outputter.print_message("Installing modules from Puppetfile")
       installer = Bolt::ModuleInstaller.new(outputter, pal)
-      ok = installer.install_puppetfile(puppetfile, moduledir, puppetfile_config)
+      ok = outputter.spin do
+        installer.install_puppetfile(puppetfile, moduledir, puppetfile_config)
+      end
+
       ok ? 0 : 1
     end
 
@@ -838,6 +848,10 @@ module Bolt
         raise Bolt::CLIError,
               "Unable to use command '#{old_command}' when 'modules' is configured in "\
               "bolt-project.yaml. Use '#{new_command}' instead."
+      elsif modules.nil? && options[:subcommand] == 'puppetfile'
+        msg = "Command '#{old_command}' is deprecated and will be removed in Bolt 3.0. Update your project to use "\
+              "the module management feature. For more information, see https://pup.pt/bolt-module-migrate."
+        Bolt::Logger.deprecate("puppetfile_command", msg)
       elsif modules.nil? && options[:subcommand] == 'module'
         msg  = "Unable to use command '#{new_command}' when 'modules' is not configured in "\
                "bolt-project.yaml. "
@@ -911,7 +925,11 @@ module Bolt
     end
 
     def outputter
-      @outputter ||= Bolt::Outputter.for_format(config.format, config.color, options[:verbose], config.trace)
+      @outputter ||= Bolt::Outputter.for_format(config.format,
+                                                config.color,
+                                                options[:verbose],
+                                                config.trace,
+                                                config.spinner)
     end
 
     def log_outputter
@@ -938,7 +956,7 @@ module Bolt
           set the BOLT_GEM environment variable.
         MSG
 
-        @logger.warn(msg)
+        Bolt::Logger.warn("gem_install", msg)
       end
 
       # We only need to enumerate bundled content when running a task or plan