run_loop 2.1.2 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 153c09febc934625b8890c29fbead9efd47ccec9
-  data.tar.gz: def40d52e20c4e6eff000a13b14ebedaf989b11c
+  metadata.gz: f87d14b21bab0d48f84d2d4793f5f38b7c75e537
+  data.tar.gz: 9e565515f6f9abcc1926424c17473dca66c05222
 SHA512:
-  metadata.gz: e8e4c05e8d8ffc9287c9f8b9b8c7db070eab11580d6219156f6c25d59938448ef6a617136a54184b6459f7c66f3741352f6234c5d27cdafb3fe4300e2f8403a6
-  data.tar.gz: f2896bcd29d50e34bdc418bd3f255bddb8e0adb172263e3a5a8859662ec4aa7437485754a9e35def02b682e069dd768acb97ed5074859ebf82083c3d3d772694
+  metadata.gz: b1c91bc8ef53e04e8766d9b2f7fffb11ff0ddf3dc940e6ac996bee128a64bce81b70f92eaa71af466862a491f0519cbfd5b8eab2479baf481b42552839c3ca69
+  data.tar.gz: bb0eaeef42beda6c2e9622f5b1d55a3e09f5f793b0fb0d1b0fc36935617937d0b8c8826355cdab218d57b82f6701ab26c84cc831e3092b8effc33e869c39e204

data/lib/run_loop.rb

@@ -1,3 +1,4 @@
+require "run_loop/abstract"
 require 'run_loop/regex'
 require 'run_loop/directory'
 require "run_loop/encoding"
@@ -19,6 +20,11 @@ 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/device_agent/frameworks"
+require "run_loop/device_agent/launcher"
+require "run_loop/device_agent/xctestctl"
+require "run_loop/device_agent/xcodebuild"
 require "run_loop/detect_aut/errors"
 require "run_loop/detect_aut/xamarin_studio"
 require "run_loop/detect_aut/xcode"
@@ -42,6 +48,7 @@ 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"
 
 module RunLoop
 

data/lib/run_loop/abstract.rb

@@ -0,0 +1,18 @@
+
+module RunLoop
+  module Abstract
+    # @!visibility private
+    class AbstractMethodError < StandardError; end
+
+    # @!visibility private
+    def abstract_method!
+      if Kernel.method_defined?(:caller_locations)
+        method_name = icaller_locations.first.label
+      else
+        method_name = caller.first[/\`(.*)\'/, 1]
+      end
+
+      raise AbstractMethodError.new("Abstract method '#{method_name}'")
+    end
+  end
+end

data/lib/run_loop/core.rb

@@ -145,11 +145,40 @@ module RunLoop
           :script => script,
           :log_file => log_file,
           :args => args,
-          :uia_strategy => uia_strategy
+          :uia_strategy => uia_strategy,
+          :base_script => instruments_script
         }
       merged_options = options.merge(discovered_options)
 
       if device.simulator?
+        if !app_details[:app]
+          raise %Q[
+
+Invalid APP, APP_BUNDLE_PATH, or BUNDLE_ID detected.
+
+The following information was detected from the environment:
+
+             APP='#{ENV["APP"]}'
+ APP_BUNDLE_PATH='#{ENV["APP_BUNDLE_PATH"]}'
+       BUNDLE_ID='#{ENV["BUNDLE_ID"]}'
+
+
+It looks like you are trying to launch an app on a simulator using a bundle
+identifier or you have incorrectly set the APP variable to an app bundle that
+does not exist.
+
+If you are trying to launch a test against a physical device, set the DEVICE_TARGET
+variable to the UDID of your device an APP to a bundle identifier or a path to
+an .ipa.
+
+# com.example.MyApp must be installed on the target device
+$ APP=com.example.MyApp DEVICE_TARGET="John's iPhone" cucumber
+
+If you are trying to launch against a simulator and you encounter this error, it
+means that the APP variable is pointing to a .app that does not exist.
+
+]
+        end
         self.prepare_simulator(app_details[:app], device, xcode, simctl, reset_options)
       end
 

data/lib/run_loop/core_simulator.rb

@@ -48,7 +48,11 @@ class RunLoop::CoreSimulator
   METADATA_PLIST = '.com.apple.mobile_container_manager.metadata.plist'
 
   # @!visibility private
-  CORE_SIMULATOR_DEVICE_DIR = File.expand_path('~/Library/Developer/CoreSimulator/Devices')
+  CORE_SIMULATOR_DEVICE_DIR = File.join(RunLoop::Environment.user_home_directory,
+                                        "Library",
+                                        "Developer",
+                                        "CoreSimulator",
+                                        "Devices")
 
 
   # @!visibility private

data/lib/run_loop/detect_aut/detect.rb

@@ -131,8 +131,14 @@ module RunLoop
 
     # @!visibility private
     def self.app_from_environment
-      RunLoop::Environment.path_to_app_bundle ||
-        RunLoop::Environment.bundle_id
+      app_bundle_path = RunLoop::Environment.path_to_app_bundle
+
+      candidate = app_bundle_path
+      if app_bundle_path && !File.exist?(app_bundle_path)
+        candidate = File.basename(app_bundle_path)
+      end
+
+      candidate || RunLoop::Environment.bundle_id
     end
 
     # @!visibility private

data/lib/run_loop/detect_aut/xcode.rb

@@ -135,12 +135,16 @@ module RunLoop
       # @!visibility private
       def derived_data
         RunLoop::Environment.derived_data ||
-          File.expand_path("~/Library/Developer/Xcode/DerivedData")
+          File.join(RunLoop::Environment.user_home_directory,
+                    "Library", "Developer", "Xcode", "DerivedData")
       end
 
       # @!visibility private
       def xcode_preferences_plist
-        File.expand_path('~/Library/Preferences/com.apple.dt.Xcode.plist')
+        File.join(RunLoop::Environment.user_home_directory,
+                  "Library",
+                  "Preferences",
+                  "com.apple.dt.Xcode.plist")
       end
 
       # @!visibility private

data/lib/run_loop/device.rb

@@ -563,10 +563,17 @@ version: #{version}
     end
 
     # @!visibility private
-    CORE_SIMULATOR_DEVICE_DIR = File.expand_path('~/Library/Developer/CoreSimulator/Devices')
+    CORE_SIMULATOR_DEVICE_DIR = File.join(RunLoop::Environment.user_home_directory,
+                                          "Library",
+                                          "Developer",
+                                          "CoreSimulator",
+                                          "Devices")
 
     # @!visibility private
-    CORE_SIMULATOR_LOGS_DIR = File.expand_path('~/Library/Logs/CoreSimulator')
+    CORE_SIMULATOR_LOGS_DIR = File.join(RunLoop::Environment.user_home_directory,
+                                        "Library",
+                                        "Logs",
+                                        "CoreSimulator")
 
     # @!visibility private
     def self.device_from_options(options)

data/lib/run_loop/device_agent/cbxrunner.rb

@@ -0,0 +1,155 @@
+
+module RunLoop
+  # @!visibility private
+  module DeviceAgent
+    # @!visibility private
+    class CBXRunner
+
+      require "run_loop/shell"
+
+      # @!visibility private
+      @@cbxdevice = nil
+
+      # @!visibility private
+      @@cbxsim = nil
+
+      # @!visibility private
+      def self.device_agent_dir
+        @@device_agent_dir ||= File.expand_path(File.dirname(__FILE__))
+      end
+
+      # @!visibility private
+      def self.detect_cbxsim
+        @@cbxsim ||= lambda do
+          from_env = RunLoop::Environment.cbxsim
+
+          if from_env
+            if File.exist?(from_env)
+              from_env
+            else
+              raise RuntimeError, %Q[
+CBXSIM environment variable defined:
+
+  #{from_env}
+
+but runner does not exist at that path.
+]
+            end
+          else
+            self.default_cbxsim
+          end
+        end.call
+      end
+
+      # @!visibility private
+      def self.detect_cbxdevice
+        @@cbxdevice ||= lambda do
+          from_env = RunLoop::Environment.cbxdevice
+
+          if from_env
+            if File.exist?(from_env)
+              from_env
+            else
+              raise RuntimeError, %Q[
+CBXDEVICE environment variable defined:
+
+  #{from_env}
+
+but runner does not exist at that path.
+]
+            end
+          else
+            self.default_cbxdevice
+          end
+        end.call
+      end
+
+      # @!visibility private
+      def self.default_cbxdevice
+        cbx = File.join(self.device_agent_dir, "ipa", "CBX-Runner.app")
+
+        if !File.exist?(cbx)
+          self.expand_runner_archive("#{cbx}.zip")
+        else
+          cbx
+        end
+      end
+
+      # @!visibility private
+      def self.default_cbxsim
+        cbx = File.join(self.device_agent_dir, "app", "CBX-Runner.app")
+
+        if !File.exist?(cbx)
+          self.expand_runner_archive("#{cbx}.zip")
+        else
+          cbx
+        end
+      end
+
+      # @!visibility private
+      def self.expand_runner_archive(archive)
+        shell = Class.new do
+          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.exec(["unzip", File.basename(archive)], options)
+        end
+        File.join(dir, "CBX-Runner.app")
+      end
+
+      # @!visibility private
+      attr_reader :device
+
+      # @!visibility private
+      # @param [RunLoop::Device] device the target device
+      def initialize(device)
+        @device = device
+      end
+
+      # @!visibility private
+      def runner
+        @runner ||= lambda do
+          if device.physical_device?
+            RunLoop::DeviceAgent::CBXRunner.detect_cbxdevice
+          else
+            RunLoop::DeviceAgent::CBXRunner.detect_cbxsim
+          end
+        end.call
+      end
+
+      # @!visibility private
+      def tester
+        @tester ||= File.join(runner, "PlugIns", "CBX.xctest")
+      end
+
+      # @!visibility private
+      def version
+        @version ||= lambda do
+          short = pbuddy.plist_read("CFBundleShortVersionString", info_plist)
+          build = pbuddy.plist_read("CFBundleVersion", info_plist)
+          str = "#{short}.pre#{build}"
+          RunLoop::Version.new(str)
+        end.call
+      end
+
+      private
+
+      # @!visibility private
+      def info_plist
+        @info_plist ||= File.join(runner, "PlugIns", "CBX.xctest", "Info.plist")
+      end
+
+      # @!visibility private
+      def pbuddy
+        @pbuddy ||= RunLoop::PlistBuddy.new
+      end
+    end
+  end
+end
+

data/lib/run_loop/device_agent/frameworks.rb

@@ -0,0 +1,64 @@
+
+module RunLoop
+  # @!visibility private
+  module DeviceAgent
+    # @!visibility private
+    class Frameworks
+      require "run_loop/shell"
+      require "singleton"
+      include Singleton
+
+      # @!visibility private
+      def install
+        if File.exist?(frameworks)
+          RunLoop.log_debug("#{frameworks} already exists; skipping install")
+          return true
+        end
+
+        RunLoop.log_debug("Installing Frameworks to #{target}")
+
+        options = { :log_cmd => true }
+
+        Dir.chdir(rootdir) do
+          RunLoop.log_unix_cmd("cd #{rootdir}")
+          shell.exec(["unzip", File.basename(zip)], options)
+        end
+
+        shell.exec(["cp", "-r", "#{frameworks}/*.framework", target], options)
+        shell.exec(["cp", "#{frameworks}/*LICENSE", target], options)
+        RunLoop.log_debug("Installed frameworks to #{target}")
+      end
+
+      private
+
+      # @!visibility private
+      def shell
+        Class.new do
+          include RunLoop::Shell
+          def to_s; "#<Frameworks Shell>"; end
+          def inspect; to_s; end
+        end.new
+      end
+
+      # @!visibility private
+      def target
+        @target ||= File.join(RunLoop::DotDir.directory, "Frameworks")
+      end
+
+      # @!visibility private
+      def frameworks
+        @frameworks ||= File.join(rootdir, "Frameworks")
+      end
+
+      # @!visibility private
+      def zip
+        @zip ||= File.join(rootdir, "Frameworks.zip")
+      end
+
+      # @!visibility private
+      def rootdir
+        @rootdir ||= File.expand_path(File.join(File.dirname(__FILE__), "frameworks"))
+      end
+    end
+  end
+end

data/lib/run_loop/device_agent/launcher.rb

@@ -0,0 +1,51 @@
+
+module RunLoop
+  # @!visibility private
+  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
+      require "run_loop/abstract"
+      include RunLoop::Abstract
+
+      # @!visibility private
+      attr_reader :device
+
+      # @!visibility private
+      # @param [RunLoop::Device] device where to launch the CBX-Runner
+      def initialize(device)
+        @device = device
+
+        if device.version < RunLoop::Version.new("9.0")
+          raise ArgumentError, %Q[
+Invalid device:
+
+#{device}
+
+XCUITest is only available for iOS >= 9.0
+]
+        end
+      end
+
+      # @!visibility private
+      #
+      # Does whatever it takes to launch the CBX-Runner on the device.
+      def launch
+        abstract_method!
+      end
+
+      # @!visibility private
+      def self.dot_dir
+        path = File.join(RunLoop::DotDir.directory, "xcuitest")
+
+        if !File.exist?(path)
+          FileUtils.mkdir_p(path)
+        end
+
+        path
+      end
+    end
+  end
+end