bolt 3.3.0 → 3.7.0

data/lib/bolt/config.rb

@@ -169,6 +169,7 @@ module Bolt
       @config_files = []
 
       default_data = {
+        'analytics'           => true,
         'apply-settings'      => {},
         'color'               => true,
         'compile-concurrency' => Etc.nprocessors,
@@ -263,6 +264,8 @@ module Bolt
           # Disabled warnings are concatenated
           when 'disable-warnings'
             val1.concat(val2)
+          when 'analytics'
+            val1 && val2
           # All other values are overwritten
           else
             val2
@@ -328,13 +331,6 @@ module Bolt
     end
 
     def validate
-      if @data['future']
-        Bolt::Logger.warn(
-          "future_option",
-          "Configuration option 'future' no longer exposes future behavior."
-        )
-      end
-
       if @data['modulepath']&.include?(@project.managed_moduledir.to_s)
         raise Bolt::ValidationError,
               "Found invalid path in modulepath: #{@project.managed_moduledir}. This path "\
@@ -395,6 +391,10 @@ module Bolt
       @data['format'] = value
     end
 
+    def future
+      @data['future']
+    end
+
     def trace
       @data['trace']
     end
@@ -459,6 +459,10 @@ module Bolt
       Set.new(@project.disable_warnings + @data['disable-warnings'])
     end
 
+    def analytics
+      @data['analytics']
+    end
+
     # Check if there is a case-insensitive match to the path
     def check_path_case(type, paths)
       return if paths.nil?

data/lib/bolt/config/options.rb

@@ -1,12 +1,13 @@
 # frozen_string_literal: true
 
-require 'bolt/config/transport/ssh'
-require 'bolt/config/transport/winrm'
-require 'bolt/config/transport/orch'
+require 'bolt/config/transport/docker'
 require 'bolt/config/transport/local'
 require 'bolt/config/transport/lxd'
-require 'bolt/config/transport/docker'
+require 'bolt/config/transport/orch'
+require 'bolt/config/transport/podman'
 require 'bolt/config/transport/remote'
+require 'bolt/config/transport/ssh'
+require 'bolt/config/transport/winrm'
 
 module Bolt
   class Config
@@ -14,13 +15,14 @@ module Bolt
       # Transport config classes. Used to load default transport config which
       # gets passed along to the inventory.
       TRANSPORT_CONFIG = {
-        'ssh'    => Bolt::Config::Transport::SSH,
-        'winrm'  => Bolt::Config::Transport::WinRM,
-        'pcp'    => Bolt::Config::Transport::Orch,
+        'docker' => Bolt::Config::Transport::Docker,
         'local'  => Bolt::Config::Transport::Local,
         'lxd'    => Bolt::Config::Transport::LXD,
-        'docker' => Bolt::Config::Transport::Docker,
-        'remote' => Bolt::Config::Transport::Remote
+        'pcp'    => Bolt::Config::Transport::Orch,
+        'podman' => Bolt::Config::Transport::Podman,
+        'remote' => Bolt::Config::Transport::Remote,
+        'ssh'    => Bolt::Config::Transport::SSH,
+        'winrm'  => Bolt::Config::Transport::WinRM
       }.freeze
 
       # Plugin definition. This is used by the JSON schemas to indicate that an option
@@ -55,6 +57,13 @@ module Bolt
       # Definitions used to validate config options.
       # https://github.com/puppetlabs/bolt/blob/main/schemas/README.md
       OPTIONS = {
+        "analytics" => {
+          description: "Whether to disable analytics. Setting this option to 'false' in the system-wide "\
+                       "or user-level configuration will disable analytics for all projects, even if this "\
+                       "option is set to 'true' at the project level.",
+          type: [TrueClass, FalseClass],
+          _example: false
+        },
         "apply-settings" => {
           description: "A map of Puppet settings to use when applying Puppet code using the `apply` "\
                        "plan function or the `bolt apply` command.",
@@ -133,6 +142,20 @@ module Bolt
           _example: "json",
           _default: "human"
         },
+        "future" => {
+          description: "Enable new Bolt features that may include breaking changes.",
+          type: Hash,
+          properties: {
+            "file_paths" => {
+              description: "Load scripts from the `scripts/` directory of a module",
+              type: [TrueClass, FalseClass],
+              _example: true,
+              _default: false
+            }
+          },
+          _plugin: false,
+          _example: { 'file_paths' => true }
+        },
         "hiera-config" => {
           description: "The path to the Hiera configuration file.",
           type: String,
@@ -497,6 +520,12 @@ module Bolt
           _plugin: true,
           _example: { "job-poll-interval" => 15, "job-poll-timeout" => 30 }
         },
+        "podman" => {
+          description: "A map of configuration options for the podman transport.",
+          type: Hash,
+          _plugin: true,
+          _example: { "cleanup" => false, "tmpdir" => "/mount/tmp" }
+        },
         "remote" => {
           description: "A map of configuration options for the remote transport.",
           type: Hash,
@@ -532,6 +561,7 @@ module Bolt
 
       # Options that are available in a bolt-defaults.yaml file
       DEFAULTS_OPTIONS = %w[
+        analytics
         color
         compile-concurrency
         concurrency
@@ -551,12 +581,14 @@ module Bolt
 
       # Options that are available in a bolt-project.yaml file
       PROJECT_OPTIONS = %w[
+        analytics
         apply-settings
         color
         compile-concurrency
         concurrency
         disable-warnings
         format
+        future
         hiera-config
         log
         modulepath

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

@@ -9,11 +9,13 @@ module Bolt
       class LXD < Base
         OPTIONS = %w[
           cleanup
+          remote
           tmpdir
         ].freeze
 
         DEFAULTS = {
-          'cleanup' => true
+          'cleanup' => true,
+          'remote'  => 'local'
         }.freeze
       end
     end

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

@@ -266,6 +266,13 @@ module Bolt
             _plugin: true,
             _example: "BOLT.PRODUCTION"
           },
+          "remote" => {
+            type: String,
+            description: "The LXD remote host to use.",
+            _default: "local",
+            _plugin: false,
+            _example: 'myremote'
+          },
           "run-as" => {
             type: String,
             description: "The user to run commands as after login. The run-as user must be different than the "\

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'bolt/error'
+require 'bolt/config/transport/base'
+
+module Bolt
+  class Config
+    module Transport
+      class Podman < Base
+        OPTIONS = %w[
+          cleanup
+          host
+          interpreters
+          shell-command
+          tmpdir
+          tty
+        ].freeze
+
+        DEFAULTS = {
+          'cleanup' => true
+        }.freeze
+
+        private def validate
+          super
+
+          if @config['interpreters']
+            @config['interpreters'] = normalize_interpreters(@config['interpreters'])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bolt/container_result.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'bolt/error'
+require 'bolt/result'
+
+module Bolt
+  class ContainerResult
+    attr_reader :value, :object
+
+    def self.from_exception(exception, exit_code, image, position: [])
+      details = Bolt::Result.create_details(position)
+      error = {
+        'kind' => 'puppetlabs.tasks/container-error',
+        'issue_code' => 'CONTAINER_ERROR',
+        'msg' => "Error running container '#{image}': #{exception}",
+        'details' => details
+      }
+      error['details']['exit_code'] = exit_code
+      ContainerResult.new({ '_error' => error }, object: image)
+    end
+
+    def _pcore_init_hash
+      { 'value' => @value,
+        'object' => @image }
+    end
+
+    # First argument can't be named given the way that Puppet deserializes variables
+    def initialize(value = nil, object: nil)
+      @value = value || {}
+      @object = object
+    end
+
+    def eql?(other)
+      self.class == other.class &&
+        value == other.value
+    end
+    alias == eql?
+
+    def [](key)
+      value[key]
+    end
+
+    def to_json(opts = nil)
+      to_data.to_json(opts)
+    end
+    alias to_s to_json
+
+    # This is the value with all non-UTF-8 characters removed, suitable for
+    # printing or converting to JSON. It *should* only be possible to have
+    # non-UTF-8 characters in stdout/stderr keys as they are not allowed from
+    # tasks but we scrub the whole thing just in case.
+    def safe_value
+      Bolt::Util.walk_vals(value) do |val|
+        if val.is_a?(String)
+          # Replace invalid bytes with hex codes, ie. \xDE\xAD\xBE\xEF
+          val.scrub { |c| c.bytes.map { |b| "\\x" + b.to_s(16).upcase }.join }
+        else
+          val
+        end
+      end
+    end
+
+    def stdout
+      value['stdout']
+    end
+
+    def stderr
+      value['stderr']
+    end
+
+    def to_data
+      {
+        "object" => object,
+        "status" => status,
+        "value" => safe_value
+      }
+    end
+
+    def status
+      ok? ? 'success' : 'failure'
+    end
+
+    def ok?
+      error_hash.nil?
+    end
+    alias ok ok?
+    alias success? ok?
+
+    # This allows access to errors outside puppet compilation
+    # it should be prefered over error in bolt code
+    def error_hash
+      value['_error']
+    end
+
+    # Warning: This will fail outside of a compilation.
+    # Use error_hash inside bolt.
+    # Is it crazy for this to behave differently outside a compiler?
+    def error
+      if error_hash
+        Puppet::DataTypes::Error.from_asserted_hash(error_hash)
+      end
+    end
+  end
+end

data/lib/bolt/error.rb

@@ -61,6 +61,21 @@ module Bolt
     end
   end
 
+  class ContainerFailure < Bolt::Error
+    attr_reader :result
+
+    def initialize(result)
+      details = {
+        'value' => result.value,
+        'object' => result.object
+      }
+      message = "Plan aborted: Running container '#{result.object}' failed."
+      super(message, 'bolt/container-failure', details)
+      @result = result
+      @error_code = 2
+    end
+  end
+
   class RunFailure < Bolt::Error
     attr_reader :result_set
 

data/lib/bolt/executor.rb

@@ -12,34 +12,37 @@ require 'bolt/config'
 require 'bolt/result_set'
 require 'bolt/puppetdb'
 # Load transports
-require 'bolt/transport/ssh'
-require 'bolt/transport/winrm'
-require 'bolt/transport/orch'
+require 'bolt/transport/docker'
 require 'bolt/transport/local'
 require 'bolt/transport/lxd'
-require 'bolt/transport/docker'
+require 'bolt/transport/orch'
+require 'bolt/transport/podman'
 require 'bolt/transport/remote'
+require 'bolt/transport/ssh'
+require 'bolt/transport/winrm'
 require 'bolt/yarn'
 
 module Bolt
   TRANSPORTS = {
-    ssh: Bolt::Transport::SSH,
-    winrm: Bolt::Transport::WinRM,
-    pcp: Bolt::Transport::Orch,
+    docker: Bolt::Transport::Docker,
     local: Bolt::Transport::Local,
     lxd: Bolt::Transport::LXD,
-    docker: Bolt::Transport::Docker,
-    remote: Bolt::Transport::Remote
+    pcp: Bolt::Transport::Orch,
+    podman: Bolt::Transport::Podman,
+    remote: Bolt::Transport::Remote,
+    ssh: Bolt::Transport::SSH,
+    winrm: Bolt::Transport::WinRM
   }.freeze
 
   class Executor
-    attr_reader :noop, :transports, :in_parallel
+    attr_reader :noop, :transports, :in_parallel, :future
     attr_accessor :run_as
 
     def initialize(concurrency = 1,
                    analytics = Bolt::Analytics::NoopClient.new,
                    noop = false,
-                   modified_concurrency = false)
+                   modified_concurrency = false,
+                   future = {})
       # lazy-load expensive gem code
       require 'concurrent'
       @analytics = analytics
@@ -64,6 +67,7 @@ module Bolt
       @noop = noop
       @run_as = nil
       @in_parallel = false
+      @future = future
       @pool = if concurrency > 0
                 Concurrent::ThreadPoolExecutor.new(name: 'exec', max_threads: concurrency)
               else
@@ -217,7 +221,7 @@ module Bolt
       results
     end
 
-    def report_transport(transport, count)
+    private def report_transport(transport, count)
       name = transport.class.name.split('::').last.downcase
       unless @reported_transports.include?(name)
         @analytics&.event('Transport', 'initialize', label: name, value: count)
@@ -475,7 +479,7 @@ module Bolt
       Time.now
     end
 
-    def wait_until(timeout, retry_interval)
+    private def wait_until(timeout, retry_interval)
       start = wait_now
       until yield
         raise(TimeoutError, 'Timed out waiting for target') if (wait_now - start).to_i >= timeout
@@ -484,22 +488,30 @@ module Bolt
     end
 
     def prompt(prompt, options)
-      @prompting = true
       unless $stdin.tty?
+        return options[:default] if options[:default]
         raise Bolt::Error.new('STDIN is not a tty, unable to prompt', 'bolt/no-tty-error')
       end
 
-      $stderr.print("#{prompt}: ")
+      @prompting = true
+
+      if options[:default] && !options[:sensitive]
+        $stderr.print("#{prompt} [#{options[:default]}]: ")
+      else
+        $stderr.print("#{prompt}: ")
+      end
 
       value = if options[:sensitive]
                 $stdin.noecho(&:gets).to_s.chomp
               else
                 $stdin.gets.to_s.chomp
               end
+
       @prompting = false
 
       $stderr.puts if options[:sensitive]
 
+      value = options[:default] if value.empty?
       value
     end