bolt 2.42.0 → 3.3.0

data/lib/bolt/config/options.rb

@@ -4,6 +4,7 @@ require 'bolt/config/transport/ssh'
 require 'bolt/config/transport/winrm'
 require 'bolt/config/transport/orch'
 require 'bolt/config/transport/local'
+require 'bolt/config/transport/lxd'
 require 'bolt/config/transport/docker'
 require 'bolt/config/transport/remote'
 
@@ -17,6 +18,7 @@ module Bolt
         'winrm'  => Bolt::Config::Transport::WinRM,
         'pcp'    => Bolt::Config::Transport::Orch,
         'local'  => Bolt::Config::Transport::Local,
+        'lxd'    => Bolt::Config::Transport::LXD,
         'docker' => Bolt::Config::Transport::Docker,
         'remote' => Bolt::Config::Transport::Remote
       }.freeze
@@ -53,31 +55,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 +114,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 +148,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 +179,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 +198,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 +216,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 +268,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 +286,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 +332,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,42 +409,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"
-            }
-          },
-          _deprecation: "This option 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.",
-          _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 "\
@@ -450,7 +425,14 @@ module Bolt
           _example: false,
           _default: true
         },
-
+        "stream" => {
+          description: "Whether to stream output from scripts and commands to the console. "\
+                       "**This option is experimental**.",
+          type: [TrueClass, FalseClass],
+          _plugin: false,
+          _default: false,
+          _example: true
+        },
         "tasks" => {
           description: "A list of task names and glob patterns to filter the project's tasks by. This option is used "\
                        "to limit the visibility of tasks for users of the project. For example, project authors "\
@@ -467,8 +449,8 @@ module Bolt
         },
         "trusted-external-command" => {
           description: "The path to an executable on the Bolt controller that can produce external trusted facts. "\
-                       "**External trusted facts are experimental in both Puppet and Bolt and this API may change or "\
-                       "be removed.**",
+                       "**External trusted facts are experimental in both Puppet and Bolt and this API might "\
+                       "change or be removed.**",
           type: String,
           _plugin: false,
           _example: "/etc/puppetlabs/facts/trusted_external.sh"
@@ -477,8 +459,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 "\
@@ -502,6 +484,13 @@ module Bolt
           _plugin: true,
           _example: { "cleanup" => false, "tmpdir" => "/tmp/bolt" }
         },
+        "lxd" => {
+          description: "A map of configuration options for the LXD transport. The LXD transport is "\
+                       "experimental and might include breaking changes between minor versions.",
+          type: Hash,
+          _plugin: true,
+          _example: { cleanup: false }
+        },
         "pcp" => {
           description: "A map of configuration options for the pcp transport.",
           type: Hash,
@@ -529,57 +518,46 @@ 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
+        stream
       ].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
@@ -588,12 +566,11 @@ module Bolt
         plans
         plugin-cache
         plugin-hooks
-        plugin_hooks
         plugins
         puppetdb
-        puppetfile
         save-rerun
         spinner
+        stream
         tasks
         trusted-external-command
       ].freeze

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/lxd.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'bolt/error'
+require 'bolt/config/transport/base'
+
+module Bolt
+  class Config
+    module Transport
+      class LXD < Base
+        OPTIONS = %w[
+          cleanup
+          tmpdir
+        ].freeze
+
+        DEFAULTS = {
+          'cleanup' => true
+        }.freeze
+      end
+    end
+  end
+end

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,
@@ -32,7 +32,7 @@ module Bolt
           "cleanup" => {
             type: [TrueClass, FalseClass],
             description: "Whether to clean up temporary files created on targets. When running commands on a target, "\
-                         "Bolt may create temporary files. After completing the command, these files are "\
+                         "Bolt might create temporary files. After completing the command, these files are "\
                          "automatically deleted. This value can be set to 'false' if you wish to leave these "\
                          "temporary files on the target.",
             _plugin: true,
@@ -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

@@ -4,6 +4,7 @@
 require 'English'
 require 'json'
 require 'logging'
+require 'pathname'
 require 'set'
 require 'bolt/analytics'
 require 'bolt/result'
@@ -15,6 +16,7 @@ require 'bolt/transport/ssh'
 require 'bolt/transport/winrm'
 require 'bolt/transport/orch'
 require 'bolt/transport/local'
+require 'bolt/transport/lxd'
 require 'bolt/transport/docker'
 require 'bolt/transport/remote'
 require 'bolt/yarn'
@@ -25,6 +27,7 @@ module Bolt
     winrm: Bolt::Transport::WinRM,
     pcp: Bolt::Transport::Orch,
     local: Bolt::Transport::Local,
+    lxd: Bolt::Transport::LXD,
     docker: Bolt::Transport::Docker,
     remote: Bolt::Transport::Remote
   }.freeze
@@ -39,7 +42,6 @@ module Bolt
                    modified_concurrency = false)
       # lazy-load expensive gem code
       require 'concurrent'
-
       @analytics = analytics
       @logger = Bolt::Logger.logger(self)
 
@@ -100,6 +102,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 +123,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 might cause file limit issues. Default concurrency has been set to "\
+              "'#{@concurrency}' to mitigate those issues, which might 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|
@@ -228,6 +233,11 @@ module Bolt
       @analytics.report_bundled_content(mode, name)
     end
 
+    def report_file_source(plan_function, source)
+      label = Pathname.new(source).absolute? ? 'absolute' : 'module'
+      @analytics&.event('Plan', plan_function, label: label)
+    end
+
     def report_apply(statement_count, resource_counts)
       data = { statement_count: statement_count }
 
@@ -258,7 +268,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 +422,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 +430,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 +442,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 +484,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 +496,7 @@ module Bolt
               else
                 $stdin.gets.to_s.chomp
               end
+      @prompting = false
 
       $stderr.puts if options[:sensitive]