run_loop 1.1.1.pre7 → 1.1.1.pre8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1420a614a1d2f74b9cbb6e7bf376fd1521eebd01
-  data.tar.gz: 26965697486e6081811a4f876e333d0d77f4750e
+  metadata.gz: 9340394da27267a6ea43ce6a61c2cb018faf97ff
+  data.tar.gz: 54d9b6db6739d00d5895b7d6108b8fd374f51aa1
 SHA512:
-  metadata.gz: 805cfd4180e6566a36e4b518c102a10dd5ce93f2e405d14db8d13904e9ef6425aeaf2b64d316b963b718492250cf1582b8dc4f82bc487fe6124dc40689151d7f
-  data.tar.gz: a43ef171976bb68f1ed6b19a582a29b1fec64dcfe6cbdaf3a710c229a941bf6c18ff091948aabdc74a2af21fcee7f984a01fe7ba180a9a9bbf39aa814b019921
+  metadata.gz: 9cbcdcee2fe866606caff3ec4609375777617a2de2ea216f314662539b2addda8ae42562bba6b624355a8398500568e442f7f8ac4980cd96e08dccfd047b54cf
+  data.tar.gz: 83bb516e414e2e1c05a1cc63f45e32194c2dbc3359c52894a406f48fd9b93b759f3adc5aef026060d0a4a66c5f8900a24e5be2b183a2f9c055c1c120eda3f8b2

data/lib/run_loop.rb

@@ -5,3 +5,5 @@ require 'run_loop/plist_buddy'
 require 'run_loop/sim_control'
 require 'run_loop/device'
 require 'run_loop/instruments'
+require 'run_loop/lipo'
+

data/lib/run_loop/core.rb

@@ -83,6 +83,48 @@ module RunLoop
       nil
     end
 
+    # Raise an error if the application binary is not compatible with the
+    # target simulator.
+    #
+    # @note This method is implemented for CoreSimulator environments only;
+    #  for Xcode < 6.0 this method does nothing.
+    #
+    # @param [Hash] launch_options These options need to contain the app bundle
+    #   path and a udid that corresponds to a simulator name or simulator udid.
+    #   In practical terms:  call this after merging the original launch
+    #   options with those options that are discovered.
+    #
+    # @param [RunLoop::SimControl] sim_control A simulator control object.
+    # @raise [RuntimeError] Raises an error if the `launch_options[:udid]`
+    #  cannot be used to find a simulator.
+    # @raise [RunLoop::IncompatibleArchitecture] Raises an error if the
+    #  application binary is not compatible with the target simulator.
+    def self.expect_compatible_simulator_architecture(launch_options, sim_control)
+      if sim_control.xcode_version_gte_6?
+        sim_identifier = launch_options[:udid]
+        simulator = sim_control.simulators.find do |simulator|
+          [simulator.instruments_identifier(sim_control.xctools),
+           simulator.udid].include?(sim_identifier)
+        end
+
+        if simulator.nil?
+          raise "Could not find simulator with identifier '#{sim_identifier}'"
+        end
+
+        lipo = RunLoop::Lipo.new(launch_options[:bundle_dir_or_bundle_id])
+        lipo.expect_compatible_arch(simulator)
+        if ENV['DEBUG'] == '1'
+          puts "Simulator instruction set '#{simulator.instruction_set}' is compatible with #{lipo.info}"
+        end
+        true
+      else
+        if ENV['DEBUG'] == '1'
+          puts "Xcode #{sim_control.xctools.xcode_version} detected; skipping simulator architecture check."
+        end
+        false
+      end
+    end
+
     def self.run_with_options(options)
       before = Time.now
 
@@ -91,11 +133,6 @@ module RunLoop
 
       RunLoop::Instruments.new.kill_instruments(xctools)
 
-      if self.simulator_target?(options, sim_control)
-        # @todo only enable accessibility on the targeted simulator
-        sim_control.enable_accessibility_on_sims({:verbose => false})
-      end
-
       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
@@ -150,7 +187,7 @@ module RunLoop
       log_file ||= File.join(results_dir, 'run_loop.out')
 
       after = Time.now
-      if ENV['DEBUG']=='1'
+      if ENV['DEBUG'] == '1'
         puts "Preparation took #{after-before} seconds"
       end
 
@@ -166,6 +203,12 @@ module RunLoop
             }
       merged_options = options.merge(discovered_options)
 
+      if self.simulator_target?(merged_options, sim_control)
+        # @todo only enable accessibility on the targeted simulator
+        sim_control.enable_accessibility_on_sims({:verbose => false})
+        self.expect_compatible_simulator_architecture(merged_options, sim_control)
+      end
+
       self.log_run_loop_options(merged_options, xctools)
 
       cmd = instruments_command(merged_options, xctools)
@@ -819,9 +862,9 @@ module RunLoop
     script
   end
 
-  def self.log_info(device_logger, message)
+  def self.log_info(logger, message)
     msg = "#{Time.now}: #{message}"
-    if device_logger && device_logger.respond_to?(:info)
+    if logger && logger.respond_to?(:info)
       logger.info(msg)
     else
       puts msg if ENV['DEBUG'] == '1'

data/lib/run_loop/device.rb

@@ -17,18 +17,6 @@ module RunLoop
       @udid = udid
     end
 
-    # Is this device a simulator?
-    # @return [Boolean] Return true if this device is a simulator.
-    def simulator?
-      not physical_device?
-    end
-
-    # Is this is a physical device?
-    # @return [Boolean] Return true if this is a physical device.
-    def physical_device?
-      (self.udid =~ /[a-f0-9]{40}/) == 0
-    end
-
     # Returns and instruments-ready device identifier that is a suitable value
     # for DEVICE_TARGET environment variable.
     #
@@ -50,5 +38,41 @@ module RunLoop
         "#{self.name} (#{version_part} Simulator)"
       end
     end
+
+    # Is this a physical device?
+    # @return [Boolean] Returns true if this is a device.
+    def physical_device?
+      not self.udid[/[a-f0-9]{40}/, 0].nil?
+    end
+
+    # Is this a simulator?
+    # @return [Boolean] Returns true if this is a simulator.
+    def simulator?
+      not self.physical_device?
+    end
+
+    # Return the instruction set for this device.
+    #
+    # **Simulator**
+    # The simulator instruction set will be i386 or x86_64 depending on the
+    # the (marketing) name of the device.
+    #
+    # @note Finding the instruction set of a device requires a third-party tool
+    #  like ideviceinfo.  Example:
+    #  `$ ideviceinfo  -u 89b59 < snip > ab7ba --key 'CPUArchitecture' => arm64`
+    #
+    # @raise [RuntimeError] Raises an error if this device is a physical device.
+    # @return [String] An instruction set.
+    def instruction_set
+      if self.simulator?
+        if ['iPhone 4s', 'iPhone 5', 'iPad 2', 'iPad Retina'].include?(self.name)
+          'i386'
+        else
+          'x86_64'
+        end
+      else
+        raise 'Finding the instruction set of a device requires a third-party tool like ideviceinfo'
+      end
+    end
   end
 end

data/lib/run_loop/lipo.rb

@@ -0,0 +1,107 @@
+require 'open3'
+
+module RunLoop
+
+  # An error class for signaling an incompatible architecture.
+  class IncompatibleArchitecture < StandardError
+  end
+
+  # A class for interacting with the lipo command-line tool to verify that an
+  # executable is valid for the test target (device or simulator).
+  #
+  # @note All lipo commands are run in the context of `xcrun`.
+  class Lipo
+
+    # The path to the application bundle we are inspecting.
+    # @!attribute [wr] bundle_path
+    # @return [String] The path to the application bundle (.app).
+    attr_accessor :bundle_path
+
+    def initialize(bundle_path)
+      @bundle_path = bundle_path
+      @plist_buddy = RunLoop::PlistBuddy.new
+    end
+
+    # Inspect the `CFBundleExecutable` in the app bundle path with `lipo` and
+    # compare the result with the target device's instruction set.
+    #
+    # **Simulators**
+    #
+    # If the target is a simulator and the binary contains an i386 slice, the
+    # app will launch on the 64-bit simulators.
+    #
+    # If the target is a simulator and the binary contains _only_ an x86_64
+    # slice, the app will not launch on these simulators:
+    #
+    # ```
+    # iPhone 4S, iPad 2, iPhone 5, and iPad Retina.
+    # ```
+    #
+    # All other simulators are 64-bit.
+    #
+    # **Devices**
+    #
+    # @see {https://www.innerfence.com/howto/apple-ios-devices-dates-versions-instruction-sets}
+    #
+    # ```
+    # armv7  <== 3gs, 4s, iPad 2, iPad mini, iPad 3, iPod 3, iPod 4, iPod 5
+    # armv7s <== 5, 5c, iPad 4
+    # arm64  <== 5s, 6, 6 Plus, Air, Air 2, iPad Mini Retina, iPad Mini 3
+    # ```
+    #
+    # @note At the moment, we are focusing on simulator compatibility.  Since we
+    #  don't have an automated way of installing an .ipa on local device, we
+    #  don't require an .ipa path.  Without an .ipa path, we cannot verify the
+    #  architectures.  Further, we would need to adopt a third-party tool like
+    #  ideviceinfo to find the target device's instruction set.
+    # @param [RunLoop::Device] device The test target.
+    # @raise [RuntimeError] Raises an error if the device is a physical device.
+    # @raise [RunLoop::IncompatibleArchitecture] Raises an error if the instruction set of the target
+    #   device is not compatible with the executable in the application.
+    def expect_compatible_arch(device)
+      if device.physical_device?
+        raise 'Ensuring compatible arches for physical devices is NYI'
+      else
+        arches = self.info
+        # An i386 binary will run on any simulator.
+        return true if arches.include?('i386')
+
+        instruction_set = device.instruction_set
+        unless arches.include?(instruction_set)
+          raise RunLoop::IncompatibleArchitecture,
+                ['Binary at:',
+                 binary_path,
+                 "does not contain a compatible architecture for target device.",
+                 "Expected '#{instruction_set}' but found #{arches}."].join("\n")
+        end
+      end
+    end
+
+    # Returns a list of architecture in the binary.
+    # @return [Array<String>] A list of architecture.
+    def info
+      execute_lipo("-info #{binary_path}") do |stdout, _, _|
+        output = stdout.read.strip
+        output.split(':')[-1].strip.split
+      end
+    end
+
+    private
+
+    def execute_lipo(argument)
+      command = "xcrun lipo #{argument}"
+      Open3.popen3(command) do |_, stdout, stderr, wait_thr|
+        yield stdout, stderr, wait_thr
+      end
+    end
+
+    def plist_path
+      File.join(@bundle_path, 'Info.plist');
+    end
+
+    def binary_path
+      binary_relative_path = @plist_buddy.plist_read('CFBundleExecutable', plist_path)
+      File.join(@bundle_path, binary_relative_path)
+    end
+  end
+end

data/lib/run_loop/version.rb

@@ -1,5 +1,5 @@
 module RunLoop
-  VERSION = '1.1.1.pre7'
+  VERSION = '1.1.1.pre8'
 
   # A model of a software release version that can be used to compare two versions.
   #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: run_loop
 version: !ruby/object:Gem::Version
-  version: 1.1.1.pre7
+  version: 1.1.1.pre8
 platform: ruby
 authors:
 - Karl Krukow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-28 00:00:00.000000000 Z
+date: 2014-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -222,6 +222,7 @@ files:
 - lib/run_loop/core.rb
 - lib/run_loop/device.rb
 - lib/run_loop/instruments.rb
+- lib/run_loop/lipo.rb
 - lib/run_loop/plist_buddy.rb
 - lib/run_loop/sim_control.rb
 - lib/run_loop/version.rb