Module: Kernel

Defined in:
lib/shellex.rb

Constant Summary collapse

SHELLEX_IO_BUFFER = 
32*1024
DEFAULT_TIMEOUT = 
5*60

Instance Method Summary collapse

Instance Method Details

#_shellex_debug(cmd, err, opts, out) ⇒ Object 



92
93
94
95
96
 
# File 'lib/shellex.rb', line 92

def _shellex_debug(cmd, err, opts, out)
  if defined?(Rails) and Rails.env.development?
    Rails.logger.info { "Executed: #{cmd}\n STDIN: #{opts[:input].inspect} STDOUT: #{out.inspect}\nSTDERR: #{err.inspect}" }
  end
end

#_shellex_extend_status(status) ⇒ Object 



23
24
25
26
27
28
29
30
 
# File 'lib/shellex.rb', line 23

def _shellex_extend_status(status)
  def status.command=(cmd)
    @command = cmd
  end
  def status.command
    @command
  end
end

#_shellex_retvalue(ret) ⇒ Object 



15
16
17
18
19
20
21
 
# File 'lib/shellex.rb', line 15

def _shellex_retvalue(ret)
  def ret.stdout; self[0] end
  def ret.stderr; self[1] end
  def ret.to_s; stdout end
  def ret.to_str; stdout end
  ret.freeze
end

#shellex(cmd, *args) ⇒ Object 



32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/shellex.rb', line 32

def shellex(cmd, *args)
  stdout, stderr, status = silent_shellex(cmd, *args)
  if status.success?
    ret = [stdout, stderr]
    return _shellex_retvalue(ret)
  else
    exc = ShellExecutionFailed.new("#{status.command} (exit code: #{status.exitstatus})\nOutput: #{stderr}")
    exc.output_without_command = stderr
    raise exc
  end
end

#silent_shellex(cmd, *args) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/shellex.rb', line 44

def silent_shellex(cmd, *args)
  opts = {:timeout => DEFAULT_TIMEOUT, :close_stdin => true}
  if args.last.is_a?(Hash)
    opts = opts.merge(args.pop)
  end

  cmd = cmd.with_args(*args)
  out, err, pid, status = '', '', nil, nil

  begin
    Timeout.timeout(opts[:timeout].to_i) do
      status = Open4.open4(cmd) do |pid, stdin, stdout, stderr|
        stdin.write(opts[:input]) if opts[:input]
        stdin.close if opts[:close_stdin]

        while tmp = stdout.read(SHELLEX_IO_BUFFER)
          out << tmp
        end

        while tmp = stderr.read(SHELLEX_IO_BUFFER)
          err << tmp
        end
      end
    end
  rescue Exception => e
    if pid
      Process.kill 9, pid
      Process.wait pid
    end

    # Exceptions coming from popen4 are deserialized from forked process, so they are not caught by listing
    # class name in rescue clause
    case e.class.to_s
      when /Timeout::Error/
        raise ShellExecutionTimeout, "Timeout after #{opts[:timeout]} secs while running '#{cmd}'"
      else
        raise ShellExecutionError, e.message
    end
  end

  _shellex_debug(cmd, err, opts, out)

  _shellex_extend_status(status)
  status.command = cmd

  return out, err, status
end