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) 


683
684
685
686
687
688
689
690
691
692
693
694
695
696
 
# File 'lib/run_loop/core.rb', line 683

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 



532
533
534
535
536
537
 
# File 'lib/run_loop/core.rb', line 532

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 



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/run_loop/core.rb', line 369

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.



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

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

  if xcode.version_gte_8?
    "iPhone 6s (10.0)"
  elsif 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

Raises:

  • (RuntimeError) 


539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File 'lib/run_loop/core.rb', line 539

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

  templates = instruments.templates

  if instruments.xcode.version_gte_8?
    raise(RuntimeError, %Q[

There is no Automation template for this #{instruments.xcode} version.

])
  end

  # 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

  raise(RuntimeError, %Q[
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:

$ xcrun xcodebuild -version
$ xcrun instruments -s templates
])
end

.detect_connected_device ⇒ Object

Deprecated.

2.1.0

Replaced with Device.detect_physical_device_on_usb



586
587
588
589
590
591
592
593
594
595
 
# File 'lib/run_loop/core.rb', line 586

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.



323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/run_loop/core.rb', line 323

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



663
664
665
 
# File 'lib/run_loop/core.rb', line 663

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

.escape_host_command(cmd) ⇒ Object 



429
430
431
432
 
# File 'lib/run_loop/core.rb', line 429

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

.instruments_pids ⇒ Object

Deprecated.

1.0.5



672
673
674
 
# File 'lib/run_loop/core.rb', line 672

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

.instruments_running? ⇒ Boolean

Returns:

  • (Boolean) 


667
668
669
 
# File 'lib/run_loop/core.rb', line 667

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

.jruby? ⇒ Boolean

Returns:

  • (Boolean) 


386
387
388
 
# File 'lib/run_loop/core.rb', line 386

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

.log_instruments_error(msg) ⇒ Object 



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

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



699
700
701
 
# File 'lib/run_loop/core.rb', line 699

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 



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

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::Cache.default.write(run_loop) unless RunLoop::Environment.xtc?
  result
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 



416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/run_loop/core.rb', line 416

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 



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

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::Cache.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



677
678
679
 
# File 'lib/run_loop/core.rb', line 677

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