run_loop 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ea1e4ca2af5aa1d018ecd229a5c864ab3b34533
-  data.tar.gz: 06ef7af54d9d9d7bac1d2070c1398d3f4723feac
+  metadata.gz: 2277694b8f2dd62516bcc3107dc59e8d227e952b
+  data.tar.gz: 77b5fa24065db03d3379d9e997251ca564ad9017
 SHA512:
-  metadata.gz: 1a71ada83c5a6558e1d423b4138e8235fc82220dfe3c1bcd7283b16978dd6219331754518387102b8c47e4572c0863aceb90f70f5039d2580cd603a5245a9b8d
-  data.tar.gz: 3c44d8bd2a89a1cda2fdae997ab9a70bcd6f975e2d4e9f97f56d12462f05dde000d54379a83a932b58547b9f5c91b42bd282721897f8b32d8f44373542558131
+  metadata.gz: 28529f12e82152e1b618a3ff6011db975d2ac84fb91668c64f95de840d69c8bddc09b94c4fe9e770b7cecd3b3cdaea418a154f6f8f13548231f3635b6f9346be
+  data.tar.gz: 6ccce42c7d166a850ecb10e2c558cc1930c73f9da097f03f78d2a32e718e3c70b440761d847233de17a1ded3d1a314414789c6fc98408482d01027afd4e0709f

data/lib/run_loop.rb

@@ -2,6 +2,7 @@ require 'run_loop/regex'
 require 'run_loop/directory'
 require 'run_loop/environment'
 require 'run_loop/logging'
+require 'run_loop/xcrun'
 require 'run_loop/xcode'
 require 'run_loop/l10n'
 require 'run_loop/process_terminator'
@@ -23,6 +24,7 @@ require 'run_loop/cache/cache'
 require 'run_loop/host_cache'
 require 'run_loop/patches/awesome_print'
 require 'run_loop/patches/retriable'
+require 'run_loop/life_cycle/core_simulator'
 require 'run_loop/simctl/bridge'
 require 'run_loop/simctl/plists'
 

data/lib/run_loop/app.rb

@@ -67,6 +67,11 @@ module RunLoop
       identifier
     end
 
+    # Returns the sha1 of the application.
+    def sha1
+      RunLoop::Directory.directory_digest(path)
+    end
+
     private
 
     def plist_buddy

data/lib/run_loop/cli/instruments.rb

@@ -100,7 +100,6 @@ module RunLoop
 
         ENV['DEBUG'] = '1' if debug
 
-
         begin
           launch_options = {
                 :args => parse_app_launch_args(options),

data/lib/run_loop/cli/simctl.rb

@@ -37,7 +37,7 @@ module RunLoop
         end
       end
 
-      desc 'refresh', 'EXPERIMENTAL: Terminate CoreSimulatorService daemons'
+      desc 'doctor', 'EXPERIMENTAL: Prepare the CoreSimulator environment for testing'
 
       method_option 'debug',
                     :desc => 'Enable debug logging.',
@@ -46,23 +46,70 @@ module RunLoop
                     :default => false,
                     :type => :boolean
 
-      def refresh
+      method_option 'device',
+                    :desc => 'The simulator UDID or name.',
+                    :aliases => '-d',
+                    :required => false,
+                    :type => :string
+
+      def doctor
+        debug = options[:debug]
+        device = options[:device]
+
+        if device
+          device = expect_device(options)
+          if debug
+            RunLoop::Environment.with_debugging do
+              launch_simulator(device)
+            end
+          else
+            launch_simulator(device)
+          end
+        else
+          if debug
+            RunLoop::Environment.with_debugging do
+              launch_each_simulator
+            end
+          else
+            launch_each_simulator
+          end
+        end
+      end
+
+      no_commands do
+        def launch_each_simulator
+          sim_control = RunLoop::SimControl.new
+          sim_control.simulators.each do |simulator|
+            launch_simulator(simulator, sim_control)
+          end
+        end
+
+        def launch_simulator(simulator, sim_control=RunLoop::SimControl.new)
+          core_sim = RunLoop::LifeCycle::CoreSimulator.new(nil,
+                                                           simulator,
+                                                           sim_control)
+          core_sim.launch_simulator
+        end
+      end
+
+      desc 'manage-processes', 'Manage CoreSimulator processes by quiting stale processes'
+
+      method_option 'debug',
+                    :desc => 'Enable debug logging.',
+                    :aliases => '-v',
+                    :required => false,
+                    :default => false,
+                    :type => :boolean
+
+      def manage_processes
         debug = options[:debug]
         original_value = ENV['DEBUG']
 
         ENV['DEBUG'] = '1' if debug
 
-        RunLoop::SimControl.terminate_all_sims
-
         begin
-          process_name = 'com.apple.CoreSimulator.CoreSimulatorService'
-          pids = RunLoop::ProcessWaiter.new(process_name, {:timeout => 0.2}).pids
-          if debug && pids.empty?
-            puts 'There are no CoreSimulatorServices processes running'
-          end
-          pids.each do |pid|
-            RunLoop::ProcessTerminator.new(pid, 'KILL', process_name).kill_process
-          end
+          RunLoop::SimControl.terminate_all_sims
+          terminate_core_simulator_processes
         ensure
           ENV['DEBUG'] = original_value if debug
         end
@@ -78,6 +125,33 @@ module RunLoop
             device.state == 'Booted'
           end
         end
+
+        # TODO this is duplicated code; extract!
+        # https://github.com/calabash/run_loop/issues/225
+        def terminate_core_simulator_processes
+          to_manage = RunLoop::LifeCycle::CoreSimulator::MANAGED_PROCESSES
+          to_manage << ['com.apple.CoreSimulator.CoreSimulatorService', false]
+
+          to_manage.each do |pair|
+            name = pair[0]
+            send_term = pair[1]
+            pids = RunLoop::ProcessWaiter.new(name).pids
+            pids.each do |pid|
+
+              if send_term
+                term = RunLoop::ProcessTerminator.new(pid, 'TERM', name)
+                killed = term.kill_process
+              else
+                killed = false
+              end
+
+              unless killed
+                term = RunLoop::ProcessTerminator.new(pid, 'KILL', name)
+                term.kill_process
+              end
+            end
+          end
+        end
       end
 
       desc 'install --app [OPTIONS]', 'Installs an app on a device'
@@ -89,7 +163,7 @@ module RunLoop
                     :type => :string
 
       method_option 'device',
-                    :desc => 'The device UDID or simulator identifier.',
+                    :desc => 'The simulator UDID or name.',
                     :aliases => '-d',
                     :required => false,
                     :type => :string
@@ -122,6 +196,17 @@ module RunLoop
 
         bridge = RunLoop::Simctl::Bridge.new(device, app.path)
 
+        xcode = bridge.sim_control.xcode
+        if xcode.version >= RunLoop::Version.new('7.0')
+          puts "ERROR: Xcode #{xcode.version.to_s} detected."
+          puts "ERROR: Apple's simctl install/uninstall is broken for this version of Xcode."
+          puts "ERROR: See the following links for details:"
+          puts "ERROR: https://forums.developer.apple.com/message/51922"
+          puts "ERROR: https://github.com/calabash/run_loop/issues/235"
+          puts "ERROR: exiting 1"
+          exit 1
+        end
+
         force_reinstall = options[:force]
 
         before = Time.now

data/lib/run_loop/core.rb

@@ -68,6 +68,8 @@ module RunLoop
       nil
     end
 
+    # @deprecated 1.5.2 No public replacement.
+    #
     # Raise an error if the application binary is not compatible with the
     # target simulator.
     #
@@ -85,6 +87,7 @@ module RunLoop
     # @raise [RunLoop::IncompatibleArchitecture] Raises an error if the
     #  application binary is not compatible with the target simulator.
     def self.expect_compatible_simulator_architecture(launch_options, sim_control)
+      RunLoop.deprecated('1.5.2', 'No public replacement.')
       logger = launch_options[:logger]
       if sim_control.xcode_version_gte_6?
         sim_identifier = launch_options[:udid]
@@ -107,6 +110,30 @@ module RunLoop
       end
     end
 
+    # Raise an error if the application binary is not compatible with the
+    # target simulator.
+    #
+    # @note This method is implemented for CoreSimulator environments only;
+    #  for Xcode < 6.0 this method does nothing.
+    #
+    # @param [RunLoop::Device] device The device to install on.
+    # @param [RunLoop::App] app The app to install.
+    # @param [RunLoop::Xcode] xcode The active Xcode.
+    #
+    # @raise [RunLoop::IncompatibleArchitecture] Raises an error if the
+    #  application binary is not compatible with the target simulator.
+    def self.expect_simulator_compatible_arch(device, app, xcode)
+      if !xcode.version_gte_6?
+        RunLoop.log_warn("Checking for compatible arches is only available in CoreSimulator environments")
+        return
+      end
+
+      lipo = RunLoop::Lipo.new(app.path)
+      lipo.expect_compatible_arch(device)
+
+      RunLoop.log_debug("Simulator instruction set '#{device.instruction_set}' is compatible with '#{lipo.info}'")
+    end
+
     # Prepares the simulator for running.
     #
     # 1. enabling accessibility and software keyboard
@@ -135,17 +162,37 @@ module RunLoop
 
         # CoreSimulator
 
+        app_bundle_path = launch_options[:bundle_dir_or_bundle_id]
+        app = RunLoop::App.new(app_bundle_path)
+
+        unless app.valid?
+          if !File.exist?(app.path)
+            message = "App '#{app_bundle_path}' does not exist."
+          else
+            message = "App '#{app_bundle_path}' is not a valid .app bundle"
+          end
+          raise RuntimeError, message
+        end
+
         udid = launch_options[:udid]
         xcode = sim_control.xcode
 
-        device = sim_control.simulators.detect do |sim|
+        device = sim_control.simulators.find do |sim|
           sim.udid == udid || sim.instruments_identifier(xcode) == udid
         end
 
         if device.nil?
-          raise "Could not find simulator with name or UDID that matches: '#{udid}'"
+          raise RuntimeError,
+                "Could not find simulator with name or UDID that matches: '#{udid}'"
         end
 
+        # Validate the architecture.
+        self.expect_simulator_compatible_arch(device, app, xcode)
+
+        bridge = RunLoop::LifeCycle::CoreSimulator.new(app, device, sim_control)
+
+        bridge.ensure_app_same
+
         # Will quit the simulator if it is running.
         # @todo fix accessibility_enabled? so we don't have to quit the sim
         # SimControl#accessibility_enabled? is always false during Core#prepare_simulator
@@ -158,11 +205,10 @@ module RunLoop
         # https://github.com/calabash/run_loop/issues/167
         sim_control.ensure_software_keyboard(device)
 
+
         # Xcode 6.3 instruments cannot launch an app that is already installed on
         # iOS 8.3 Simulators. See: https://github.com/calabash/calabash-ios/issues/744
         if sim_control.xcode.version_gte_63?
-          app_bundle_path = launch_options[:bundle_dir_or_bundle_id]
-          bridge = RunLoop::Simctl::Bridge.new(device, app_bundle_path)
 
           if bridge.app_is_installed? && !sim_control.sim_is_running?
             bridge.launch_simulator
@@ -259,7 +305,6 @@ Please update your sources to pass an instance of RunLoop::Xcode))
       merged_options = options.merge(discovered_options)
 
       if self.simulator_target?(merged_options)
-        self.expect_compatible_simulator_architecture(merged_options, sim_control)
         self.prepare_simulator(merged_options, sim_control)
       end
 
@@ -286,34 +331,55 @@ Please update your sources to pass an instance of RunLoop::Xcode))
 
       uia_timeout = options[:uia_timeout] || RunLoop::Environment.uia_timeout || 10
 
-      after = Time.now
-      RunLoop::Logging.log_debug(logger, "Preparation took #{after-before} seconds")
+      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]
 
-      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}")
+
+          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}")
-        raise RunLoop::TimeoutError, "Time out waiting for UIAutomation run-loop #{e}. \n Logfile #{log_file} \n\n #{File.read(log_file)}\n"
+
+        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} seconds")
+      RunLoop::Logging.log_debug(logger, "Launching took #{Time.now-before_instruments_launch} seconds")
 
       dylib_path = self.dylib_path_from_options(merged_options)
 
@@ -324,6 +390,7 @@ Please update your sources to pass an instance of RunLoop::Xcode))
         lldb.retriable_inject_dylib
       end
 
+      RunLoop.log_debug("It took #{Time.now - before} seconds to launch the app")
       run_loop
     end
 
@@ -360,131 +427,148 @@ Please update your sources to pass an instance of RunLoop::Xcode))
     def self.simulator_target?(run_options, sim_control=nil)
       value = run_options[:device_target]
 
-      # match the behavior of udid_and_bundle_for_launcher
+      # Match the behavior of udid_and_bundle_for_launcher.
       return true if value.nil? or value == ''
 
-      # support for 'simulator' and Xcode >= 5.1 device targets
+      # 5.1 <= Xcode < 7.0
       return true if value.downcase.include?('simulator')
 
-      value[DEVICE_UDID_REGEX, 0] == nil
+      # Not a physical device.
+      return false if value[DEVICE_UDID_REGEX, 0] != nil
+
+      # Check for named simulators and Xcode >= 7.0 simulators.
+      sim_control = run_options[:sim_control] || RunLoop::SimControl.new
+      xcode = sim_control.xcode
+      if xcode.version_gte_6?
+        simulator = sim_control.simulators.find do |sim|
+          sim.instruments_identifier(xcode) == value ||
+                sim.udid == value
+        end
+        !simulator.nil?
+      else
+        false
+      end
     end
 
-    # Extracts the value of :inject_dylib from options Hash.
-    # @param options [Hash] arguments passed to {RunLoop.run}
-    # @return [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.
-    # @raise [RuntimeError] If :inject_dylib points to a path that does not exist.
-    # @raise [ArgumentError] If :inject_dylib is not a String.
-    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
+
+  # Extracts the value of :inject_dylib from options Hash.
+  # @param options [Hash] arguments passed to {RunLoop.run}
+  # @return [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.
+  # @raise [RuntimeError] If :inject_dylib points to a path that does not exist.
+  # @raise [ArgumentError] If :inject_dylib is not a String.
+  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
 
-    # 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.
-    #
-    # @param [RunLoop::XCTools, RunLoop::XCode] xcode Used to detect the current xcode
-    #  version.
-    def self.default_simulator(xcode=RunLoop::Xcode.new)
-      if xcode.is_a?(RunLoop::XCTools)
-        RunLoop.deprecated('1.5.0',
-                           %q(
+  # 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.
+  #
+  # @param [RunLoop::XCTools, RunLoop::XCode] xcode Used to detect the current xcode
+  #  version.
+  def self.default_simulator(xcode=RunLoop::Xcode.new)
+    if xcode.is_a?(RunLoop::XCTools)
+      RunLoop.deprecated('1.5.0',
+                         %q(
 RunLoop::XCTools has been replaced with RunLoop::Xcode.
 Please update your sources to pass an instance of RunLoop::Xcode))
-      end
+    end
 
-      if 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)'
-      elsif xcode.version_gte_6?
-        'iPhone 5s (8.0 Simulator)'
-      else
-        'iPhone Retina (4-inch) - Simulator - iOS 7.1'
-      end
+    if 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)'
+    elsif xcode.version_gte_6?
+      'iPhone 5s (8.0 Simulator)'
+    else
+      'iPhone Retina (4-inch) - Simulator - iOS 7.1'
     end
+  end
 
-    def self.udid_and_bundle_for_launcher(device_target, options, sim_control=RunLoop::SimControl.new)
-      xcode = sim_control.xcode
+  def self.udid_and_bundle_for_launcher(device_target, options, sim_control=RunLoop::SimControl.new)
+    xcode = sim_control.xcode
 
-      bundle_dir_or_bundle_id = options[:app] || RunLoop::Environment.bundle_id || RunLoop::Environment.path_to_app_bundle
+    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
+    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
+    udid = nil
 
-      if xcode.version_gte_51?
-        if device_target.nil? || device_target.empty? || device_target == 'simulator'
-          device_target = self.default_simulator(xcode)
-        end
-        udid = device_target
+    if xcode.version_gte_51?
+      if device_target.nil? || device_target.empty? || device_target == 'simulator'
+        device_target = self.default_simulator(xcode)
+      end
+      udid = device_target
 
-        unless self.simulator_target?(options)
-          bundle_dir_or_bundle_id = options[:bundle_id] if options[:bundle_id]
-        end
-      else
-        #TODO: this can be removed - Xcode < 5.1.1 not supported.
-        if device_target == 'simulator'
+      unless self.simulator_target?(options)
+        bundle_dir_or_bundle_id = options[:bundle_id] if options[:bundle_id]
+      end
+    else
+      #TODO: this can be removed - Xcode < 5.1.1 not supported.
+      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
+        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
+        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}'")
+        plistbuddy='/usr/libexec/PlistBuddy'
+        plistfile="#{bundle_dir_or_bundle_id}/Info.plist"
+        if device == :iphone
+          uidevicefamily=1
         else
-          udid = device_target
-          bundle_dir_or_bundle_id = options[:bundle_id] if options[:bundle_id]
+          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
-      return udid, bundle_dir_or_bundle_id
     end
+    return udid, bundle_dir_or_bundle_id
+  end
 
-    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
+  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
-      rescue RunLoop::TimeoutError => _
+      end
+    rescue RunLoop::TimeoutError => _
         raise RunLoop::TimeoutError, 'Unable to create pipe (mkfifo failed)'
       end
     end