bolt 3.15.0 → 3.18.0

data/lib/bolt/config/modulepath.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'bolt/config'
+require_relative '../../bolt/config'
 
 module Bolt
   class Config

data/lib/bolt/config/options.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'bolt/config/transport/docker'
-require 'bolt/config/transport/local'
-require 'bolt/config/transport/lxd'
-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'
+require_relative '../../bolt/config/transport/docker'
+require_relative '../../bolt/config/transport/local'
+require_relative '../../bolt/config/transport/lxd'
+require_relative '../../bolt/config/transport/orch'
+require_relative '../../bolt/config/transport/podman'
+require_relative '../../bolt/config/transport/remote'
+require_relative '../../bolt/config/transport/ssh'
+require_relative '../../bolt/config/transport/winrm'
 
 module Bolt
   class Config
@@ -147,14 +147,23 @@ module Bolt
           type: Hash,
           properties: {
             "file_paths" => {
-              description: "Load scripts from the `scripts/` directory of a module",
+              description: "Load scripts from the `scripts/` directory of a module.",
+              type: [TrueClass, FalseClass],
+              _example: true,
+              _default: false,
+              _deprecation: "Bolt no longer honors this option and enables loading scripts from the scripts "\
+                            "directory by default."
+            },
+            "script_interpreter" => {
+              description: "Use a target's [`interpreters` configuration](bolt_transports_reference.md#interpreters) "\
+                           "when running a script.",
               type: [TrueClass, FalseClass],
               _example: true,
               _default: false
             }
           },
           _plugin: false,
-          _example: { 'file_paths' => true }
+          _example: { 'script_interpreter' => true }
         },
         "hiera-config" => {
           description: "The path to the Hiera configuration file.",
@@ -248,10 +257,16 @@ module Bolt
           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.",
+              description: "A subsection for configuring connections to a Forge host.",
               type: Hash,
               properties: {
+                "authorization_token" => {
+                  description: "The token used to authorize requests to the Forge host. Must also specify "\
+                               "`baseurl` when using this option.",
+                  type: String,
+                  _example: "Bearer eyJhbGciOiJIUzI1NiIsInR5c...",
+                  _plugin: true
+                },
                 "baseurl" => {
                   description: "The URL to the Forge host.",
                   type: String,
@@ -265,7 +280,11 @@ module Bolt
                   _example: "https://my-forge-proxy.com:8080"
                 }
               },
-              _example: { "baseurl" => "https://forge.example.com", "proxy" => "https://my-forge-proxy.com:8080" }
+              _example: {
+                "authorization_token" => "Bearer eyJhbGciOiJIUzI1NiIsInR5c...",
+                "baseurl" => "https://forge.example.com",
+                "proxy" => "https://my-forge-proxy.com:8080"
+              }
             },
             "proxy" => {
               description: "The HTTP proxy to use for Git and Forge operations.",

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

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'bolt/error'
-require 'bolt/util'
-require 'bolt/validator'
-require 'bolt/config/transport/options'
+require_relative '../../../bolt/error'
+require_relative '../../../bolt/util'
+require_relative '../../../bolt/validator'
+require_relative '../../../bolt/config/transport/options'
 
 module Bolt
   class Config

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bolt/error'
-require 'bolt/config/transport/base'
+require_relative '../../../bolt/error'
+require_relative '../../../bolt/config/transport/base'
 
 module Bolt
   class Config

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bolt/error'
-require 'bolt/config/transport/base'
+require_relative '../../../bolt/error'
+require_relative '../../../bolt/config/transport/base'
 
 module Bolt
   class Config

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bolt/error'
-require 'bolt/config/transport/base'
+require_relative '../../../bolt/error'
+require_relative '../../../bolt/config/transport/base'
 
 module Bolt
   class Config

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bolt/error'
-require 'bolt/config/transport/base'
+require_relative '../../../bolt/error'
+require_relative '../../../bolt/config/transport/base'
 
 module Bolt
   class Config

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bolt/error'
-require 'bolt/config/transport/base'
+require_relative '../../../bolt/error'
+require_relative '../../../bolt/config/transport/base'
 
 module Bolt
   class Config

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bolt/error'
-require 'bolt/config/transport/base'
+require_relative '../../../bolt/error'
+require_relative '../../../bolt/config/transport/base'
 
 module Bolt
   class Config

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bolt/error'
-require 'bolt/config/transport/base'
+require_relative '../../../bolt/error'
+require_relative '../../../bolt/config/transport/base'
 
 module Bolt
   class Config

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bolt/error'
-require 'bolt/config/transport/base'
+require_relative '../../../bolt/error'
+require_relative '../../../bolt/config/transport/base'
 
 module Bolt
   class Config

data/lib/bolt/config.rb

@@ -3,11 +3,11 @@
 require 'etc'
 require 'logging'
 require 'pathname'
-require 'bolt/project'
-require 'bolt/logger'
-require 'bolt/util'
-require 'bolt/config/options'
-require 'bolt/validator'
+require_relative '../bolt/project'
+require_relative '../bolt/logger'
+require_relative '../bolt/util'
+require_relative 'config/options'
+require_relative '../bolt/validator'
 
 module Bolt
   class UnknownTransportError < Bolt::Error

data/lib/bolt/container_result.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require 'json'
-require 'bolt/error'
-require 'bolt/result'
+require_relative '../bolt/error'
+require_relative '../bolt/result'
 
 module Bolt
   class ContainerResult

data/lib/bolt/error.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'bolt/util'
+require_relative '../bolt/util'
 
 module Bolt
   class Error < RuntimeError

data/lib/bolt/executor.rb

@@ -6,21 +6,21 @@ require 'json'
 require 'logging'
 require 'pathname'
 require 'set'
-require 'bolt/analytics'
-require 'bolt/config'
-require 'bolt/fiber_executor'
-require 'bolt/puppetdb'
-require 'bolt/result'
-require 'bolt/result_set'
+require_relative '../bolt/analytics'
+require_relative '../bolt/config'
+require_relative '../bolt/fiber_executor'
+require_relative '../bolt/puppetdb'
+require_relative '../bolt/result'
+require_relative '../bolt/result_set'
 # Load transports
-require 'bolt/transport/docker'
-require 'bolt/transport/local'
-require 'bolt/transport/lxd'
-require 'bolt/transport/orch'
-require 'bolt/transport/podman'
-require 'bolt/transport/remote'
-require 'bolt/transport/ssh'
-require 'bolt/transport/winrm'
+require_relative '../bolt/transport/docker'
+require_relative '../bolt/transport/local'
+require_relative '../bolt/transport/lxd'
+require_relative '../bolt/transport/orch'
+require_relative '../bolt/transport/podman'
+require_relative '../bolt/transport/remote'
+require_relative '../bolt/transport/ssh'
+require_relative '../bolt/transport/winrm'
 
 module Bolt
   TRANSPORTS = {
@@ -300,6 +300,9 @@ module Bolt
       description = options.fetch(:description, "script #{script}")
       log_action(description, targets) do
         options[:run_as] = run_as if run_as && !options.key?(:run_as)
+        options[:script_interpreter] = (future || {}).fetch('script_interpreter', false)
+
+        @analytics&.event('Future', 'script_interpreter', label: options[:script_interpreter].to_s)
 
         batch_execute(targets) do |transport, batch|
           with_node_logging("Running script #{script} with '#{arguments.to_json}'", batch) do

data/lib/bolt/fiber_executor.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bolt/logger'
-require 'bolt/plan_future'
+require_relative '../bolt/logger'
+require_relative '../bolt/plan_future'
 
 module Bolt
   class FiberExecutor
@@ -52,7 +52,7 @@ module Bolt
       # tracking which Futures to wait on when `wait()` is called without
       # arguments.
       @id += 1
-      future = Bolt::PlanFuture.new(future, @id, name: name, plan_id: plan_id)
+      future = Bolt::PlanFuture.new(future, @id, name: name, plan_id: plan_id, scope: newscope)
       @logger.trace("Created future #{future.name}")
 
       # Register the PlanFuture with the FiberExecutor to be executed
@@ -68,11 +68,15 @@ module Bolt
     #
     def round_robin
       active_futures.each do |future|
-        # If the Fiber is still running and can be resumed, then resume it
+        # If the Fiber is still running and can be resumed, then resume it.
+        # Override Puppet's global_scope to prevent ephemerals in other scopes
+        # from being popped off in the wrong order due to race conditions.
+        # This primarily happens when running executor functions from custom
+        # Puppet language functions, but may happen elsewhere.
         @logger.trace("Checking future '#{future.name}'")
         if future.alive?
           @logger.trace("Resuming future '#{future.name}'")
-          future.resume
+          Puppet.override(global_scope: future.scope) { future.resume }
         end
 
         # Once we've restarted the Fiber, check to see if it's finished again

data/lib/bolt/inventory/group.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require 'bolt/config/options'
-require 'bolt/inventory/group'
-require 'bolt/inventory/inventory'
-require 'bolt/inventory/target'
+require_relative '../../bolt/config/options'
+require_relative '../../bolt/inventory/group'
+require_relative '../../bolt/inventory/inventory'
+require_relative '../../bolt/inventory/target'
 
 module Bolt
   class Inventory

data/lib/bolt/inventory/inventory.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'bolt/inventory/group'
-require 'bolt/inventory/target'
+require_relative '../../bolt/inventory/group'
+require_relative '../../bolt/inventory/target'
 
 module Bolt
   class Inventory
     class Inventory
-      attr_reader :config, :plugins, :source, :targets, :transport
+      attr_reader :plugins, :source, :targets, :transport
 
       class WildcardError < Bolt::Error
         def initialize(target)
@@ -14,25 +14,15 @@ module Bolt
         end
       end
 
-      # TODO: Pass transport config instead of config object
       def initialize(data, transport, transports, plugins, source = nil)
-        @logger       = Bolt::Logger.logger(self)
-        @data         = data || {}
-        @transport    = transport
-        @config       = transports
-        @plugins      = plugins
-        @groups       = Group.new(@data, plugins, all_group: true)
-        @group_lookup = {}
-        @targets      = {}
-        @source       = source
-
-        @groups.resolve_string_targets(@groups.target_aliases, @groups.all_targets)
-
-        collect_groups
-      end
-
-      def validate
-        @groups.validate
+        @logger          = Bolt::Logger.logger(self)
+        @data            = data || {}
+        @transport       = transport
+        @config          = transports
+        @config_resolved = transports.values.all?(&:resolved?)
+        @plugins         = plugins
+        @targets         = {}
+        @source          = source
       end
 
       def version
@@ -43,13 +33,46 @@ module Bolt
         Bolt::Target
       end
 
-      def collect_groups
-        # Provide a lookup map for finding a group by name
-        @group_lookup = @groups.collect_groups
+      # Load and resolve the groups in the inventory. Loading groups resolves
+      # all plugin references except for those for target data and config.
+      #
+      # @return [Bolt::Inventory::Group]
+      #
+      def groups
+        @groups ||= Group.new(@data, @plugins, all_group: true).tap do |groups|
+          groups.resolve_string_targets(groups.target_aliases, groups.all_targets)
+          groups.validate
+        end
       end
 
+      # Return a list of all group names in the inventory.
+      #
+      # @return [Array[String]]
+      #
       def group_names
-        @group_lookup.keys
+        group_lookup.keys
+      end
+
+      # Return a map of all groups in the inventory.
+      #
+      # @return [Hash[String, Bolt::Inventory::Group]]
+      #
+      def group_lookup
+        @group_lookup ||= groups.collect_groups
+      end
+
+      # Return a map of transport configuration for the inventory. Any
+      # unresolved plugin references are resolved.
+      #
+      # @return [Hash[String, Bolt::Config::Transport]]
+      #
+      def config
+        if @config_resolved
+          @config
+        else
+          @config_resolved = true
+          @config.transform_values! { |t| t.resolved? ? t : t.resolve(@plugins) }
+        end
       end
 
       def group_names_for(target_name)
@@ -57,7 +80,7 @@ module Bolt
       end
 
       def target_names
-        @groups.all_targets
+        groups.all_targets
       end
       # alias for analytics
       alias node_names target_names
@@ -81,7 +104,7 @@ module Bolt
 
       #### PRIVATE ####
       def group_data_for(target_name)
-        @groups.group_collect(target_name)
+        groups.group_collect(target_name)
       end
 
       # If target is a group name, expand it to the members of that group.
@@ -89,15 +112,15 @@ module Bolt
       # If a wildcard string, error if no matches are found.
       # Else fall back to [target] if no matches are found.
       def resolve_name(target)
-        if (group = @group_lookup[target])
+        if (group = group_lookup[target])
           group.all_targets
         else
           # Try to wildcard match targets in inventory
           # Ignore case because hostnames are generally case-insensitive
           regexp = Regexp.new("^#{Regexp.escape(target).gsub('\*', '.*?')}$", Regexp::IGNORECASE)
 
-          targets = @groups.all_targets.select { |targ| targ =~ regexp }
-          targets += @groups.target_aliases.select { |target_alias, _target| target_alias =~ regexp }.values
+          targets = groups.all_targets.select { |targ| targ =~ regexp }
+          targets += groups.target_aliases.select { |target_alias, _target| target_alias =~ regexp }.values
 
           if targets.empty?
             raise(WildcardError, target) if target.include?('*')
@@ -165,7 +188,7 @@ module Bolt
       # associated references. This is used when a target is resolved by
       # get_targets.
       def create_target_from_inventory(target_name)
-        target_data = @groups.target_collect(target_name) || { 'uri' => target_name }
+        target_data = groups.target_collect(target_name) || { 'uri' => target_name }
 
         target = Bolt::Inventory::Target.new(target_data, self)
         @targets[target.name] = target
@@ -187,24 +210,24 @@ module Bolt
         @targets[new_target.name] = new_target
 
         if existing_target
-          clear_alia_from_group(@groups, new_target.name)
+          clear_alia_from_group(groups, new_target.name)
         else
           add_to_group([new_target], 'all')
         end
 
         if new_target.target_alias
-          @groups.insert_alia(new_target.name, Array(new_target.target_alias))
+          groups.insert_alia(new_target.name, Array(new_target.target_alias))
         end
 
         new_target
       end
 
       def validate_target_from_hash(target)
-        groups = Set.new(group_names)
-        targets = target_names
+        used_groups  = Set.new(group_names)
+        used_targets = target_names
 
         # Make sure there are no group name conflicts
-        if groups.include?(target.name)
+        if used_groups.include?(target.name)
           raise ValidationError.new("Target name #{target.name} conflicts with group of the same name", nil)
         end
 
@@ -217,11 +240,11 @@ module Bolt
         end
 
         # Make sure there are no conflicts with the new target aliases
-        used_aliases = @groups.target_aliases
+        used_aliases = groups.target_aliases
         Array(target.target_alias).each do |alia|
-          if groups.include?(alia)
+          if used_groups.include?(alia)
             raise ValidationError.new("Alias #{alia} conflicts with group of the same name", nil)
-          elsif targets.include?(alia)
+          elsif used_targets.include?(alia)
             raise ValidationError.new("Alias #{alia} conflicts with target of the same name", nil)
           elsif used_aliases[alia] && used_aliases[alia] != target.name
             raise ValidationError.new(
@@ -250,7 +273,7 @@ module Bolt
         end
 
         if group_names.include?(desired_group)
-          remove_target(@groups, @targets[target.first.name], desired_group)
+          remove_target(groups, @targets[target.first.name], desired_group)
         else
           raise ValidationError.new("Group #{desired_group} does not exist in inventory", nil)
         end
@@ -260,7 +283,7 @@ module Bolt
         if group_names.include?(desired_group)
           targets.each do |target|
             # Add the inventory copy of the target
-            add_target(@groups, @targets[target.name], desired_group)
+            add_target(groups, @targets[target.name], desired_group)
           end
         else
           raise ValidationError.new("Group #{desired_group} does not exist in inventory", nil)

data/lib/bolt/inventory/options.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'bolt/config/options'
+require_relative '../../bolt/config/options'
 
 module Bolt
   class Inventory

data/lib/bolt/inventory/target.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'bolt/resource_instance'
+require_relative '../../bolt/resource_instance'
 
 module Bolt
   class Inventory

data/lib/bolt/inventory.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 require 'set'
-require 'bolt/config'
-require 'bolt/inventory/group'
-require 'bolt/inventory/inventory'
-require 'bolt/inventory/options'
-require 'bolt/target'
-require 'bolt/util'
-require 'bolt/plugin'
-require 'bolt/validator'
+require_relative '../bolt/config'
+require_relative 'inventory/group'
+require_relative 'inventory/inventory'
+require_relative 'inventory/options'
+require_relative '../bolt/target'
+require_relative '../bolt/util'
+require_relative '../bolt/plugin'
+require_relative '../bolt/validator'
 require 'yaml'
 
 module Bolt
@@ -91,19 +91,12 @@ module Bolt
         end
       end
 
-      # Resolve plugin references from transport config
-      config.transports.each_value do |t|
-        t.resolve(plugins) unless t.resolved?
-      end
-
       Bolt::Validator.new.tap do |validator|
         validator.validate(data, schema, source)
         validator.warnings.each { |warning| Bolt::Logger.warn(warning[:id], warning[:msg]) }
       end
 
-      inventory = create_version(data, config.transport, config.transports, plugins, source)
-      inventory.validate
-      inventory
+      create_version(data, config.transport, config.transports, plugins, source)
     end
 
     def self.create_version(data, transport, transports, plugins, source = nil)
@@ -119,7 +112,7 @@ module Bolt
 
     def self.empty
       config  = Bolt::Config.default
-      plugins = Bolt::Plugin.setup(config, nil)
+      plugins = Bolt::Plugin.new(config, nil)
 
       create_version({}, config.transport, config.transports, plugins, nil)
     end

data/lib/bolt/module_installer/installer.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bolt/r10k_log_proxy'
-require 'bolt/error'
+require_relative '../../bolt/r10k_log_proxy'
+require_relative '../../bolt/error'
 
 # This class is used to install modules from a Puppetfile to a module directory.
 #

data/lib/bolt/module_installer/puppetfile/forge_module.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'semantic_puppet'
-require 'bolt/module_installer/puppetfile/module'
+require_relative '../../../bolt/module_installer/puppetfile/module'
 
 # This class represents a resolved Forge module.
 #

data/lib/bolt/module_installer/puppetfile/git_module.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'bolt/module_installer/puppetfile/module'
+require_relative '../../../bolt/module_installer/puppetfile/module'
 
 # This class represents a resolved Git module.
 #

data/lib/bolt/module_installer/puppetfile/module.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'bolt/error'
+require_relative '../../../bolt/error'
 
 module Bolt
   class ModuleInstaller