bolt 2.44.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa7f2db70ebfda5de9128554d289d3506ad0c922dac4042e80e29ad691b04447
-  data.tar.gz: b0eedc91174b14a594352d3033a27c13f4f29dbd038679345568e39bea486bc4
+  metadata.gz: e265544847cf9e2086949db52ee887dc05e8b0aab953728742982f9cd8965779
+  data.tar.gz: 616156a11d84daa9b28328b1c19f6c5bc23ca6036741c4898cc7dc9e891ca81d
 SHA512:
-  metadata.gz: 1d5620a57dbf4ba82778704296116f53b162a469557162f766c208a5ca5d01e52fbdb219c8e9e965823dca7224dfd1dec507cb432d0d64fa29604fc117a1930f
-  data.tar.gz: 0fdf98e91e30c49960caf5b67bca32d6698c3df18ce1d75db98831cfc0694ac1ba444c08691e809ba3ecca76d702b16e46154ed5fc65a59db432f27355bf57a0
+  metadata.gz: bc271dc6f2e7dd536ff60b4af94f48757fda48794808f4a2ea055a064c6627c01f832c3a64a430927879206b8aa1aaee94ac7075caed65580a06fa3402304bb4
+  data.tar.gz: 6ca3af874edf3c165766c8a48070b130defb611d0fa98ee92393bf44e524182341a8812c3730c3d4094aecbb99d7fd52201b9cf6f6e262afa75849042737cdde

data/Puppetfile

@@ -28,7 +28,7 @@ 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'
+mod 'puppetlabs-stdlib', '6.6.0'
 
 # Plugin modules
 mod 'puppetlabs-aws_inventory', '0.6.0'

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/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/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
@@ -791,15 +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|
-        Bolt::Logger.deprecate(
-          "description_cli_option",
-          "Command line option '--description' is deprecated, and will be "\
-          "removed in Bolt 3.0."
-        )
-        @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)
@@ -877,31 +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|
-        Bolt::Logger.deprecate(
-          "boltdir_cli_option",
-          "Command line option '--boltdir' is deprecated, use '--project' instead."
-        )
-        @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|
-        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."
-        )
-        @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)
@@ -913,19 +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'
-        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}'."
-        )
-        @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
@@ -1018,15 +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.
-        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",
              "trace, debug, info, warn, error, fatal, any.") do |level|

data/lib/bolt/cli.rb

@@ -33,19 +33,18 @@ module Bolt
 
   class CLI
     COMMANDS = {
-      'command'    => %w[run],
-      'script'     => %w[run],
-      'task'       => %w[show run],
-      'plan'       => %w[show run convert new],
-      'file'       => %w[download upload],
-      'puppetfile' => %w[install show-modules generate-types],
-      'secret'     => %w[encrypt decrypt createkeys],
-      'inventory'  => %w[show],
-      'group'      => %w[show],
-      'project'    => %w[init migrate],
-      'module'     => %w[add generate-types install show],
-      'apply'      => %w[],
-      'guide'      => %w[]
+      'command' => %w[run],
+      'script' => %w[run],
+      'task' => %w[show run],
+      'plan' => %w[show run convert new],
+      'file' => %w[download upload],
+      'secret' => %w[encrypt decrypt createkeys],
+      'inventory' => %w[show],
+      'group' => %w[show],
+      'project' => %w[init migrate],
+      'module' => %w[add generate-types install show],
+      'apply' => %w[],
+      'guide' => %w[]
     }.freeze
 
     attr_reader :config, :options
@@ -155,25 +154,19 @@ module Bolt
     # Loads the project and configuration. All errors that are raised here are not
     # handled by the outputter, as it relies on config being loaded.
     def load_config
-      @config = if ENV['BOLT_PROJECT']
-                  project = Bolt::Project.create_project(ENV['BOLT_PROJECT'], 'environment')
-                  Bolt::Config.from_project(project, options)
-                elsif options[:configfile]
-                  Bolt::Config.from_file(options[:configfile], options)
+      project = if ENV['BOLT_PROJECT']
+                  Bolt::Project.create_project(ENV['BOLT_PROJECT'], 'environment')
+                elsif options[:project]
+                  dir = Pathname.new(options[:project])
+                  if (dir + Bolt::Project::BOLTDIR_NAME).directory?
+                    Bolt::Project.create_project(dir + Bolt::Project::BOLTDIR_NAME)
+                  else
+                    Bolt::Project.create_project(dir)
+                  end
                 else
-                  cli_flag = options[:project] || options[:boltdir]
-                  project = if cli_flag
-                              dir = Pathname.new(cli_flag)
-                              if (dir + Bolt::Project::BOLTDIR_NAME).directory?
-                                Bolt::Project.create_project(dir + Bolt::Project::BOLTDIR_NAME)
-                              else
-                                Bolt::Project.create_project(dir)
-                              end
-                            else
-                              Bolt::Project.find_boltdir(Dir.pwd)
-                            end
-                  Bolt::Config.from_project(project, options)
+                  Bolt::Project.find_boltdir(Dir.pwd)
                 end
+      @config = Bolt::Config.from_project(project, options)
     rescue Bolt::Error => e
       fatal_error(e)
       raise e
@@ -210,9 +203,8 @@ module Bolt
 
         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)
+        msg = "Detected PowerShell 2 on controller. PowerShell 2 is unsupported."
+        Bolt::Logger.deprecation_warning("powershell_2_controller", msg)
       end
     end
 
@@ -306,10 +298,6 @@ module Bolt
               "Unknown argument(s) #{options[:leftovers].join(', ')}"
       end
 
-      if options.slice(:boltdir, :configfile, :project).length > 1
-        raise Bolt::CLIError, "Only one of '--boltdir', '--project', or '--configfile' may be specified"
-      end
-
       if options[:noop] &&
          !(options[:subcommand] == 'task' && options[:action] == 'run') && options[:subcommand] != 'apply'
         raise Bolt::CLIError,
@@ -322,10 +310,6 @@ module Bolt
                 "Option '--env-var' may only be specified when running a command or script"
         end
       end
-
-      if options.key?(:debug) && options.key?(:log)
-        raise Bolt::CLIError, "Only one of '--debug' or '--log-level' may be specified"
-      end
     end
 
     def handle_parser_errors
@@ -388,7 +372,7 @@ module Bolt
       # Initialize inventory and targets. Errors here are better to catch early.
       # options[:target_args] will contain a string/array version of the targetting options this is passed to plans
       # options[:targets] will contain a resolved set of Target objects
-      unless %w[guide module project puppetfile secret].include?(options[:subcommand]) ||
+      unless %w[guide module project secret].include?(options[:subcommand]) ||
              %w[convert new show].include?(options[:action])
         update_targets(options)
       end
@@ -443,9 +427,6 @@ module Bolt
           list_modules
         end
         return 0
-      when 'show-modules'
-        list_modules
-        return 0
       when 'convert'
         pal.convert_plan(options[:object])
         return 0
@@ -495,17 +476,6 @@ module Bolt
         when 'generate-types'
           code = generate_types
         end
-      when 'puppetfile'
-        case options[:action]
-        when 'generate-types'
-          code = generate_types
-        when 'install'
-          code = install_puppetfile(
-            config.puppetfile_config,
-            config.puppetfile,
-            config.modulepath.first
-          )
-        end
       when 'secret'
         code = Bolt::Secret.execute(plugins, outputter, options)
       when 'apply'
@@ -523,7 +493,6 @@ module Bolt
 
         elapsed_time = Benchmark.realtime do
           executor_opts = {}
-          executor_opts[:description] = options[:description] if options.key?(:description)
           executor_opts[:env_vars] = options[:env_vars] if options.key?(:env_vars)
           executor.subscribe(outputter)
           executor.subscribe(log_outputter)
@@ -540,8 +509,7 @@ module Bolt
                            targets,
                            options[:task_options],
                            executor,
-                           inventory,
-                           options[:description])
+                           inventory)
             when 'file'
               src = options[:object]
               dest = options[:leftovers].first
@@ -664,7 +632,6 @@ module Bolt
 
       plan_context = { plan_name: plan_name,
                        params: plan_arguments }
-      plan_context[:description] = options[:description] if options[:description]
 
       executor = Bolt::Executor.new(config.concurrency, analytics, options[:noop], config.modified_concurrency)
       if %w[human rainbow].include?(options.fetch(:format, 'human'))
@@ -728,12 +695,10 @@ module Bolt
     end
 
     def list_modules
-      assert_puppetfile_or_module_command(config.project.modules)
       outputter.print_module_list(pal.list_modules)
     end
 
     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(cache: true)
       0
@@ -743,19 +708,17 @@ module Bolt
     #
     def install_project_modules(project, config, force, resolve)
       assert_project_file(project)
-      assert_puppetfile_or_module_command(project.modules)
 
-      unless project.modules
+      unless project.modules.any?
         outputter.print_message "Project configuration file #{project.project_file} does not "\
                                 "specify any module dependencies. Nothing to do."
         return 0
       end
 
-      modules   = project.modules || []
       installer = Bolt::ModuleInstaller.new(outputter, pal)
 
       ok = outputter.spin do
-        installer.install(modules,
+        installer.install(project.modules,
                           project.puppetfile,
                           project.managed_moduledir,
                           config,
@@ -770,14 +733,12 @@ module Bolt
     #
     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 = outputter.spin do
         installer.add(name,
-                      modules,
+                      project.modules,
                       project.puppetfile,
                       project.managed_moduledir,
                       project.project_file,
@@ -808,8 +769,6 @@ module Bolt
     # Loads a Puppetfile and installs its modules.
     #
     def install_puppetfile(puppetfile_config, puppetfile, moduledir)
-      assert_puppetfile_or_module_command(config.project.modules)
-
       outputter.print_message("Installing modules from Puppetfile")
       installer = Bolt::ModuleInstaller.new(outputter, pal)
       ok = outputter.spin do
@@ -819,47 +778,6 @@ module Bolt
       ok ? 0 : 1
     end
 
-    # Raises an error if the 'puppetfile install' command is deprecated due to
-    # modules being configured.
-    #
-    def assert_puppetfile_or_module_command(modules)
-      if Bolt::Util.powershell?
-        case options[:action]
-        when 'generate-types'
-          old_command = 'Register-BoltPuppetfileTypes'
-          new_command = 'Register-BoltModuleTypes'
-        when 'install'
-          old_command = 'Install-BoltPuppetfile'
-          new_command = 'Install-BoltModule'
-        when 'show', 'show-modules'
-          old_command = 'Get-BoltPuppetfileModules'
-          new_command = 'Get-BoltModule'
-        end
-      else
-        old_command = "bolt puppetfile #{options[:action]}"
-        new_command = if options[:action] == 'show-modules'
-                        'bolt module show'
-                      else
-                        "bolt module #{options[:action]}"
-                      end
-      end
-
-      if modules && options[:subcommand] == 'puppetfile'
-        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. "
-        msg += "Use '#{old_command}' instead." if options[:action] != 'add'
-        raise Bolt::CLIError, msg
-      end
-    end
-
     def pal
       @pal ||= Bolt::PAL.new(Bolt::Config::Modulepath.new(config.modulepath),
                              config.hiera_config,