Module: RunLoop::Core

Defined in:
lib/run_loop/core.rb

Constant Summary collapse

START_DELIMITER = 
"OUTPUT_JSON:\n"
END_DELIMITER = 
"\nEND_OUTPUT"
SCRIPTS_PATH = 
File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'scripts'))
SCRIPTS = 
{
    :dismiss => 'run_dismiss_location.js',
    :run_loop_fast_uia => 'run_loop_fast_uia.js',
    :run_loop_shared_element => 'run_loop_shared_element.js',
    :run_loop_host => 'run_loop_host.js',
    :run_loop_basic => 'run_loop_basic.js'
}
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) 


53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/run_loop/core.rb', line 53

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(xctools, candidate = RunLoop::Environment.trace_template) ⇒ Object 



564
565
566
567
568
569
 
# File 'lib/run_loop/core.rb', line 564

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

.create_uia_pipe(repl_path) ⇒ Object 



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/run_loop/core.rb', line 417

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 => e
          #retry
          sleep(0.1)
        end
      end
    end
  rescue RunLoop::TimeoutError => _
    raise RunLoop::TimeoutError, 'Unable to create pipe (mkfifo failed)'
  end
end

.default_simulator(xcode_tools = RunLoop::XCTools.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_tools (RunLoop::XCTools) (defaults to: RunLoop::XCTools.new) —

    Used to detect the current xcode version.



349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/run_loop/core.rb', line 349

def self.default_simulator(xcode_tools=RunLoop::XCTools.new)
  if xcode_tools.xcode_version_gte_63?
    'iPhone 5s (8.3 Simulator)'
  elsif xcode_tools.xcode_version_gte_62?
    'iPhone 5s (8.2 Simulator)'
  elsif xcode_tools.xcode_version_gte_61?
    'iPhone 5s (8.1 Simulator)'
  elsif xcode_tools.xcode_version_gte_6?
    'iPhone 5s (8.0 Simulator)'
  else
    'iPhone Retina (4-inch) - Simulator - iOS 7.1'
  end
end

.default_tracetemplate(xctools = RunLoop::XCTools.new) ⇒ Object 



571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/run_loop/core.rb', line 571

def self.default_tracetemplate(xctools=RunLoop::XCTools.new)
  templates = xctools.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.
  res = templates.select { |name| name == 'Automation' }.first
  return res if res

  res = templates.select do |path|
    path =~ /\/Automation.tracetemplate/ and path =~ /Xcode/
  end.first.tr("\"", '').strip
  return res if res

  msgs = ['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 msgs.join("\n")
end

.detect_connected_device ⇒ Object 



75
76
77
78
79
80
81
82
83
84
 
# File 'lib/run_loop/core.rb', line 75

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.



329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/run_loop/core.rb', line 329

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



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

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

.escape_host_command(cmd) ⇒ Object 



478
479
480
481
 
# File 'lib/run_loop/core.rb', line 478

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

.expect_compatible_simulator_architecture(launch_options, sim_control) ⇒ Object

Note:

This method is implemented for CoreSimulator environments only; for Xcode < 6.0 this method does nothing.

Raise an error if the application binary is not compatible with the target simulator.

Parameters:

  • launch_options (Hash) —

    These options need to contain the app bundle path and a udid that corresponds to a simulator name or simulator udid. In practical terms: call this after merging the original launch options with those options that are discovered.

  • sim_control (RunLoop::SimControl) —

    A simulator control object.

Raises:



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/run_loop/core.rb', line 102

def self.expect_compatible_simulator_architecture(launch_options, sim_control)
  logger = launch_options[:logger]
  if sim_control.xcode_version_gte_6?
    sim_identifier = launch_options[:udid]
    simulator = sim_control.simulators.find do |simulator|
      [simulator.instruments_identifier(sim_control.xctools),
       simulator.udid].include?(sim_identifier)
    end

    if simulator.nil?
      raise "Could not find simulator with identifier '#{sim_identifier}'"
    end

    lipo = RunLoop::Lipo.new(launch_options[:bundle_dir_or_bundle_id])
    lipo.expect_compatible_arch(simulator)
    RunLoop::Logging.log_debug(logger, "Simulator instruction set '#{simulator.instruction_set}' is compatible with #{lipo.info}")
    true
  else
    RunLoop::Logging.log_debug(logger, "Xcode #{sim_control.xctools.xcode_version} detected; skipping simulator architecture check.")
    false
  end
end

.instruments_pids ⇒ Object

Deprecated.

1.0.5



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

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

.instruments_running? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

.jruby? ⇒ Boolean

Returns:

  • (Boolean) 


435
436
437
 
# File 'lib/run_loop/core.rb', line 435

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

.log_run_loop_options(options, xctools) ⇒ Object 



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

def self.log_run_loop_options(options, xctools)
  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] = xctools.xcode_version.to_s
  options_to_log[:xcode_path] = xctools.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



560
561
562
 
# File 'lib/run_loop/core.rb', line 560

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 



483
484
485
486
487
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
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/run_loop/core.rb', line 483

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)
        $stderr.puts "\n\n****** Accessibility is not enabled on device/simulator, please enable it *** \n\n"
        $stderr.flush
      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
    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 



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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/run_loop/core.rb', line 125

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

  logger = options[:logger]
  sim_control ||= options[:sim_control] || RunLoop::SimControl.new
  xctools ||= options[:xctools] || sim_control.xctools

  instruments = RunLoop::Instruments.new
  instruments.kill_instruments

  device_target = options[:udid] || options[:device_target] || detect_connected_device || 'simulator'
  if device_target && device_target.to_s.downcase == 'device'
    device_target = detect_connected_device
  end

  log_file = options[:log_path]
  timeout = options[:timeout] || 30

  results_dir = options[:results_dir] || Dir.mktmpdir('run_loop')
  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')

  code = File.read(options[:script])
  code = code.gsub(/\$PATH/, results_dir)
  code = code.gsub(/\$READ_SCRIPT_PATH/, READ_SCRIPT_PATH)
  code = code.gsub(/\$TIMEOUT_SCRIPT_PATH/, TIMEOUT_SCRIPT_PATH)
  code = code.gsub(/\$MODE/, 'FLUSH') unless options[:no_flush]

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

  uia_strategy = options[:uia_strategy]
  if uia_strategy == :host
    create_uia_pipe(repl_path)
    RunLoop::HostCache.default.clear unless RunLoop::Environment.xtc?
  else
    FileUtils.touch repl_path
  end

  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 code
  end

  udid = options[:udid]
  bundle_dir_or_bundle_id = options[:bundle_dir_or_bundle_id]

  if !(udid && bundle_dir_or_bundle_id)
    # Compute udid and bundle_dir / bundle_id from options and target depending on Xcode version
    udid, bundle_dir_or_bundle_id = self.udid_and_bundle_for_launcher(device_target, options, sim_control)
  end

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

  log_file ||= File.join(results_dir, 'run_loop.out')

  discovered_options =
        {
              :udid => udid,
              :results_dir_trace => results_dir_trace,
              :bundle_dir_or_bundle_id => bundle_dir_or_bundle_id,
              :results_dir => results_dir,
              :script => script,
              :log_file => log_file,
              :args => args
        }
  merged_options = options.merge(discovered_options)

  if self.simulator_target?(merged_options, sim_control)
    # @todo only enable accessibility on the targeted simulator
    sim_control.enable_accessibility_on_sims({:verbose => false})
    self.expect_compatible_simulator_architecture(merged_options, sim_control)
  end

  self.log_run_loop_options(merged_options, xctools)

  automation_template = automation_template(xctools)

  RunLoop::Logging.log_header(logger, "Starting on #{device_target} App: #{bundle_dir_or_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 => udid,
              :app => bundle_dir_or_bundle_id,
              :repl_path => repl_path,
              :log_file => log_file,
              :results_dir => results_dir}

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

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

  before = Time.now
  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 RunLoop::Fifo::NoReaderConfiguredError,
          RunLoop::Fifo::WriteTimedOut => e
        RunLoop::Logging.log_debug(logger, "Error while writing to fifo. #{e}")
        raise RunLoop::TimeoutError.new("Error while writing to fifo. #{e}")
      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}")
    raise RunLoop::TimeoutError, "Time out waiting for UIAutomation run-loop #{e}. \n Logfile #{log_file} \n\n #{File.read(log_file)}\n"
  end

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

  dylib_path = self.dylib_path_from_options(merged_options)

  if dylib_path
    RunLoop::LLDB.kill_lldb_processes
    app = RunLoop::App.new(options[:app])
    lldb = RunLoop::DylibInjector.new(app.executable_name, dylib_path)
    lldb.retriable_inject_dylib
  end

  run_loop
end

.script_for_key(key) ⇒ Object 



68
69
70
71
72
73
 
# File 'lib/run_loop/core.rb', line 68

def self.script_for_key(key)
  if SCRIPTS[key].nil?
    return nil
  end
  File.join(scripts_path, SCRIPTS[key])
end

.scripts_path ⇒ Object 



28
29
30
 
# File 'lib/run_loop/core.rb', line 28

def self.scripts_path
  SCRIPTS_PATH
end

.udid_and_bundle_for_launcher(device_target, options, sim_control = RunLoop::SimControl.new) ⇒ Object 



363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/run_loop/core.rb', line 363

def self.udid_and_bundle_for_launcher(device_target, options, sim_control=RunLoop::SimControl.new)
  xctools = sim_control.xctools

  bundle_dir_or_bundle_id = options[:app] || RunLoop::Environment.bundle_id || RunLoop::Environment.path_to_app_bundle

  unless bundle_dir_or_bundle_id
    raise 'key :app or environment variable APP_BUNDLE_PATH, BUNDLE_ID or APP must be specified as path to app bundle (simulator) or bundle id (device)'
  end

  udid = nil

  if xctools.xcode_version_gte_51?
    if device_target.nil? || device_target.empty? || device_target == 'simulator'
      device_target = self.default_simulator(xctools)
    end
    udid = device_target

    unless self.simulator_target?(options, sim_control)
      bundle_dir_or_bundle_id = options[:bundle_id] if options[:bundle_id]
    end
  else
    if device_target == 'simulator'

      unless File.exist?(bundle_dir_or_bundle_id)
        raise "Unable to find app in directory #{bundle_dir_or_bundle_id} when trying to launch simulator"
      end


      device = options[:device] || :iphone
      device = device && device.to_sym

      plistbuddy='/usr/libexec/PlistBuddy'
      plistfile="#{bundle_dir_or_bundle_id}/Info.plist"
      if device == :iphone
        uidevicefamily=1
      else
        uidevicefamily=2
      end
      system("#{plistbuddy} -c 'Delete :UIDeviceFamily' '#{plistfile}'")
      system("#{plistbuddy} -c 'Add :UIDeviceFamily array' '#{plistfile}'")
      system("#{plistbuddy} -c 'Add :UIDeviceFamily:0 integer #{uidevicefamily}' '#{plistfile}'")
    else
      udid = device_target
      bundle_dir_or_bundle_id = options[:bundle_id] if options[:bundle_id]
    end
  end
  return udid, bundle_dir_or_bundle_id
end

.validate_index_written(run_loop, index, logger) ⇒ Object 



465
466
467
468
469
470
471
472
473
474
475
476
 
# File 'lib/run_loop/core.rb', line 465

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 



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

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(xctools = RunLoop::XCTools.new) ⇒ Object

Deprecated.

1.0.0 replaced with Xctools#version



413
414
415
 
# File 'lib/run_loop/core.rb', line 413

def self.xcode_version(xctools=RunLoop::XCTools.new)
  xctools.xcode_version.to_s
end