Module: RunLoop::Core

Defined in:
lib/run_loop/core.rb

Constant Summary collapse

START_DELIMITER = 
"OUTPUT_JSON:\n"
END_DELIMITER = 
"\nEND_OUTPUT"
SCRIPTS = 
{
  :dismiss => 'run_dismiss_location.js',
  :run_loop_host => 'run_loop_host.js',
  :run_loop_fast_uia => 'run_loop_fast_uia.js',
  :run_loop_shared_element => 'run_loop_shared_element.js',
  :run_loop_basic => 'run_loop_basic.js'
}
SCRIPTS_PATH = 
File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'scripts'))
READ_SCRIPT_PATH = 
File.join(SCRIPTS_PATH, 'read-cmd.sh')
TIMEOUT_SCRIPT_PATH = 
File.join(SCRIPTS_PATH, 'timeout3')

Class Method Summary collapse

Class Method Details

.above_or_eql_version?(target_version, xcode_version) ⇒ Boolean

Deprecated.

since 1.0.0

still used extensively in calabash-ios launcher

Returns:

  • (Boolean) 


620
621
622
623
624
625
626
627
628
629
630
631
632
633
 
# File 'lib/run_loop/core.rb', line 620

def self.above_or_eql_version?(target_version, xcode_version)
  if target_version.is_a?(RunLoop::Version)
    target = target_version
  else
    target = RunLoop::Version.new(target_version)
  end

  if xcode_version.is_a?(RunLoop::Version)
    xcode = xcode_version
  else
    xcode = RunLoop::Version.new(xcode_version)
  end
  target >= xcode
end

.automation_template(instruments, candidate = RunLoop::Environment.trace_template) ⇒ Object 



481
482
483
484
485
486
 
# File 'lib/run_loop/core.rb', line 481

def self.automation_template(instruments, candidate=RunLoop::Environment.trace_template)
  unless candidate && File.exist?(candidate)
    candidate = default_tracetemplate(instruments)
  end
  candidate
end

.create_uia_pipe(repl_path) ⇒ Object 



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/run_loop/core.rb', line 318

def self.create_uia_pipe(repl_path)
  begin
    Timeout::timeout(5, RunLoop::TimeoutError) do
      loop do
        begin
          FileUtils.rm_f(repl_path)
          return repl_path if system(%Q[mkfifo "#{repl_path}"])
        rescue Errno::EINTR => _
          sleep(0.1)
        end
      end
    end
  rescue RunLoop::TimeoutError => _
    raise RunLoop::TimeoutError, 'Unable to create pipe (mkfifo failed)'
  end
end

.default_simulator(xcode = RunLoop::Xcode.new) ⇒ Object

Returns the a default simulator to target. This default needs to be one that installed by default in the current Xcode version.

For historical reasons, the most recent non-64b SDK should be used.

Parameters:

  • xcode (RunLoop::Xcode) (defaults to: RunLoop::Xcode.new) —

    Used to detect the current xcode version.



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/run_loop/core.rb', line 294

def self.default_simulator(xcode=RunLoop::Xcode.new)

  if xcode.version_gte_73?
    "iPhone 6s (9.3)"
  elsif xcode.version_gte_72?
    "iPhone 6s (9.2)"
  elsif xcode.version_gte_71?
    "iPhone 6s (9.1)"
  elsif xcode.version_gte_7?
    "iPhone 5s (9.0)"
  elsif xcode.version_gte_64?
    "iPhone 5s (8.4 Simulator)"
  elsif xcode.version_gte_63?
    "iPhone 5s (8.3 Simulator)"
  elsif xcode.version_gte_62?
    "iPhone 5s (8.2 Simulator)"
  elsif xcode.version_gte_61?
    "iPhone 5s (8.1 Simulator)"
  else
    "iPhone 5s (8.0 Simulator)"
  end
end

.default_tracetemplate(instruments = RunLoop::Instruments.new) ⇒ Object 



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
 
# File 'lib/run_loop/core.rb', line 488

def self.default_tracetemplate(instruments=RunLoop::Instruments.new)

  templates = instruments.templates

  # xcrun instruments -s templates
  # Xcode >= 6 will return known, Apple defined tracetemplates as names
  #  e.g.  Automation, Zombies, Allocations
  #
  # Xcode < 6 will return known, Apple defined tracetemplates as paths.
  #
  # Xcode 6 Beta versions also return paths, but revert to 'normal'
  # behavior when GM is released.
  #
  # Xcode 7 Beta versions appear to behavior like Xcode 6 Beta versions.
  template = templates.find { |name| name == 'Automation' }
  return template if template

  candidate = templates.find do |path|
    path =~ /\/Automation.tracetemplate/ and path =~ /Xcode/
  end

  if !candidate.nil?
    return candidate.tr("\"", '').strip
  end

  message = ['Expected instruments to report an Automation tracetemplate.',
             'Please report this as bug:  https://github.com/calabash/run_loop/issues',
             "In the bug report, include the output of:\n",
             '$ xcrun xcodebuild -version',
             "$ xcrun instruments -s templates\n"]
  raise message.join("\n")
end

.detect_connected_device ⇒ Object

Deprecated.

2.1.0

Replaced with Device.detect_physical_device_on_usb



523
524
525
526
527
528
529
530
531
532
 
# File 'lib/run_loop/core.rb', line 523

def self.detect_connected_device
  begin
    Timeout::timeout(1, RunLoop::TimeoutError) do
      return `#{File.join(SCRIPTS_PATH, 'udidetect')}`.chomp
    end
  rescue RunLoop::TimeoutError => _
    `killall udidetect &> /dev/null`
  end
  nil
end

.dylib_path_from_options(options) ⇒ String?

Extracts the value of :inject_dylib from options Hash.

Parameters:

Returns:

  • (String, nil) —

    If the options contains :inject_dylibs and it is a path to a dylib that exists, return the path. Otherwise return nil or raise an error.

Raises:

  • (RuntimeError) —

    If :inject_dylib points to a path that does not exist.

  • (ArgumentError) —

    If :inject_dylib is not a String.



274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/run_loop/core.rb', line 274

def self.dylib_path_from_options(options)
  inject_dylib = options.fetch(:inject_dylib, nil)
  return nil if inject_dylib.nil?
  unless inject_dylib.is_a? String
    raise ArgumentError, "Expected :inject_dylib to be a path to a dylib, but found '#{inject_dylib}'"
  end
  dylib_path = File.expand_path(inject_dylib)
  unless File.exist?(dylib_path)
    raise "Cannot load dylib.  The file '#{dylib_path}' does not exist."
  end
  dylib_path
end

.ensure_instruments_not_running! ⇒ Object

Deprecated.

1.0.5



600
601
602
 
# File 'lib/run_loop/core.rb', line 600

def self.ensure_instruments_not_running!
  RunLoop::Instruments.new.kill_instruments
end

.escape_host_command(cmd) ⇒ Object 



378
379
380
381
 
# File 'lib/run_loop/core.rb', line 378

def self.escape_host_command(cmd)
  backquote = "\\"
  cmd.gsub(backquote,backquote*4)
end

.instruments_pids ⇒ Object

Deprecated.

1.0.5



609
610
611
 
# File 'lib/run_loop/core.rb', line 609

def self.instruments_pids
  RunLoop::Instruments.new.instruments_pids
end

.instruments_running? ⇒ Boolean

Returns:

  • (Boolean) 


604
605
606
 
# File 'lib/run_loop/core.rb', line 604

def self.instruments_running?
  RunLoop::Instruments.new.instruments_running?
end

.jruby? ⇒ Boolean

Returns:

  • (Boolean) 


335
336
337
 
# File 'lib/run_loop/core.rb', line 335

def self.jruby?
  RUBY_PLATFORM == 'java'
end

.log_instruments_error(msg) ⇒ Object 



383
384
385
386
 
# File 'lib/run_loop/core.rb', line 383

def self.log_instruments_error(msg)
  $stderr.puts "\033[31m\n\n*** #{msg} ***\n\n\033[0m"
  $stderr.flush
end

.log_run_loop_options(options, xcode) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/run_loop/core.rb', line 30

def self.log_run_loop_options(options, xcode)
  return unless RunLoop::Environment.debug?
  # Ignore :sim_control b/c it is a ruby object; printing is not useful.
  ignored_keys = [:sim_control]
  options_to_log = {}
  options.each_pair do |key, value|
    next if ignored_keys.include?(key)
    options_to_log[key] = value
  end
  # Objects that override '==' cannot be printed by awesome_print
  # https://github.com/michaeldv/awesome_print/issues/154
  # RunLoop::Version overrides '=='
  options_to_log[:xcode] = xcode.version.to_s
  options_to_log[:xcode_path] = xcode.developer_dir
  message = options_to_log.ai({:sort_keys => true})
  logger = options[:logger]
  RunLoop::Logging.log_debug(logger, "\n" + message)
end

.pids_for_run_loop(run_loop, &block) ⇒ Object

Deprecated.

1.0.5



636
637
638
 
# File 'lib/run_loop/core.rb', line 636

def self.pids_for_run_loop(run_loop, &block)
  RunLoop::Instruments.new.instruments_pids(&block)
end

.read_response(run_loop, expected_index, empty_file_timeout = 10, search_for_property = 'index') ⇒ Object 



388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/run_loop/core.rb', line 388

def self.read_response(run_loop, expected_index, empty_file_timeout=10, search_for_property='index')
  debug_read = RunLoop::Environment.debug_read?

  log_file = run_loop[:log_file]
  initial_offset = run_loop[:initial_offset] || 0
  offset = initial_offset

  result = nil
  loop do
    unless File.exist?(log_file) && File.size?(log_file)
      sleep(0.2)
      next
    end

    size = File.size(log_file)
    output = File.read(log_file, size-offset, offset)

    if /AXError: Could not auto-register for pid status change/.match(output)
      if /kAXErrorServerNotFound/.match(output)
        self.log_instruments_error('Accessibility is not enabled on device/simulator, please enable it.')
      end
      raise RunLoop::TimeoutError.new('AXError: Could not auto-register for pid status change')
    end

    if /Automation Instrument ran into an exception/.match(output)
      raise RunLoop::TimeoutError.new('Exception while running script')
    end

    if /FBSOpenApplicationErrorDomain error/.match(output)
      msg = "Instruments failed to launch app: 'FBSOpenApplicationErrorDomain error 8"
      if RunLoop::Environment.debug?
        self.log_instruments_error(msg)
      end
      raise RunLoop::TimeoutError.new(msg)
    end

    if /Error: Script threw an uncaught JavaScript error: unknown JavaScript exception/.match(output)
      msg = "Instruments failed to launch: because of an unknown JavaScript exception"
      if RunLoop::Environment.debug?
        self.log_instruments_error(msg)
      end
      raise RunLoop::TimeoutError.new(msg)
    end

    index_if_found = output.index(START_DELIMITER)
    if debug_read
      puts output.gsub('*', '')
      puts "Size #{size}"
      puts "offset #{offset}"
      puts "index_of #{START_DELIMITER}: #{index_if_found}"
    end

    if index_if_found

      offset = offset + index_if_found
      rest = output[index_if_found+START_DELIMITER.size..output.length]
      index_of_json = rest.index("}#{END_DELIMITER}")

      if index_of_json.nil?
        #Wait for rest of json
        sleep(0.1)
        next
      end

      json = rest[0..index_of_json]


      if debug_read
        puts "Index #{index_if_found}, Size: #{size} Offset #{offset}"

        puts ("parse #{json}")
      end

      offset = offset + json.size
      parsed_result = JSON.parse(json)
      if debug_read
        p parsed_result
      end
      json_index_if_present = parsed_result[search_for_property]
      if json_index_if_present && json_index_if_present == expected_index
        result = parsed_result
        break
      end
    else
      sleep(0.1)
    end
  end

  run_loop[:initial_offset] = offset
  RunLoop::HostCache.default.write(run_loop) unless RunLoop::Environment.xtc?
  result
end

.run_with_options(options) ⇒ Object 



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
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/run_loop/core.rb', line 56

def self.run_with_options(options)
  before = Time.now

  self.prepare(options)

  logger = options[:logger]
  simctl = options[:sim_control] || options[:simctl] || RunLoop::Simctl.new
  xcode = options[:xcode] || RunLoop::Xcode.new
  instruments = options[:instruments] || RunLoop::Instruments.new

  # Device under test: DUT
  device = RunLoop::Device.detect_device(options, xcode, simctl, instruments)

  # App under test: AUT
  app_details = RunLoop::DetectAUT.detect_app_under_test(options)

  # Find the script to pass to instruments and the strategy to communicate
  # with UIAutomation.
  script_n_strategy = self.detect_instruments_script_and_strategy(options,
                                                                  device,
                                                                  xcode)
  instruments_script = script_n_strategy[:script]
  uia_strategy = script_n_strategy[:strategy]

  # The app life cycle reset options.
  reset_options = self.detect_reset_options(options)

  instruments.kill_instruments(xcode)

  timeout = options[:timeout] || 30

  results_dir = options[:results_dir] || RunLoop::DotDir.make_results_dir
  results_dir_trace = File.join(results_dir, 'trace')
  FileUtils.mkdir_p(results_dir_trace)

  dependencies = options[:dependencies] || []
  dependencies << File.join(SCRIPTS_PATH, 'calabash_script_uia.js')
  dependencies.each do |dep|
    FileUtils.cp(dep, results_dir)
  end

  script = File.join(results_dir, '_run_loop.js')

  javascript = UIAScriptTemplate.new(SCRIPTS_PATH, instruments_script).result
  UIAScriptTemplate.sub_path_var!(javascript, results_dir)
  UIAScriptTemplate.sub_read_script_path_var!(javascript, READ_SCRIPT_PATH)
  UIAScriptTemplate.sub_timeout_script_path_var!(javascript, TIMEOUT_SCRIPT_PATH)

  # Using a :no_* option is confusing.
  # TODO Replace :no_flush with :flush_uia_logs; it should default to true
  if RunLoop::Environment.xtc?
    UIAScriptTemplate.sub_mode_var!(javascript, "FLUSH") unless options[:no_flush]
  else
    if self.detect_flush_uia_log_option(options)
      UIAScriptTemplate.sub_flush_uia_logs_var!(javascript, "FLUSH_LOGS")
    end
  end

  repl_path = File.join(results_dir, 'repl-cmd.pipe')
  FileUtils.rm_f(repl_path)

  if uia_strategy == :host
    create_uia_pipe(repl_path)
  else
    FileUtils.touch repl_path
  end

  RunLoop::HostCache.default.clear unless RunLoop::Environment.xtc?

  cal_script = File.join(SCRIPTS_PATH, 'calabash_script_uia.js')
  File.open(script, 'w') do |file|
    if include_calabash_script?(options)
      file.puts IO.read(cal_script)
    end
    file.puts javascript
  end

  args = options.fetch(:args, [])

  log_file = options[:log_path] || File.join(results_dir, 'run_loop.out')

  discovered_options =
    {
      :udid => device.udid,
      :device => device,
      :results_dir_trace => results_dir_trace,
      :bundle_id => app_details[:bundle_id],
      :app => app_details[:app]  || app_details[:bundle_id],
      :results_dir => results_dir,
      :script => script,
      :log_file => log_file,
      :args => args,
      :uia_strategy => uia_strategy
    }
  merged_options = options.merge(discovered_options)

  if device.simulator?
    self.prepare_simulator(app_details[:app], device, xcode, simctl, reset_options)
  end

  self.log_run_loop_options(merged_options, xcode)

  automation_template = automation_template(instruments)

  RunLoop::Logging.log_header(logger, "Starting on #{device.name} App: #{app_details[:bundle_id]}")

  pid = instruments.spawn(automation_template, merged_options, log_file)

  File.open(File.join(results_dir, 'run_loop.pid'), 'w') do |f|
    f.write pid
  end

  run_loop = {
    :pid => pid,
    :index => 1,
    :uia_strategy => uia_strategy,
    :udid => device.udid,
    :app => app_details[:bundle_id],
    :repl_path => repl_path,
    :log_file => log_file,
    :results_dir => results_dir
  }

  uia_timeout = options[:uia_timeout] || RunLoop::Environment.uia_timeout || 10

  RunLoop::Logging.log_debug(logger, "Preparation took #{Time.now-before} seconds")

  before_instruments_launch = Time.now

  fifo_retry_on = [
    RunLoop::Fifo::NoReaderConfiguredError,
    RunLoop::Fifo::WriteTimedOut
  ]

  begin

    if options[:validate_channel]
      options[:validate_channel].call(run_loop, 0, uia_timeout)
    else

      cmd = "UIALogger.logMessage('Listening for run loop commands')"

      begin

        fifo_timeout = options[:fifo_timeout] || 30
        RunLoop::Fifo.write(repl_path, "0:#{cmd}", timeout: fifo_timeout)

      rescue *fifo_retry_on => e

        message = "Error while writing to fifo. #{e}"
        RunLoop::Logging.log_debug(logger, message)
        raise RunLoop::TimeoutError.new(message)

      end

      Timeout::timeout(timeout, RunLoop::TimeoutError) do
        read_response(run_loop, 0, uia_timeout)
      end

    end
  rescue RunLoop::TimeoutError => e
    RunLoop::Logging.log_debug(logger, "Failed to launch. #{e}: #{e && e.message}")

    message = %Q(

"Timed out waiting for UIAutomation run-loop #{e}.

Logfile: #{log_file}

    #{File.read(log_file)}

    )
    raise RunLoop::TimeoutError, message
  end

  RunLoop::Logging.log_debug(logger, "Launching took #{Time.now-before_instruments_launch} seconds")

  dylib_path = self.dylib_path_from_options(merged_options)

  if dylib_path
    if device.physical_device?
      raise RuntimeError, "Injecting a dylib is not supported when targeting a device"
    end

    app = app_details[:app]
    lldb = RunLoop::DylibInjector.new(app.executable_name, dylib_path)
    lldb.retriable_inject_dylib
  end

  RunLoop.log_debug("It took #{Time.now - before} seconds to launch the app")
  run_loop
end

.script_for_key(key) ⇒ Object 



49
50
51
52
53
54
 
# File 'lib/run_loop/core.rb', line 49

def self.script_for_key(key)
  if SCRIPTS[key].nil?
    return nil
  end
  SCRIPTS[key]
end

.validate_index_written(run_loop, index, logger) ⇒ Object 



365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/run_loop/core.rb', line 365

def self.validate_index_written(run_loop, index, logger)
  begin
    Timeout::timeout(10, RunLoop::TimeoutError) do
      Core.read_response(run_loop, index, 10, 'last_index')
    end
    RunLoop::Logging.log_debug(logger, "validate index written for index #{index} ok")
    return true
  rescue RunLoop::TimeoutError => _
    RunLoop::Logging.log_debug(logger, "validate index written for index #{index} failed. Retrying.")
    return false
  end
end

.write_request(run_loop, cmd, logger = nil) ⇒ Object 



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/run_loop/core.rb', line 339

def self.write_request(run_loop, cmd, logger=nil)
  repl_path = run_loop[:repl_path]
  index = run_loop[:index]
  cmd_str = "#{index}:#{escape_host_command(cmd)}"
  RunLoop::Logging.log_debug(logger, cmd_str)
  write_succeeded = false
  2.times do |i|
    RunLoop::Logging.log_debug(logger, "Trying write of command #{cmd_str} at index #{index}")
    begin
      RunLoop::Fifo.write(repl_path, cmd_str)
      write_succeeded = validate_index_written(run_loop, index, logger)
    rescue RunLoop::Fifo::NoReaderConfiguredError,
      RunLoop::Fifo::WriteTimedOut => e
      RunLoop::Logging.log_debug(logger, "Error while writing command (retry count #{i}). #{e}")
    end
    break if write_succeeded
  end
  unless write_succeeded
    RunLoop::Logging.log_debug(logger, 'Failing...Raising RunLoop::WriteFailedError')
    raise RunLoop::WriteFailedError.new("Trying write of command #{cmd_str} at index #{index}")
  end
  run_loop[:index] = index + 1
  RunLoop::HostCache.default.write(run_loop) unless RunLoop::Environment.xtc?
  index
end

.xcode_version(xcode = RunLoop::Xcode.new) ⇒ Object

Deprecated.

1.0.0 replaced with Xctools#version



614
615
616
 
# File 'lib/run_loop/core.rb', line 614

def self.xcode_version(xcode=RunLoop::Xcode.new)
  xcode.version
end