run_loop 0.2.1 → 1.0.0.pre3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d55b4a44c450ce991b37aa481254f80a9b7f8cc4
-  data.tar.gz: 222e967b3c709961e0c753b4e8ba91dc04071fde
+  metadata.gz: 8fbeb69acc86dff93a612295675c56e5c60b9286
+  data.tar.gz: 3d8639044fcbf76a09a8b1dc3ec426ad6dcae537
 SHA512:
-  metadata.gz: 764f0823c6d20c9aca52cd552399629e7d4830fd877abea5862ff854fb55c41fc2437aff2ad697d40d040c8b619102d7dc80e02568e7b4c8f8b755c1ead806d2
-  data.tar.gz: 48fbe055e7df6e20636596c14118e2c873e16ddf702b7ec4dbaf7129683e51b58824501fe37fb732cd3f96d839d8d5e957145f1e45b00f64929253447bb7a47a
+  metadata.gz: 521d737aa170ac8ef6be590b47024aced47db7b8698641a0124b1bc5bff4a6fb7e6207ca01039039cea551e2776c8ae4f55e14ce61f3ad93573a0b6293f36f0e
+  data.tar.gz: 4c22b25f74512d2590efd9a0ee79c7c8d776319672f938215acbae5861ca0163b706311ee05d5569951ec6fc968168d9517b77dd83ebaf558a7ba517e86d9090

data/lib/run_loop.rb

@@ -1,3 +1,6 @@
-require 'rubygems'
 require 'run_loop/core'
 require 'run_loop/version'
+require 'run_loop/xctools'
+require 'run_loop/plist_buddy'
+require 'run_loop/sim_control'
+require 'run_loop/device'

data/lib/run_loop/core.rb

@@ -2,6 +2,7 @@ require 'fileutils'
 require 'tmpdir'
 require 'timeout'
 require 'json'
+require 'open3'
 
 module RunLoop
 
@@ -24,6 +25,23 @@ module RunLoop
       SCRIPTS_PATH
     end
 
+    # @deprecated since 1.0.0
+    # still used extensively in calabash-ios launcher
+    def self.above_or_eql_version?(target_version, xcode_version)
+      if target_version.is_a?(RunLoop::Version)
+        target = target_version
+      else
+        target = RunLoop::Version.new(target_version)
+      end
+
+      if xcode_version.is_a?(RunLoop::Version)
+        xcode = xcode_version
+      else
+        xcode = RunLoop::Version.new(xcode_version)
+      end
+      target >= xcode
+    end
+
     def self.script_for_key(key)
       if SCRIPTS[key].nil?
         return nil
@@ -36,7 +54,7 @@ module RunLoop
         Timeout::timeout(1, TimeoutError) do
           return `#{File.join(scripts_path, 'udidetect')}`.chomp
         end
-      rescue TimeoutError => e
+      rescue TimeoutError => _
         `killall udidetect &> /dev/null`
       end
       nil
@@ -46,6 +64,13 @@ module RunLoop
       before = Time.now
       ensure_instruments_not_running!
 
+      sim_control ||= options[:sim_control] || RunLoop::SimControl.new
+      xctools ||= options[:xctools] || sim_control.xctools
+
+      # @todo only enable accessibility when there is simulator target
+      # @todo only enable accessibility on the targeted simulator
+      sim_control.enable_accessibility_on_sims({:verbose => true})
+
       device_target = options[:udid] || options[:device_target] || detect_connected_device || 'simulator'
       if device_target && device_target.to_s.downcase == 'device'
         device_target = detect_connected_device
@@ -78,11 +103,12 @@ module RunLoop
 
 
       # Compute udid and bundle_dir / bundle_id from options and target depending on Xcode version
-
-      udid, bundle_dir_or_bundle_id = udid_and_bundle_for_launcher(device_target, options)
+      udid, bundle_dir_or_bundle_id = udid_and_bundle_for_launcher(device_target, options, xctools)
 
       args = options.fetch(:args, [])
 
+      inject_dylib = options.fetch(:inject_dylib, (ENV['CALABASH_USE_DYLIB']=='1'))
+
       log_file ||= File.join(results_dir, 'run_loop.out')
 
       if ENV['DEBUG']=='1'
@@ -94,6 +120,7 @@ module RunLoop
         puts "log_file=#{log_file}"
         puts "timeout=#{timeout}"
         puts "args=#{args}"
+        puts "inject_dylib=#{inject_dylib}"
       end
 
       after = Time.now
@@ -109,7 +136,8 @@ module RunLoop
                                               :results_dir => results_dir,
                                               :script => script,
                                               :log_file => log_file,
-                                              :args => args))
+                                              :args => args),
+                                xctools)
 
       log_header("Starting on #{device_target} App: #{bundle_dir_or_bundle_id}")
       cmd_str = cmd.join(' ')
@@ -134,11 +162,38 @@ module RunLoop
 
       uia_timeout = options[:uia_timeout] || (ENV['UIA_TIMEOUT'] && ENV['UIA_TIMEOUT'].to_f) || 10
 
+      raw_lldb_output = nil
       before = Time.now
       begin
         Timeout::timeout(timeout, TimeoutError) do
           read_response(run_loop, 0, uia_timeout)
         end
+        if inject_dylib
+          lldb_template_file = File.join(scripts_path,'calabash.lldb.erb')
+          require 'erb'
+          lldb_template = ::ERB.new(File.read(lldb_template_file))
+          lldb_template.filename = lldb_template_file
+
+          cf_bundle_executable = find_cf_bundle_executable(bundle_dir_or_bundle_id)
+          require 'calabash/dylibs'
+          dylib_path_for_target = Calabash::Dylibs.path_to_sim_dylib
+
+          lldb_cmd = lldb_template.result(binding)
+
+          tmpdir = Dir.mktmpdir('lldb_cmd')
+          lldb_script = File.join(tmpdir,'lldb')
+
+          File.open(lldb_script,'w') {|f| f.puts(lldb_cmd)}
+
+          if ENV['DEBUG'] == '1'
+            puts "lldb script #{lldb_script}"
+          end
+
+          raw_lldb_output = `lldb -s #{lldb_script}`
+          if ENV['DEBUG'] == '1'
+            puts raw_lldb_output
+          end
+        end
       rescue TimeoutError => e
         if ENV['DEBUG']
           puts "Failed to launch\n"
@@ -150,6 +205,7 @@ module RunLoop
           puts "log_file=#{log_file}"
           puts "timeout=#{timeout}"
           puts "args=#{args}"
+          puts "lldb_output=#{raw_lldb_output}" if raw_lldb_output
         end
         raise TimeoutError, "Time out waiting for UIAutomation run-loop to Start. \n Logfile #{log_file} \n\n #{File.read(log_file)}\n"
       end
@@ -163,7 +219,16 @@ module RunLoop
       run_loop
     end
 
-    def self.udid_and_bundle_for_launcher(device_target, options)
+    def self.find_cf_bundle_executable(bundle_dir_or_bundle_id)
+      unless File.directory?(bundle_dir_or_bundle_id)
+        raise "Injecting dylibs currently only works with simulator and app bundles"
+      end
+      info_plist = Dir[File.join(bundle_dir_or_bundle_id,'Info.plist')].first
+      raise "Unable to find Info.plist in #{bundle_dir_or_bundle_id}" if info_plist.nil?
+      `/usr/libexec/PlistBuddy -c "Print :CFBundleExecutable" "#{info_plist}"`.strip
+    end
+
+    def self.udid_and_bundle_for_launcher(device_target, options, xctools=RunLoop::XCTools.new)
       bundle_dir_or_bundle_id = options[:app] || ENV['BUNDLE_ID']|| ENV['APP_BUNDLE_PATH'] || ENV['APP']
 
       unless bundle_dir_or_bundle_id
@@ -171,16 +236,21 @@ module RunLoop
       end
 
       udid = nil
-      if above_or_eql_version?('5.1', xcode_version)
+
+      if xctools.xcode_version_gte_51?
         if device_target.nil? || device_target.empty? || device_target == 'simulator'
-          device_target = 'iPhone Retina (4-inch) - Simulator - iOS 7.1'
+          if xctools.xcode_version_gte_6?
+            # the simulator can be either the textual name or the UDID (directory name)
+            device_target = 'iPhone 5 (8.0 Simulator)'
+          else
+            device_target = 'iPhone Retina (4-inch) - Simulator - iOS 7.1'
+          end
         end
         udid = device_target
 
         unless /simulator/i.match(device_target)
           bundle_dir_or_bundle_id = options[:bundle_id] if options[:bundle_id]
         end
-
       else
         if device_target == 'simulator'
 
@@ -210,30 +280,9 @@ module RunLoop
       return udid, bundle_dir_or_bundle_id
     end
 
-    def self.above_or_eql_version?(target_version, xcode_version)
-      t_major,t_minor,t_patch = target_version.split('.')
-      x_major,x_minor,x_patch = xcode_version.split('.')
-      return true if x_major.to_i > t_major.to_i
-      return false if x_major.to_i < t_major.to_i
-      #major versions are equal
-      t_minor_i = (t_minor && t_minor.to_i || 0)
-      x_minor_i = (x_minor && x_minor.to_i || 0)
-      return true if x_minor_i > t_minor_i
-      return false if x_minor_i < t_minor_i
-      #minor versions are equal
-
-      t_patch_i = (t_patch && t_patch.to_i || 0)
-      x_patch_i = (x_patch && x_patch.to_i || 0)
-
-      x_patch_i >= t_patch_i
-    end
-
-    def self.xcode_version
-      xcode_build_output = `xcodebuild -version`.split("\n")
-      xcode_build_output.each do |line|
-        match=/^Xcode\s(.*)$/.match(line.strip)
-        return match[1] if match && match.length > 1
-      end
+    # @deprecated 1.0.0 replaced with Xctools#version
+    def self.xcode_version(xctools=XCTools.new)
+      xctools.xcode_version.to_s
     end
 
     def self.jruby?
@@ -360,7 +409,7 @@ module RunLoop
     end
 
     def self.instruments_command_prefix(udid, results_dir_trace)
-      instruments_path = 'instruments'
+      instruments_path = 'xcrun instruments'
       if udid
         instruments_path = "#{instruments_path} -w \"#{udid}\""
       end
@@ -369,7 +418,7 @@ module RunLoop
     end
 
 
-    def self.instruments_command(options)
+    def self.instruments_command(options, xctools=XCTools.new)
       udid = options[:udid]
       results_dir_trace = options[:results_dir_trace]
       bundle_dir_or_bundle_id = options[:bundle_dir_or_bundle_id]
@@ -381,7 +430,7 @@ module RunLoop
       instruments_prefix = instruments_command_prefix(udid, results_dir_trace)
       cmd = [
           instruments_prefix,
-          '-t', "\"#{automation_template}\"",
+          '-t', "\"#{automation_template(xctools)}\"",
           "\"#{bundle_dir_or_bundle_id}\"",
           '-e', 'UIARESULTSPATH', results_dir,
           '-e', 'UIASCRIPT', script,
@@ -393,21 +442,20 @@ module RunLoop
       cmd
     end
 
-    def self.automation_template(candidate = ENV['TRACE_TEMPLATE'])
+    def self.automation_template(xctools, candidate = ENV['TRACE_TEMPLATE'])
       unless candidate && File.exist?(candidate)
-        candidate = default_tracetemplate
+        candidate = default_tracetemplate xctools
       end
       candidate
     end
 
-    def self.default_tracetemplate
-      xcode_path = `xcode-select -print-path`.chomp
-      automation_bundle = File.expand_path(File.join(xcode_path, '..', 'Applications', 'Instruments.app', 'Contents', 'PlugIns', 'AutomationInstrument.bundle'))
-      if not File.exist? automation_bundle
-        automation_bundle= File.expand_path(File.join(xcode_path, 'Platforms', 'iPhoneOS.platform', 'Developer', 'Library', 'Instruments', 'PlugIns', 'AutomationInstrument.bundle'))
-        raise 'Unable to find AutomationInstrument.bundle' if not File.exist? automation_bundle
-      end
-      File.join(automation_bundle, 'Contents', 'Resources', 'Automation.tracetemplate')
+    def self.default_tracetemplate(xctools=XCTools.new)
+      templates = xctools.instruments :templates
+      templates.delete_if do |path|
+        not path =~ /\/Automation.tracetemplate/
+      end.delete_if do |path|
+        not path =~ /Xcode/
+      end.first.tr("\"", '').strip
     end
 
     def self.log(message)
@@ -467,7 +515,7 @@ module RunLoop
         result = Core.read_response(run_loop, expected_index)
       end
 
-    rescue TimeoutError => e
+    rescue TimeoutError => _
       raise TimeoutError, "Time out waiting for UIAutomation run-loop for command #{cmd}. Waiting for index:#{expected_index}"
     end
 

data/lib/run_loop/device.rb

@@ -0,0 +1,22 @@
+module RunLoop
+  class Device
+
+    attr_reader :name
+    attr_reader :version
+    attr_reader :udid
+
+    def initialize(name, version, udid)
+      @name = name
+
+      if version.is_a? String
+        @version = RunLoop::Version.new version
+      else
+        @version = version
+      end
+
+      @udid = udid
+    end
+
+  end
+
+end

data/lib/run_loop/plist_buddy.rb

@@ -0,0 +1,173 @@
+module RunLoop
+  # A class for reading and writing property list values.
+  #
+  # Why not use CFPropertyList?  Because it is super wonky.  Among its other
+  # faults, it matches Boolean to a string type with 'true/false' values which
+  # is problematic for our purposes.
+  class PlistBuddy
+
+    # Reads key from file and returns the result.
+    # @param [String] key the key to inspect (may not be nil or empty)
+    # @param [String] file the plist to read
+    # @param [Hash] opts options for controlling execution
+    # @option opts [Boolean] :verbose (false) controls log level
+    # @return [String] the value of the key
+    # @raise [ArgumentError] if nil or empty key
+    def plist_read(key, file, opts={})
+      if key.nil? or key.length == 0
+        raise(ArgumentError, "key '#{key}' must not be nil or empty")
+      end
+      cmd = build_plist_cmd(:print, {:key => key}, file)
+      res = execute_plist_cmd(cmd, opts)
+      if res == "Print: Entry, \":#{key}\", Does Not Exist"
+        nil
+      else
+        res
+      end
+    end
+
+    # Checks if the key exists in plist.
+    # @param [String] key the key to inspect (may not be nil or empty)
+    # @param [String] file the plist to read
+    # @param [Hash] opts options for controlling execution
+    # @option opts [Boolean] :verbose (false) controls log level
+    # @return [Boolean] true if the key exists in plist file
+    def plist_key_exists?(key, file, opts={})
+      plist_read(key, file, opts) != nil
+    end
+
+    # Replaces or creates the value of key in the file.
+    #
+    # @param [String] key the key to set (may not be nil or empty)
+    # @param [String] type the plist type (used only when adding a value)
+    # @param [String] value the new value
+    # @param [String] file the plist to read
+    # @param [Hash] opts options for controlling execution
+    # @option opts [Boolean] :verbose (false) controls log level
+    # @return [Boolean] true if the operation was successful
+    # @raise [ArgumentError] if nil or empty key
+    def plist_set(key, type, value, file, opts={})
+      default_opts = {:verbose => false}
+      merged = default_opts.merge(opts)
+
+      if key.nil? or key.length == 0
+        raise(ArgumentError, "key '#{key}' must not be nil or empty")
+      end
+
+      cmd_args = {:key => key,
+                  :type => type,
+                  :value => value}
+
+      if plist_key_exists?(key, file, merged)
+        cmd = build_plist_cmd(:set, cmd_args, file)
+      else
+        cmd = build_plist_cmd(:add, cmd_args, file)
+      end
+
+      res = execute_plist_cmd(cmd, merged)
+      res == ''
+    end
+
+    private
+
+    # returns the path to the PlistBuddy executable
+    # @return [String] path to PlistBuddy
+    def plist_buddy
+      '/usr/libexec/PlistBuddy'
+    end
+
+    # Executes cmd as a shell command and returns the result.
+    #
+    # @param [String] cmd shell command to execute
+    # @param [Hash] opts options for controlling execution
+    # @option opts [Boolean] :verbose (false) controls log level
+    # @return [Boolean,String] `true` if command was successful.  If :print'ing
+    #  the result, the value of the key.  If there is an error, the output of
+    #  stderr.
+    def execute_plist_cmd(cmd, opts={})
+      default_opts = {:verbose => false}
+      merged = default_opts.merge(opts)
+
+      puts cmd if merged[:verbose]
+
+      res = nil
+      # noinspection RubyUnusedLocalVariable
+      Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thr|
+        err = stderr.read
+        std = stdout.read
+        if not err.nil? and err != ''
+          res = err.chomp
+        else
+          res = std.chomp
+        end
+      end
+      res
+    end
+
+    # Composes a PlistBuddy command that can be executed as a shell command.
+    #
+    # @param [Symbol] type should be one of [:print, :set, :add]
+    #
+    # @param [Hash] args_hash arguments used to construct plist command
+    # @option args_hash [String] :key (required) the plist key
+    # @option args_hash [String] :value (required for :set and :add) the new value
+    # @option args_hash [String] :type (required for :add) the new type of the value
+    #
+    # @param [String] file the plist file to interact with (must exist)
+    #
+    # @raise [RuntimeError] if file does not exist
+    # @raise [ArgumentError] when invalid type is passed
+    # @raise [ArgumentError] when args_hash does not include required key/value pairs
+    #
+    # @return [String] a shell-ready PlistBuddy command
+    def build_plist_cmd(type, args_hash, file)
+
+      unless File.exist?(File.expand_path(file))
+        raise(RuntimeError, "plist '#{file}' does not exist - could not read")
+      end
+
+      case type
+        when :add
+          value_type = args_hash[:type]
+          unless value_type
+            raise(ArgumentError, ':value_type is a required key for :add command')
+          end
+          allowed_value_types = ['string', 'bool', 'real', 'integer']
+          unless allowed_value_types.include?(value_type)
+            raise(ArgumentError, "expected '#{value_type}' to be one of '#{allowed_value_types}'")
+          end
+          value = args_hash[:value]
+          unless value
+            raise(ArgumentError, ':value is a required key for :add command')
+          end
+          key = args_hash[:key]
+          unless key
+            raise(ArgumentError, ':key is a required key for :add command')
+          end
+          cmd_part = "\"Add :#{key} #{value_type} #{value}\""
+        when :print
+          key = args_hash[:key]
+          unless key
+            raise(ArgumentError, ':key is a required key for :print command')
+          end
+          cmd_part = "\"Print :#{key}\""
+        when :set
+          value = args_hash[:value]
+          unless value
+            raise(ArgumentError, ':value is a required key for :set command')
+          end
+          key = args_hash[:key]
+          unless key
+            raise(ArgumentError, ':key is a required key for :set command')
+          end
+          cmd_part = "\"Set :#{key} #{value}\""
+        else
+          cmds = [:add, :print, :set]
+          raise(ArgumentError, "expected '#{type}' to be one of '#{cmds}'")
+      end
+
+      "#{plist_buddy} -c #{cmd_part} \"#{file}\""
+    end
+
+  end
+end