Class: Bsdkrun::Result

Inherits:

Data

• Object
• Data
• Bsdkrun::Result

Defined in:

lib/bsdkrun/types.rb

Overview

The captured result of running a command in a guest via Sandbox#exec.

Instance Attribute Summary

• #command ⇒ String readonly

  A human label for the command.

• #exit_code ⇒ Integer readonly
• #stderr ⇒ String readonly
• #stdout ⇒ String readonly

Instance Method Summary

• #json ⇒ Object

  Stdout parsed as JSON.

• #lines ⇒ Array<String>

  Non-empty stdout lines.

• #ok? ⇒ Boolean

  Whether the command succeeded (exit 0).

• #text ⇒ String

  Stdout with trailing newlines trimmed — the common case.

• #throw_if_failed! ⇒ self

Instance Attribute Details

#command ⇒ String (readonly)

Returns a human label for the command.

Returns:

• (String) —

  a human label for the command.

# File 'lib/bsdkrun/types.rb', line 346

Result = Data.define(:stdout, :stderr, :exit_code, :command) do
  # @return [Boolean] whether the command succeeded (exit 0).
  def ok?
    exit_code.zero?
  end

  # @return [String] stdout with trailing newlines trimmed — the common case.
  def text
    stdout.sub(/\n+\z/, "")
  end

  # @return [Object] stdout parsed as JSON.
  def json
    require "json"
    JSON.parse(stdout)
  end

  # @return [Array<String>] non-empty stdout lines.
  def lines
    stdout.split("\n").reject(&:empty?)
  end

  # @raise [CommandFailed] if the command exited non-zero.
  # @return [self]
  def throw_if_failed!
    unless ok?
      raise CommandFailed.new(
        exit_code: exit_code, stdout: stdout, stderr: stderr, command: command
      )
    end
    self
  end
end

#exit_code ⇒ Integer (readonly)

Returns:

• (Integer)

# File 'lib/bsdkrun/types.rb', line 346

Result = Data.define(:stdout, :stderr, :exit_code, :command) do
  # @return [Boolean] whether the command succeeded (exit 0).
  def ok?
    exit_code.zero?
  end

  # @return [String] stdout with trailing newlines trimmed — the common case.
  def text
    stdout.sub(/\n+\z/, "")
  end

  # @return [Object] stdout parsed as JSON.
  def json
    require "json"
    JSON.parse(stdout)
  end

  # @return [Array<String>] non-empty stdout lines.
  def lines
    stdout.split("\n").reject(&:empty?)
  end

  # @raise [CommandFailed] if the command exited non-zero.
  # @return [self]
  def throw_if_failed!
    unless ok?
      raise CommandFailed.new(
        exit_code: exit_code, stdout: stdout, stderr: stderr, command: command
      )
    end
    self
  end
end

#stderr ⇒ String (readonly)

Returns:

• (String)

# File 'lib/bsdkrun/types.rb', line 346

Result = Data.define(:stdout, :stderr, :exit_code, :command) do
  # @return [Boolean] whether the command succeeded (exit 0).
  def ok?
    exit_code.zero?
  end

  # @return [String] stdout with trailing newlines trimmed — the common case.
  def text
    stdout.sub(/\n+\z/, "")
  end

  # @return [Object] stdout parsed as JSON.
  def json
    require "json"
    JSON.parse(stdout)
  end

  # @return [Array<String>] non-empty stdout lines.
  def lines
    stdout.split("\n").reject(&:empty?)
  end

  # @raise [CommandFailed] if the command exited non-zero.
  # @return [self]
  def throw_if_failed!
    unless ok?
      raise CommandFailed.new(
        exit_code: exit_code, stdout: stdout, stderr: stderr, command: command
      )
    end
    self
  end
end

#stdout ⇒ String (readonly)

Returns:

• (String)

# File 'lib/bsdkrun/types.rb', line 346

Result = Data.define(:stdout, :stderr, :exit_code, :command) do
  # @return [Boolean] whether the command succeeded (exit 0).
  def ok?
    exit_code.zero?
  end

  # @return [String] stdout with trailing newlines trimmed — the common case.
  def text
    stdout.sub(/\n+\z/, "")
  end

  # @return [Object] stdout parsed as JSON.
  def json
    require "json"
    JSON.parse(stdout)
  end

  # @return [Array<String>] non-empty stdout lines.
  def lines
    stdout.split("\n").reject(&:empty?)
  end

  # @raise [CommandFailed] if the command exited non-zero.
  # @return [self]
  def throw_if_failed!
    unless ok?
      raise CommandFailed.new(
        exit_code: exit_code, stdout: stdout, stderr: stderr, command: command
      )
    end
    self
  end
end

Instance Method Details

#json ⇒ Object

Returns stdout parsed as JSON.

Returns:

• (Object) —

  stdout parsed as JSON.

# File 'lib/bsdkrun/types.rb', line 358

def json
  require "json"
  JSON.parse(stdout)
end

#lines ⇒ Array<String>

Returns non-empty stdout lines.

Returns:

• (Array<String>) —

  non-empty stdout lines.

# File 'lib/bsdkrun/types.rb', line 364

def lines
  stdout.split("\n").reject(&:empty?)
end

#ok? ⇒ Boolean

Returns whether the command succeeded (exit 0).

Returns:

• (Boolean) —

  whether the command succeeded (exit 0).

# File 'lib/bsdkrun/types.rb', line 348

def ok?
  exit_code.zero?
end

#text ⇒ String

Returns stdout with trailing newlines trimmed — the common case.

Returns:

• (String) —

  stdout with trailing newlines trimmed — the common case.

# File 'lib/bsdkrun/types.rb', line 353

def text
  stdout.sub(/\n+\z/, "")
end

#throw_if_failed! ⇒ self

Returns:

• (self)

Raises:

• (CommandFailed) —

  if the command exited non-zero.

# File 'lib/bsdkrun/types.rb', line 370

def throw_if_failed!
  unless ok?
    raise CommandFailed.new(
      exit_code: exit_code, stdout: stdout, stderr: stderr, command: command
    )
  end
  self
end