bolt 3.1.0 → 3.6.1

data/lib/bolt/task.rb

@@ -148,7 +148,7 @@ module Bolt
 
       if unknown_keys.any?
         msg = "Metadata for task '#{@name}' contains unknown keys: #{unknown_keys.join(', ')}."
-        msg += " This could be a typo in the task metadata or may result in incorrect behavior."
+        msg += " This could be a typo in the task metadata or might result in incorrect behavior."
         Bolt::Logger.warn("unknown_task_metadata_keys", msg)
       end
     end

data/lib/bolt/transport/docker.rb

@@ -2,7 +2,7 @@
 
 require 'json'
 require 'shellwords'
-require 'bolt/transport/base'
+require 'bolt/transport/simple'
 
 module Bolt
   module Transport

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

@@ -34,6 +34,15 @@ module Bolt
           @container_info["Id"]
         end
 
+        def run_cmd(cmd, env_vars)
+          Bolt::Util.exec_docker(cmd, env_vars)
+        end
+
+        private def env_hash
+          # Set the DOCKER_HOST if we are using a non-default service-url
+          @docker_host.nil? ? {} : { 'DOCKER_HOST' => @docker_host }
+        end
+
         def connect
           # We don't actually have a connection, but we do need to
           # check that the container exists and is running.
@@ -54,10 +63,7 @@ module Bolt
         end
 
         def add_env_vars(env_vars)
-          @env_vars = env_vars.each_with_object([]) do |env_var, acc|
-            acc << "--env"
-            acc << "#{env_var[0]}=#{env_var[1]}"
-          end
+          @env_vars = Bolt::Util.format_env_vars_for_cli(env_vars)
         end
 
         # Executes a command inside the target container. This is called from the shell class.
@@ -88,9 +94,9 @@ module Bolt
 
         def upload_file(source, destination)
           @logger.trace { "Uploading #{source} to #{destination}" }
-          _stdout, stderr, status = execute_local_command('cp', [source, "#{container_id}:#{destination}"])
-          unless status.exitstatus.zero?
-            raise "Error writing to container #{container_id}: #{stderr}"
+          _out, err, stat = run_cmd(['cp', source, "#{container_id}:#{destination}"], env_hash)
+          unless stat.exitstatus.zero?
+            raise "Error writing to container #{container_id}: #{err}"
           end
         rescue StandardError => e
           raise Bolt::Node::FileError.new(e.message, 'WRITE_ERROR')
@@ -102,31 +108,14 @@ module Bolt
           # copy the *contents* of the directory.
           # https://docs.docker.com/engine/reference/commandline/cp/
           FileUtils.mkdir_p(destination)
-          _stdout, stderr, status = execute_local_command('cp', ["#{container_id}:#{source}", destination])
-          unless status.exitstatus.zero?
-            raise "Error downloading content from container #{container_id}: #{stderr}"
+          _out, err, stat = run_cmd(['cp', "#{container_id}:#{source}", destination], env_hash)
+          unless stat.exitstatus.zero?
+            raise "Error downloading content from container #{container_id}: #{err}"
           end
         rescue StandardError => e
           raise Bolt::Node::FileError.new(e.message, 'WRITE_ERROR')
         end
 
-        # Executes a Docker CLI command. This is useful for running commands as
-        # part of this class without having to go through the `execute`
-        # function and manage pipes.
-        #
-        # @param subcommand [String] The docker subcommand to run
-        #   e.g. 'inspect' for `docker inspect`
-        # @param arguments [Array] Arguments to pass to the docker command
-        #   e.g. 'src' and 'dest' for `docker cp <src> <dest>
-        # @return [String, String, Process::Status] The output of the command: STDOUT, STDERR, Process Status
-        private def execute_local_command(subcommand, arguments = [])
-          # Set the DOCKER_HOST if we are using a non-default service-url
-          env_hash = @docker_host.nil? ? {} : { 'DOCKER_HOST' => @docker_host }
-          docker_command = [subcommand].concat(arguments)
-
-          Open3.capture3(env_hash, 'docker', *docker_command, { binmode: true })
-        end
-
         # Executes a Docker CLI command and parses the output in JSON format
         #
         # @param subcommand [String] The docker subcommand to run
@@ -134,15 +123,15 @@ module Bolt
         # @param arguments [Array] Arguments to pass to the docker command
         #   e.g. 'src' and 'dest' for `docker cp <src> <dest>
         # @return [Object] Ruby object representation of the JSON string
-        private def execute_local_json_command(subcommand, arguments = [])
-          command_options = ['--format', '{{json .}}'].concat(arguments)
-          stdout, _stderr, _status = execute_local_command(subcommand, command_options)
-          extract_json(stdout)
+        def execute_local_json_command(subcommand, arguments = [])
+          cmd = [subcommand, '--format', '{{json .}}'].concat(arguments)
+          out, _err, _stat = run_cmd(cmd, env_hash)
+          extract_json(out)
         end
 
         # Converts the JSON encoded STDOUT string from the docker cli into ruby objects
         #
-        # @param stdout_string [String] The string to convert
+        # @param stdout [String] The string to convert
         # @return [Object] Ruby object representation of the JSON string
         private def extract_json(stdout)
           # The output from the docker format command is a JSON string per line.

data/lib/bolt/transport/lxd.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'bolt/logger'
+require 'bolt/node/errors'
+require 'bolt/transport/simple'
+
+module Bolt
+  module Transport
+    class LXD < Simple
+      def provided_features
+        ['shell']
+      end
+
+      def with_connection(target, options = {})
+        Bolt::Logger.warn_once("lxd_experimental",
+                               "The LXD transport is experimental, and might "\
+                               "include breaking changes between minor versions.")
+        conn = Connection.new(target, options)
+        conn.connect
+        yield conn
+      end
+    end
+  end
+end
+
+require 'bolt/transport/lxd/connection'

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

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require 'logging'
+require 'bolt/node/errors'
+
+module Bolt
+  module Transport
+    class LXD < Simple
+      class Connection
+        attr_reader :user, :target
+
+        def initialize(target, options)
+          raise Bolt::ValidationError, "Target #{target.safe_name} does not have a host" unless target.host
+
+          @target = target
+          @user = ENV['USER'] || Etc.getlogin
+          @options = options
+          @logger = Bolt::Logger.logger(target.safe_name)
+          @logger.trace("Initializing LXD connection to #{target.safe_name}")
+        end
+
+        def shell
+          Bolt::Shell::Bash.new(target, self)
+        end
+
+        def container_id
+          "#{@target.transport_config['remote']}:#{@target.host}"
+        end
+
+        def connect
+          out, err, status = execute_local_command(%W[list #{container_id} --format json])
+          unless status.exitstatus.zero?
+            raise "Error listing available containers: #{err}"
+          end
+          containers = JSON.parse(out)
+          if containers.empty?
+            raise "Could not find a container with name or ID matching '#{container_id}'"
+          end
+          @logger.trace("Opened session")
+          true
+        rescue StandardError => e
+          raise Bolt::Node::ConnectError.new(
+            "Failed to connect to #{container_id}: #{e.message}",
+            'CONNECT_ERROR'
+          )
+        end
+
+        def add_env_vars(env_vars)
+          @env_vars = env_vars.each_with_object([]) do |env_var, acc|
+            acc << "--env"
+            acc << "#{env_var[0]}=#{Shellwords.shellescape(env_var[1])}"
+          end
+        end
+
+        def execute(command)
+          lxc_command = %w[lxc exec]
+          lxc_command += @env_vars if @env_vars
+          lxc_command += %W[#{container_id} -- sh -c #{Shellwords.shellescape(command)}]
+
+          @logger.trace { "Executing: #{lxc_command.join(' ')}" }
+          Open3.popen3(lxc_command.join(' '))
+        end
+
+        private def execute_local_command(command)
+          Open3.capture3('lxc', *command, { binmode: true })
+        end
+
+        def upload_file(source, destination)
+          @logger.trace { "Uploading #{source} to #{destination}" }
+          args = %w[--create-dirs]
+          if File.directory?(source)
+            args << '--recursive'
+            # If we don't do this, LXD will upload to
+            # /tmp/d2020-11/d2020-11/dir instead of /tmp/d2020-11/dir
+            destination = Pathname.new(destination).dirname.to_s
+          end
+          cmd = %w[file push] + args + %W[#{source} #{container_id}#{destination}]
+          _out, err, stat = execute_local_command(cmd)
+          unless stat.exitstatus.zero?
+            raise "Error writing to #{container_id}: #{err}"
+          end
+        rescue StandardError => e
+          raise Bolt::Node::FileError.new(e.message, 'WRITE_ERROR')
+        end
+
+        def download_file(source, destination, _download)
+          @logger.trace { "Downloading #{source} to #{destination}" }
+          FileUtils.mkdir_p(destination)
+          _out, err, stat = execute_local_command(%W[file pull --recursive #{container_id}#{source} #{destination}])
+          unless stat.exitstatus.zero?
+            raise "Error downloading content from container #{container_id}: #{err}"
+          end
+        rescue StandardError => e
+          raise Bolt::Node::FileError.new(e.message, 'WRITE_ERROR')
+        end
+      end
+    end
+  end
+end

data/lib/bolt/transport/orch.rb

@@ -59,6 +59,18 @@ module Bolt
           # the result otherwise make sure an error is generated
           if state == 'finished' || (result && result['_error'])
             if result['_error']
+              unless result['_error'].is_a?(Hash)
+                result['_error'] = { 'kind' => 'puppetlabs.tasks/task-error',
+                                     'issue_code' => 'TASK_ERROR',
+                                     'msg' => result['_error'],
+                                     'details' => {} }
+              end
+
+              result['_error']['details'] ||= {}
+              unless result['_error']['details'].is_a?(Hash)
+                deets = result['_error']['details']
+                result['_error']['details'] = { 'msg' => deets }
+              end
               file_line = %w[file line].zip(position).to_h.compact
               result['_error']['details'].merge!(file_line) unless result['_error']['details']['file']
             end
@@ -252,11 +264,7 @@ module Bolt
 
         # If we get here, there's no error so we don't need the file or line
         # number
-        Bolt::Result.for_command(target,
-                                 result.value['stdout'],
-                                 result.value['stderr'],
-                                 result.value['exit_code'],
-                                 action, obj, [])
+        Bolt::Result.for_command(target, result.value, action, obj, [])
       end
     end
   end

data/lib/bolt/transport/podman.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'shellwords'
+require 'bolt/transport/base'
+
+module Bolt
+  module Transport
+    class Podman < Docker
+      def with_connection(target)
+        conn = Connection.new(target)
+        conn.connect
+        yield conn
+      end
+    end
+  end
+end
+
+require 'bolt/transport/podman/connection'

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

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'logging'
+require 'bolt/node/errors'
+
+module Bolt
+  module Transport
+    class Podman < Docker
+      class Connection < Connection
+        attr_reader :user, :target
+
+        def initialize(target)
+          raise Bolt::ValidationError, "Target #{target.safe_name} does not have a host" unless target.host
+          @target = target
+          @user = ENV['USER'] || Etc.getlogin
+          @logger = Bolt::Logger.logger(target.safe_name)
+          @container_info = {}
+          @logger.trace("Initializing podman connection to #{target.safe_name}")
+        end
+
+        def run_cmd(cmd, env_vars)
+          Bolt::Util.exec_podman(cmd, env_vars)
+        end
+
+        def shell
+          @shell ||= if Bolt::Util.windows?
+                       Bolt::Shell::Powershell.new(target, self)
+                     else
+                       Bolt::Shell::Bash.new(target, self)
+                     end
+        end
+
+        def connect
+          # We don't actually have a connection, but we do need to
+          # check that the container exists and is running.
+          ps = execute_local_json_command('ps')
+          container = Array(ps).find { |item|
+            item["ID"].to_s.eql?(@target.host) ||
+              item["Id"].to_s.start_with?(@target.host) ||
+              Array(item["Names"]).include?(@target.host)
+          }
+          raise "Could not find a container with name or ID matching '#{@target.host}'" if container.nil?
+          # Now find the indepth container information
+          id = container["ID"] || container["Id"]
+          output = execute_local_json_command('inspect', [id])
+          # Store the container information for later
+          @container_info = output.first
+          @logger.trace { "Opened session" }
+          true
+        rescue StandardError => e
+          raise Bolt::Node::ConnectError.new(
+            "Failed to connect to #{target.safe_name}: #{e.message}",
+            'CONNECT_ERROR'
+          )
+        end
+
+        # Executes a command inside the target container. This is called from the shell class.
+        #
+        # @param command [string] The command to run
+        def execute(command)
+          args = []
+          args += %w[--interactive]
+          args += %w[--tty] if target.options['tty']
+          args += @env_vars if @env_vars
+
+          if target.options['shell-command'] && !target.options['shell-command'].empty?
+            # escape any double quotes in command
+            command = command.gsub('"', '\"')
+            command = "#{target.options['shell-command']} \"#{command}\""
+          end
+
+          podman_command = %w[podman exec] + args + [container_id] + Shellwords.split(command)
+          @logger.trace { "Executing: #{podman_command.join(' ')}" }
+
+          Open3.popen3(*podman_command)
+        rescue StandardError
+          @logger.trace { "Command aborted" }
+          raise
+        end
+
+        # Converts the JSON encoded STDOUT string from the podman cli into ruby objects
+        #
+        # @param stdout [String] The string to convert
+        # @return [Object] Ruby object representation of the JSON string
+        private def extract_json(stdout)
+          # Podman renders the output in pretty JSON, which results in a newline
+          # appearing in the output before the closing bracket.
+          # should we only get a single line with no newline at all, we also
+          # assume it is a single minified JSON object
+          stdout.strip!
+          newline = stdout.index("\n") || -1
+          bracket = stdout.index('}') || -1
+          JSON.parse(stdout) if bracket > newline
+        end
+      end
+    end
+  end
+end

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

@@ -230,7 +230,7 @@ module Bolt
           end
           [in_wr, out_rd, err_rd, th]
         rescue Errno::EMFILE => e
-          msg = "#{e.message}. This may be resolved by increasing your user limit "\
+          msg = "#{e.message}. This might be resolved by increasing your user limit "\
             "with 'ulimit -n 1024'. See https://puppet.com/docs/bolt/latest/bolt_known_issues.html for details."
           raise Bolt::Error.new(msg, 'bolt/too-many-files')
         end

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

@@ -130,7 +130,7 @@ module Bolt
 
           [inp, out_rd, err_rd, th]
         rescue Errno::EMFILE => e
-          msg = "#{e.message}. This may be resolved by increasing your user limit "\
+          msg = "#{e.message}. This might be resolved by increasing your user limit "\
             "with 'ulimit -n 1024'. See https://puppet.com/docs/bolt/latest/bolt_known_issues.html for details."
           raise Bolt::Error.new(msg, 'bolt/too-many-files')
         rescue StandardError

data/lib/bolt/util.rb

@@ -77,6 +77,14 @@ module Bolt
         File.exist?(path) ? read_yaml_hash(path, file_name) : {}
       end
 
+      def first_runs_free
+        Bolt::Config.user_path + '.first_runs_free'
+      end
+
+      def first_run?
+        Bolt::Config.user_path && !File.exist?(first_runs_free)
+      end
+
       # Accepts a path with either 'plans' or 'tasks' in it and determines
       # the name of the module
       def module_name(path)
@@ -324,6 +332,40 @@ module Bolt
         end
       end
 
+      # Executes a Docker CLI command. This is useful for running commands as
+      # part of this class without having to go through the `execute`
+      # function and manage pipes.
+      #
+      # @param cmd [String] The docker command and arguments to run
+      #   e.g. 'cp <src> <dest>' for `docker cp <src> <dest>`
+      # @return [String, String, Process::Status] The output of the command: STDOUT, STDERR, Process Status
+      def exec_docker(cmd, env = {})
+        Open3.capture3(env, 'docker', *cmd, { binmode: true })
+      end
+
+      # Executes a Podman CLI command. This is useful for running commands as
+      # part of this class without having to go through the `execute`
+      # function and manage pipes.
+      #
+      # @param cmd [String] The podman command and arguments to run
+      #   e.g. 'cp <src> <dest>' for `podman cp <src> <dest>`
+      # @return [String, String, Process::Status] The output of the command: STDOUT, STDERR, Process Status
+      def exec_podman(cmd, env = {})
+        Open3.capture3(env, 'podman', *cmd, { binmode: true })
+      end
+
+      # Formats a map of environment variables to be passed to a command that
+      # accepts repeated `--env` flags
+      #
+      # @param env_vars [Hash] A map of environment variables keys and their values
+      # @return [String]
+      def format_env_vars_for_cli(env_vars)
+        @env_vars = env_vars.each_with_object([]) do |(key, value), acc|
+          acc << "--env"
+          acc << "#{key}=#{value}"
+        end
+      end
+
       def unix_basename(path)
         raise Bolt::ValidationError, "path must be a String, received #{path.class} #{path}" unless path.is_a?(String)
         path.split('/').last