run_loop 2.1.7 → 2.1.8

data/lib/run_loop/device_agent/ios_device_manager.rb

@@ -5,7 +5,15 @@ module RunLoop
     # @!visibility private
     #
     # A wrapper around the test-control binary.
-    class IOSDeviceManager < RunLoop::DeviceAgent::Launcher
+    class IOSDeviceManager < RunLoop::DeviceAgent::LauncherStrategy
+
+      EXIT_CODES = {
+        "0" => :success,
+        "2" => :false
+      }.freeze
+
+      require "run_loop/shell"
+      include RunLoop::Shell
 
       # @!visibility private
       @@ios_device_manager = nil
@@ -40,7 +48,7 @@ but binary does not exist at that path.
 
       # @!visibility private
       def name
-        :xctestctl
+        :ios_device_manager
       end
 
       # @!visibility private
@@ -55,56 +63,73 @@ but binary does not exist at that path.
 
       # @!visibility private
       def runner
-        @runner ||= RunLoop::DeviceAgent::CBXRunner.new(device)
+        @runner ||= RunLoop::DeviceAgent::Runner.new(device)
       end
 
       # @!visibility private
       def self.log_file
-        path = File.join(Launcher.dot_dir, "ios-device-manager.log")
+        path = File.join(LauncherStrategy.dot_dir, "ios-device-manager.log")
         FileUtils.touch(path) if !File.exist?(path)
         path
       end
 
       # @!visibility private
-      def launch
+      def launch(options)
+        code_sign_identity = options[:code_sign_identity]
+
         RunLoop::DeviceAgent::Frameworks.instance.install
+        cmd = RunLoop::DeviceAgent::IOSDeviceManager.ios_device_manager
 
-        # WIP: it is unclear what the behavior should be.
+        start = Time.now
         if device.simulator?
-          # Simulator cannot be running for this version.
-          CoreSimulator.quit_simulator
+          cbxapp = RunLoop::App.new(runner.runner)
 
-          CoreSimulator.wait_for_simulator_state(device, "Shutdown")
+          # quits the simulator
+          sim = CoreSimulator.new(device, cbxapp)
+          sim.install
+          sim.launch_simulator
+        else
 
-          # TODO: run-loop is responsible for detecting an outdated CBX-Runner
-          # application and installing a new one.  However, iOSDeviceManager
-          # fails if simulator is already running.
+          if !code_sign_identity
+            raise ArgumentError, %Q[
+Targeting a physical devices requires a code signing identity.
 
-          # cbxapp = RunLoop::App.new(runner.runner)
-          #
-          # # quits the simulator
-          # sim = CoreSimulator.new(device, cbxapp)
-          # sim.install
-          # sim.launch_simulator
-        end
+Rerun your test with:
 
-        cmd = RunLoop::DeviceAgent::IOSDeviceManager.ios_device_manager
+$ CODE_SIGN_IDENTITY="iPhone Developer: Your Name (ABCDEF1234)" cucumber
 
-        args = ["start_test",
-                "-r", runner.runner,
-                "-t", runner.tester,
-                "-d", device.udid]
+]
+          end
 
-        code_sign_identity = RunLoop::Environment.code_sign_identity
-        if !code_sign_identity
-          code_sign_identity = "iPhone Developer"
-        end
+          options = {:log_cmd => true}
+          args = [
+            cmd, "install",
+            "--device-id", device.udid,
+            "--app-bundle", runner.runner,
+            "--codesign-identity", code_sign_identity
+          ]
 
-        if device.physical_device?
-          args << "-c"
-          args << code_sign_identity
+          start = Time.now
+          hash = run_shell_command(args, options)
+
+
+          if hash[:exit_status] != 0
+            raise RuntimeError, %Q[
+
+Could not install #{runner.runner}.  iOSDeviceManager says:
+
+#{hash[:out]}
+
+            ]
+          end
         end
 
+        RunLoop::log_debug("Took #{Time.now - start} seconds to install DeviceAgent");
+
+        cmd = RunLoop::DeviceAgent::IOSDeviceManager.ios_device_manager
+
+        args = ["start_test", "--device-id", device.udid]
+
         log_file = IOSDeviceManager.log_file
         FileUtils.rm_rf(log_file)
         FileUtils.touch(log_file)
@@ -122,11 +147,51 @@ but binary does not exist at that path.
         Process.detach(pid)
 
         if device.simulator?
-          device.simulator_wait_for_stable_state
+          # Give it a whirl.
+          # device.simulator_wait_for_stable_state
         end
 
         pid.to_i
       end
+
+      def app_installed?(bundle_identifier)
+        options = {:log_cmd => true}
+
+        cmd = RunLoop::DeviceAgent::IOSDeviceManager.ios_device_manager
+
+        args = [
+          cmd, "is_installed",
+          "--device-id", device.udid,
+          "--bundle-identifier", bundle_identifier
+        ]
+
+        start = Time.now
+        hash = run_shell_command(args, options)
+
+        exit_status = EXIT_CODES[hash[:exit_status].to_s]
+        if exit_status == :success
+          true
+        elsif exit_status == :false
+          false
+        else
+          raise RuntimeError, %Q[
+
+Could not check if app is installed:
+
+bundle identifier: #{bundle_identifier}
+           device: #{device}
+
+iOSDeviceManager says:
+
+#{hash[:out]}
+
+]
+        end
+
+        RunLoop::log_debug("Took #{Time.now - start} seconds to check if app was installed");
+
+        hash[:exit_status] == 0
+      end
     end
   end
 end

data/lib/run_loop/device_agent/{launcher.rb → launcher_strategy.rb}

@@ -4,9 +4,9 @@ module RunLoop
   module DeviceAgent
     # @!visibility private
     #
-    # An abstract base class for something that can launch the CBXRunner on a
-    # device.  The CBXRunner is AKA the DeviceAgent.
-    class Launcher
+    # A base class for something that can launch the DeviceAgent-Runner on a
+    # device.
+    class LauncherStrategy
       require "run_loop/abstract"
       include RunLoop::Abstract
 
@@ -14,7 +14,7 @@ module RunLoop
       attr_reader :device
 
       # @!visibility private
-      # @param [RunLoop::Device] device where to launch the CBX-Runner
+      # @param [RunLoop::Device] device where to launch the DeviceAgent-Runner
       def initialize(device)
         @device = device
 
@@ -24,7 +24,7 @@ Invalid device:
 
 #{device}
 
-XCUITest is only available for iOS >= 9.0
+DeviceAgent is only available for iOS >= 9.0
 ]
         end
       end
@@ -32,15 +32,15 @@ XCUITest is only available for iOS >= 9.0
       # @!visibility private
       # The name of this launcher. Must be a symbol (keyword).  This value will
       # be used for the key :cbx_launcher in the RunLoop::Cache so Calabash
-      # iOS can attach and reattach to an XCUITest instance.
+      # iOS can attach and reattach to a DeviceAgent instance.
       def name
         abstract_method!
       end
 
       # @!visibility private
       #
-      # Does whatever it takes to launch the CBX-Runner on the device.
-      def launch
+      # Does whatever it takes to launch the DeviceAgent-Runner on the device.
+      def launch(options)
         abstract_method!
       end
 

data/lib/run_loop/device_agent/{cbxrunner.rb → runner.rb}

@@ -3,8 +3,7 @@ module RunLoop
   # @!visibility private
   module DeviceAgent
     # @!visibility private
-    class CBXRunner
-
+    class Runner
 
       # @!visibility private
       @@cbxdevice = nil
@@ -19,7 +18,7 @@ module RunLoop
 
       # @!visibility private
       def self.detect_cbxsim
-        @@cbxsim ||= lambda do
+        @@cbxsim ||= begin
           from_env = RunLoop::Environment.cbxsim
 
           if from_env
@@ -37,12 +36,12 @@ but runner does not exist at that path.
           else
             self.default_cbxsim
           end
-        end.call
+        end
       end
 
       # @!visibility private
       def self.detect_cbxdevice
-        @@cbxdevice ||= lambda do
+        @@cbxdevice ||= begin
           from_env = RunLoop::Environment.cbxdevice
 
           if from_env
@@ -60,12 +59,12 @@ but runner does not exist at that path.
           else
             self.default_cbxdevice
           end
-        end.call
+        end
       end
 
       # @!visibility private
       def self.default_cbxdevice
-        cbx = File.join(self.device_agent_dir, "ipa", "CBX-Runner.app")
+        cbx = File.join(self.device_agent_dir, "ipa", "DeviceAgent-Runner.app")
 
         if !File.exist?(cbx)
           self.expand_runner_archive("#{cbx}.zip")
@@ -76,7 +75,7 @@ but runner does not exist at that path.
 
       # @!visibility private
       def self.default_cbxsim
-        cbx = File.join(self.device_agent_dir, "app", "CBX-Runner.app")
+        cbx = File.join(self.device_agent_dir, "app", "DeviceAgent-Runner.app")
 
         if !File.exist?(cbx)
           self.expand_runner_archive("#{cbx}.zip")
@@ -86,22 +85,13 @@ 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
-        end.new
-
         dir = File.dirname(archive)
         options = { :log_cmd => true }
         Dir.chdir(dir) do
-          RunLoop.log_unix_cmd("cd #{dir}")
-          shell.run_shell_command(["ditto", "-xk", File.basename(archive), "."], options)
+          Shell.run_shell_command(["ditto", "-xk", File.basename(archive), "."], options)
         end
-        File.join(dir, "CBX-Runner.app")
+        File.join(dir, "DeviceAgent-Runner.app")
       end
 
       # @!visibility private
@@ -115,18 +105,18 @@ but runner does not exist at that path.
 
       # @!visibility private
       def runner
-        @runner ||= lambda do
+        @runner ||= begin
           if device.physical_device?
-            RunLoop::DeviceAgent::CBXRunner.detect_cbxdevice
+            RunLoop::DeviceAgent::Runner.detect_cbxdevice
           else
-            RunLoop::DeviceAgent::CBXRunner.detect_cbxsim
+            RunLoop::DeviceAgent::Runner.detect_cbxsim
           end
-        end.call
+        end
       end
 
       # @!visibility private
       def tester
-        @tester ||= File.join(runner, "PlugIns", "CBX.xctest")
+        @tester ||= File.join(runner, "PlugIns", "DeviceAgent.xctest")
       end
 
       # @!visibility private
@@ -143,7 +133,7 @@ but runner does not exist at that path.
 
       # @!visibility private
       def info_plist
-        @info_plist ||= File.join(runner, "PlugIns", "CBX.xctest", "Info.plist")
+        @info_plist ||= File.join(runner, "Info.plist")
       end
 
       # @!visibility private

data/lib/run_loop/device_agent/xcodebuild.rb

@@ -5,7 +5,7 @@ module RunLoop
   module DeviceAgent
 
     # @!visibility private
-    class Xcodebuild < RunLoop::DeviceAgent::Launcher
+    class Xcodebuild < RunLoop::DeviceAgent::LauncherStrategy
 
       # @!visibility private
       def self.log_file
@@ -30,7 +30,7 @@ module RunLoop
       end
 
       # @!visibility private
-      def launch
+      def launch(_)
         workspace
 
         if device.simulator?
@@ -48,14 +48,25 @@ module RunLoop
 
       # @!visibility private
       def workspace
-        @workspace ||= lambda do
-          path = RunLoop::Environment.send(:cbxws)
-          if path
+        @workspace ||= begin
+          path = RunLoop::Environment.send(:cbxws) || default_workspace
+
+          if File.exist?(path)
             path
           else
-            raise "The CBXWS env var is undefined. Are you a maintainer?"
+            raise(RuntimeError, %Q[
+Cannot find the DeviceAgent.xcworkspace.
+
+Expected it here:
+
+  #{path}
+
+Use the CBXWS environment variable to override the default.
+
+])
+
           end
-        end.call
+        end
       end
 
       # @!visibility private
@@ -68,7 +79,7 @@ module RunLoop
         args = [
           "xcrun",
           "xcodebuild",
-          "-scheme", "CBXAppStub",
+          "-scheme", "AppStub",
           "-workspace", workspace,
           "-config", "Debug",
           "-destination",
@@ -95,6 +106,12 @@ module RunLoop
         Process.detach(pid)
         pid.to_i
       end
+
+      def default_workspace
+        this_dir = File.expand_path(File.dirname(__FILE__))
+        relative = File.expand_path(File.join(this_dir, "..", "..", "..", ".."))
+        File.join(relative, "DeviceAgent.iOS/DeviceAgent.xcworkspace")
+      end
     end
   end
 end

data/lib/run_loop/environment.rb

@@ -316,9 +316,11 @@ module RunLoop
     end
 
     # !@visibility private
-    # Returns the value of CBXWS.  This can be used to override the default
-    # CBXDriver.xcworkspace.  You should only set this if you are actively
-    # developing the CBXDriver.
+    # Returns the value of CBXWS.  This can be used in conjunction with
+    # :cbx_launcher => :xcodebuild to launch the DeviceAgent rather than
+    # iOSDeviceManager.
+    #
+    # You should only set this if you are actively developing the DeviceAgent.
     def self.cbxws
       value = ENV["CBXWS"]
       if value.nil? || value == ""
@@ -326,12 +328,14 @@ module RunLoop
       else
         path = File.expand_path(value)
         if !File.directory?(path)
-          raise RuntimeError, %Q[CBXWS is set, but there is no workspace at
+          raise RuntimeError, %Q[
+CBXWS is set, but there is no workspace at
+
 #{path}
 
-Only set CBXWS if you are developing new features in the CBXRunner.
+Only set CBXWS if you are developing new features in the DeviceAgent.
 
-Check your environment.]
+]
         end
         path
       end

data/lib/run_loop/http/retriable_client.rb

@@ -113,7 +113,13 @@ module RunLoop
         interval = options.fetch(:interval, @interval)
         header = options.fetch(:header, HEADER)
 
-        RunLoop.log_debug("HTTP: #{request_method} #{@server.endpoint + request.route} #{options}")
+        if RunLoop::Environment.debug?
+          http_options = {
+            :retries => retries,
+            :timeout => timeout
+          }
+          RunLoop.log_debug("HTTP: #{request_method} #{@server.endpoint + request.route} #{http_options}")
+        end
 
         start_time = Time.now
         last_error = nil

data/lib/run_loop/simctl.rb

@@ -24,6 +24,7 @@ module RunLoop
       "Shutdown" => 1,
       "Shutting Down" => 2,
       "Booted" => 3,
+      "Plist Missing" => -1
     }.freeze
 
     # @!visibility private
@@ -38,24 +39,28 @@ module RunLoop
 
     # @!visibility private
     def self.ensure_valid_core_simulator_service
+      max_tries = 3
+      valid = false
+      3.times do |try|
+        valid = self.valid_core_simulator_service?
+        break if valid
+        RunLoop.log_debug("Invalid CoreSimulator service for active Xcode: try #{try + 1} of #{max_tries}")
+      end
+      valid
+    end
+
+    # @!visibility private
+    def self.valid_core_simulator_service?
       require "run_loop/shell"
       args = ["xcrun", "simctl", "help"]
 
-      max_tries = 3
-      3.times do |try|
-        hash = {}
-        begin
-          hash = Shell.run_shell_command(args)
-          if hash[:exit_status] != 0
-            RunLoop.log_debug("Invalid CoreSimulator service for active Xcode: try #{try + 1} of #{max_tries}")
-          else
-            return true
-          end
-        rescue RunLoop::Shell::Error => _
-          RunLoop.log_debug("Invalid CoreSimulator service for active Xcode, retrying #{try + 1} of #{max_tries}")
-        end
+      begin
+        hash = Shell.run_shell_command(args)
+        hash[:exit_status] == 0 &&
+          !hash[:out][/Failed to locate a valid instance of CoreSimulatorService/]
+      rescue RunLoop::Shell::Error => _
+        false
       end
-      false
     end
 
     # @!visibility private
@@ -119,7 +124,11 @@ module RunLoop
     # @!visibility private
     def simulator_state_as_int(device)
       plist = device.simulator_device_plist
-      pbuddy.plist_read("state", plist).to_i
+      if File.exist?(plist)
+        pbuddy.plist_read("state", plist).to_i
+      else
+        SIM_STATES["Plist Missing"]
+      end
     end
 
     # @!visibility private

data/lib/run_loop/version.rb

@@ -1,5 +1,5 @@
 module RunLoop
-  VERSION = "2.1.7"
+  VERSION = "2.1.8"
 
   # A model of a software release version that can be used to compare two versions.
   #
@@ -7,12 +7,17 @@ module RunLoop
   # However, the semantic versioning spec is incompatible with RubyGem's patterns
   # for pre-release gems.
   #
-  # > "But returning to the practical: No release version of SemVer is compatible with Rubygems." - _David Kellum_
+  # > "But returning to the practical: No release version of SemVer is compatible
+  # > with Rubygems." - _David Kellum_
   #
   # Calabash and RunLoop version numbers will be in the form `<major>.<minor>.<patch>[.pre<N>]`.
   #
   # @see http://semver.org/
   # @see http://gravitext.com/2012/07/22/versioning.html
+  #
+  # TODO Expand to handle versions with more than 1 "." and no "."
+  # ^ Needs to handle arbitrary versions from Info.plists.  In particular it
+  #   needs to handle a unix timestamp - found the DeviceAgent-Runner.app.
   class Version
 
     # @!attribute [rw] major

data/lib/run_loop/xcode.rb

@@ -237,7 +237,7 @@ module RunLoop
     # @raise [RuntimeError] If path to Xcode.app/Contents/Developer
     #   cannot be determined.
     def developer_dir
-      @xcode_developer_dir ||= lambda do
+      @xcode_developer_dir ||= begin
         if RunLoop::Environment.developer_dir
           path = RunLoop::Environment.developer_dir
         else
@@ -267,7 +267,7 @@ $ man xcode-select
 }
         end
         path
-      end.call
+      end
     end
 
     private

data/lib/run_loop.rb

@@ -20,9 +20,14 @@ require 'run_loop/plist_buddy'
 require "run_loop/codesign"
 require 'run_loop/app'
 require 'run_loop/ipa'
-require "run_loop/device_agent/cbxrunner"
+require "run_loop/http/error"
+require "run_loop/http/server"
+require "run_loop/http/request"
+require "run_loop/http/retriable_client"
+require "run_loop/device_agent/client"
+require "run_loop/device_agent/runner"
 require "run_loop/device_agent/frameworks"
-require "run_loop/device_agent/launcher"
+require "run_loop/device_agent/launcher_strategy"
 require "run_loop/device_agent/ios_device_manager"
 require "run_loop/device_agent/xcodebuild"
 require "run_loop/detect_aut/errors"
@@ -42,11 +47,6 @@ require "run_loop/simctl"
 require 'run_loop/template'
 require "run_loop/locale"
 require "run_loop/language"
-require "run_loop/xcuitest"
-require "run_loop/http/error"
-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/physical_device/ios_device_manager"
 
@@ -110,7 +110,7 @@ module RunLoop
 
     gesture_performer = RunLoop.detect_gesture_performer(cloned_options, xcode, device)
     if gesture_performer == :device_agent
-      RunLoop::XCUITest.run(cloned_options)
+      RunLoop::DeviceAgent::Client.run(cloned_options)
     else
       if RunLoop::Instruments.new.instruments_app_running?
         raise %q(The Instruments.app is open.
@@ -261,8 +261,8 @@ 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.
+Calabash cannot test iOS < 9.0 using Xcode 8 because DeviceAgent 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:
 
@@ -280,7 +280,7 @@ $ DEVELOPER_DIR=/path/to/Xcode/7.3.1/Xcode.app/Contents/Developer cucumber
   #
   # First pass at choosing the correct code path.
   #
-  # We don't know if we can test on iOS 8 with UIAutomation or XCUITest on
+  # We don't know if we can test on iOS 8 with UIAutomation or DeviceAgent on
   # Xcode 8.
   #
   # @param [Hash] options The options passed by the user
@@ -311,8 +311,8 @@ 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.
+Calabash cannot test iOS < 9.0 using Xcode 8 because DeviceAgent 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: