bolt 3.4.0 → 3.7.1

data/lib/bolt/cli.rb

@@ -47,6 +47,8 @@ module Bolt
       'guide' => %w[]
     }.freeze
 
+    TARGETING_OPTIONS = %i[query rerun targets].freeze
+
     attr_reader :config, :options
 
     def initialize(argv)
@@ -262,7 +264,7 @@ module Bolt
     end
 
     def update_targets(options)
-      target_opts = options.keys.select { |opt| %i[query rerun targets].include?(opt) }
+      target_opts = options.keys.select { |opt| TARGETING_OPTIONS.include?(opt) }
       target_string = "'--targets', '--rerun', or '--query'"
       if target_opts.length > 1
         raise Bolt::CLIError, "Only one targeting option #{target_string} can be specified"
@@ -541,7 +543,11 @@ module Bolt
         end
         code = apply_manifest(options[:code], options[:targets], options[:object], options[:noop])
       else
-        executor = Bolt::Executor.new(config.concurrency, analytics, options[:noop], config.modified_concurrency)
+        executor = Bolt::Executor.new(config.concurrency,
+                                      analytics,
+                                      options[:noop],
+                                      config.modified_concurrency,
+                                      config.future)
         targets = options[:targets]
 
         results = nil
@@ -630,8 +636,39 @@ module Bolt
     end
 
     def list_targets
-      inventoryfile = config.inventoryfile || config.default_inventoryfile
+      if options.keys.any? { |key| TARGETING_OPTIONS.include?(key) }
+        target_flag = true
+      else
+        options[:targets] = 'all'
+      end
+
+      outputter.print_targets(
+        group_targets_by_source,
+        inventory.source,
+        config.default_inventoryfile,
+        target_flag
+      )
+    end
 
+    def show_targets
+      if options.keys.any? { |key| TARGETING_OPTIONS.include?(key) }
+        target_flag = true
+      else
+        options[:targets] = 'all'
+      end
+
+      outputter.print_target_info(
+        group_targets_by_source,
+        inventory.source,
+        config.default_inventoryfile,
+        target_flag
+      )
+    end
+
+    # Returns a hash of targets sorted by those that are found in the
+    # inventory and those that are provided on the command line.
+    #
+    private def group_targets_by_source
       # Retrieve the known group and target names. This needs to be done before
       # updating targets, as that will add adhoc targets to the inventory.
       known_names = inventory.target_names
@@ -642,22 +679,11 @@ module Bolt
         known_names.include?(target.name)
       end
 
-      target_list = {
-        inventory: inventory_targets,
-        adhoc:     adhoc_targets
-      }
-
-      outputter.print_targets(target_list, inventoryfile)
-    end
-
-    def show_targets
-      update_targets(options)
-      outputter.print_target_info(options[:targets])
+      { inventory: inventory_targets, adhoc: adhoc_targets }
     end
 
     def list_groups
-      groups = inventory.group_names
-      outputter.print_groups(groups)
+      outputter.print_groups(inventory.group_names.sort, inventory.source, config.default_inventoryfile)
     end
 
     def run_plan(plan_name, plan_arguments, nodes, options)
@@ -688,7 +714,11 @@ module Bolt
       plan_context = { plan_name: plan_name,
                        params: plan_arguments }
 
-      executor = Bolt::Executor.new(config.concurrency, analytics, options[:noop], config.modified_concurrency)
+      executor = Bolt::Executor.new(config.concurrency,
+                                    analytics,
+                                    options[:noop],
+                                    config.modified_concurrency,
+                                    config.future)
       if %w[human rainbow].include?(options.fetch(:format, 'human'))
         executor.subscribe(outputter)
       else
@@ -724,7 +754,11 @@ module Bolt
         Bolt::Logger.warn("empty_manifest", message)
       end
 
-      executor = Bolt::Executor.new(config.concurrency, analytics, noop, config.modified_concurrency)
+      executor = Bolt::Executor.new(config.concurrency,
+                                    analytics,
+                                    noop,
+                                    config.modified_concurrency,
+                                    config.future)
       executor.subscribe(outputter) if options.fetch(:format, 'human') == 'human'
       executor.subscribe(log_outputter)
       # apply logging looks like plan logging, so tell the outputter we're in a
@@ -809,15 +843,10 @@ module Bolt
     #
     def assert_project_file(project)
       unless project.project_file?
-        msg = if project.config_file.exist?
-                command = Bolt::Util.powershell? ? 'Update-BoltProject' : 'bolt project migrate'
-                "Detected Bolt configuration file #{project.config_file}, unable to install "\
-                "modules. To update to a project configuration file, run '#{command}'."
-              else
-                command = Bolt::Util.powershell? ? 'New-BoltProject' : 'bolt project init'
-                "Could not find project configuration file #{project.project_file}, unable "\
-                "to install modules. To create a Bolt project, run '#{command}'."
-              end
+        command = Bolt::Util.powershell? ? 'New-BoltProject' : 'bolt project init'
+
+        msg = "Could not find project configuration file #{project.project_file}, unable "\
+              "to install modules. To create a Bolt project, run '#{command}'."
 
         raise Bolt::Error.new(msg, 'bolt/missing-project-config-error')
       end
@@ -863,7 +892,7 @@ module Bolt
 
     # Display the list of available Bolt guides.
     def list_topics
-      outputter.print_topics(guides.keys)
+      outputter.print_topics(guides.keys - ['guide'])
       0
     end
 
@@ -935,7 +964,7 @@ module Bolt
 
     def analytics
       @analytics ||= begin
-        client = Bolt::Analytics.build_client
+        client = Bolt::Analytics.build_client(config.analytics)
         client.bundled_content = bundled_content
         client
       end

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/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