Module: RunLoop::Shell

Includes:
Encoding
Included in:
CLI::IDM, CoreSimulator, Device, PlistBuddy, ProcessWaiter, Xcode
Defined in:
lib/run_loop/shell.rb

Defined Under Namespace

Classes: Error, TimeoutError

Constant Summary collapse

DEFAULT_OPTIONS =

Controls the behavior of Shell#run_shell_command.

You can override these values if they do not work in your environment.

For cucumber users, the best place to override would be in your features/support/env.rb.

For example:

RunLoop::Shell::DEFAULT_OPTIONS = 60

{
  :timeout => 30,
  :log_cmd => false
}

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Encoding

#transliterate

Class Method Details

.run_shell_command(args, options = {}) ⇒ Object 



29
30
31
32
33
34
35
36
37
 
# File 'lib/run_loop/shell.rb', line 29

def self.run_shell_command(args, options={})
  shell = Class.new do
    include RunLoop::Shell
    def to_s; "#<Anonymous Shell>"; end
    def inspect; to_s; end
  end.new

  shell.run_shell_command(args, options)
end

Instance Method Details

#run_shell_command(args, options = {}) ⇒ Object 



39
40
41
42
43
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/run_loop/shell.rb', line 39

def run_shell_command(args, options={})

  merged_options = DEFAULT_OPTIONS.merge(options)

  timeout = merged_options[:timeout]

  unless args.is_a?(Array)
    raise ArgumentError,
          "Expected args '#{args}' to be an Array, but found '#{args.class}'"
  end

  args.each do |arg|
    unless arg.is_a?(String)
      raise ArgumentError,
%Q{Expected arg '#{arg}' to be a String, but found '#{arg.class}'
IO.popen requires all arguments to be Strings.
}
    end
  end

  cmd = "#{args.join(' ')}"

  # Don't see your log?
  # Commands are only logged when debugging.
  RunLoop.log_unix_cmd(cmd) if merged_options[:log_cmd]

  hash = {}
  shell_start_time = Time.now

  environment = options.fetch(:environment, {})

  begin
    command_output = CommandRunner.run(args,
                                       timeout: timeout,
                                       environment: environment)

    out = ensure_command_output_utf8(command_output[:out], cmd)
    process_status = command_output[:status]

    hash =
          {
                :out => out,
                :pid => process_status.pid,
                # nil if process was killed before completion
                :exit_status => process_status.exitstatus
          }

  rescue RunLoop::Encoding::UTF8Error => e
    raise e
  rescue => e
    elapsed = "%0.2f" % (Time.now - shell_start_time)
    raise Error,
%Q{Encountered an error after #{elapsed} seconds:

#{e.message}

executing this command:

#{cmd}
}
  ensure
    hash[:seconds_elapsed] = Time.now - shell_start_time
  end

  if hash[:exit_status].nil?
    elapsed = "%0.2f" % (hash[:seconds_elapsed])

    if timeout_exceeded?(shell_start_time, timeout)
      raise TimeoutError,
%Q[
Timed out after #{elapsed} seconds executing

#{cmd}

with a timeout of #{timeout}
]
    else
      raise Error,
            %Q[
There was an error executing:

#{cmd}

The command generated this output:

#{hash[:out]}
]

    end
  end
  hash
end