Выполните команду из Ruby и получите STDOUT и STDERR

Question

У меня есть исполняемый файл Ruby, который выполняет системную команду.Мне нужно следующее поведение:

1. STDOUT и STDERR из подкоманды должны отображаться в реальном времени (как если бы я выполнил подкоманду непосредственно из командной строки).
2. Непосредственно перед тем, как мой исполняемый файл заканчивается, я хотел бы получить весь контент, который был добавлен в STDOUT и STDERR, чтобы я мог его проверить.

Какой лучший способ заставить эту работу работать? В прошлом я использовал capture3 для выполнения команды и получения STDOUT / STDERR, но capture3 подавляет вывод из терминала.Раньше я использовал backticks и system, но они только позволяют мне легко получить доступ к STDOUT.

Answer 1

Вы можете наблюдать за ручками stdout и stderr, возвращаемыми Open3.popen3, и перепечатывать их, как они происходят, а также собирать.

Для вашего удобства вот полный класс Runner, который я лежал вокруг:

require 'open3'

class Runner
  attr_reader :cmd, :exit_status, :stdout, :stderr

  # Run a command, return runner instance
  # @param cmd [String,Array<String>] command to execute
  def self.run(*cmd)
    Runner.new(*cmd).run
  end

  # Run a command, raise Runner::Error if it fails
  # @param cmd [String,Array<String>] command to execute
  # @raise [Runner::Error]
  def self.run!(*cmd)
    Runner.new(*cmd).run!
  end

  # Run a command, return true if it succeeds, false if not
  # @param cmd [String,Array<String>] command to execute
  # @return [Boolean]
  def self.run?(*cmd)
    Runner.new(*cmd).run?
  end

  Error = Class.new(StandardError)

  # @param cmd [String,Array<String>] command to execute
  def initialize(cmd)
    @cmd = cmd.is_a?(Array) ? cmd.join(' ') : cmd
    @stdout = +''
    @stderr = +''
    @exit_status = nil
  end

  # @return [Boolean] success or failure?
  def success?
    exit_status.zero?
  end

  # Run the command, return self
  # @return [Runner]
  def run
    Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thr|
      until [stdout, stderr].all?(&:eof?)
        readable = IO.select([stdout, stderr])
        next unless readable&.first

        readable.first.each do |stream|
          data = +''
          # rubocop:disable Lint/HandleExceptions
          begin
            stream.read_nonblock(1024, data)
          rescue EOFError
            # ignore, it's expected for read_nonblock to raise EOFError
            # when all is read
          end

          if stream == stdout
            @stdout << data
            $stdout.write(data)
          else
            @stderr << data
            $stderr.write(data)
          end
        end
      end
      @exit_status = wait_thr.value.exitstatus
    end

    self
  end

  # Run the command and return stdout, raise if fails
  # @return stdout [String]
  # @raise [Runner::Error]
  def run!
    return run.stdout if run.success?

    raise(Error, "command failed, exit: %d - stdout: %s / stderr: %s" % [exit_status, stdout, stderr])
  end

  # Run the command and return true if success, false if failure
  # @return success [Boolean]
  def run?
    run.success?
  end
end

С этим вы можете сделать:

runner = Runner.new('ls -al')
runner.run
runner.success? # true if command was a success
runner.stdout # captured stdout
runner.stderr # captured stderr