run_loop 1.4.1 → 1.5.0

data/lib/run_loop/instruments.rb

@@ -5,6 +5,24 @@ module RunLoop
   # @note All instruments commands are run in the context of `xcrun`.
   class Instruments
 
+    include RunLoop::Regex
+
+    attr_reader :xcode
+
+    def xcode
+      @xcode ||= RunLoop::Xcode.new
+    end
+
+    # @!visibility private
+    def to_s
+      "#<Instruments #{version.to_s}>"
+    end
+
+    # @!visibility private
+    def inspect
+      to_s
+    end
+
     # Returns an Array of instruments process ids.
     #
     # @note The `block` parameter is included for legacy API and will be
@@ -32,10 +50,17 @@ module RunLoop
     #
     # Only one instruments process can be running at any one time.
     #
-    # @param [RunLoop::XCTools] xcode_tools The Xcode tools to use to determine
-    #  what version of Xcode is active.
-    def kill_instruments(xcode_tools = RunLoop::XCTools.new)
-      kill_signal = kill_signal xcode_tools
+    # @param [RunLoop::Xcode, RunLoop::XCTools] xcode Used to make check the
+    #  active Xcode version.
+    def kill_instruments(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
+
+      kill_signal = kill_signal(xcode)
       instruments_pids.each do |pid|
         terminator = RunLoop::ProcessTerminator.new(pid, kill_signal, 'instruments')
         unless terminator.kill_process
@@ -77,8 +102,144 @@ module RunLoop
       pid.to_i
     end
 
+    # Returns the instruments version.
+    # @return [RunLoop::Version] A version object.
+    def version
+      @instruments_version ||= lambda do
+        execute_command([]) do |_, stderr, _|
+          version_str = stderr.read[VERSION_REGEX, 0]
+          RunLoop::Version.new(version_str)
+        end
+      end.call
+    end
+
+    # Returns an array of Instruments.app templates.
+    #
+    # Depending on the Xcode version Instruments.app templates will either be:
+    #
+    # * A full path to the template. # Xcode 5 and Xcode > 5 betas
+    # * The name of a template.      # Xcode >= 6 (non beta)
+    #
+    # **Maintainers!** The rules above are important and explain why we can't
+    # simply filter by `~= /tracetemplate/`.
+    #
+    # Templates that users have saved will always be full paths - regardless
+    # of the Xcode version.
+    #
+    # @return [Array<String>] Instruments.app templates.
+    def templates
+      @instruments_templates ||= lambda do
+        if xcode.version_gte_6?
+          execute_command(['-s', 'templates']) do |stdout, stderr, _|
+            filter_stderr_spam(stderr)
+            stdout.read.chomp.split("\n").map do |elm|
+              stripped = elm.strip.tr('"', '')
+              if stripped == '' || stripped == 'Known Templates:'
+                nil
+              else
+                stripped
+              end
+            end.compact
+          end
+        elsif xcode.version_gte_51?
+          execute_command(['-s', 'templates']) do |stdout, stderr, _|
+            err = stderr.read
+            if !err.nil? || err != ''
+              $stderr.puts stderr.read
+            end
+
+            stdout.read.strip.split("\n").delete_if do |path|
+              not path =~ /tracetemplate/
+            end.map { |elm| elm.strip }
+          end
+        else
+          raise "Xcode version '#{xcode.version}' is not supported."
+        end
+      end.call
+    end
+
+    # Returns an array the available physical devices.
+    #
+    # @return [Array<RunLoop::Device>] All the devices will be physical
+    #  devices.
+    def physical_devices
+      @instruments_physical_devices ||= lambda do
+        execute_command(['-s', 'devices']) do |stdout, stderr, _|
+          filter_stderr_spam(stderr)
+          all = stdout.read.chomp.split("\n")
+          valid = all.select do |device|
+            device =~ DEVICE_UDID_REGEX
+          end
+          valid.map do |device|
+            udid = device[DEVICE_UDID_REGEX, 0]
+            version = device[VERSION_REGEX, 0]
+            name = device.split('(').first.strip
+            RunLoop::Device.new(name, version, udid)
+          end
+        end
+      end.call
+    end
+
+    # Returns an array of the available simulators.
+    #
+    # **Xcode 5.1**
+    # * iPad Retina - Simulator - iOS 7.1
+    #
+    # **Xcode 6**
+    # * iPad Retina (8.3 Simulator) [EA79555F-ADB4-4D75-930C-A745EAC8FA8B]
+    #
+    # **Xcode 7**
+    # * iPhone 6 (9.0) [3EDC9C6E-3096-48BF-BCEC-7A5CAF8AA706]
+    # * iPhone 6 (9.0) + Apple Watch - 38mm (2.0) [EE3C200C-69BA-4816-A087-0457C5FCEDA0]
+    #
+    # @return [Array<RunLoop::Device>] All the devices will be simulators.
+    def simulators
+      @instruments_simulators ||= lambda do
+        execute_command(['-s', 'devices']) do |stdout, stderr, _|
+          filter_stderr_spam(stderr)
+          lines = stdout.read.chomp.split("\n")
+          lines.map do |line|
+            stripped = line.strip
+            if line_is_simulator?(stripped) &&
+                  !line_is_simulator_paired_with_watch?(stripped)
+
+              version = stripped[VERSION_REGEX, 0]
+
+              if line_is_xcode5_simulator?(stripped)
+                name = line
+                udid = line
+              else
+                name = stripped.split('(').first.strip
+                udid = line[CORE_SIMULATOR_UDID_REGEX, 0]
+              end
+
+              RunLoop::Device.new(name, version, udid)
+            else
+              nil
+            end
+          end.compact
+        end
+      end.call
+    end
+
     private
 
+    # @!visibility private
+    #
+    # ```
+    # $ ps x -o pid,command | grep -v grep | grep instruments
+    # 98081 sh -c xcrun instruments -w "43be3f89d9587e9468c24672777ff6241bd91124" < args >
+    # 98082 /Xcode/6.0.1/Xcode.app/Contents/Developer/usr/bin/instruments -w < args >
+    # ```
+    #
+    # When run from run-loop (via rspec), expect this:
+    #
+    # ```
+    # $ ps x -o pid,command | grep -v grep | grep instruments
+    # 98082 /Xcode/6.0.1/Xcode.app/Contents/Developer/usr/bin/instruments -w < args >
+    # ```
+    INSTRUMENTS_FIND_PIDS_CMD = 'ps x -o pid,command | grep -v grep | grep instruments'
+
     # @!visibility private
     # Parses the run-loop options hash into an array of arguments that can be
     # passed to `Process.spawn` to launch instruments.
@@ -109,22 +270,6 @@ module RunLoop
       array + options.fetch(:args, [])
     end
 
-    # @!visibility private
-    #
-    # ```
-    # $ ps x -o pid,command | grep -v grep | grep instruments
-    # 98081 sh -c xcrun instruments -w "43be3f89d9587e9468c24672777ff6241bd91124" < args >
-    # 98082 /Xcode/6.0.1/Xcode.app/Contents/Developer/usr/bin/instruments -w < args >
-    # ```
-    #
-    # When run from run-loop (via rspec), expect this:
-    #
-    # ```
-    # $ ps x -o pid,command | grep -v grep | grep instruments
-    # 98082 /Xcode/6.0.1/Xcode.app/Contents/Developer/usr/bin/instruments -w < args >
-    # ```
-    INSTRUMENTS_FIND_PIDS_CMD = 'ps x -o pid,command | grep -v grep | grep instruments'
-
     # @!visibility private
     #
     # Executes `ps_cmd` to find instruments processes and returns the result.
@@ -185,12 +330,67 @@ module RunLoop
     #
     # @see https://github.com/calabash/run_loop/issues/34
     #
-    # @param [RunLoop::XCTools] xcode_tools The Xcode tools to use to determine
+    # @param [RunLoop::Xcode, RunLoop::XCTools] xcode The Xcode tools to use to determine
     #  what version of Xcode is active.
     # @return [String] Either 'QUIT' or 'TERM', depending on the Xcode
     #  version.
-    def kill_signal(xcode_tools = RunLoop::XCTools.new)
-      xcode_tools.xcode_version_gte_6? ? 'QUIT' : 'TERM'
+    def kill_signal(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
+      xcode.version_gte_6? ? 'QUIT' : 'TERM'
+    end
+
+    # @!visibility private
+    #
+    # Execute an instruments command.
+    # @param [Array] args An array of arguments
+    def execute_command(args)
+      Open3.popen3('xcrun', 'instruments', *args) do |_, stdout, stderr, process_status|
+        yield stdout, stderr, process_status
+      end
+    end
+
+    # @!visibility private
+    #
+    # Filters `instruments` spam.
+    def filter_stderr_spam(stderr)
+      # Xcode 6 GM is spamming "WebKit Threading Violations"
+      stderr.read.strip.split("\n").each do |line|
+        unless line[/WebKit Threading Violation/, 0]
+          $stderr.puts line
+        end
+      end
+    end
+
+    # @!visibility private
+    def line_is_simulator?(line)
+      line_is_core_simulator?(line) || line_is_xcode5_simulator?(line)
+    end
+
+    # @!visibility private
+    def line_is_xcode5_simulator?(line)
+      !line[CORE_SIMULATOR_UDID_REGEX, 0] && line[/Simulator/, 0]
+    end
+
+    # @!visibility private
+    def line_is_core_simulator?(line)
+      return nil if !line_has_a_version?(line)
+
+      line[CORE_SIMULATOR_UDID_REGEX, 0]
+    end
+
+    # @!visibility private
+    def line_has_a_version?(line)
+      line[VERSION_REGEX, 0]
+    end
+
+    # @!visibility private
+    def line_is_simulator_paired_with_watch?(line)
+      line[CORE_SIMULATOR_UDID_REGEX, 0] && line[/Apple Watch/, 0]
     end
   end
 end

data/lib/run_loop/ipa.rb

@@ -35,6 +35,11 @@ module RunLoop
       "#<IPA: #{bundle_identifier}: '#{path}'>"
     end
 
+    # @!visibility private
+    def inspect
+      to_s
+    end
+
     # The bundle identifier of this ipa.
     # @return [String] A string representation of this ipa's CFBundleIdentifier
     # @raise [RuntimeError] If ipa does not expand into a Payload/<app name>.app

data/lib/run_loop/l10n.rb

@@ -0,0 +1,117 @@
+module RunLoop
+  class L10N
+
+    # Find the localized name for a given key_code
+    #
+    # @example
+    #  lookup_localization_name('delete.key', 'da') => 'Slet'
+    #
+    # @param [String] key_code the localization signifier, e.g. 'delete.key'
+    # @param [String] localized_lang an iso language code returned by calabash ios server
+    #
+    # @return [String] the localized name
+    def lookup_localization_name(key_code, localized_lang)
+      lookup_table_dir = lang_dir(localized_lang)
+      return nil unless lookup_table_dir
+
+      key_name_lookup_table(lookup_table_dir)[key_code]
+    end
+
+    UIKIT_AXBUNDLE_PATH_CORE_SIM = 'Platforms/iPhoneSimulator.platform/Developer/SDKs/iPhoneSimulator.sdk/System/Library/AccessibilityBundles/UIKit.axbundle/'
+
+    LANG_CODE_TO_LANG_NAME_MAP = {
+          'en' => 'English',
+          'nl' => 'Dutch',
+          'fr' => 'French',
+          'de' => 'German',
+          'es' => 'Spanish',
+          'it' => 'Italian',
+          'jp' => 'Japanese'
+    }
+
+    # @!visibility private
+    def to_s
+      "#<L10N #{uikit_bundle_l10n_path}>"
+    end
+
+    # @!visibility private
+    def inspect
+      to_s
+    end
+
+    # maps the ios keyboard localization to a language directory where we can
+    # find a key-code -> localized-label mapping
+    def lang_dir(localized_lang)
+      l10n_path = uikit_bundle_l10n_path
+
+      ## 2 char + _ + sub localization
+      # en_GB.lproj
+      lang_dir_name = "#{localized_lang}.lproj".sub('-','_')
+      if File.exists?(File.join(l10n_path, lang_dir_name))
+        return lang_dir_name
+      end
+
+      # 2 char iso language code
+      # vi.lproj
+      two_char_country_code = localized_lang.split('-')[0]
+      lang_dir_name = "#{two_char_country_code}.lproj"
+      if File.exists?(File.join(l10n_path, lang_dir_name))
+        return lang_dir_name
+      end
+
+      # Full name
+      # e.g. Dutch.lproj
+      lang_dir_name = "#{LANG_CODE_TO_LANG_NAME_MAP[two_char_country_code]}.lproj"
+      if is_full_name?(two_char_country_code) &&
+            File.exists?(File.join(l10n_path, lang_dir_name))
+        return lang_dir_name
+      end
+      nil
+    end
+
+    def uikit_bundle_l10n_path
+      developer_dir = xcode.developer_dir
+      if !developer_dir
+        nil
+      else
+        if xcode.version_gte_6?
+          File.join(developer_dir, UIKIT_AXBUNDLE_PATH_CORE_SIM)
+        else
+          ['7.1', '7.0', '6.1'].map do |sdk|
+            path = axbundle_path_for_sdk(developer_dir, sdk)
+            if File.exist?(path)
+              path
+            else
+              nil
+            end
+          end.compact.first
+        end
+      end
+    end
+
+    # Xcode 5.1.1 path.
+    def axbundle_path_for_sdk(developer_dir, sdk)
+      File.join(developer_dir,
+                'Platforms/iPhoneSimulator.platform/Developer/SDKs',
+                "iPhoneSimulator#{sdk}.sdk",
+                'System/Library/AccessibilityBundles/UIKit.axbundle')
+    end
+
+    def is_full_name?(two_letter_country_code)
+      LANG_CODE_TO_LANG_NAME_MAP.has_key?(two_letter_country_code)
+    end
+
+    def key_name_lookup_table(lang_dir_name)
+      path = File.join(uikit_bundle_l10n_path, lang_dir_name, 'Accessibility.strings')
+      JSON.parse(`plutil -convert json #{path} -o -`)
+    end
+
+    # @!visibility private
+    attr_reader :xcode
+
+    # @!visibility private
+    def xcode
+      @xcode ||= RunLoop::Xcode.new
+    end
+  end
+end

data/lib/run_loop/lipo.rb

@@ -22,6 +22,16 @@ module RunLoop
       @plist_buddy = RunLoop::PlistBuddy.new
     end
 
+    # @!visibility private
+    def to_s
+      "#<Lipo #{bundle_path}>"
+    end
+
+    # @!visibility private
+    def inspect
+      to_s
+    end
+
     # Inspect the `CFBundleExecutable` in the app bundle path with `lipo` and
     # compare the result with the target device's instruction set.
     #

data/lib/run_loop/regex.rb

@@ -0,0 +1,19 @@
+module RunLoop
+
+  # @!visibility private
+  module Regex
+
+    # @!visibility private
+    CORE_SIMULATOR_UDID_REGEX = /[A-F0-9]{8}-([A-F0-9]{4}-){3}[A-F0-9]{12}/.freeze
+
+    # @!visibility private
+    XCODE_511_SIMULATOR_REGEX = /(\d)\.(\d)\.?(\d)?(-64)?/.freeze
+
+    # @!visibility private
+    DEVICE_UDID_REGEX = /[a-f0-9]{40}/.freeze
+
+    # @!visibility private
+    VERSION_REGEX = /(\d\.\d(\.\d)?)/.freeze
+
+  end
+end

data/lib/run_loop/sim_control.rb

@@ -14,40 +14,42 @@ module RunLoop
   # @todo `puts` calls need to be replaced with proper logging
   class SimControl
 
-    # Returns an instance of XCTools.
-    # @return [RunLoop::XCTools] The xcode tools instance that is used internally.
+    include RunLoop::Regex
+
+    # @deprecated 1.5.0 - replaced by #xcode
     def xctools
+      RunLoop.deprecated('1.5.0', 'Replaced by RunLoop::Xcode')
       @xctools ||= RunLoop::XCTools.new
     end
 
     # @!visibility private
-    # Are we running Xcode 7 or above?
-    #
-    # This is a convenience method.
-    #
-    # @return [Boolean] `true` if the current Xcode version is >= 7.0
+    def xcode
+      @xcode ||= RunLoop::Xcode.new
+    end
+
+    # @!visibility private
+    def xcode_version
+      xcode.version
+    end
+
+    # @!visibility private
     def xcode_version_gte_7?
-      xctools.xcode_version_gte_7?
+      xcode.version_gte_7?
     end
 
     # @!visibility private
-    # Are we running Xcode 6 or above?
-    #
-    # This is a convenience method.
-    #
-    # @return [Boolean] `true` if the current Xcode version is >= 6.0
     def xcode_version_gte_6?
-      xctools.xcode_version_gte_6?
+      xcode.version_gte_6?
     end
 
     # @!visibility private
-    # Are we running Xcode 5.1 or above?
-    #
-    # This is a convenience method.
-    #
-    # @return [Boolean] `true` if the current Xcode version is >= 5.1
     def xcode_version_gte_51?
-      xctools.xcode_version_gte_51?
+      xcode.version_gte_51?
+    end
+
+    # @!visibility private
+    def xcode_developer_dir
+      xcode.developer_dir
     end
 
     # Return an instance of PlistBuddy.
@@ -309,26 +311,22 @@ module RunLoop
     # @param [String] udid the String to check
     # @return [Boolean] Returns true iff the `udid` matches /[A-F0-9]{8}-([A-F0-9]{4}-){3}[A-F0-9]{12}/
     def sim_udid?(udid)
-      udid.length == 36 and udid[XCODE_6_SIM_UDID_REGEX,0] != nil
+      udid.length == 36 and udid[CORE_SIMULATOR_UDID_REGEX,0] != nil
     end
 
     def simulators
-      unless xcode_version_gte_51?
+      unless xcode_version_gte_6?
         raise RuntimeError, 'simctl is only available on Xcode >= 6'
       end
 
-      if xcode_version_gte_6?
-        hash = simctl_list :devices
-        sims = []
-        hash.each_pair do |sdk, list|
-          list.each do |details|
-            sims << RunLoop::Device.new(details[:name], sdk, details[:udid], details[:state])
-          end
+      hash = simctl_list :devices
+      sims = []
+      hash.each_pair do |sdk, list|
+        list.each do |details|
+          sims << RunLoop::Device.new(details[:name], sdk, details[:udid], details[:state])
         end
-        sims
-      else
-        raise NotImplementedError, 'the simulators method is not available yet for Xcode 5.1.1'
       end
+      sims
     end
 
     def accessibility_enabled?(device)
@@ -586,7 +584,7 @@ module RunLoop
     # @!visibility private
     # A regex for finding directories under ~/Library/Developer/CoreSimulator/Devices
     # and parsing the output of `simctl list sessions`.
-    XCODE_6_SIM_UDID_REGEX = /[A-F0-9]{8}-([A-F0-9]{4}-){3}[A-F0-9]{12}/.freeze
+    CORE_SIMULATOR_UDID_REGEX = /[A-F0-9]{8}-([A-F0-9]{4}-){3}[A-F0-9]{12}/.freeze
 
     CORE_SIMULATOR_KEYBOARD_PROPERTIES_HASH =
           {
@@ -639,7 +637,7 @@ module RunLoop
     #  Xcode.
     def sim_app_path
       @sim_app_path ||= lambda {
-        dev_dir = xctools.xcode_developer_dir
+        dev_dir = xcode_developer_dir
         if xcode_version_gte_7?
           "#{dev_dir}/Applications/Simulator.app"
         elsif xcode_version_gte_6?
@@ -704,9 +702,9 @@ module RunLoop
     def existing_sim_sdk_or_device_data_dirs
       base_dir = sim_app_support_dir
       if xcode_version_gte_6?
-        regex = XCODE_6_SIM_UDID_REGEX
+        regex = CORE_SIMULATOR_UDID_REGEX
       else
-        regex = /(\d)\.(\d)\.?(\d)?(-64)?/
+        regex = XCODE_511_SIMULATOR_REGEX
       end
       dirs = Dir.glob("#{base_dir}/*").select { |path|
         path =~ regex
@@ -840,13 +838,12 @@ module RunLoop
       quit_sim
 
       verbose = merged_opts[:verbose]
-      target_udid = sim_data_dir[XCODE_6_SIM_UDID_REGEX, 0]
+      target_udid = sim_data_dir[CORE_SIMULATOR_UDID_REGEX, 0]
 
       # Directory contains simulators not reported by instruments -s devices
       simulator_details = sim_details_keyed_with_udid[target_udid]
       if simulator_details.nil?
         if verbose
-          xcode_version = xctools.xcode_version
           puts ["INFO: Skipping '#{target_udid}' directory because",
                 "there is no corresponding simulator for active Xcode (version '#{xcode_version}')"].join("\n")
         end
@@ -930,13 +927,12 @@ module RunLoop
       quit_sim
 
       verbose = merged_opts[:verbose]
-      target_udid = sim_data_dir[XCODE_6_SIM_UDID_REGEX, 0]
+      target_udid = sim_data_dir[CORE_SIMULATOR_UDID_REGEX, 0]
 
       # Directory contains simulators not reported by instruments -s devices
       simulator_details = sim_details_keyed_with_udid[target_udid]
       if simulator_details.nil?
         if verbose
-          xcode_version = xctools.xcode_version
           puts ["INFO: Skipping '#{target_udid}' directory because",
                 "there is no corresponding simulator for active Xcode (version '#{xcode_version}')"].join("\n")
         end
@@ -1014,16 +1010,17 @@ module RunLoop
       end
 
       hash = {}
-      xctools.instruments(:sims).each do |elm|
-        launch_name = elm[/\A.+\((\d\.\d(\.\d)? Simulator\))/, 0]
-        udid = elm[XCODE_6_SIM_UDID_REGEX,0]
-        sdk_version = elm[/(\d\.\d(\.\d)? Simulator)/, 0].split(' ').first
-        value =
-              {
-                    :launch_name => launch_name,
-                    :udid => udid,
-                    :sdk_version => RunLoop::Version.new(sdk_version)
-              }
+
+      simulators.each do |device|
+        launch_name = device.instruments_identifier(xcode)
+        udid = device.udid
+        value = {
+              :launch_name => device.instruments_identifier(xcode),
+              :udid => device.udid,
+              :sdk_version => device.version
+
+        }
+
         if primary_key == :udid
           key = udid
         else
@@ -1153,15 +1150,27 @@ module RunLoop
         res = {}
         out.split("\n").each do |line|
 
-          possible_sdk = line[/(\d\.\d(\.\d)?)/,0]
+          possible_sdk = line[VERSION_REGEX,0]
           if possible_sdk
             current_sdk = possible_sdk
             res[current_sdk] = []
             next
           end
 
-          unavailable_skd = line[/Unavailable/, 0]
-          if unavailable_skd
+          unavailable_sdk = line[/Unavailable/, 0]
+          if unavailable_sdk
+            current_sdk = nil
+            next
+          end
+
+          watch_os = line[/watchOS/, 0]
+          if watch_os
+            current_sdk = nil
+            next
+          end
+
+          watch = line[/Apple Watch/, 0]
+          if watch
             current_sdk = nil
             next
           end
@@ -1169,7 +1178,7 @@ module RunLoop
           if current_sdk
             unless line[/unavailable/,0]
               name = line.split('(').first.strip
-              udid = line[XCODE_6_SIM_UDID_REGEX,0]
+              udid = line[CORE_SIMULATOR_UDID_REGEX,0]
               state = line[/(Booted|Shutdown)/,0]
               res[current_sdk] << {:name => name, :udid => udid, :state => state}
             end

data/lib/run_loop/simctl/bridge.rb

@@ -194,7 +194,12 @@ module RunLoop::Simctl
             ['launchd_sim', true],
 
             # Yes, but does not always appear.
-            ['CoreSimulatorBridge', true]
+            ['CoreSimulatorBridge', true],
+
+            # Xcode 7
+            ['ids_simd', true],
+            ['com.apple.CoreSimulator.CoreSimulatorService', true],
+            ['com.apple.CoreSimulator.SimVerificationService', true]
       ].each do |pair|
         name = pair[0]
         send_term = pair[1]