run_loop 2.2.4 → 2.3.0

data/lib/run_loop/device.rb

@@ -31,7 +31,7 @@ module RunLoop
       # exceeded - if the default 30 seconds has passed, the
       # simulator is probably stable enough for subsequent
       # operations.
-      :timeout => RunLoop::Environment.ci? ? 120 : 30
+      :timeout => RunLoop::Environment.ci? ? 240 : 120
     }
 
     attr_reader :name
@@ -322,124 +322,54 @@ version: #{version}
     end
 
     # @!visibility private
-    #
-    # Waits for three conditions:
-    #
-    # 1. The SHA sum of the simulator data/ directory to be stable.
-    # 2. No more log messages are begin generated.
-    # 3. 1 and 2 must hold for 1.5 seconds.
-    #
-    # When the simulator version is >= iOS 9, two more conditions are added to
-    # get past the iOS 9+ boot screen.
-    #
-    # 4. Wait for com.apple.audio.SystemSoundServer-iOS-Simulator process to
-    #    start.
-    # 5. 1 and 2 must hold for 1.5 seconds.
-    #
-    # When the simulator version is >= iOS 9 and the device is an iPad another
-    # condition is added because simctl fails to correctly install applications;
-    # the app and data container exists, but Springboard does not detect them.
-    #
-    # 6. 1 and 2 must hold for 1.5 seconds.
-    #
-    # TODO needs update for Xcode 8 + iOS 10 simulators.
-    def simulator_wait_for_stable_state
-
-      # How long to wait between stability checks.
-      # Shorter than this gives false positives.
-      delay = 0.5
-
-      # How many times to wait for stable state.
-      max_stable_count = 3
-
-      # How long to wait for iOS 9 boot screen.
-      boot_screen_wait_options = {
-        :max_boot_screen_wait => 10,
-        :raise_on_timeout => false
-      }
-
-      # How much additional time to wait for iOS 9+ iPads.
-      #
-      # Installing and launching on iPads is problematic.
-      # Sometimes the app is installed, but SpringBoard does
-      # not recognize that the app is installed even though
-      # simctl says that it is.
-      additional_ipad_delay = delay * 2
-
-      # Adjust for CI environments
-      if RunLoop::Environment.ci?
-        max_stable_count = 5
-        boot_screen_wait_options[:max_boot_screen_wait] = 20
-        additional_ipad_delay = delay * 4
-      end
-
-      # iOS 9 simulators have an additional boot screen.
-      is_gte_ios9 = version >= RunLoop::Version.new('9.0')
-
-      # Xcode 8 simulators do not need to wait for log file
-      is_xcode8 = RunLoop::Xcode.new.version_gte_8?
+    # In megabytes
+    def simulator_size_on_disk
+      data_path = File.join(simulator_root_dir, 'data')
+      RunLoop::Directory.size(data_path, :mb)
+    end
 
-      # iOS > 9 iPad simulators need additional time to stabilize, especially
-      # to ensure that `simctl install` notifies SpringBoard that a new app
-      # has been installed.
-      is_ipad = simulator_is_ipad?
+    # @!visibility private
+    def simulator_wait_for_stable_state
+      required = simulator_required_child_processes
 
       timeout = SIM_STABLE_STATE_OPTIONS[:timeout]
       now = Time.now
       poll_until = now + timeout
 
       RunLoop.log_debug("Waiting for simulator to stabilize with timeout: #{timeout} seconds")
+      footprint = simulator_size_on_disk
 
-      current_dir_sha = simulator_data_directory_sha
-      if is_xcode8
-        current_log_sha = true
-      else
-        current_log_sha = simulator_log_file_sha
-      end
-
-      is_stable = false
-      waited_for_boot = false
-      waited_for_ipad = false
-      stable_count = 0
-
-      while Time.now < poll_until do
-        latest_dir_sha = simulator_data_directory_sha
-        if is_xcode8
-          latest_log_sha = true
+      if version.major >= 9 && footprint < 18
+        first_launch = true
+      elsif version.major == 8
+        if version.minor >= 3 && footprint < 19
+          first_launch = true
         else
-          latest_log_sha = simulator_log_file_sha
+          first_launch = footprint < 11
         end
+      else
+        first_launch = false
+      end
 
-        is_stable = [current_dir_sha == latest_dir_sha,
-                     current_log_sha == latest_log_sha].all?
-
-        if is_stable
-          stable_count = stable_count + 1
-          if stable_count == max_stable_count
-            if is_gte_ios9 && !waited_for_boot
-              process_name = "com.apple.audio.SystemSoundServer-iOS-Simulator"
-              RunLoop::ProcessWaiter.new(process_name, boot_screen_wait_options).wait_for_any
-              waited_for_boot = true
-              stable_count = 0
-            elsif is_gte_ios9 && is_ipad && !waited_for_ipad
-              RunLoop.log_debug("Waiting additional time for iOS 9 iPad to stabilize")
-              sleep(additional_ipad_delay)
-              waited_for_ipad = true
-              stable_count = 0
-            else
-              break
-            end
+      while !required.empty? && Time.now < poll_until do
+        sleep(0.5)
+        required = required.map do |process_name|
+          if simulator_process_running?(process_name)
+            nil
+          else
+            process_name
           end
-        end
-
-        current_dir_sha = latest_dir_sha
-        current_log_sha = latest_log_sha
-        sleep(delay)
+        end.compact
       end
 
-      if is_stable
+      if required.empty?
         elapsed = Time.now - now
-        RunLoop.log_debug("Waited a total of #{elapsed} seconds for simulator to stabilize")
+        RunLoop.log_debug("All required simulator processes have started after #{elapsed}")
+        if first_launch
+          RunLoop.log_debug("Detected a first launch, waiting a little longer - footprint was #{footprint} MB")
+          sleep(RunLoop::Environment.ci? ? 10 : 5)
+        end
+        RunLoop.log_debug("Waited for #{elapsed} seconds for simulator to stabilize")
       else
         RunLoop.log_debug("Timed out after #{timeout} seconds waiting for simulator to stabilize")
       end
@@ -541,9 +471,61 @@ failed with this output:
       simulator_languages
     end
 
+    # @!visibility private
+    def simulator_running_app_details
+      pids = simulator_running_app_pids
+      running_apps = {}
+
+      pids.each do |pid|
+        cmd = ["ps", "-o", "comm=", "-p", pid.to_s]
+
+        hash = run_shell_command(cmd)
+        out = hash[:out]
+
+        if out.nil? || out == "" || out.strip.nil?
+          nil
+        else
+          name = out.strip.split("/").last
+
+          cmd = ["ps", "-o", "command=", "-p", pid.to_s]
+          hash = run_shell_command(cmd)
+          out = hash[:out]
+
+          if out.nil? || out == "" || out.strip.nil?
+            nil
+          else
+            tokens = out.split("#{name} ")
+
+            # No arguments
+            if tokens.count == 1
+              args = ""
+            else
+              args = tokens.last.strip
+            end
+
+            running_apps[name] = {
+              args: args,
+              command: out.strip
+            }
+          end
+        end
+      end
+
+      running_apps
+    end
+
+=begin
+  PRIVATE METHODS
+=end
+
     private
 
-    attr_reader :pbuddy, :simctl, :xcrun
+    attr_reader :pbuddy, :simctl, :xcrun, :xcode
+
+    # @!visibility private
+    def xcode
+      @xcode ||= RunLoop::Xcode.new
+    end
 
     # @!visibility private
     def xcrun
@@ -610,6 +592,76 @@ failed with this output:
       udid
     end
 
+    # @!visibility private
+    def simulator_required_child_processes
+      @simulator_required_child_processes ||= begin
+        required = ["backboardd", "installd", "SimulatorBridge", "SpringBoard"]
+        if xcode.version_gte_8? && version.major > 8
+          required << "medialibraryd"
+        end
+
+        if simulator_is_ipad? && version.major == 9
+          required << "com.apple.audio.SystemSoundServer-iOS-Simulator"
+        end
+
+        required
+      end
+    end
+
+    # @!visibility private
+    def simulator_launchd_sim_pid
+      waiter = RunLoop::ProcessWaiter.new("launchd_sim")
+      waiter.wait_for_any
+
+      return nil if !waiter.running_process?
+
+      pid = nil
+
+      waiter.pids.each do |launchd_sim_pid|
+        cmd = ["ps", "x", "-o", "pid,command", launchd_sim_pid.to_s]
+        hash = run_shell_command(cmd)
+        out = hash[:out]
+        process_line = out.split($-0)[1]
+        if !process_line || process_line == ""
+          false
+        else
+          pid = process_line.split(" ").first.strip
+          if process_line[/#{udid}/] == nil
+            RunLoop.log_debug("Terminating launchd_sim process with pid #{pid}")
+            RunLoop::ProcessTerminator.new(pid, "KILL", "launchd_sim").kill_process
+            pid = nil
+          end
+        end
+      end
+      pid
+    end
+
+    # @!visibility private
+    def process_parent_is_launchd_sim?(pid)
+      launchd_sim_pid = simulator_launchd_sim_pid
+      return false if !launchd_sim_pid
+
+      cmd = ["ps", "x", "-o", "ppid=", "-p", pid.to_s]
+      hash = run_shell_command(cmd)
+
+      out = hash[:out]
+      if out.nil? || out == ""
+        false
+      else
+        ppid = out.strip
+        ppid == launchd_sim_pid.to_s
+      end
+    end
+
+    # @!visibility private
+    def simulator_process_running?(process_name)
+      waiter = RunLoop::ProcessWaiter.new(process_name)
+      waiter.pids.any? do |pid|
+        process_parent_is_launchd_sim?(pid)
+        #process_parent_is_current_xcode?(pid)
+      end
+    end
+
     # @!visibility private
     def simulator_data_directory_sha
       path = File.join(simulator_root_dir, 'data')
@@ -688,6 +740,26 @@ https://github.com/calabash/calabash-ios/wiki/Testing-on-Physical-Devices
       end
       true
     end
+
+    # @!visibility private
+    def simulator_running_app_pids
+      simulator_running_user_app_pids +
+        simulator_running_system_app_pids
+    end
+
+    # @!visibility private
+    def simulator_running_user_app_pids
+      path = File.join(udid, "data", "Containers", "Bundle")
+      RunLoop::ProcessWaiter.pgrep_f(path)
+    end
+
+    # @!visibility private
+    def simulator_running_system_app_pids
+      base_dir = xcode.developer_dir
+      sim_apps_dir = "Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator.sdk/Applications"
+      path = File.expand_path(File.join(base_dir, sim_apps_dir))
+      RunLoop::ProcessWaiter.pgrep_f(path)
+    end
   end
 end
 

data/lib/run_loop/device_agent/client.rb

@@ -38,12 +38,20 @@ module RunLoop
 
         # Ignored in the XTC.
         # This key is subject to removal or changes
-        :device_agent_install_timeout => RunLoop::Environment.ci? ? 120 : 90,
+        :device_agent_install_timeout => RunLoop::Environment.ci? ? 240 : 120,
         # This value must always be false on the XTC.
         # This is should only be used by gem maintainers or very advanced users.
-        :shutdown_device_agent_before_launch => false
+        :shutdown_device_agent_before_launch => false,
+
+        # This value was derived empirically by typing hundreds of strings
+        # using XCUIElement#typeText.  It corresponds to the DeviceAgent
+        # constant CBX_DEFAULT_SEND_STRING_FREQUENCY which is 60.  _Decrease_
+        # this value if you are timing out typing strings.
+        :characters_per_second => 12
       }
 
+      AUT_LAUNCHED_BY_RUN_LOOP_ARG = "LAUNCHED_BY_RUN_LOOP"
+
       # @!visibility private
       #
       # These defaults may change at any time.
@@ -67,7 +75,6 @@ module RunLoop
 
       # @!visibility private
       def self.run(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
@@ -88,10 +95,19 @@ module RunLoop
         default_options = {
             :xcode => xcode
         }
+
         merged_options = default_options.merge(options)
 
         if device.simulator? && app
+          RunLoop::Core.expect_simulator_compatible_arch(device, app)
+
+          if merged_options[:relaunch_simulator]
+            RunLoop.log_debug("Detected :relaunch_simulator option; will force simulator to restart")
+            RunLoop::CoreSimulator.quit_simulator
+          end
+
           core_sim = RunLoop::CoreSimulator.new(device, app, merged_options)
+
           if reset_options
             core_sim.reset_app_sandbox
           end
@@ -100,7 +116,7 @@ module RunLoop
           core_sim.install
         end
 
-        cbx_launcher = Client.detect_cbx_launcher(options, device)
+        cbx_launcher = Client.detect_cbx_launcher(merged_options, device)
 
         code_sign_identity = options[:code_sign_identity]
         if !code_sign_identity
@@ -114,6 +130,10 @@ module RunLoop
         aut_args = options.fetch(:args, [])
         aut_env = options.fetch(:env, {})
 
+        if !aut_args.include?(AUT_LAUNCHED_BY_RUN_LOOP_ARG)
+          aut_args << AUT_LAUNCHED_BY_RUN_LOOP_ARG
+        end
+
         launcher_options = {
             code_sign_identity: code_sign_identity,
             device_agent_install_timeout: install_timeout,
@@ -282,6 +302,9 @@ INSTANCE METHODS
       # @!visibility private
       #
       # Experimental!
+      #
+      # This will launch the other app using the same arguments and environment
+      # as the AUT.
       def launch_other_app(bundle_id)
         launch_aut(bundle_id)
       end
@@ -327,7 +350,9 @@ INSTANCE METHODS
 
       # @!visibility private
       def clear_text
-        options = enter_text_http_options
+        # Tries to touch the keyboard delete key, but falls back on typing the
+        # backspace character.
+        options = enter_text_http_options("\b")
         parameters = {
           :gesture => "clear_text"
         }
@@ -342,7 +367,7 @@ INSTANCE METHODS
         if !keyboard_visible?
           raise RuntimeError, "Keyboard must be visible"
         end
-        options = enter_text_http_options
+        options = enter_text_http_options(string.to_s)
         parameters = {
           :gesture => "enter_text",
           :options => {
@@ -362,7 +387,7 @@ INSTANCE METHODS
       # 1. Removes duplicate check.
       # 2. It turns out DeviceAgent query can be very slow.
       def enter_text_without_keyboard_check(string)
-        options = enter_text_http_options
+        options = enter_text_http_options(string.to_s)
         parameters = {
           :gesture => "enter_text",
           :options => {
@@ -752,6 +777,20 @@ Timed out after #{timeout} seconds waiting for the keyboard to appear.
         end
       end
 
+      # @!visibility private
+      def wait_for_no_keyboard(timeout=WAIT_DEFAULTS[:timeout])
+        options = WAIT_DEFAULTS.dup
+        options[:timeout] = timeout
+        message = %Q[
+
+Timed out after #{timeout} seconds waiting for the keyboard to disappear.
+
+]
+        wait_for(message, options) do
+          !keyboard_visible?
+        end
+      end
+
       # @!visibility private
       def wait_for_alert(timeout=WAIT_DEFAULTS[:timeout])
         options = WAIT_DEFAULTS.dup
@@ -784,23 +823,52 @@ Timed out after #{timeout} seconds waiting for an alert to disappear.
       # @!visibility private
       def wait_for_text_in_view(text, uiquery, options={})
         merged_options = WAIT_DEFAULTS.merge(options)
-        result = wait_for_view(uiquery, merged_options)
-
-        # This is not quite right.  It is possible to get a false positive.
-        # If result does not have "value" or "label" and the text is nil
-        candidates = [result["value"],
-                      result["label"]]
-        match = candidates.any? do |elm|
-          elm == text
-        end
-        if !match
-          fail(%Q[
 
-Expected to find '#{text}' as a 'value' or 'label' in
+        begin
+          wait_for("TMP", merged_options) do
+            view = query(uiquery).first
+
+            if view
+              # Guard against this edge case:
+              #
+              # Text is "" and value or label keys do not exist in view which
+              # implies that value or label was the empty string (see the
+              # DeviceAgent JSONUtils and Facebook macros).
+              if text == "" || text == nil
+                view["value"] == nil && view["label"] == nil
+              else
+                [view["value"], view["label"]].any? { |elm| elm == text }
+              end
+            else
+              false
+            end
+          end
+        rescue merged_options[:exception_class] => e
+          view = query(uiquery)
+          if !view
+            message = %Q[
+Timed out wait after #{merged_options[:timeout]} seconds waiting for a view to match:
 
-#{JSON.pretty_generate(result)}
+  #{uiquery}
 
-])
+]
+          else
+            message = %Q[
+Timed out after #{merged_options[:timeout]} seconds waiting for a view matching:
+
+  '#{uiquery}'
+
+to have 'value' or 'label' matching text:
+
+  '#{text}'
+
+Found:
+
+#{JSON.pretty_generate(view)}
+
+]
+          end
+          fail(merged_options[:exception_class], message)
         end
       end
 
@@ -1069,8 +1137,11 @@ PRIVATE
       # @!visibility private
       #
       # A patch while we are trying to figure out what is wrong with text entry.
-      def enter_text_http_options
-        timeout = DEFAULTS[:http_timeout] * 6
+      def enter_text_http_options(string)
+        characters = string.length + 1
+        characters_per_second = DEFAULTS[:characters_per_second]
+        to_type_timeout = [characters/characters_per_second, 2.0].max
+        timeout = (DEFAULTS[:http_timeout] * 3) + to_type_timeout
         {
           :timeout => timeout,
           :interval => 0.1,
@@ -1178,21 +1249,26 @@ PRIVATE
         hash
       end
 
-      # TODO Might not be necessary - this is an edge case and it is likely
-      # that iOSDeviceManager will be able to handle this for us.
+      # @!visibility private
       def cbx_runner_stale?
-        false
-        # The RunLoop::Version class needs to be updated to handle timestamps.
-        #
-        # if cbx_launcher.name == :xcodebuild
-        #   return false
-        # end
+        return false if RunLoop::Environment.xtc?
+        return false if cbx_launcher.name == :xcodebuild
+        return false if !running?
+
+        version_info = server_version
+        running_version_timestamp = version_info[:bundle_version].to_i
+
+        app = RunLoop::App.new(cbx_launcher.runner.runner)
+        plist_buddy = RunLoop::PlistBuddy.new
+        version_timestamp = plist_buddy.plist_read("CFBundleVersion", app.info_plist_path).to_i
 
-        # version_info = server_version
-        # running_bundle_version = RunLoop::Version.new(version_info[:bundle_version])
-        # bundle_version = RunLoop::App.new(cbx_launcher.runner.runner).bundle_version
-        #
-        # running_bundle_version < bundle_version
+        if running_version_timestamp == version_timestamp
+          RunLoop.log_debug("The running DeviceAgent version is the same as the version on disk")
+          false
+        else
+          RunLoop.log_debug("The running DeviceAgent version is not the same as the version on disk")
+          true
+        end
       end
 
       # @!visibility private
@@ -1289,7 +1365,7 @@ Please install it.
           client = http_client(http_options)
           request = request("session",
                             {
-                              :bundleID => bundle_id,
+                              :bundle_id => bundle_id,
                               :launchArgs => aut_args,
                               :environment => aut_env
                             })