bolt 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59ccedf25067dbbeb8769b4cb77178679c6b5a7a312dcecba80841af2d472ffe
-  data.tar.gz: 358e3ce1e0e4e3241eb9442fac18b80b9e36bec98b3e3d1dbbd039c5708d458b
+  metadata.gz: 557353adda3a863e4f748933cb24860616848d1696d9f0914be23474616f43ca
+  data.tar.gz: 91dc4d72ba25e2e827c5bf170574bedef50c744a4e31ac48684699ff59cdf753
 SHA512:
-  metadata.gz: 42734205200d757dd20e82aeed34f61734b4688fd8e72de40b5f5341fdd1f452537de9db1277b585a9cf274abb0dad0ba20cc2a5822e4769d40c505ca42da4f5
-  data.tar.gz: 6c906fafb671ab787e79fbcdb3bfbd544b31eeb2ade0f9937be4c3ebe7472dc9d7a399ed5ae8e357d2582e93250371a15beadf08d93cd9a68762e85e91dc9088
+  metadata.gz: 6a4c8b39f2c353498168cf89a5e70f7b4699e6332e2826efd24a905d94ca7b52ec76a6db98e94f83fe5f7fce4b6c7f58cbc51b56e79b3fce3acf0f014f2669f8
+  data.tar.gz: 6bf22f4aaef6a2741b64d77b900c9a85fd3c3588feb4a071d582415afbc5ecc479048ba7aea9912131c383d5ec2e3966682f5ea8a3cade87722a927d12275c7e

data/bolt-modules/boltlib/lib/puppet/functions/run_task.rb

@@ -99,7 +99,7 @@ Puppet::Functions.create_function(:run_task) do
     options['_description'] = description if description
 
     # Don't bother loading the local task definition if all targets use the 'pcp' transport.
-    if !targets.empty? && targets.all? { |t| t.protocol == 'pcp' }
+    if !targets.empty? && targets.all? { |t| t.transport == 'pcp' }
       # create a fake task
       task = Bolt::Task.new(name: task_name, files: [{ 'name' => '', 'path' => '' }])
     else

data/lib/bolt/config.rb

@@ -10,6 +10,7 @@ require 'bolt/transport/winrm'
 require 'bolt/transport/orch'
 require 'bolt/transport/local'
 require 'bolt/transport/docker'
+require 'bolt/transport/remote'
 
 module Bolt
   TRANSPORTS = {
@@ -17,7 +18,8 @@ module Bolt
     winrm: Bolt::Transport::WinRM,
     pcp: Bolt::Transport::Orch,
     local: Bolt::Transport::Local,
-    docker: Bolt::Transport::Docker
+    docker: Bolt::Transport::Docker,
+    remote: Bolt::Transport::Remote
   }.freeze
 
   class UnknownTransportError < Bolt::Error
@@ -36,16 +38,15 @@ module Bolt
                            private-key tty tmpdir user connect-timeout
                            cacert token-file service-url].freeze
 
-    TRANSPORT_DEFAULTS = {
-      'connect-timeout' => 10,
-      'tty' => false
-    }.freeze
-
+    # TODO: move these to the transport themselves
     TRANSPORT_SPECIFIC_DEFAULTS = {
       ssh: {
-        'host-key-check' => true
+        'connect-timeout' => 10,
+        'host-key-check' => true,
+        'tty' => false
       },
       winrm: {
+        'connect-timeout' => 10,
         'ssl' => true,
         'ssl-verify' => true
       },
@@ -53,7 +54,10 @@ module Bolt
         'task-environment' => 'production'
       },
       local: {},
-      docker: {}
+      docker: {},
+      remote: {
+        'run-on' => 'localhost'
+      }
     }.freeze
 
     def self.default
@@ -88,7 +92,7 @@ module Bolt
 
       @transports = {}
       TRANSPORTS.each_key do |transport|
-        @transports[transport] = TRANSPORT_DEFAULTS.merge(TRANSPORT_SPECIFIC_DEFAULTS[transport])
+        @transports[transport] = TRANSPORT_SPECIFIC_DEFAULTS[transport].dup
       end
 
       update_from_file(config_data)
@@ -158,7 +162,7 @@ module Bolt
 
       TRANSPORTS.each do |key, impl|
         if data[key.to_s]
-          selected = data[key.to_s].select { |k| impl.options.include?(k) }
+          selected = impl.filter_options(data[key.to_s])
           @transports[key].merge!(selected)
         end
       end

data/lib/bolt/executor.rb

@@ -32,9 +32,15 @@ module Bolt
       @load_config = load_config
 
       @transports = Bolt::TRANSPORTS.each_with_object({}) do |(key, val), coll|
-        coll[key.to_s] = Concurrent::Delay.new do
-          val.new
-        end
+        coll[key.to_s] = if key == :remote
+                           Concurrent::Delay.new do
+                             val.new(self)
+                           end
+                         else
+                           Concurrent::Delay.new do
+                             val.new
+                           end
+                         end
       end
       @reported_transports = Set.new
 
@@ -64,7 +70,7 @@ module Bolt
     # defined by the transport. Yields each batch, along with the corresponding
     # transport, to the block in turn and returns an array of result promises.
     def queue_execute(targets)
-      targets.group_by(&:protocol).flat_map do |protocol, protocol_targets|
+      targets.group_by(&:transport).flat_map do |protocol, protocol_targets|
         transport = transport(protocol)
         report_transport(transport, protocol_targets.count)
         transport.batches(protocol_targets).flat_map do |batch|

data/lib/bolt/inventory.rb

@@ -167,19 +167,17 @@ module Bolt
     # Should this reconfigure configured targets?
     def update_target(target)
       data = @groups.data_for(target.name)
-
-      unless data
-        data = {}
-        unless Bolt::Util.windows?
-          data['config'] = { 'transport' => 'local' } if target.name == 'localhost'
-        end
-      end
+      data ||= {}
 
       unless data['config']
         @logger.debug("Did not find config for #{target.name} in inventory")
         data['config'] = {}
       end
 
+      unless data['config']['transport']
+        data['config']['transport'] = 'local' if target.name == 'localhost'
+      end
+
       # These should only get set from the inventory if they have not yet
       # been instantiated
       set_vars_from_hash(target.name, data['vars']) unless @target_vars[target.name]
@@ -191,11 +189,13 @@ module Bolt
       conf.update_from_inventory(data['config'])
       conf.validate
 
-      unless target.protocol.nil? || Bolt::TRANSPORTS.include?(target.protocol.to_sym)
-        raise Bolt::UnknownTransportError.new(target.protocol, target.uri)
+      target.update_conf(conf.transport_conf)
+
+      unless target.transport.nil? || Bolt::TRANSPORTS.include?(target.transport.to_sym)
+        raise Bolt::UnknownTransportError.new(target.transport, target.uri)
       end
 
-      target.update_conf(conf.transport_conf)
+      target
     end
     private :update_target
 
@@ -226,6 +226,7 @@ module Bolt
 
     def expand_targets(targets)
       if targets.is_a? Bolt::Target
+        targets.inventory = self
         targets
       elsif targets.is_a? Array
         targets.map { |tish| expand_targets(tish) }

data/lib/bolt/node/errors.rb

@@ -7,7 +7,8 @@ module Bolt
     class BaseError < Bolt::Error
       attr_reader :issue_code
 
-      def initialize(message, issue_code)
+      # TODO: can we just drop issue code here?
+      def initialize(message, issue_code = nil)
         super(message, kind, nil, issue_code)
       end
 
@@ -34,6 +35,12 @@ module Bolt
       end
     end
 
+    class RemoteError < BaseError
+      def kind
+        'puppetlabs.tasks/remote-task-error'
+      end
+    end
+
     class EnvironmentVarError < BaseError
       def initialize(var, val)
         message = "Could not set environment variable '#{var}' to '#{val}'"

data/lib/bolt/target.rb

@@ -6,7 +6,9 @@ require 'bolt/error'
 module Bolt
   class Target
     attr_reader :uri, :options
-    attr_writer :inventory
+    # CODEREVIEW: this feels wrong. The altertative is threading inventory through the
+    # executor to the RemoteTransport
+    attr_accessor :inventory
 
     PRINT_OPTS ||= %w[host user port protocol].freeze
 
@@ -41,7 +43,7 @@ module Bolt
     def update_conf(conf)
       @protocol = conf[:transport]
 
-      t_conf = conf[:transports][protocol.to_sym]
+      t_conf = conf[:transports][transport.to_sym] || {}
       # Override url methods
       @user = t_conf['user']
       @password = t_conf['password']
@@ -85,6 +87,18 @@ module Bolt
       "Target('#{@uri}', #{opts})"
     end
 
+    def to_h
+      options.merge(
+        'name' => name,
+        'uri' => uri,
+        'protocol' => protocol,
+        'user' => user,
+        'password' => password,
+        'host' => host,
+        'port' => port
+      )
+    end
+
     def host
       @uri_obj.hostname
     end
@@ -95,10 +109,19 @@ module Bolt
       uri
     end
 
+    def remote?
+      @uri_obj.scheme == 'remote' || @protocol == 'remote'
+    end
+
     def port
       @uri_obj.port || @port
     end
 
+    # transport is separate from protocol for remote targets.
+    def transport
+      remote? ? 'remote' : protocol
+    end
+
     def protocol
       @uri_obj.scheme || @protocol
     end

data/lib/bolt/task.rb

@@ -1,6 +1,13 @@
 # frozen_string_literal: true
 
 module Bolt
+  class NoImplementationError < Bolt::Error
+    def initialize(target, task)
+      msg = "No suitable implementation of #{task.name} for #{target.name}"
+      super(msg, 'bolt/no-implementation')
+    end
+  end
+
   # Represents a Task.
   # @file and @files are mutually exclusive.
   # @name [String] name of the task
@@ -51,13 +58,17 @@ module Bolt
       file_map[file_name]['path']
     end
 
+    def implementations
+      metadata['implementations']
+    end
+
     # Returns a hash of implementation name, path to executable, input method (if defined),
     # and any additional files (name and path)
     def select_implementation(target, additional_features = [])
-      impl = if (impls = metadata['implementations'])
+      impl = if (impls = implementations)
                available_features = target.features + additional_features
                impl = impls.find { |imp| Set.new(imp['requirements']).subset?(available_features) }
-               raise "No suitable implementation of #{name} for #{target.name}" unless impl
+               raise NoImplementationError.new(target, self) unless impl
                impl = impl.dup
                impl['path'] = file_path(impl['name'])
                impl.delete('requirements')

data/lib/bolt/task/remote.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'bolt/task'
+
+module Bolt
+  class Task
+    class Remote < Task
+      def self.from_task(task)
+        new(task.name, task.file, task.files, task.metadata)
+      end
+
+      def implementations
+        metadata['implementations']&.select { |i| i['remote'] || metadata['remote'] }
+      end
+
+      def select_implementation(target, *args)
+        unless implementations || metadata['remote']
+          raise NoImplementationError.new(target, self)
+        end
+
+        super(target, *args)
+      end
+    end
+  end
+end

data/lib/bolt/transport/base.rb

@@ -44,7 +44,12 @@ module Bolt
 
       # Returns options this transport supports
       def self.options
-        raise NotImplementedError, "self.options() must be implemented by the transport class"
+        raise NotImplementedError,
+              "self.options() or self.filter_options(unfiltered) must be implemented by the transport class"
+      end
+
+      def self.filter_options(unfiltered)
+        unfiltered.select { |k| options.include?(k) }
       end
 
       def self.validate(_options)
@@ -72,13 +77,24 @@ module Bolt
         []
       end
 
-      def filter_options(target, options)
+      def default_input_method(_executable)
+        'both'
+      end
+
+      def select_implementation(target, task)
+        impl = task.select_implementation(target, provided_features)
+        impl['input_method'] ||= default_input_method(impl['path'])
+        impl
+      end
+
+      def reject_transport_options(target, options)
         if target.options['run-as']
           options.reject { |k, _v| k == '_run_as' }
         else
           options
         end
       end
+      private :reject_transport_options
 
       # Transform a parameter map to an environment variable map, with parameter names prefixed
       # with 'PT_' and values transformed to JSON unless they're strings.
@@ -111,7 +127,7 @@ module Bolt
         target = targets.first
         with_events(target, callback) do
           @logger.debug { "Running task run '#{task}' on #{target.uri}" }
-          run_task(target, task, arguments, filter_options(target, options))
+          run_task(target, task, arguments, reject_transport_options(target, options))
         end
       end
 
@@ -125,7 +141,7 @@ module Bolt
         target = targets.first
         with_events(target, callback) do
           @logger.debug("Running command '#{command}' on #{target.uri}")
-          run_command(target, command, filter_options(target, options))
+          run_command(target, command, reject_transport_options(target, options))
         end
       end
 
@@ -139,7 +155,7 @@ module Bolt
         target = targets.first
         with_events(target, callback) do
           @logger.debug { "Running script '#{script}' on #{target.uri}" }
-          run_script(target, script, arguments, filter_options(target, options))
+          run_script(target, script, arguments, reject_transport_options(target, options))
         end
       end
 
@@ -153,7 +169,7 @@ module Bolt
         target = targets.first
         with_events(target, callback) do
           @logger.debug { "Uploading: '#{source}' to #{destination} on #{target.uri}" }
-          upload(target, source, destination, filter_options(target, options))
+          upload(target, source, destination, reject_transport_options(target, options))
         end
       end
 

data/lib/bolt/transport/docker.rb

@@ -116,6 +116,12 @@ module Bolt
           end
         end
       end
+
+      def connected?(target)
+        with_connection(target) { true }
+      rescue Bolt::Node::ConnectError
+        false
+      end
     end
   end
 end

data/lib/bolt/transport/local.rb

@@ -4,6 +4,7 @@ require 'json'
 require 'fileutils'
 require 'tmpdir'
 require 'bolt/transport/base'
+require 'bolt/transport/powershell'
 require 'bolt/util'
 
 module Bolt
@@ -14,19 +15,23 @@ module Bolt
       end
 
       def provided_features
-        ['shell']
+        if Bolt::Util.windows?
+          ['powershell']
+        else
+          ['shell']
+        end
+      end
+
+      def default_input_method(executable)
+        input_method ||= Powershell.powershell_file?(executable) ? 'powershell' : 'both'
+        input_method
       end
 
       def self.validate(_options); end
 
       def initialize
         super
-
-        if Bolt::Util.windows?
-          raise NotImplementedError, "The local transport is not yet implemented on Windows"
-        else
-          @conn = Shell.new
-        end
+        @conn = Shell.new
       end
 
       def in_tmpdir(base)
@@ -73,20 +78,32 @@ module Bolt
 
           # unpack any Sensitive data AFTER we log
           arguments = unwrap_sensitive_args(arguments)
-          if arguments.empty?
-            # We will always provide separated arguments, so work-around Open3's handling of a single
-            # argument as the entire command string for script paths containing spaces.
-            arguments = ['']
+          if Bolt::Util.windows?
+            if Powershell.powershell_file?(file)
+              command = Powershell.run_script(arguments, file)
+              output = @conn.execute(command, dir: dir, env: "powershell.exe")
+            else
+              path, args = *Powershell.process_from_extension(file)
+              args += Powershell.escape_arguments(arguments)
+              command = args.unshift(path).join(' ')
+              output = @conn.execute(command, dir: dir)
+            end
+          else
+            if arguments.empty?
+              # We will always provide separated arguments, so work-around Open3's handling of a single
+              # argument as the entire command string for script paths containing spaces.
+              arguments = ['']
+            end
+            output = @conn.execute(file, *arguments, dir: dir)
           end
-          output = @conn.execute(file, *arguments, dir: dir)
           Bolt::Result.for_command(target, output.stdout.string, output.stderr.string, output.exit_code)
         end
       end
 
       def run_task(target, task, arguments, _options = {})
-        implementation = task.select_implementation(target, provided_features)
+        implementation = select_implementation(target, task)
         executable = implementation['path']
-        input_method = implementation['input_method'] || 'both'
+        input_method = implementation['input_method']
         extra_files = implementation['files']
 
         in_tmpdir(target.options['tmpdir']) do |dir|
@@ -108,16 +125,43 @@ module Bolt
           copy_file(executable, script)
           File.chmod(0o750, script)
 
-          # unpack any Sensitive data, write it to a separate variable because
-          # we log 'arguments' below
+          # log the arguments with sensitive data redacted, do NOT log unwrapped_arguments
+          logger.debug("Running '#{script}' with #{arguments}")
           unwrapped_arguments = unwrap_sensitive_args(arguments)
+
           stdin = STDIN_METHODS.include?(input_method) ? JSON.dump(unwrapped_arguments) : nil
-          env = ENVIRONMENT_METHODS.include?(input_method) ? envify_params(unwrapped_arguments) : nil
 
-          # log the arguments with sensitive data redacted, do NOT log unwrapped_arguments
-          logger.debug("Running '#{script}' with #{arguments}")
+          if Bolt::Util.windows?
+            # WINDOWS
+            if ENVIRONMENT_METHODS.include?(input_method)
+              environment_params = envify_params(unwrapped_arguments).each_with_object([]) do |(arg, val), list|
+                list << Powershell.set_env(arg, val)
+              end
+              environment_params = environment_params.join("\n") + "\n"
+            else
+              environment_params = ""
+            end
 
-          output = @conn.execute(script, stdin: stdin, env: env, dir: dir)
+            output =
+              if Powershell.powershell_file?(script) && stdin.nil?
+                command = Powershell.run_ps_task(arguments, script, input_method)
+                command = environment_params + Powershell.shell_init + command
+                if input_method == 'powershell'
+                  @conn.execute(command, dir: dir, env: "powershell.exe")
+                else
+                  @conn.execute(command, dir: dir, stdin: stdin, env: "powershell.exe")
+                end
+              else
+                path, args = *Powershell.process_from_extension(script)
+                command = args.unshift(path).join(' ')
+                command = environment_params + Powershell.shell_init + command
+                @conn.execute(command, dir: dir, stdin: stdin, env: "powershell.exe")
+              end
+          else
+            # POSIX
+            env = ENVIRONMENT_METHODS.include?(input_method) ? envify_params(unwrapped_arguments) : nil
+            output = @conn.execute(script, stdin: stdin, env: env, dir: dir)
+          end
           Bolt::Result.for_task(target, output.stdout.string, output.stderr.string, output.exit_code)
         end
       end