run_loop 2.1.3 → 2.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f87d14b21bab0d48f84d2d4793f5f38b7c75e537
-  data.tar.gz: 9e565515f6f9abcc1926424c17473dca66c05222
+  metadata.gz: b78530b9096de94687ede2b3747d0c767c32b369
+  data.tar.gz: 146634e680bf39a1ddb834c5ccc0b48baf0878bc
 SHA512:
-  metadata.gz: b1c91bc8ef53e04e8766d9b2f7fffb11ff0ddf3dc940e6ac996bee128a64bce81b70f92eaa71af466862a491f0519cbfd5b8eab2479baf481b42552839c3ca69
-  data.tar.gz: bb0eaeef42beda6c2e9622f5b1d55a3e09f5f793b0fb0d1b0fc36935617937d0b8c8826355cdab218d57b82f6701ab26c84cc831e3092b8effc33e869c39e204
+  metadata.gz: 3b7f41b533a82f4b9602a99f25671b2273d6da50bb7e69f4a2e0f169013d7d042af3b7bf081607c91276aff2c3da9473c6ab31062cbd047d1c482ad159e45b19
+  data.tar.gz: 3d3ed52198cb8cf0c8dc274d384142f5d149c3c00a5b0219c4f49f58798c979b8898e5f5180d96f6bfef716b2229720c751488d042e25c7066d15cecdb155640

data/lib/run_loop.rb

@@ -23,7 +23,7 @@ require 'run_loop/ipa'
 require "run_loop/device_agent/cbxrunner"
 require "run_loop/device_agent/frameworks"
 require "run_loop/device_agent/launcher"
-require "run_loop/device_agent/xctestctl"
+require "run_loop/device_agent/ios_device_manager"
 require "run_loop/device_agent/xcodebuild"
 require "run_loop/detect_aut/errors"
 require "run_loop/detect_aut/xamarin_studio"
@@ -35,8 +35,7 @@ require 'run_loop/instruments'
 require 'run_loop/lipo'
 require "run_loop/otool"
 require "run_loop/strings"
-require 'run_loop/cache/cache'
-require 'run_loop/host_cache'
+require 'run_loop/cache'
 require 'run_loop/patches/awesome_print'
 require 'run_loop/core_simulator'
 require "run_loop/simctl"
@@ -49,6 +48,7 @@ require "run_loop/http/server"
 require "run_loop/http/request"
 require "run_loop/http/retriable_client"
 require "run_loop/physical_device/life_cycle"
+require "run_loop/dnssd"
 
 module RunLoop
 
@@ -80,10 +80,20 @@ module RunLoop
     # 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.
@@ -91,7 +101,15 @@ module RunLoop
       cloned_options[:sim_control] = options[:sim_control]
     end
 
-    if options[:xcuitest]
+    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
+
+    gesture_performer = RunLoop.detect_gesture_performer(cloned_options, xcode, device)
+    if gesture_performer == :device_agent
       RunLoop::XCUITest.run(cloned_options)
     else
       if RunLoop::Instruments.new.instruments_app_running?
@@ -224,4 +242,101 @@ Please quit the Instruments.app and try again.)
   def self.log_info(*args)
     RunLoop::Logging.log_info(*args)
   end
+
+  # @!visibility private
+  #
+  # @param [RunLoop::Xcode] xcode The active Xcode
+  # @param [RunLoop::Device] device The device under test.
+  def self.default_gesture_performer(xcode, device)
+    # TODO XTC support
+    return :instruments if RunLoop::Environment.xtc?
+
+    if xcode.version_gte_8?
+      if device.version >= RunLoop::Version.new("9.0")
+        :device_agent
+      else
+        raise RuntimeError, %Q[
+Invalid Xcode and iOS combination:
+
+Xcode version: #{xcode.version.to_s}
+  iOS version: #{device.version.to_s}
+
+Calabash cannot test iOS < 9.0 using Xcode 8 because XCUITest is not compatible
+with iOS < 9.0 and UIAutomation is not available in Xcode 8.
+
+You can rerun your test if you have Xcode 7 installed:
+
+$ DEVELOPER_DIR=/path/to/Xcode/7.3.1/Xcode.app/Contents/Developer cucumber
+
+]
+      end
+
+    else
+      :instruments
+    end
+  end
+
+  # @!visibility private
+  #
+  # First pass at choosing the correct code path.
+  #
+  # We don't know if we can test on iOS 8 with UIAutomation or XCUITest on
+  # Xcode 8.
+  #
+  # @param [Hash] options The options passed by the user
+  # @param [RunLoop::Xcode] xcode The active Xcode
+  # @param [RunLoop::Device] device The device under test
+  def self.detect_gesture_performer(options, xcode, device)
+    # TODO XTC support
+    return :instruments if RunLoop::Environment.xtc?
+
+    gesture_performer = options[:gesture_performer]
+
+    if gesture_performer
+      if xcode.version_gte_8?
+        if gesture_performer == :instruments
+          raise RuntimeError, %Q[
+Incompatible :gesture_performer option for active Xcode.
+
+Detected :gesture_performer => :instruments and Xcode #{xcode.version}.
+
+Don't set the :gesture_performer option unless you are gem maintainer.
+
+]
+        elsif device.version < RunLoop::Version.new("9.0")
+          raise RuntimeError, %Q[
+
+Invalid Xcode and iOS combination:
+
+Xcode version: #{xcode.version.to_s}
+  iOS version: #{device.version.to_s}
+
+Calabash cannot test iOS < 9.0 using Xcode 8 because XCUITest is not compatible
+with iOS < 9.0 and UIAutomation is not available in Xcode 8.
+
+You can rerun your test if you have Xcode 7 installed:
+
+$ DEVELOPER_DIR=/path/to/Xcode/7.3.1/Xcode.app/Contents/Developer cucumber
+
+Don't set the :gesture_performer option unless you are gem maintainer.
+
+]
+        end
+      end
+
+      if ![:device_agent, :instruments].include?(gesture_performer)
+        raise RuntimeError, %Q[
+Invalid :gesture_performer option: #{gesture_performer}
+
+Allowed performers: :device_agent or :instruments.
+
+Don't set the :gesture_performer option unless you are gem maintainer.
+
+]
+      end
+      gesture_performer
+    else
+      RunLoop.default_gesture_performer(xcode, device)
+    end
+  end
 end

data/lib/run_loop/{host_cache.rb → cache.rb}

@@ -12,7 +12,7 @@ module RunLoop
   # Marshal is safe to use here because:
   # 1. This code is not executed on the XTC.
   # 2. Users who muck about with this cache can only hurt themselves.
-  class HostCache
+  class Cache
 
     # The path to the cache file.
     #
@@ -40,7 +40,7 @@ RunLoop requires this directory to cache files
 
     # The default cache.
     def self.default
-      RunLoop::HostCache.new(self.default_directory)
+      RunLoop::Cache.new(self.default_directory)
     end
 
     # Creates a new HostCache that is ready for IO.
@@ -50,7 +50,7 @@ RunLoop requires this directory to cache files
     # @options [Hash] options Options to control the state of the new object.
     # @option [String] filename (host_run_loop.hash) The cache filename.
     # @option [Boolean] clear (false) If true, the current cache will be cleared.
-    # @return [RunLoop::HostCache] A cache that is ready for IO.
+    # @return [RunLoop::Cache] A cache that is ready for IO.
     def initialize(directory, options = {})
       sha1 = Digest::SHA1.hexdigest 'host_run_loop.hash'
       default_opts = {:filename => sha1,
@@ -125,4 +125,9 @@ RunLoop requires this directory to cache files
       self.write({})
     end
   end
+
+  # @!visibility private
+  # Required for backward compatibility.
+  # The only legitimate caller is in Calabash iOS Launcher#attach.
+  class HostCache < RunLoop::Cache ; end
 end

data/lib/run_loop/codesign.rb

@@ -18,7 +18,7 @@ module RunLoop
     # @!visibility private
     def self.info(path)
       self.expect_path_exists(path)
-      self.exec(["--display", "--verbose=4", path])
+      self.run_codesign_command(["--display", "--verbose=4", path])
     end
 
     # @!visibility private
@@ -59,7 +59,7 @@ module RunLoop
       end
     end
 
-    def self.exec(args)
+    def self.run_codesign_command(args)
       if !args.is_a?(Array)
         raise ArgumentError, "Expected args: '#{args}' to be an Array"
       end
@@ -67,7 +67,7 @@ module RunLoop
       xcrun = RunLoop::Xcrun.new
       cmd = ["codesign"] + args
       options = {:log_cmd => true}
-      hash = xcrun.exec(cmd, options)
+      hash = xcrun.run_command_in_context(cmd, options)
 
       hash[:out]
     end

data/lib/run_loop/core.rb

@@ -53,6 +53,8 @@ module RunLoop
       SCRIPTS[key]
     end
 
+    # @!visibility private
+    # This is the entry point for UIAutomation.
     def self.run_with_options(options)
       before = Time.now
 
@@ -63,6 +65,22 @@ module RunLoop
       xcode = options[:xcode] || RunLoop::Xcode.new
       instruments = options[:instruments] || RunLoop::Instruments.new
 
+      if xcode.version_gte_8?
+        raise %Q[
+UIAutomation is not available on Xcode >= 8.*.
+
+We are in the process of updating Calabash to use our new tool: DeviceAgent.
+
+We will track progress in this forum post:
+
+https://groups.google.com/forum/#!topic/calabash-ios/g34znf0LnE4
+
+For now, testing with Xcode 8 is not supported.
+
+Thank you for your patience.
+]
+      end
+
       # Device under test: DUT
       device = RunLoop::Device.detect_device(options, xcode, simctl, instruments)
 
@@ -120,7 +138,7 @@ module RunLoop
         FileUtils.touch repl_path
       end
 
-      RunLoop::HostCache.default.clear unless RunLoop::Environment.xtc?
+      RunLoop::Cache.default.clear unless RunLoop::Environment.xtc?
 
       cal_script = File.join(SCRIPTS_PATH, 'calabash_script_uia.js')
       File.open(script, 'w') do |file|
@@ -202,7 +220,8 @@ means that the APP variable is pointing to a .app that does not exist.
         :app => app_details[:bundle_id],
         :repl_path => repl_path,
         :log_file => log_file,
-        :results_dir => results_dir
+        :results_dir => results_dir,
+        :gesture_performer => :instruments
       }
 
       uia_timeout = options[:uia_timeout] || RunLoop::Environment.uia_timeout || 10
@@ -322,7 +341,9 @@ Logfile: #{log_file}
     #  version.
     def self.default_simulator(xcode=RunLoop::Xcode.new)
 
-      if xcode.version_gte_73?
+      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)"
@@ -387,7 +408,7 @@ Logfile: #{log_file}
         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?
+      RunLoop::Cache.default.write(run_loop) unless RunLoop::Environment.xtc?
       index
     end
 
@@ -503,7 +524,7 @@ Logfile: #{log_file}
       end
 
       run_loop[:initial_offset] = offset
-      RunLoop::HostCache.default.write(run_loop) unless RunLoop::Environment.xtc?
+      RunLoop::Cache.default.write(run_loop) unless RunLoop::Environment.xtc?
       result
     end
 

data/lib/run_loop/core_simulator.rb

@@ -1,6 +1,9 @@
 # A class to manage interactions with CoreSimulators.
 class RunLoop::CoreSimulator
 
+  require "run_loop/shell"
+  include RunLoop::Shell
+
   # These options control various aspects of an app's life cycle on the iOS
   # Simulator.
   #
@@ -61,15 +64,13 @@ class RunLoop::CoreSimulator
               # This process is a daemon, and requires 'KILL' to terminate.
               # Killing the process is fast, but it takes a long time to
               # restart.
-              ['com.apple.CoreSimulator.CoreSimulatorService', false],
+              "com.apple.CoreSimulator.CoreSimulatorService",
 
-              # Probably do not need to quit this, but it is tempting to do so.
-              #['com.apple.CoreSimulator.SimVerificationService', false],
+              # Not yet.
+              # "com.apple.CoreSimulator.SimVerificationService",
 
               'SimulatorBridge',
               'configd_sim',
-
-              # Does not always appear.
               'CoreSimulatorBridge',
 
               # Xcode 7
@@ -207,7 +208,7 @@ class RunLoop::CoreSimulator
 
     if simulator.update_simulator_state != "Shutdown"
       args = ["simctl", "shutdown", simulator.udid]
-      xcrun.exec(args, xcrun_opts)
+      xcrun.run_command_in_context(args, xcrun_opts)
       begin
         self.wait_for_simulator_state(simulator, "Shutdown")
       rescue RuntimeError => _
@@ -226,7 +227,7 @@ $ bundle exec run-loop simctl manage-processes
     end
 
     args = ["simctl", "erase", simulator.udid]
-    hash = xcrun.exec(args, xcrun_opts)
+    hash = xcrun.run_command_in_context(args, xcrun_opts)
 
     if hash[:exit_status] != 0
       raise RuntimeError, %Q{
@@ -489,7 +490,7 @@ $ bundle exec run-loop simctl manage-processes
     args = ['simctl', 'uninstall', device.udid, app.bundle_identifier]
 
     timeout = DEFAULT_OPTIONS[:uninstall_app_timeout]
-    xcrun.exec(args, log_cmd: true, timeout: timeout)
+    xcrun.run_command_in_context(args, log_cmd: true, timeout: timeout)
 
     device.simulator_wait_for_stable_state
     true
@@ -569,8 +570,8 @@ $ bundle exec run-loop simctl manage-processes
   def running_simulator_pid
     process_name = "MacOS/#{sim_name}"
 
-    args = ["xcrun", "ps", "x", "-o", "pid,command"]
-    hash = xcrun.exec(args)
+    args = ["ps", "x", "-o", "pid,command"]
+    hash = run_shell_command(args)
 
     exit_status = hash[:exit_status]
     if exit_status != 0
@@ -611,7 +612,7 @@ Command had no output
 
     args = ['simctl', 'install', device.udid, app.path]
     timeout = DEFAULT_OPTIONS[:install_app_timeout]
-    xcrun.exec(args, log_cmd: true, timeout: timeout)
+    xcrun.run_command_in_context(args, log_cmd: true, timeout: timeout)
 
     device.simulator_wait_for_stable_state
     installed_app_bundle_dir
@@ -621,7 +622,7 @@ Command had no output
   def launch_app_with_simctl
     args = ['simctl', 'launch', device.udid, app.bundle_identifier]
     timeout = DEFAULT_OPTIONS[:launch_app_timeout]
-    xcrun.exec(args, log_cmd: true, timeout: timeout)
+    xcrun.run_command_in_context(args, log_cmd: true, timeout: timeout)
   end
 
   # @!visibility private
@@ -864,7 +865,7 @@ Command had no output
     target = File.join(directory, bundle_name)
 
     args = ['ditto', app.path, target]
-    xcrun.exec(args, log_cmd: true)
+    xcrun.run_command_in_context(args, log_cmd: true)
 
     RunLoop.log_debug("Installed #{app} on CoreSimulator #{device.udid}")
 

data/lib/run_loop/detect_aut/detect.rb

@@ -29,7 +29,7 @@ module RunLoop
 
       # @!visibility private
       DEFAULTS = {
-        :search_depth => 5
+        :search_depth => 10
       }
 
       # @!visibility private

data/lib/run_loop/device.rb

@@ -505,7 +505,7 @@ version: #{version}
       ]
 
       # RunLoop::PlistBuddy cannot add items to arrays.
-      xcrun.exec(cmd, {:log_cmd => true})
+      xcrun.run_command_in_context(cmd, {:log_cmd => true})
 
       simulator_languages
     end
@@ -547,7 +547,7 @@ version: #{version}
       end
 
       args = ['simctl', 'list', 'devices']
-      hash = xcrun.exec(args)
+      hash = xcrun.run_command_in_context(args)
       out = hash[:out]
 
       matched_line = out.split("\n").find do |line|

data/lib/run_loop/device_agent/cbxrunner.rb

@@ -5,7 +5,6 @@ module RunLoop
     # @!visibility private
     class CBXRunner
 
-      require "run_loop/shell"
 
       # @!visibility private
       @@cbxdevice = nil
@@ -87,8 +86,10 @@ but runner does not exist at that path.
       end
 
       # @!visibility private
+      # TODO move this behavior to shell.rb - should be able to call Shell.run_unix_command
       def self.expand_runner_archive(archive)
         shell = Class.new do
+          require "run_loop/shell"
           include RunLoop::Shell
           def to_s; "#<CBXRunner Shell>"; end
           def inspect; to_s; end
@@ -98,7 +99,7 @@ but runner does not exist at that path.
         options = { :log_cmd => true }
         Dir.chdir(dir) do
           RunLoop.log_unix_cmd("cd #{dir}")
-          shell.exec(["unzip", File.basename(archive)], options)
+          shell.run_shell_command(["ditto", "-xk", File.basename(archive), "."], options)
         end
         File.join(dir, "CBX-Runner.app")
       end