bolt 3.5.0 → 3.8.0

data/lib/bolt/catalog.rb

@@ -65,7 +65,8 @@ module Bolt
       puppet_overrides = {
         bolt_pdb_client: pdb_client,
         bolt_inventory: inv,
-        bolt_project: bolt_project
+        bolt_project: bolt_project,
+        future: request['future']
       }
 
       # Facts will be set by the catalog compiler, so we need to ensure

data/lib/bolt/cli.rb

@@ -33,20 +33,23 @@ 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],
-      'secret' => %w[encrypt decrypt createkeys],
+      'apply'     => %w[],
+      'command'   => %w[run],
+      'file'      => %w[download upload],
+      'group'     => %w[show],
+      'guide'     => %w[],
       'inventory' => %w[show],
-      'group' => %w[show],
-      'project' => %w[init migrate],
-      'module' => %w[add generate-types install show],
-      'apply' => %w[],
-      'guide' => %w[]
+      'lookup'    => %w[],
+      'module'    => %w[add generate-types install show],
+      'plan'      => %w[show run convert new],
+      'project'   => %w[init migrate],
+      'script'    => %w[run],
+      'secret'    => %w[encrypt decrypt createkeys],
+      'task'      => %w[show run]
     }.freeze
 
+    TARGETING_OPTIONS = %i[query rerun targets].freeze
+
     attr_reader :config, :options
 
     def initialize(argv)
@@ -262,7 +265,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"
@@ -324,6 +327,10 @@ module Bolt
         raise Bolt::CLIError, "a manifest file or --execute is required"
       end
 
+      if options[:subcommand] == 'lookup' && !options[:object]
+        raise Bolt::CLIError, "Must specify a key to look up"
+      end
+
       if options[:subcommand] == 'command' && (!options[:object] || options[:object].empty?)
         raise Bolt::CLIError, "Must specify a command to run"
       end
@@ -509,6 +516,8 @@ module Bolt
         when 'migrate'
           code = Bolt::ProjectManager.new(config, outputter, pal).migrate
         end
+      when 'lookup'
+        code = lookup(options[:object], options[:targets])
       when 'plan'
         case options[:action]
         when 'new'
@@ -541,7 +550,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
@@ -557,7 +570,8 @@ module Bolt
             when 'command'
               executor.run_command(targets, options[:object], executor_opts)
             when 'script'
-              script_path = find_file(options[:object])
+              script_path = find_file(options[:object], executor.future&.fetch('file_paths', false))
+              validate_file('script', script_path)
               executor.run_script(targets, script_path, options[:leftovers], executor_opts)
             when 'task'
               pal.run_task(options[:object],
@@ -582,8 +596,9 @@ module Bolt
                 dest = File.expand_path(dest, Dir.pwd)
                 executor.download_file(targets, src, dest, executor_opts)
               when 'upload'
-                validate_file('source file', src, true)
-                executor.upload_file(targets, src, dest, executor_opts)
+                src_path = find_file(src, executor.future&.fetch('file_paths', false))
+                validate_file('source file', src_path, true)
+                executor.upload_file(targets, src_path, dest, executor_opts)
               end
             end
         end
@@ -630,8 +645,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 +688,43 @@ module Bolt
         known_names.include?(target.name)
       end
 
-      target_list = {
-        inventory: inventory_targets,
-        adhoc:     adhoc_targets
-      }
-
-      outputter.print_targets(target_list, inventoryfile)
+      { inventory: inventory_targets, adhoc: adhoc_targets }
     end
 
-    def show_targets
-      update_targets(options)
-      outputter.print_target_info(options[:targets])
+    def list_groups
+      outputter.print_groups(inventory.group_names.sort, inventory.source, config.default_inventoryfile)
     end
 
-    def list_groups
-      groups = inventory.group_names
-      outputter.print_groups(groups)
+    # Looks up a value with Hiera, using targets as the contexts to perform the
+    # look ups in.
+    #
+    def lookup(key, targets)
+      executor = Bolt::Executor.new(
+        config.concurrency,
+        analytics,
+        options[:noop],
+        config.modified_concurrency,
+        config.future
+      )
+
+      executor.subscribe(outputter) if options.fetch(:format, 'human') == 'human'
+      executor.subscribe(log_outputter)
+      executor.publish_event(type: :plan_start, plan: nil)
+
+      results = outputter.spin do
+        pal.lookup(
+          key,
+          targets,
+          inventory,
+          executor,
+          config.concurrency
+        )
+      end
+
+      executor.shutdown
+      outputter.print_result_set(results)
+
+      results.ok ? 0 : 1
     end
 
     def run_plan(plan_name, plan_arguments, nodes, options)
@@ -688,7 +755,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 +795,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 +884,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 +933,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
 
@@ -900,20 +970,17 @@ module Bolt
     # the path is a Puppet file path and looks for the file in a module's files
     # directory.
     #
-    def find_file(path)
-      unless File.exist?(path) || Pathname.new(path).absolute?
-        modulepath = Bolt::Config::Modulepath.new(config.modulepath)
-        modules    = Bolt::Module.discover(modulepath.full_modulepath, config.project)
-        mod, file = path.split(File::SEPARATOR, 2)
-
-        if modules[mod]
-          @logger.debug("Did not find file at #{File.expand_path(path)}, checking in module '#{mod}'")
-          path = File.join(modules[mod].path, 'files', file)
-        end
+    def find_file(path, future_file_paths)
+      return path if File.exist?(path) || Pathname.new(path).absolute?
+      modulepath = Bolt::Config::Modulepath.new(config.modulepath)
+      modules    = Bolt::Module.discover(modulepath.full_modulepath, config.project)
+      mod, file = path.split(File::SEPARATOR, 2)
+
+      if modules[mod]
+        @logger.debug("Did not find file at #{File.expand_path(path)}, checking in module '#{mod}'")
+        found = Bolt::Util.find_file_in_module(modules[mod].path, file || "", future_file_paths)
+        path = found.nil? ? File.join(modules[mod].path, 'files', file) : found
       end
-
-      Bolt::Util.validate_file('script', path)
-
       path
     end
 
@@ -935,7 +1002,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