run_loop 2.0.5 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e74f558ad6dac0b1679f8d2cdd4566810aa922fd
-  data.tar.gz: a81469d91af4d38631e344de86e8176f85b66b06
+  metadata.gz: e713b8074f4a98cc789fe39327c63c675d8483cb
+  data.tar.gz: 98d467c958129c5a33efa0fe654088f38b0b7b0f
 SHA512:
-  metadata.gz: 512cf1830f6ee0a79e00879ad72c38c2f20563867128995652c58dc2d6f34d5200a289f5d08c148c8b16bc8f293409be0e3b3cae965601855caa481e33cd7eaa
-  data.tar.gz: 110fc79bc875f364d9cf3a1b020467c0649a3d39e7c4f2c701bfb0c812d352d399bc3ce3561df0a83000b941044d7bdb0e8762f9c71f2123189c40245456ae75
+  metadata.gz: 810a32b9c38f9b720129ca06dc8a80cb6d92c4243d8bd7dc4dd62cee55600e19d68f9eb38d7c28643f9ed023d3437e1c9b35beb26a1e9f95a64b8de3a9308a23
+  data.tar.gz: 0963ce5adff45b9aae3b20cc2635000ea69ef166deef85956461c2808abca49a371140d8a42d911a622a4e88547fbd6e90c713ff63befeaf49087b921ecfb56a

data/lib/run_loop.rb

@@ -20,6 +20,8 @@ require 'run_loop/sim_control'
 require 'run_loop/device'
 require 'run_loop/instruments'
 require 'run_loop/lipo'
+require "run_loop/otool"
+require "run_loop/strings"
 require 'run_loop/cache/cache'
 require 'run_loop/host_cache'
 require 'run_loop/patches/awesome_print'

data/lib/run_loop/app.rb

@@ -14,6 +14,20 @@ module RunLoop
     # @return [RunLoop::App] A instance of App with a path.
     def initialize(app_bundle_path)
       @path = File.expand_path(app_bundle_path)
+
+      if !App.valid?(app_bundle_path)
+        raise ArgumentError,
+%Q{App does not exist at path or is not an app bundle.
+
+#{app_bundle_path}
+
+Bundle must:
+
+1. be a directory that exists,
+2. have a .app extension,
+3. and contain an Info.plist.
+}
+      end
     end
 
     # @!visibility private
@@ -28,19 +42,23 @@ module RunLoop
 
     # Is this a valid app?
     def valid?
-      [File.exist?(path),
-       File.directory?(path),
-       File.extname(path) == '.app'].all?
+      App.valid?(path)
+    end
+
+    # @!visibility private
+    def self.valid?(app_bundle_path)
+      return false if app_bundle_path.nil?
+
+      File.exist?(app_bundle_path) &&
+        File.directory?(app_bundle_path) &&
+        File.extname(app_bundle_path) == '.app' &&
+        File.exist?(File.join(app_bundle_path, "Info.plist"))
     end
 
     # Returns the Info.plist path.
     # @raise [RuntimeError] If there is no Info.plist.
     def info_plist_path
-      info_plist = File.join(path, 'Info.plist')
-      unless File.exist?(info_plist)
-        raise "Expected an Info.plist at '#{path}'"
-      end
-      info_plist
+      @info_plist_path ||= File.join(path, 'Info.plist')
     end
 
     # Inspects the app's Info.plist for the bundle identifier.
@@ -69,20 +87,26 @@ module RunLoop
 
     # Inspects the app's file for the server version
     def calabash_server_version
-      if valid?
-        path_to_bin = File.join(path, executable_name)
-        xcrun ||= RunLoop::Xcrun.new
-        hash = xcrun.exec(["strings", path_to_bin])
-        unless hash.nil?
-          version_str = hash[:out][/CALABASH VERSION: \d+\.\d+\.\d+/, 0]
-          unless version_str.nil? || version_str == ""
-            server_ver = version_str.split(":")[1].delete(' ')
-            RunLoop::Version.new(server_ver)
-          end
+      version = nil
+      executables.each do |executable|
+        version = strings(executable).server_version
+        break if version
+      end
+      version
+    end
+
+    # @!visibility private
+    # Collects the paths to executables in the bundle.
+    def executables
+      executables = []
+      Dir.glob("#{path}/**/*") do |file|
+        next if File.directory?(file)
+        next if skip_executable_check?(file)
+        if otool(file).executable?
+          executables << file
         end
-      else
-        raise 'Path is not valid'
       end
+      executables
     end
 
     # Returns the sha1 of the application.
@@ -92,9 +116,89 @@ module RunLoop
 
     private
 
+    # @!visibility private
     def plist_buddy
       @plist_buddy ||= RunLoop::PlistBuddy.new
     end
 
+    # @!visibility private
+    # An otool factory.
+    def otool(file)
+      RunLoop::Otool.new(file)
+    end
+
+    # @!visibility private
+    # A strings factory
+    def strings(file)
+      RunLoop::Strings.new(file)
+    end
+
+    # @!visibility private
+    def skip_executable_check?(file)
+      image?(file) ||
+        text?(file) ||
+        plist?(file) ||
+        lproj_asset?(file) ||
+        code_signing_asset?(file) ||
+        core_data_asset?(file)
+    end
+
+    # @!visibility private
+    def text?(file)
+       extension = File.extname(file)
+
+       extension == ".txt" ||
+         extension == ".md" ||
+         extension == ".html" ||
+         extension == ".xml" ||
+         extension == ".json" ||
+         extension == ".yaml" ||
+         extension == ".yml" ||
+         extension == ".rtf" ||
+         file[/NOTICE|LICENSE|README|ABOUT/, 0]
+    end
+
+    # @!visibility private
+    def image?(file)
+      file[/jpeg|jpg|gif|png|tiff|svg|pdf|car|iTunesArtwork/, 0]
+    end
+
+    # @!visibility private
+    def plist?(file)
+      File.extname(file) == ".plist"
+    end
+
+    # @!visibility private
+    def lproj_asset?(file)
+      extension = File.extname(file)
+
+      file[/lproj/, 0] ||
+        file[/storyboard/, 0] ||
+        extension == ".strings" ||
+        extension == ".xib" ||
+        extension == ".nib"
+    end
+
+    # @!visibility private
+    def code_signing_asset?(file)
+      name = File.basename(file)
+      extension = File.extname(file)
+
+      name == "PkgInfo" ||
+        name == "embedded" ||
+        extension == ".mobileprovision" ||
+        extension == ".xcent" ||
+        file[/_CodeSignature/, 0]
+    end
+
+    # @!visibility private
+    def core_data_asset?(file)
+      extension = File.extname(file)
+
+      file[/momd/, 0] ||
+        extension == ".mom" ||
+        extension == ".db"
+    end
   end
 end
+

data/lib/run_loop/ipa.rb

@@ -2,18 +2,11 @@ module RunLoop
   # A model of the an .ipa - a application binary for iOS devices.
   class Ipa
 
-
     # The path to this .ipa.
     # @!attribute [r] path
     # @return [String] A path to this .ipa.
     attr_reader :path
 
-    # The bundle identifier of this ipa.
-    # @!attribute [r] bundle_identifier
-    # @return [String] The bundle identifier of this ipa; obtained by inspecting
-    #  the app's Info.plist.
-    attr_reader :bundle_identifier
-
     # Create a new ipa instance.
     # @param [String] path_to_ipa The path the .ipa file.
     # @return [Calabash::Ipa] A new ipa instance.
@@ -42,96 +35,59 @@ module RunLoop
 
     # 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
-    #  directory.
-    # @raise [RuntimeError] If an Info.plist does exist in the .app.
     def bundle_identifier
-      if bundle_dir.nil? || !File.exist?(bundle_dir)
-        raise "Expected a '#{File.basename(path).split('.').first}.app'\nat path '#{payload_dir}'"
-      end
-
-      @bundle_identifier ||= lambda {
-        info_plist_path = File.join(bundle_dir, 'Info.plist')
-        unless File.exist? info_plist_path
-          raise "Expected an 'Info.plist' at '#{bundle_dir}'"
-        end
-        identifier = plist_buddy.plist_read('CFBundleIdentifier', info_plist_path)
-
-        unless identifier
-          raise "Expected key 'CFBundleIdentifier' in '#{info_plist_path}'"
-        end
-        identifier
-      }.call
+      app.bundle_identifier
     end
 
     # Inspects the app's Info.plist for the executable name.
     # @return [String] The value of CFBundleExecutable.
-    # @raise [RuntimeError] If the plist cannot be read or the
-    #   CFBundleExecutable is empty or does not exist.
     def executable_name
-      if bundle_dir.nil? || !File.exist?(bundle_dir)
-        raise "Expected a '#{File.basename(path).split('.').first}.app'\nat path '#{payload_dir}'"
-      end
-
-      @executable_name ||= lambda {
-        info_plist_path = File.join(bundle_dir, 'Info.plist')
-        unless File.exist? info_plist_path
-          raise "Expected an 'Info.plist' at '#{bundle_dir}'"
-        end
-        name = plist_buddy.plist_read('CFBundleExecutable', info_plist_path)
-
-        unless name
-          raise "Expected key 'CFBundleExecutable' in '#{info_plist_path}'"
-        end
-        name
-      }.call
+      app.executable_name
     end
 
-    # Inspects the app's file for the server version
+    # Inspects the app's executables for the server version
+    # @return[RunLoop::Version] a version instance
     def calabash_server_version
-      if bundle_dir.nil? || !File.exist?(bundle_dir)
-        raise "Expected a '#{File.basename(path).split('.').first}.app'\nat path '#{payload_dir}'"
-      else
-        if !executable_name.nil? && executable_name != ''
-          path_to_bin = File.join(bundle_dir, executable_name)
-          xcrun ||= RunLoop::Xcrun.new
-          hash = xcrun.exec(["strings", path_to_bin])
-          unless hash.nil?
-            version_str = hash[:out][/CALABASH VERSION: \d+\.\d+\.\d+/, 0]
-            unless version_str.nil? || version_str == ""
-              server_ver = version_str.split(":")[1].delete(' ')
-              RunLoop::Version.new(server_ver)
-            end
-          end
-        end
-      end
+      app.calabash_server_version
     end
 
     private
 
+    # @!visibility private
     def tmpdir
       @tmpdir ||= Dir.mktmpdir
     end
 
+    # @!visibility private
     def payload_dir
-      @payload_dir ||= lambda {
+      @payload_dir ||= lambda do
         FileUtils.cp(path, tmpdir)
         zip_path = File.join(tmpdir, File.basename(path))
         Dir.chdir(tmpdir) do
           system('unzip', *['-q', zip_path])
         end
         File.join(tmpdir, 'Payload')
-      }.call
+      end.call
     end
 
+    # @!visibility private
     def bundle_dir
-      @bundle_dir ||= lambda {
-        Dir.glob(File.join(payload_dir, '*')).detect {|f| File.directory?(f) && f.end_with?('.app')}
-      }.call
+      @bundle_dir ||= lambda do
+        Dir.glob(File.join(payload_dir, '*')).detect do |f|
+          File.directory?(f) && f.end_with?('.app')
+        end
+      end.call
+    end
+
+    # @!visibility private
+    def app
+      @app ||= RunLoop::App.new(bundle_dir)
     end
 
+    # @!visibility private
     def plist_buddy
       @plist_buddy ||= RunLoop::PlistBuddy.new
     end
   end
 end
+

data/lib/run_loop/otool.rb

@@ -0,0 +1,76 @@
+module RunLoop
+  # @!visibility private
+  #
+  # A class for interacting with otool
+  class Otool
+
+    # @!visibility private
+    attr_reader :path
+
+    # @!visibility private
+    def initialize(path)
+      @path = path
+
+      if !Otool.valid_path?(path)
+        raise ArgumentError,
+%Q{File:
+
+#{path}
+
+must exist and not be a directory.
+}
+      end
+    end
+
+    # @!visibility private
+    def to_s
+      "#<OTOOL: #{path}>"
+    end
+
+    # @!visibility private
+    def inspect
+      to_s
+    end
+
+    # @!visibility private
+    def executable?
+      !arch_info[/is not an object file/, 0]
+    end
+
+    private
+
+    # @!visibility private
+    def arch_info
+      args = ["otool", "-hv", "-arch", "all", path]
+      opts = { :log_cmd => true }
+
+      hash = xcrun.exec(args, opts)
+
+      if hash[:exit_status] != 0
+        raise RuntimeError,
+%Q{Could not get arch info from file:
+
+#{path}
+
+#{args.join(" ")}
+
+exited #{hash[:exit_status]} with the following output:
+
+#{hash[:out]}
+}
+      end
+
+      @arch_info = hash[:out]
+    end
+
+    # @!visibility private
+    def self.valid_path?(path)
+      File.exist?(path) && !File.directory?(path)
+    end
+
+    # @!visibility private
+    def xcrun
+      RunLoop::Xcrun.new
+    end
+  end
+end

data/lib/run_loop/strings.rb

@@ -0,0 +1,88 @@
+module RunLoop
+  # @!visibility private
+  #
+  # A class for interacting with the strings tool
+  class Strings
+
+    # @!visibility private
+    attr_reader :path
+
+    # @!visibility private
+    def initialize(path)
+      @path = path
+
+      if !Strings.valid_path?(path)
+        raise ArgumentError,
+%Q{File:
+
+#{path}
+
+must exist and not be a directory.
+}
+      end
+    end
+
+    # @!visibility private
+    def to_s
+      "#<STRINGS: #{path}>"
+    end
+
+    # @!visibility private
+    def inspect
+      to_s
+    end
+
+    # @!visibility private
+    #
+    # @return [RunLoop::Version] A version instance or nil if the file
+    #   at path does not contain server version information.
+    def server_version
+      regex = /CALABASH VERSION: (\d+\.\d+\.\d+(\.pre\d+)?)/
+      match = dump[regex, 0]
+
+      if match
+        str = match.split(":")[1]
+        RunLoop::Version.new(str)
+      else
+        nil
+      end
+    end
+
+    private
+
+    # @!visibility private
+    def dump
+      args = ["strings", path]
+      opts = { :log_cmd => true }
+
+      hash = xcrun.exec(args, opts)
+
+      if hash[:exit_status] != 0
+        raise RuntimeError,
+%Q{Could not get strings info from file:
+
+#{path}
+
+#{args.join(" ")}
+
+exited #{hash[:exit_status]} with the following output:
+
+#{hash[:out]}
+}
+      end
+
+      @dump = hash[:out]
+    end
+
+    # @!visibility private
+    def self.valid_path?(path)
+      File.exist?(path) && !File.directory?(path)
+    end
+
+    # @!visibility private
+    def xcrun
+      RunLoop::Xcrun.new
+    end
+  end
+end
+

data/lib/run_loop/version.rb

@@ -1,5 +1,5 @@
 module RunLoop
-  VERSION = "2.0.5"
+  VERSION = "2.0.6"
 
   # A model of a software release version that can be used to compare two versions.
   #

data/lib/run_loop/xcrun.rb

@@ -21,6 +21,8 @@ module RunLoop
     # Raised when Xcrun fails.
     class Error < RuntimeError; end
 
+    # Raised when the output of the command cannot be coerced to UTF8
+    class UTF8Error < RuntimeError; end
 
     # Raised when Xcrun times out.
     class TimeoutError < RuntimeError; end
@@ -58,12 +60,7 @@ IO.popen requires all arguments to be Strings.
         start_time = Time.now
         command_output = CommandRunner.run(['xcrun'] + args, timeout: timeout)
 
-        if command_output[:out]
-          out = command_output[:out].force_encoding('utf-8').chomp
-        else
-          out = ''
-        end
-
+        out = encode_utf8_or_raise(command_output[:out], cmd)
         process_status = command_output[:status]
 
         hash =
@@ -74,6 +71,8 @@ IO.popen requires all arguments to be Strings.
                     :exit_status => process_status.exitstatus
               }
 
+      rescue UTF8Error => e
+        raise e
       rescue => e
         elapsed = "%0.2f" % (Time.now - start_time)
         raise Error,
@@ -100,5 +99,35 @@ with a timeout of #{timeout}
 
       hash
     end
+
+    private
+
+    # @!visibility private
+    def encode_utf8_or_raise(string, command)
+      return '' if !string
+
+      utf8 = string.force_encoding("UTF-8").chomp
+
+      return utf8 if utf8.valid_encoding?
+
+      encoded = utf8.encode('UTF-8', 'UTF-8', invalid: :replace, undef: :replace, replace: '')
+
+      return encoded if encoded.valid_encoding?
+
+        raise UTF8Error, %Q{
+Could not force UTF-8 encoding on this string:
+
+#{string}
+
+which is the output of this command:
+
+#{command}
+
+Please file an issue with a stacktrace and the text of this error.
+
+https://github.com/calabash/run_loop/issues
+}
+    end
   end
 end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: run_loop
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.0.6
 platform: ruby
 authors:
 - Karl Krukow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-29 00:00:00.000000000 Z
+date: 2016-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -295,6 +295,7 @@ files:
 - lib/run_loop/lldb.rb
 - lib/run_loop/locale.rb
 - lib/run_loop/logging.rb
+- lib/run_loop/otool.rb
 - lib/run_loop/patches/awesome_print.rb
 - lib/run_loop/plist_buddy.rb
 - lib/run_loop/process_terminator.rb
@@ -302,6 +303,7 @@ files:
 - lib/run_loop/regex.rb
 - lib/run_loop/sim_control.rb
 - lib/run_loop/simctl/plists.rb
+- lib/run_loop/strings.rb
 - lib/run_loop/template.rb
 - lib/run_loop/version.rb
 - lib/run_loop/xcode.rb