bolt 2.40.1 → 3.0.1

data/lib/bolt/config/options.rb

@@ -53,31 +53,38 @@ module Bolt
       # Definitions used to validate config options.
       # https://github.com/puppetlabs/bolt/blob/main/schemas/README.md
       OPTIONS = {
-        "apply_settings" => {
+        "apply-settings" => {
           description: "A map of Puppet settings to use when applying Puppet code using the `apply` "\
                        "plan function or the `bolt apply` command.",
           type: Hash,
           properties: {
-            "show_diff" => {
-              description: "Whether to log and report a contextual diff.",
+            "evaltrace" => {
+              description: "Whether each resource should log when it is being evaluated. This allows "\
+                           "you to interactively see exactly what is being done.",
               type: [TrueClass, FalseClass],
               _example: true,
               _default: false
-            }
-          },
-          _plugin: false,
-          _deprecation: "This option will be removed in Bolt 3.0. Use `apply-settings` instead."
-        },
-        "apply-settings" => {
-          description: "A map of Puppet settings to use when applying Puppet code using the `apply` "\
-                       "plan function or the `bolt apply` command.",
-          type: Hash,
-          properties: {
+            },
+            "log_level" => {
+              description: "The log level for logs in apply reports from Puppet. These can be seen "\
+                           "in ApplyResults.",
+              type: String,
+              enum: %w[debug info notice warning err alert emerg crit],
+              _example: "debug",
+              _default: "notice"
+            },
             "show_diff" => {
               description: "Whether to log and report a contextual diff.",
               type: [TrueClass, FalseClass],
               _example: true,
               _default: false
+            },
+            "trace" => {
+              description: "Whether to print stack traces on some errors. Will print internal Ruby "\
+                           "stack trace interleaved with Puppet function frames.",
+              type: [TrueClass, FalseClass],
+              _example: true,
+              _default: false
             }
           },
           _plugin: false
@@ -105,6 +112,17 @@ module Bolt
           _example: 50,
           _default: "100 or 1/7 the ulimit, whichever is lower."
         },
+        "disable-warnings" => {
+          description: "An array of IDs of warnings to suppress. Warnings with a matching ID will not be logged "\
+                       "by Bolt. If you are upgrading Bolt to a new major version, you should re-enable all warnings "\
+                       "until you have finished upgrading.",
+          type: Array,
+          items: {
+            type: String
+          },
+          _plugin: false,
+          _example: ["powershell_2"]
+        },
         "format" => {
           description: "The format to use when printing results.",
           type: String,
@@ -128,18 +146,6 @@ module Bolt
           _plugin: false,
           _example: {}
         },
-        "inventoryfile" => {
-          description: "The path to a structured data inventory file used to refer to groups of targets on the "\
-                       "command line and from plans. Read more about using inventory files in [Inventory "\
-                       "files](inventory_file_v2.md).",
-          type: String,
-          _plugin: false,
-          _deprecation: "This option will be removed in Bolt 3.0. Use the `--inventoryfile` command-line option "\
-                        "to use a non-default inventory file or move the file contents to `inventory.yaml` in the "\
-                        "project directory.",
-          _example: "~/.puppetlabs/bolt/inventory.yaml",
-          _default: "project/inventory.yaml"
-        },
         "plugin-cache" => {
           description: "This feature is experimental. Enable plugin caching and set the time-to-live.",
           type: Hash,
@@ -171,7 +177,7 @@ module Bolt
                 "level" => {
                   description: "The type of information to log.",
                   type: String,
-                  enum: %w[trace debug error info notice warn fatal any],
+                  enum: %w[trace debug error info warn fatal any],
                   _default: "warn"
                 }
               }
@@ -190,7 +196,7 @@ module Bolt
               "level" => {
                 description: "The type of information to log.",
                 type: String,
-                enum: %w[trace debug error info notice warn fatal any],
+                enum: %w[trace debug error info warn fatal any],
                 _default: "warn"
               }
             }
@@ -208,7 +214,7 @@ module Bolt
           },
           _plugin: false,
           _example: ["~/.puppetlabs/bolt/modules", "~/.puppetlabs/bolt/site-modules"],
-          _default: ["project/modules", "project/site-modules", "project/site"]
+          _default: ["project/modules"]
         },
         "module-install" => {
           description: "Options that configure where Bolt downloads modules from. This option is only used when "\
@@ -260,6 +266,10 @@ module Bolt
                     description: "The name of the module.",
                     type: String
                   },
+                  "resolve" => {
+                    description: "Whether to resolve the module's dependencies when installing modules.",
+                    type: [TrueClass, FalseClass]
+                  },
                   "version_requirement" => {
                     description: "The version requirement for the module. Accepts a specific version (1.2.3), version "\
                                  "shorthand (1.2.x), or a version range (>= 1.2.0).",
@@ -274,15 +284,24 @@ module Bolt
                     description: "The URL to the public git repository.",
                     type: String
                   },
+                  "name" => {
+                    description: "The name of the module. Required when `resolve` is `false`.",
+                    type: String
+                  },
                   "ref" => {
                     description: "The git reference to check out. Can be either a branch, tag, or commit SHA.",
                     type: String
+                  },
+                  "resolve" => {
+                    description: "Whether to resolve the module's dependencies when installing modules.",
+                    type: [TrueClass, FalseClass]
                   }
                 }
               }
             ]
           },
           _plugin: false,
+          _default: [],
           _example: [
             "puppetlabs-facts",
             { "name" => "puppetlabs-mysql" },
@@ -311,16 +330,6 @@ module Bolt
           _plugin: false,
           _example: ["myproject", "myproject::foo", "myproject::bar", "myproject::deploy::*"]
         },
-        "plugin_hooks" => {
-          description: "A map of [plugin hooks](writing_plugins.md#hooks) and which plugins a hook should use. "\
-                       "The only configurable plugin hook is `puppet_library`, which can use two possible plugins: "\
-                       "[`puppet_agent`](https://github.com/puppetlabs/puppetlabs-puppet_agent#puppet_agentinstall) "\
-                       "and [`task`](using_plugins.md#task).",
-          type: Hash,
-          _plugin: true,
-          _example: { "puppet_library" => { "plugin" => "puppet_agent", "version" => "6.15.0", "_run_as" => "root" } },
-          _deprecation: "This option will be removed in Bolt 3.0. Use `plugin-hooks` instead."
-        },
         "plugin-hooks" => {
           description: "A map of [plugin hooks](writing_plugins.md#hooks) and which plugins a hook should use. "\
                        "The only configurable plugin hook is `puppet_library`, which can use two possible plugins: "\
@@ -398,40 +407,6 @@ module Bolt
           },
           _plugin: true
         },
-        "puppetfile" => {
-          description: "A map containing options for the `bolt puppetfile install` command and "\
-                       "`Install-BoltPuppetfile` cmdlet.",
-          type: Hash,
-          properties: {
-            "forge" => {
-              description: "A subsection that can have its own `proxy` setting to set an HTTP proxy for Forge "\
-                           "operations only, and a `baseurl` setting to specify a different Forge host.",
-              type: Hash,
-              properties: {
-                "baseurl" => {
-                  description: "The URL to the Forge host.",
-                  type: String,
-                  format: "uri",
-                  _example: "https://forge.example.com"
-                },
-                "proxy" => {
-                  description: "The HTTP proxy to use for Forge operations.",
-                  type: String,
-                  format: "uri",
-                  _example: "https://my-forge-proxy.com:8080"
-                }
-              },
-              _example: { "baseurl" => "https://forge.example.com", "proxy" => "https://my-forge-proxy.com:8080" }
-            },
-            "proxy" => {
-              description: "The HTTP proxy to use for Git and Forge operations.",
-              type: String,
-              format: "uri",
-              _example: "https://my-proxy.com:8080"
-            }
-          },
-          _plugin: false
-        },
         "save-rerun" => {
           description: "Whether to update `.rerun.json` in the Bolt project directory. If "\
                        "your target names include passwords, set this value to `false` to avoid "\
@@ -475,8 +450,8 @@ module Bolt
 
       # Options that configure the inventory, specifically the default transport
       # used by targets and the transports themselves. These options are used in
-      # bolt.yaml, under a 'config' key in inventory.yaml, and under the
-      # 'inventory-config' key in bolt-defaults.yaml.
+      # bolt-defaults.yaml under 'inventory-config' and in inventory.yaml under
+      # 'config'.
       INVENTORY_OPTIONS = {
         "transport" => {
           description: "The default transport to use when the transport for a target is not "\
@@ -527,57 +502,45 @@ module Bolt
         }
       }.freeze
 
-      # Options that are available in a bolt.yaml file
-      BOLT_OPTIONS = %w[
-        apply-settings
-        apply_settings
-        color
+      # Options that are available on the command line
+      # This only includes options where users can provide arbitrary
+      # values from the command-line, allowing the validator to check them
+      CLI_OPTIONS = %w[
         compile-concurrency
         concurrency
         format
-        hiera-config
-        inventoryfile
         log
         modulepath
-        plugin-hooks
-        plugin_hooks
-        plugins
-        puppetdb
-        puppetfile
-        save-rerun
-        spinner
-        trusted-external-command
+        transport
       ].freeze
 
       # Options that are available in a bolt-defaults.yaml file
-      BOLT_DEFAULTS_OPTIONS = %w[
+      DEFAULTS_OPTIONS = %w[
         color
         compile-concurrency
         concurrency
+        disable-warnings
         format
         inventory-config
         log
         module-install
         plugin-cache
         plugin-hooks
-        plugin_hooks
         plugins
         puppetdb
-        puppetfile
         save-rerun
         spinner
       ].freeze
 
       # Options that are available in a bolt-project.yaml file
-      BOLT_PROJECT_OPTIONS = %w[
+      PROJECT_OPTIONS = %w[
         apply-settings
-        apply_settings
         color
         compile-concurrency
         concurrency
+        disable-warnings
         format
         hiera-config
-        inventoryfile
         log
         modulepath
         module-install
@@ -586,10 +549,8 @@ module Bolt
         plans
         plugin-cache
         plugin-hooks
-        plugin_hooks
         plugins
         puppetdb
-        puppetfile
         save-rerun
         spinner
         tasks

data/lib/bolt/config/transport/local.rb

@@ -17,6 +17,7 @@ module Bolt
         OPTIONS = WINDOWS_OPTIONS.dup.concat(RUN_AS_OPTIONS).sort.freeze
 
         DEFAULTS = {
+          'bundled-ruby' => true,
           'cleanup' => true
         }.freeze
 

data/lib/bolt/config/transport/options.rb

@@ -21,7 +21,7 @@ module Bolt
             type: [TrueClass, FalseClass],
             _plugin: false,
             _example: true,
-            _default: false
+            _default: true
           },
           "cacert" => {
             type: String,
@@ -253,6 +253,13 @@ module Bolt
             _plugin: true,
             _example: "jump.example.com"
           },
+          "read-timeout" => {
+            type: Integer,
+            description: "How long to wait in seconds when making requests to the Orchestrator.",
+            minimum: 1,
+            _plugin: true,
+            _example: 15
+          },
           "realm" => {
             type: String,
             description: "The Kerberos realm (Active Directory domain) to authenticate against.",

data/lib/bolt/config/transport/orch.rb

@@ -12,6 +12,7 @@ module Bolt
           host
           job-poll-interval
           job-poll-timeout
+          read-timeout
           service-url
           task-environment
           token-file

data/lib/bolt/executor.rb

@@ -100,6 +100,8 @@ module Bolt
         # that type of event, publish the event
         next unless types.nil? || types.include?(event[:type])
         @publisher.post(subscriber) do |sub|
+          # Wait for user to input to prompt before printing anything
+          sleep(0.1) while @prompting
           sub.handle_event(event)
         end
       end
@@ -119,11 +121,12 @@ module Bolt
     def queue_execute(targets)
       if @warn_concurrency && targets.length > @concurrency
         @warn_concurrency = false
-        @logger.warn("The ulimit is low, which may cause file limit issues. Default concurrency has been set to "\
-                     "'#{@concurrency}' to mitigate those issues, which may cause Bolt to run slow. "\
-                     "Disable this warning by configuring ulimit using 'ulimit -n <limit>' in your shell "\
-                     "configuration, or by configuring Bolt's concurrency. "\
-                     "See https://puppet.com/docs/bolt/latest/bolt_known_issues.html for details.")
+        msg = "The ulimit is low, which may cause file limit issues. Default concurrency has been set to "\
+              "'#{@concurrency}' to mitigate those issues, which may cause Bolt to run slow. "\
+              "Disable this warning by configuring ulimit using 'ulimit -n <limit>' in your shell "\
+              "configuration, or by configuring Bolt's concurrency. "\
+              "See https://puppet.com/docs/bolt/latest/bolt_known_issues.html for details."
+        Bolt::Logger.warn("low_ulimit", msg)
       end
 
       targets.group_by(&:transport).flat_map do |protocol, protocol_targets|
@@ -258,7 +261,9 @@ module Bolt
 
     def with_node_logging(description, batch, log_level = :info)
       @logger.send(log_level, "#{description} on #{batch.map(&:safe_name)}")
+      publish_event(type: :start_spin)
       result = yield
+      publish_event(type: :stop_spin)
       @logger.send(log_level, result.to_json)
       result
     end
@@ -410,6 +415,7 @@ module Bolt
       subscribe(self, [:node_result])
       results = Array.new(skein.length)
       @in_parallel = true
+      publish_event(type: :stop_spin)
 
       until skein.empty?
         @thread_completed = false
@@ -417,6 +423,7 @@ module Bolt
 
         skein.each do |yarn|
           if yarn.alive?
+            publish_event(type: :stop_spin)
             r = yarn.resume
           else
             results[yarn.index] = yarn.value
@@ -428,6 +435,7 @@ module Bolt
         sleep(0.1) until @thread_completed || skein.empty?
       end
 
+      publish_event(type: :stop_spin)
       @in_parallel = false
       unsubscribe(self, [:node_result])
       results
@@ -469,6 +477,7 @@ module Bolt
     end
 
     def prompt(prompt, options)
+      @prompting = true
       unless $stdin.tty?
         raise Bolt::Error.new('STDIN is not a tty, unable to prompt', 'bolt/no-tty-error')
       end
@@ -480,6 +489,7 @@ module Bolt
               else
                 $stdin.gets.to_s.chomp
               end
+      @prompting = false
 
       $stderr.puts if options[:sensitive]
 

data/lib/bolt/inventory.rb

@@ -55,7 +55,8 @@ module Bolt
       schema = {
         type:        Hash,
         properties:  OPTIONS.map { |opt| [opt, _ref: opt] }.to_h,
-        definitions: DEFINITIONS
+        definitions: DEFINITIONS,
+        _plugin:     true
       }
 
       schema[:definitions]['config'][:properties] = Bolt::Config.transport_definitions
@@ -96,7 +97,7 @@ module Bolt
 
       Bolt::Validator.new.tap do |validator|
         validator.validate(data, schema, source)
-        validator.warnings.each { |warning| logger.warn(warning) }
+        validator.warnings.each { |warning| Bolt::Logger.warn(warning[:id], warning[:msg]) }
       end
 
       inventory = create_version(data, config.transport, config.transports, plugins)

data/lib/bolt/inventory/group.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'bolt/config/options'
 require 'bolt/inventory/group'
 require 'bolt/inventory/inventory'
 require 'bolt/inventory/target'
@@ -18,12 +19,23 @@ module Bolt
       GROUP_KEYS = DATA_KEYS + %w[name groups targets]
       CONFIG_KEYS = Bolt::Config::INVENTORY_OPTIONS.keys
 
-      def initialize(input, plugins)
+      def initialize(input, plugins, all_group: false)
         @logger = Bolt::Logger.logger(self)
         @plugins = plugins
 
         input = @plugins.resolve_top_level_references(input) if @plugins.reference?(input)
 
+        if all_group
+          if input.key?('name') && input['name'] != 'all'
+            Bolt::Logger.warn(
+              "top_level_group_name",
+              "Top-level group '#{input['name']}' cannot specify a name, using 'all' instead."
+            )
+          end
+
+          input = input.merge('name' => 'all')
+        end
+
         raise ValidationError.new("Group does not have a name", nil) unless input.key?('name')
 
         @name = @plugins.resolve_references(input['name'])
@@ -125,7 +137,7 @@ module Bolt
 
         unless (unexpected_keys = target.keys - TARGET_KEYS).empty?
           msg = "Found unexpected key(s) #{unexpected_keys.join(', ')} in target #{t_name}"
-          @logger.warn(msg)
+          Bolt::Logger.warn("unknown_target_keys", msg)
         end
 
         validate_data_keys(target, t_name)
@@ -252,7 +264,7 @@ module Bolt
 
         unless (unexpected_keys = input.keys - GROUP_KEYS).empty?
           msg = "Found unexpected key(s) #{unexpected_keys.join(', ')} in group #{@name}"
-          @logger.warn(msg)
+          Bolt::Logger.warn("unknown_group_keys", msg)
         end
       end
 
@@ -315,7 +327,26 @@ module Bolt
           'features' => @plugins.resolve_references(data.fetch('features', [])),
           'plugin_hooks' => @plugins.resolve_references(data.fetch('plugin_hooks', {}))
         }
+
         validate_data_keys(result, target)
+
+        Bolt::Config::Options::TRANSPORT_CONFIG.each_key do |transport|
+          next unless result['config'].key?(transport)
+          transport_config = result['config'][transport]
+          next unless transport_config.is_a?(Hash)
+          transport_config = Bolt::Util.postwalk_vals(transport_config) do |val|
+            if val.is_a?(Hash)
+              val = val.compact
+              val = nil if val.empty?
+            end
+            val
+          end
+          # the transport config is user-specified data so we
+          # still want to preserve it even if it exclusively
+          # contains nil-resolved keys
+          result['config'][transport] = transport_config || {}
+        end
+
         result['features'] = Set.new(result['features'].flatten)
         result
       end
@@ -340,7 +371,7 @@ module Bolt
             msg = +"Found unexpected key(s) #{unexpected_keys.join(', ')} in config for"
             msg << " target #{target} in" if target
             msg << " group #{@name}"
-            @logger.warn(msg)
+            Bolt::Logger.warn("unknown_config_keys", msg)
           end
         end
       end