module AwesomeSpawn

(see AwesomeSpawn::CommandLineBuilder#build)

# File lib/awesome_spawn.rb, line 109
def build_command_line(command, params = nil)
  CommandLineBuilder.new.build(command, params)
end

Execute `command` synchronously via Kernel.spawn and gather the output

stream, error stream, and exit status in a {CommandResult}.

@example With normal output

result = AwesomeSpawn.run('echo Hi')
# => #<AwesomeSpawn::CommandResult:0x007f9d1d197320 @exit_status=0>
result.output       # => "Hi\n"
result.error        # => ""
result.exit_status  # => 0

@example With error output as well

result = AwesomeSpawn.run('echo Hi; echo "Hi2" 1>&2')
# => <AwesomeSpawn::CommandResult:0x007ff64b98d930 @exit_status=0>
result.output       # => "Hi\n"
result.error        # => "Hi2\n"
result.exit_status  # => 0

@example With exit status that is not 0

result = AwesomeSpawn.run('false')
#<AwesomeSpawn::CommandResult:0x007ff64b971410 @exit_status=1>
result.exit_status  # => 1

@example With parameters sanitized

result = AwesomeSpawn.run('echo', :params => {:out => "; rm /some/file"})
# => #<AwesomeSpawn::CommandResult:0x007ff64baa6650 @exit_status=0>
result.command_line
# => "echo --out \\;\\ rm\\ /some/file"

@example With data to be passed on stdin

result = AwesomeSpawn.run('cat', :in_data => "line1\nline2")
=> #<AwesomeSpawn::CommandResult:0x007fff05b0ab10 @exit_status=0>
result.output
=> "line1\nline2"

@param [String] command The command to run @param [Hash] options The options for running the command. Also accepts any

option that can be passed to Kernel.spawn, except `:in`, `:out` and `:err`.

@option options [Hash,Array] :params The command line parameters. See

{#build_command_line} for how to specify params.

@option options [String] :in_data Data to be passed on stdin.

@raise [NoSuchFileError] if the `command` is not found @return [CommandResult] the output stream, error stream, and exit status @see ruby-doc.org/core/Kernel.html#method-i-spawn Kernel.spawn

# File lib/awesome_spawn.rb, line 63
def run(command, options = {})
  raise ArgumentError, "options cannot contain :out" if options.include?(:out)
  raise ArgumentError, "options cannot contain :err" if options.include?(:err)
  raise ArgumentError, "options cannot contain :in" if options.include?(:in)
  options = options.dup
  params  = options.delete(:params)
  if (in_data = options.delete(:in_data))
    options[:stdin_data] = in_data
  end

  output, error, status = "", "", nil
  command_line = build_command_line(command, params)

  output, error, status = launch(command_line, options)
rescue Errno::ENOENT => err
  raise NoSuchFileError.new(err.message) if NoSuchFileError.detected?(err.message)
  raise
else
  CommandResult.new(command_line, output, error, status)
end

Same as {#run}, additionally raising a {CommandResultError} if the exit

status is not 0.

@example With exit status that is not 0

error = AwesomeSpawn.run!('false') rescue $!
# => #<AwesomeSpawn::CommandResultError: false exit code: 1>
error.message # => false exit code: 1
error.result  # => #<AwesomeSpawn::CommandResult:0x007ff64ba08018 @exit_status=1>

@raise [CommandResultError] if the exit status is not 0. @return (see run)

# File lib/awesome_spawn.rb, line 95
def run!(command, options = {})
  command_result = run(command, options)

  if command_result.failure?
    message = "#{command} exit code: #{command_result.exit_status}"
    logger.error("AwesomeSpawn: #{message}")
    logger.error("AwesomeSpawn: #{command_result.error}")
    raise CommandResultError.new(message, command_result)
  end

  command_result
end