Module: RunLoop

Defined in:
lib/run_loop.rb,
lib/run_loop/app.rb,
lib/run_loop/ipa.rb,
lib/run_loop/core.rb,
lib/run_loop/fifo.rb,
lib/run_loop/l10n.rb,
lib/run_loop/lipo.rb,
lib/run_loop/lldb.rb,
lib/run_loop/cache.rb,
lib/run_loop/dnssd.rb,
lib/run_loop/otool.rb,
lib/run_loop/regex.rb,
lib/run_loop/shell.rb,
lib/run_loop/xcode.rb,
lib/run_loop/xcrun.rb,
lib/run_loop/device.rb,
lib/run_loop/locale.rb,
lib/run_loop/simctl.rb,
lib/run_loop/cli/cli.rb,
lib/run_loop/logging.rb,
lib/run_loop/strings.rb,
lib/run_loop/version.rb,
lib/run_loop/abstract.rb,
lib/run_loop/codesign.rb,
lib/run_loop/encoding.rb,
lib/run_loop/language.rb,
lib/run_loop/template.rb,
lib/run_loop/directory.rb,
lib/run_loop/cli/errors.rb,
lib/run_loop/cli/locale.rb,
lib/run_loop/cli/simctl.rb,
lib/run_loop/http/error.rb,
lib/run_loop/environment.rb,
lib/run_loop/http/server.rb,
lib/run_loop/instruments.rb,
lib/run_loop/plist_buddy.rb,
lib/run_loop/sim_control.rb,
lib/run_loop/cli/codesign.rb,
lib/run_loop/http/request.rb,
lib/run_loop/dylib_injector.rb,
lib/run_loop/process_waiter.rb,
lib/run_loop/cli/instruments.rb,
lib/run_loop/detect_aut/xcode.rb,
lib/run_loop/detect_aut/detect.rb,
lib/run_loop/detect_aut/errors.rb,
lib/run_loop/process_terminator.rb,
lib/run_loop/device_agent/client.rb,
lib/run_loop/device_agent/runner.rb,
lib/run_loop/http/retriable_client.rb,
lib/run_loop/device_agent/frameworks.rb,
lib/run_loop/device_agent/xcodebuild.rb,
lib/run_loop/detect_aut/xamarin_studio.rb,
lib/run_loop/physical_device/life_cycle.rb,
lib/run_loop/device_agent/launcher_strategy.rb,
lib/run_loop/device_agent/ios_device_manager.rb,
lib/run_loop/physical_device/ios_device_manager.rb

Defined Under Namespace

Modules: Abstract, CLI, Color, Core, DotDir, Encoding, Fifo, HTTP, Shell Classes: App, CoreSimulator, Device, Directory, Environment, IncompatibleArchitecture, Instruments, Ipa, L10N, LLDB, Lipo, PlistBuddy, ProcessTerminator, ProcessWaiter, SimControl, TimeoutError, Version, WriteFailedError, Xcode, Xcrun

Constant Summary collapse

VERSION =
"2.6.3"

Class Method Summary collapse

Class Method Details

.deprecated(version, msg) ⇒ void

This method returns an undefined value.

Prints a deprecated message that includes the line number.

Parameters:

  • version (String)

    Indicates when the feature was deprecated.

  • msg (String)

    Deprecation message (possibly suggesting alternatives)


60
61
62
63
64
65
66
67
68
# File 'lib/run_loop.rb', line 60

def self.deprecated(version, msg)

  stack = Kernel.caller(0, 6)[1..-1].join("\n")

  msg = "deprecated '#{version}' - #{msg}\n#{stack}"

  $stderr.puts "\033[34mWARN: #{msg}\033[0m"
  $stderr.flush
end

.log_debug(msg) ⇒ Object

magenta


56
57
58
59
60
# File 'lib/run_loop/logging.rb', line 56

def self.log_debug(msg)
  if RunLoop::Environment.debug?
    puts Color.magenta("DEBUG: #{msg}") if msg
  end
end

.log_error(msg) ⇒ Object

red


69
70
71
# File 'lib/run_loop/logging.rb', line 69

def self.log_error(msg)
  puts Color.red("ERROR: #{msg}") if msg
end

.log_info(*args) ⇒ Object


242
243
244
# File 'lib/run_loop.rb', line 242

def self.log_info(*args)
  RunLoop::Logging.log_info(*args)
end

.log_info2(msg) ⇒ Object

.log_info is already taken by the XTC logger. (>_O) green


64
65
66
# File 'lib/run_loop/logging.rb', line 64

def self.log_info2(msg)
  puts Color.green("INFO: #{msg}") if msg
end

.log_unix_cmd(msg) ⇒ Object

cyan


44
45
46
47
48
# File 'lib/run_loop/logging.rb', line 44

def self.log_unix_cmd(msg)
  if RunLoop::Environment.debug?
    puts Color.cyan("SHELL: #{msg}") if msg
  end
end

.log_warn(msg) ⇒ Object

blue


51
52
53
# File 'lib/run_loop/logging.rb', line 51

def self.log_warn(msg)
  puts Color.blue("WARN: #{msg}") if msg
end

.run(options = {}) ⇒ Object


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
# File 'lib/run_loop.rb', line 76

def self.run(options={})

  cloned_options = options.clone

  # We want to use the _exact_ objects that were passed.
  if options[:xcode]
    cloned_options[:xcode] = options[:xcode]
  else
    cloned_options[:xcode] = RunLoop::Xcode.new
  end

  if options[:simctl]
    cloned_options[:simctl] = options[:simctl]
  else
    cloned_options[:simctl] = RunLoop::Simctl.new
  end

  if options[:instruments]
    cloned_options[:instruments] = options[:instruments]
  else
    cloned_options[:instruments] = RunLoop::Instruments.new
  end

  # Soon to be unsupported.
  if options[:sim_control]
    cloned_options[:sim_control] = options[:sim_control]
  end

  xcode = cloned_options[:xcode]
  simctl = cloned_options[:simctl]
  instruments = cloned_options[:instruments]

  device = Device.detect_device(cloned_options, xcode, simctl, instruments)
  cloned_options[:device] = device

  automator = RunLoop.detect_automator(cloned_options, xcode, device)
  if automator == :device_agent
    RunLoop::DeviceAgent::Client.run(cloned_options)
  else
    if RunLoop::Instruments.new.instruments_app_running?
      raise %q(The Instruments.app is open.

If the Instruments.app is open, the instruments command line tool cannot take
control of your application.

Please quit the Instruments.app and try again.)

    end
    Core.run_with_options(cloned_options)
  end
end

.send_command(run_loop, cmd, options = {timeout: 60}, num_retries = 0, last_error = nil) ⇒ Object


128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
# File 'lib/run_loop.rb', line 128

def self.send_command(run_loop, cmd, options={timeout: 60}, num_retries=0, last_error=nil)
  if num_retries > 3
    if last_error
      raise last_error
    else
      raise "Max retries exceeded #{num_retries} > 3. No error recorded."
    end
  end

  if options.is_a?(Numeric)
    options = {timeout: options}
  end

  if not cmd.is_a?(String)
    raise "Illegal command #{cmd} (must be a string)"
  end

  if not options.is_a?(Hash)
    raise "Illegal options #{options} (must be a Hash (or number for compatibility))"
  end

  timeout = options[:timeout] || 60
  logger = options[:logger]
  interrupt_retry_timeout = options[:interrupt_retry_timeout] || 25

  expected_index = run_loop[:index]
  result = nil
  begin
    expected_index = Core.write_request(run_loop, cmd, logger)
  rescue RunLoop::WriteFailedError, Errno::EINTR => write_error
    # Attempt recover from interrupt by attempting to read result (assuming write went OK)
    # or retry if attempted read result fails
    run_loop[:index] = expected_index # restore expected index in case it changed
    log_info(logger, "Core.write_request failed: #{write_error}. Attempting recovery...")
    log_info(logger, "Attempting read in case the request was received... Please wait (#{interrupt_retry_timeout})...")
    begin
      Timeout::timeout(interrupt_retry_timeout, TimeoutError) do
        result = Core.read_response(run_loop, expected_index)
      end
      # Update run_loop expected index since we succeeded in reading the index
      run_loop[:index] = expected_index + 1
      log_info(logger, "Did read response for interrupted request of index #{expected_index}... Proceeding.")
      return result
    rescue TimeoutError => _
      log_info(logger, "Read did not result in a response for index #{expected_index}... Retrying send_command...")
      return send_command(run_loop, cmd, options, num_retries+1, write_error)
    end
  end


  begin
    Timeout::timeout(timeout, TimeoutError) do
      result = Core.read_response(run_loop, expected_index)
    end
  rescue TimeoutError => _
    raise TimeoutError, "Time out waiting for UIAutomation run-loop for command #{cmd}. Waiting for index:#{expected_index}"
  end

  result
end

.stop(run_loop, out = Dir.pwd) ⇒ Object


189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'lib/run_loop.rb', line 189

def self.stop(run_loop, out=Dir.pwd)
  return if run_loop.nil?
  results_dir = run_loop[:results_dir]
  dest = out

  RunLoop::Instruments.new.kill_instruments

  FileUtils.mkdir_p(dest)
  if results_dir
    pngs = Dir.glob(File.join(results_dir, 'Run 1', '*.png'))
  else
    pngs = []
  end
  FileUtils.cp(pngs, dest) if pngs and pngs.length > 0
end