bolt 3.23.1 → 3.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67f08b10db67ef79aadf22a542f6564aa502743f53619f41c40aff4761e2e0c0
-  data.tar.gz: 81d8b927c1349299ba568358a2f155d624fb28f7b65ae5985bcfc8b6fe24eb6b
+  metadata.gz: 7ad3bbc9413aac278feeac8a7e31173bd065f0029fb211d7e1906c4803a4c390
+  data.tar.gz: 387d3a07844139eb29a1db06d1792acfdad6a09eab2b5576a9c4d34fdffdaca8
 SHA512:
-  metadata.gz: a3e66f8d5adc727228b09e212de34c7de796c556a0d91153e1599cbf619b30b98c9358ea3683c2e00650375ecac8745fdf7a79977a42d6761967ce98c5c2ac71
-  data.tar.gz: a6dedd218bc2db8e5365906366a1cbeef5e99b02f606c80677081eccc71172fa7f15f3798630847239228feafc861278938044e98b2107429c8e34cea7143f9c
+  metadata.gz: 83c1685fc238f049dad5cf841ea55f37c57a1aa59d66ef420d754b78d7b0ba8cca4533accb2cfbe53915587f1832beb7cbf956501486de63e135933b57f5fa98
+  data.tar.gz: c6900fde1fd9234a603171c79c2f2b3a22b2d2661797b94bf0afd2050f4ef5cc32844562734d3e41bd94464806e1efaabaac346d6887773f547c801c33cc3d6f

data/Puppetfile

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-forge "http://forge.puppetlabs.com"
+forge 'https://forge.puppetlabs.com'
 
 moduledir File.join(File.dirname(__FILE__), 'modules')
 
@@ -26,7 +26,7 @@ mod 'puppetlabs-package', '2.2.0'
 mod 'puppetlabs-powershell_task_helper', '0.1.0'
 mod 'puppetlabs-puppet_conf', '1.3.0'
 mod 'puppetlabs-python_task_helper', '0.5.0'
-mod 'puppetlabs-reboot', '4.1.0'
+mod 'puppetlabs-reboot', '4.2.0'
 mod 'puppetlabs-ruby_task_helper', '0.6.1'
 mod 'puppetlabs-ruby_plugin_helper', '0.2.0'
 mod 'puppetlabs-stdlib', '8.2.0'

data/lib/bolt/application.rb

@@ -49,7 +49,7 @@ module Bolt
                         code
                       end
 
-      targets = inventory.get_targets(targets)
+      targets = inventory.get_targets(targets, ext_glob: true)
 
       Puppet[:tasks] = false
       ast = pal.parse_manifest(manifest_code, manifest)
@@ -90,7 +90,7 @@ module Bolt
     # @return [Bolt::ResultSet]
     #
     def run_command(command, targets, env_vars: nil)
-      targets = inventory.get_targets(targets)
+      targets = inventory.get_targets(targets, ext_glob: true)
 
       with_benchmark do
         executor.run_command(targets, command, env_vars: env_vars)
@@ -106,7 +106,7 @@ module Bolt
     #
     def download_file(source, destination, targets)
       destination = File.expand_path(destination, Dir.pwd)
-      targets     = inventory.get_targets(targets)
+      targets     = inventory.get_targets(targets, ext_glob: true)
 
       with_benchmark do
         executor.download_file(targets, source, destination)
@@ -122,7 +122,7 @@ module Bolt
     #
     def upload_file(source, destination, targets)
       source  = find_file(source)
-      targets = inventory.get_targets(targets)
+      targets = inventory.get_targets(targets, ext_glob: true)
 
       Bolt::Util.validate_file('source file', source, true)
 
@@ -225,7 +225,7 @@ module Bolt
 
       with_benchmark do
         pal.lookup(key,
-                   inventory.get_targets(targets),
+                   inventory.get_targets(targets, ext_glob: true),
                    inventory,
                    executor,
                    plan_vars: vars)
@@ -351,6 +351,7 @@ module Bolt
     # @return [Bolt::PlanResult]
     #
     def run_plan(plan, targets, params: {})
+      plan_params = pal.get_plan_info(plan)['parameters']
       if targets && targets.any?
         if params['nodes'] || params['targets']
           key = params.include?('nodes') ? 'nodes' : 'targets'
@@ -360,7 +361,6 @@ module Bolt
                 "in the JSON data passed in the --params option"
         end
 
-        plan_params  = pal.get_plan_info(plan)['parameters']
         target_param = plan_params.dig('targets', 'type') =~ /TargetSpec/
         node_param   = plan_params.include?('nodes')
 
@@ -375,13 +375,17 @@ module Bolt
         end
       end
 
-      plan_context = { plan_name: plan, params: params }
+      sensitive_params = params.keys.select { |param| plan_params.dig(param, 'sensitive') }
+
+      plan_context = { plan_name: plan, params: params, sensitive: sensitive_params }
 
       executor.start_plan(plan_context)
       result = pal.run_plan(plan, params, executor, inventory, plugins.puppetdb_client)
       executor.finish_plan(result)
 
       result
+    rescue Bolt::Error => e
+      Bolt::PlanResult.new(e, 'failure')
     end
 
     # Show plan information.
@@ -620,7 +624,10 @@ module Bolt
       Bolt::Util.validate_file('script', script)
 
       with_benchmark do
-        executor.run_script(inventory.get_targets(targets), script, arguments, env_vars: env_vars)
+        executor.run_script(inventory.get_targets(targets, ext_glob: true),
+                            script,
+                            arguments,
+                            env_vars: env_vars)
       end
     end
 
@@ -676,7 +683,7 @@ module Bolt
     # @return [Bolt::ResultSet]
     #
     def run_task(task, targets, params: {})
-      targets = inventory.get_targets(targets)
+      targets = inventory.get_targets(targets, ext_glob: true)
 
       with_benchmark do
         pal.run_task(task, targets, params, executor, inventory)
@@ -775,7 +782,7 @@ module Bolt
       # 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
-      targets     = inventory.get_targets(targets)
+      targets     = inventory.get_targets(targets, ext_glob: true)
 
       inventory_targets, adhoc_targets = targets.partition do |target|
         known_names.include?(target.name)

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

@@ -9,6 +9,7 @@ module Bolt
       class LXD < Base
         OPTIONS = %w[
           cleanup
+          interpreters
           remote
           tmpdir
         ].concat(RUN_AS_OPTIONS).sort.freeze
@@ -17,6 +18,14 @@ module Bolt
           'cleanup' => true,
           'remote'  => 'local'
         }.freeze
+
+        private def validate
+          super
+
+          if @config['interpreters']
+            @config['interpreters'] = normalize_interpreters(@config['interpreters'])
+          end
+        end
       end
     end
   end

data/lib/bolt/inventory/inventory.rb

@@ -8,6 +8,12 @@ module Bolt
     class Inventory
       attr_reader :plugins, :source, :targets, :transport
 
+      # Getting targets from the inventory using '--targets' supports extended glob pattern
+      # matching. In this case, use the extended regex so Bolt only uses commas outside
+      # brackets and braces as delimiters.
+      EXTENDED_TARGET_REGEX = /[[:space:],]+(?=[^\]}]*(?:[\[{]|$))/.freeze
+      TARGET_REGEX          = /[[:space:],]+/.freeze
+
       class WildcardError < Bolt::Error
         def initialize(target)
           super("Found 0 targets matching wildcard pattern #{target}", 'bolt.inventory/wildcard-error')
@@ -85,8 +91,8 @@ module Bolt
       # alias for analytics
       alias node_names target_names
 
-      def get_targets(targets)
-        target_array = expand_targets(targets)
+      def get_targets(targets, ext_glob: false)
+        target_array = expand_targets(targets, ext_glob: ext_glob)
         if target_array.is_a? Array
           target_array.flatten.uniq(&:name)
         else
@@ -107,20 +113,31 @@ module Bolt
         groups.group_collect(target_name)
       end
 
+      # Does a target match the glob-style wildcard?
+      # Ignore case; use extended globs ({a,b}) when running from the CLI.
+      def match_wildcard?(wildcard, target_name, ext_glob: false)
+        if ext_glob
+          File.fnmatch(wildcard, target_name, File::FNM_CASEFOLD | File::FNM_EXTGLOB)
+        else
+          regexp = Regexp.new("^#{Regexp.escape(wildcard).gsub('\*', '.*?')}$", Regexp::IGNORECASE)
+          target_name =~ regexp
+        end
+      end
+
       # If target is a group name, expand it to the members of that group.
       # Else match against targets in inventory by name or alias.
       # If a wildcard string, error if no matches are found.
       # Else fall back to [target] if no matches are found.
-      def resolve_name(target)
+      def resolve_name(target, ext_glob: false)
         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| match_wildcard?(target, targ, ext_glob: ext_glob) }
+          targets += groups.target_aliases
+                           .select { |tgt_alias, _| match_wildcard?(target, tgt_alias, ext_glob: ext_glob) }
+                           .values
 
           if targets.empty?
             raise(WildcardError, target) if target.include?('*')
@@ -132,16 +149,18 @@ module Bolt
       end
       private :resolve_name
 
-      def expand_targets(targets)
+      def expand_targets(targets, ext_glob: false)
         case targets
         when Bolt::Target
           targets
         when Array
-          targets.map { |tish| expand_targets(tish) }
+          targets.map { |tish| expand_targets(tish, ext_glob: ext_glob) }
         when String
           # Expand a comma-separated list
-          targets.split(/[[:space:],]+/).reject(&:empty?).map do |name|
-            ts = resolve_name(name)
+          # Regex magic below is required to workaround `{foo,bar}` glob syntax
+          regex = ext_glob ? EXTENDED_TARGET_REGEX : TARGET_REGEX
+          targets.split(regex).reject(&:empty?).map do |name|
+            ts = resolve_name(name, ext_glob: ext_glob)
             ts.map do |t|
               # If the target doesn't exist, evaluate it from the inventory.
               # Then return a Bolt::Target.

data/lib/bolt/outputter/human.rb

@@ -2,6 +2,7 @@
 
 require_relative '../../bolt/container_result'
 require_relative '../../bolt/pal'
+require_relative '../../bolt/util/format'
 
 module Bolt
   class Outputter
@@ -890,7 +891,7 @@ module Bolt
       end
 
       def print_message(message)
-        @stream.puts(message)
+        @stream.puts(Bolt::Util::Format.stringify(message))
       end
 
       def print_error(message)

data/lib/bolt/outputter/json.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative '../../bolt/util/format'
+
 module Bolt
   class Outputter
     class JSON < Bolt::Outputter
@@ -190,7 +192,7 @@ module Bolt
       end
 
       def print_message(message)
-        $stderr.puts(message)
+        $stderr.puts(Bolt::Util::Format.stringify(message))
       end
       alias print_error print_message
 

data/lib/bolt/outputter/rainbow.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative '../../bolt/pal'
+require_relative '../../bolt/util/format'
 
 module Bolt
   class Outputter
@@ -110,7 +111,7 @@ module Bolt
       end
 
       def print_message(message)
-        @stream.puts colorize(:rainbow, message)
+        @stream.puts colorize(:rainbow, Bolt::Util::Format.stringify(message))
       end
     end
   end

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

@@ -6,7 +6,7 @@ module Bolt
       class Connection
         attr_reader :logger, :key
 
-        CONTEXT_KEYS = Set.new(%i[plan_name description params]).freeze
+        CONTEXT_KEYS = Set.new(%i[plan_name description params sensitive]).freeze
 
         def self.get_key(opts)
           [
@@ -46,6 +46,7 @@ module Bolt
           if plan_context
             begin
               opts = plan_context.select { |k, _| CONTEXT_KEYS.include? k }
+              opts[:params] = opts[:params].reject { |k, _| plan_context[:sensitive].include?(k) }
               @client.command.plan_start(opts)['name']
             rescue OrchestratorClient::ApiError => e
               if e.code == '404'

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

@@ -53,9 +53,11 @@ module Bolt
             @connection = ::WinRM::Connection.new(options)
             @connection.logger = @transport_logger
 
-            @session = @connection.shell(:powershell)
-            @session.run('$PSVersionTable.PSVersion')
-            @logger.trace { "Opened session" }
+            @connection.shell(:powershell) do |session|
+              session.run('$PSVersionTable.PSVersion')
+            end
+
+            @logger.trace { "Opened connection" }
           end
         rescue Timeout::Error
           # If we're using the default port with SSL, a timeout probably means the
@@ -95,9 +97,8 @@ module Bolt
         end
 
         def disconnect
-          @session&.close
           @client&.disconnect!
-          @logger.trace { "Closed session" }
+          @logger.trace { "Closed connection" }
         end
 
         def execute(command)
@@ -116,12 +117,18 @@ module Bolt
             # propagate to the main thread via the shell, there's no chance
             # they will be unhandled, so the default stack trace is unneeded.
             Thread.current.report_on_exception = false
-            result = @session.run(command)
-            out_wr << result.stdout
-            err_wr << result.stderr
-            out_wr.close
-            err_wr.close
-            result.exitcode
+
+            # Open a new shell instance for each command executed. PowerShell is
+            # unable to unload any DLLs loaded when running a PowerShell script
+            # or task from the same shell instance they were loaded in, which
+            # prevents Bolt from cleaning up the temp directory successfully.
+            # Using a new PowerShell instance avoids this limitation.
+            @connection.shell(:powershell) do |session|
+              result = session.run(command)
+              out_wr << result.stdout
+              err_wr << result.stderr
+              result.exitcode
+            end
           ensure
             # Close the streams to avoid the caller deadlocking
             out_wr.close

data/lib/bolt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bolt
-  VERSION = '3.23.1'
+  VERSION = '3.24.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 3.23.1
+  version: 3.24.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-16 00:00:00.000000000 Z
+date: 2022-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -163,6 +163,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -170,6 +173,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: net-ssh-krb
   requirement: !ruby/object:Gem::Requirement