run_loop 2.0.7 → 2.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48c1c78396cdf8d493ce6d242d09b2a36884fe5e
-  data.tar.gz: 83cfc779ce7803e4deae06af1bc7a3a55a299310
+  metadata.gz: a796cf1b151815127a2c4ee38c6fadf13be9cef8
+  data.tar.gz: 40e6b8e223325fba4d2a13683afa1609b2f9348c
 SHA512:
-  metadata.gz: 2acc78eed572c025036a5e168b592c0ea00c2ca53cfb8562118a6e603052eccde496fd262ed1c9cb0ab2a1cbefb2d35a306829c8e7725bfc51842c404f172599
-  data.tar.gz: 6d0a90bf5529840121434d05ec23948bd0cc50a1be2fa5bf6616d4748154b479e8e1eff07bc7cf35447610a43805649b4a32e3ee76f987a057052bfbf8f1bf44
+  metadata.gz: d0b6d5bb57703550c6592a5d665c1d11d74db9075bf8b688156e2f6094efd6ab0e3efc72c19e9080228f1da8d003f8d115382f804303228a091d05043d3a7309
+  data.tar.gz: 8b53742a9c3b4fe65036f387e93dd189ff350e57bd24ebd90bb7c24e1f6635543a675aafb9500bdf34b92640d61ed6adb5c8eb81e9c9833fcab2f6588d28d7a7

data/lib/run_loop.rb

@@ -17,6 +17,10 @@ require 'run_loop/plist_buddy'
 require "run_loop/codesign"
 require 'run_loop/app'
 require 'run_loop/ipa'
+require "run_loop/detect_aut/errors"
+require "run_loop/detect_aut/xamarin_studio"
+require "run_loop/detect_aut/xcode"
+require "run_loop/detect_aut/detect"
 require 'run_loop/sim_control'
 require 'run_loop/device'
 require 'run_loop/instruments'

data/lib/run_loop/app.rb

@@ -25,7 +25,8 @@ Bundle must:
 
 1. be a directory that exists,
 2. have a .app extension,
-3. and contain an Info.plist.
+3. contain an Info.plist,
+4. and the app binary (CFBundleExecutable) must exist
 }
       end
     end
@@ -49,10 +50,12 @@ Bundle must:
     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"))
+      return false if !File.directory?(app_bundle_path)
+      return false if !File.extname(app_bundle_path) == ".app"
+
+      return false if !self.info_plist_exist?(app_bundle_path)
+      return false if !self.executable_file_exist?(app_bundle_path)
+      true
     end
 
     # Returns the Info.plist path.
@@ -66,7 +69,7 @@ Bundle must:
     # @raise [RuntimeError] If the plist cannot be read or the
     #   CFBundleIdentifier is empty or does not exist.
     def bundle_identifier
-      identifier = plist_buddy.plist_read('CFBundleIdentifier', info_plist_path)
+      identifier = plist_buddy.plist_read("CFBundleIdentifier", info_plist_path)
       unless identifier
         raise "Expected key 'CFBundleIdentifier' in '#{info_plist_path}'"
       end
@@ -78,11 +81,28 @@ Bundle must:
     # @raise [RuntimeError] If the plist cannot be read or the
     #   CFBundleExecutable is empty or does not exist.
     def executable_name
-      identifier = plist_buddy.plist_read('CFBundleExecutable', info_plist_path)
-      unless identifier
+      name = plist_buddy.plist_read("CFBundleExecutable", info_plist_path)
+      unless name
         raise "Expected key 'CFBundleExecutable' in '#{info_plist_path}'"
       end
-      identifier
+      name
+    end
+
+    # Returns the arches for the binary.
+    def arches
+      @arches ||= lipo.info
+    end
+
+    # True if the app has been built for the simulator
+    def simulator?
+      arches.include?("i386") || arches.include?("x86_64")
+    end
+
+    # True if the app has been built for physical devices
+    def physical_device?
+      arches.any? do |arch|
+        arch[/arm/, 0]
+      end
     end
 
     # Inspects the app's file for the server version
@@ -115,7 +135,6 @@ Bundle must:
     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
@@ -131,6 +150,30 @@ Bundle must:
 
     private
 
+    # @!visibility private
+    def self.info_plist_exist?(app_bundle_path)
+      info_plist = File.join(app_bundle_path, "Info.plist")
+      File.exist?(info_plist)
+    end
+
+    # @!visibility private
+    def self.executable_file_exist?(app_bundle_path)
+      return false if !self.info_plist_exist?(app_bundle_path)
+      info_plist = File.join(app_bundle_path, "Info.plist")
+      pbuddy = RunLoop::PlistBuddy.new
+      name = pbuddy.plist_read("CFBundleExecutable", info_plist)
+      if name
+        File.exist?(File.join(app_bundle_path, name))
+      else
+        false
+      end
+    end
+
+    # @!visibility private
+    def lipo
+      @lipo ||= RunLoop::Lipo.new(path)
+    end
+
     # @!visibility private
     def plist_buddy
       @plist_buddy ||= RunLoop::PlistBuddy.new
@@ -150,17 +193,20 @@ Bundle must:
 
     # @!visibility private
     def skip_executable_check?(file)
-      image?(file) ||
+      File.directory?(file) ||
+        image?(file) ||
         text?(file) ||
         plist?(file) ||
         lproj_asset?(file) ||
         code_signing_asset?(file) ||
-        core_data_asset?(file)
+        core_data_asset?(file) ||
+        font?(file)
     end
 
     # @!visibility private
     def text?(file)
        extension = File.extname(file)
+       filename = File.basename(file)
 
        extension == ".txt" ||
          extension == ".md" ||
@@ -170,12 +216,25 @@ Bundle must:
          extension == ".yaml" ||
          extension == ".yml" ||
          extension == ".rtf" ||
-         file[/NOTICE|LICENSE|README|ABOUT/, 0]
+
+         ["NOTICE", "LICENSE", "README", "ABOUT"].any? do |elm|
+           filename[/#{elm}/]
+         end
     end
 
     # @!visibility private
     def image?(file)
-      file[/jpeg|jpg|gif|png|tiff|svg|pdf|car|iTunesArtwork/, 0]
+      extension = File.extname(file)
+
+      extension == ".jpeg" ||
+      extension == ".jpg" ||
+      extension == ".gif" ||
+      extension == ".png" ||
+      extension == ".tiff" ||
+      extension == ".svg" ||
+      extension == ".pdf" ||
+      extension == ".car" ||
+      file[/iTunesArtwork/, 0]
     end
 
     # @!visibility private
@@ -186,9 +245,11 @@ Bundle must:
     # @!visibility private
     def lproj_asset?(file)
       extension = File.extname(file)
+      dir_extension = File.extname(File.dirname(file))
 
-      file[/lproj/, 0] ||
-        file[/storyboard/, 0] ||
+      dir_extension == ".lproj" ||
+        dir_extension == ".storyboard" ||
+        dir_extension == ".storyboardc" ||
         extension == ".strings" ||
         extension == ".xib" ||
         extension == ".nib"
@@ -198,21 +259,31 @@ Bundle must:
     def code_signing_asset?(file)
       name = File.basename(file)
       extension = File.extname(file)
+      dirname = File.basename(File.dirname(file))
 
       name == "PkgInfo" ||
         name == "embedded" ||
         extension == ".mobileprovision" ||
         extension == ".xcent" ||
-        file[/_CodeSignature/, 0]
+        dirname == "_CodeSignature"
     end
 
     # @!visibility private
     def core_data_asset?(file)
       extension = File.extname(file)
+      dir_extension = File.extname(File.dirname(file))
 
-      file[/momd/, 0] ||
+      dir_extension == ".momd" ||
         extension == ".mom" ||
-        extension == ".db"
+        extension == ".db" ||
+        extension == ".omo"
+    end
+
+    # @!visibility private
+    def font?(file)
+      extension = File.extname(file)
+
+      extension == ".tff" || extension == ".otf"
     end
   end
 end

data/lib/run_loop/detect_aut/detect.rb

@@ -0,0 +1,96 @@
+module RunLoop
+
+  # @!visibility private
+  module DetectAUT
+
+    # @!visibility private
+    class Detect
+      include RunLoop::DetectAUT::Errors
+      include RunLoop::DetectAUT::XamarinStudio
+      include RunLoop::DetectAUT::Xcode
+
+      # @!visibility private
+      def app_for_simulator
+        path = RunLoop::Environment.path_to_app_bundle
+        return RunLoop::App.new(path) if path
+
+        if xcode_project?
+          apps, search_dirs = detect_xcode_apps
+        elsif xamarin_project?
+          search_dirs = [solution_directory]
+          apps = candidate_apps(search_dirs.first)
+        else
+          apps = []
+          search_dirs = []
+        end
+
+        # If this is a Xamarin project, we've already searched the local
+        # directory tree for .app.
+        if apps.empty? && !xamarin_project?
+          search_dirs << File.expand_path("./")
+          apps = candidate_apps(File.expand_path("./"))
+        end
+
+        if apps.empty?
+          raise_no_simulator_app_found(search_dirs)
+        end
+
+        app = select_most_recent_app(apps)
+
+        RunLoop.log_info2("Detected app at path:")
+        RunLoop.log_info2("#{app.path}")
+        time_str = mtime(app).strftime("%a %d %b %Y %H:%M:%S %Z")
+        RunLoop.log_info2("Modification time of app: #{time_str}")
+        RunLoop.log_info2("If this is incorrect, set the APP variable and/or rebuild your app")
+        RunLoop.log_info2("It is your responsibility to ensure you are testing the right app.")
+
+        app
+      end
+
+      # @!visibility private
+      # @param [Array<RunLoop::Detect>] apps
+      def select_most_recent_app(apps)
+        apps.max do |a, b|
+          mtime(a).to_i <=> mtime(b).to_i
+        end
+      end
+
+      # @!visibility private
+      # @param [String] bundle_path
+      def app_with_bundle(bundle_path)
+        RunLoop::App.new(bundle_path)
+      end
+
+      # @!visibility private
+      # @param [String] base_dir where to start the recursive search
+      def candidate_apps(base_dir)
+        candidates = []
+        Dir.glob("#{base_dir}/**/*.app").each do |bundle_path|
+          app = app_or_nil(bundle_path)
+          candidates << app if app
+        end
+        candidates
+      end
+
+      # @!visibility private
+      # @param [String] bundle_path path to .app
+      def app_or_nil(bundle_path)
+        return nil if !RunLoop::App.valid?(bundle_path)
+
+        app = app_with_bundle(bundle_path)
+        if app.simulator? && app.calabash_server_version
+          app
+        else
+          nil
+        end
+      end
+
+      # @!visibility private
+      # @param [RunLoop::Detect] app
+      def mtime(app)
+        path = File.join(app.path, app.executable_name)
+        File.mtime(path)
+      end
+    end
+  end
+end

data/lib/run_loop/detect_aut/errors.rb

@@ -0,0 +1,127 @@
+module RunLoop
+
+  # @!visibility private
+  class SolutionMissingError < RuntimeError ; end
+
+  # @!visibility private
+  class XcodeprojMissingError < RuntimeError; end
+
+  # @!visibility private
+  class MultipleXcodeprojError < RuntimeError; end
+
+  # @!visibility private
+  class NoSimulatorAppFoundError < RuntimeError; end
+
+  # @!visibility private
+  module DetectAUT
+
+    # @!visibility private
+    module Errors
+
+      # @!visibility private
+      #
+      # Raised when XCODEPROJ is defined, but does not exist
+      def raise_xcodeproj_missing(xcodeproj)
+        raise RunLoop::XcodeprojMissingError,
+%Q[The XCODEPROJ environment variable has been set to:
+
+#{xcodeproj}
+
+but no directory exists at that path.
+
+You should only set XCODEPROJ variable if your Calabash project has more than
+one .xcodeproj directory or your .xcodeproj directory is located above the
+current directory (where you run `cucumber` from).  Calabash will discover the
+.xcodeproj if is below the current working directory.
+
+# .xcodeproj is above the working directory
+$ ls ../*.xcodeproj
+MyApp.xcodeproj
+
+$ XCODEPROJ=../*.xcodeproj cucumber
+
+# There is more than one .xcodeproj
+$ ls *.xcodeproj
+MyiOSApp.xcodeproj
+MyMacApp.xcodeproj
+
+$ XCODEPROJ=MyiOSApp.xcodeproj
+]
+      end
+
+      # @!visibility private
+      #
+      # Raised when there are more than > 1 .xcodeproj in **/*
+      # Is not raised when there are 0 .xcodeproj in **/*
+      #
+      # @param [Array<String>] projects a list of paths to .xcodeproj
+      def raise_multiple_xcodeproj(projects)
+      raise RunLoop::MultipleXcodeprojError,
+%Q[Found multiple .xcodeproj directories:
+
+#{projects.each { |path| puts "    #{path}" }}
+
+Which project contains the target of the application you are trying to test?
+
+Set the XCODEPROJ variable to specify the correct .xcodeproj directory.
+
+# Examples
+$ XCODEPROJ="../MyApp.xcodeproj" cucumber
+$ XCODEPROJ="iOS/MyApp.xcodeproj" cucumber
+]
+      end
+
+      # @!visibility private
+      #
+      # Raised when SOLUTION is defined but does not exist
+      def raise_solution_missing(solution)
+        raise RunLoop::SolutionMissingError,
+%Q[The SOLUTION environment variable has been set to:
+
+#{solution}
+
+but no solution exists at that path.
+
+You should only set SOLUTION variable if your .sln is not located in
+the current directory or in the directory just above the current
+directory (where you run `cucumber` from). Calabash will discover the
+.snl if it is in the current working directory or the directory just
+above.
+
+# Calabash will discover solution - don't set SOLUTION
+$ ls *.sln => MyApp.sln
+$ ls ../*.sln => MyApp.sln
+
+# Calabash will _not_ discover solution
+$ ls ../../*.sln => MyApp.sln
+$ SOLUTION=../../MyApp.sln cucumber
+
+$ ls project/*.sln => MyApp.sln
+$ SOLUTION=project/MyApp.sln cucumber
+
+$ ls ~/some/other/directory/*.sln => MyApp.sln
+$ SOLUTION=~/some/other/directory/MyApp.sln
+]
+      end
+
+      # @!visibility private
+      # Raised when no app can found by the discovery algorithm
+      def raise_no_simulator_app_found(search_directories)
+        raise RunLoop::NoSimulatorAppFoundError,
+              %Q[Searched these directories:
+
+#{search_directories.each { |path| puts "    #{path}" }}
+
+but could not find any .app for the simulator that contains the Calabash iOS
+server.
+
+Make sure you have built your app for a simulator target from Xcode.
+
+If you testing a stand-alone .app (you don't have an Xcode project), put your
+.app in the same directory (or below) the directory you run `cucumber` from.
+]
+      end
+    end
+  end
+end
+

data/lib/run_loop/detect_aut/xamarin_studio.rb

@@ -0,0 +1,46 @@
+module RunLoop
+  # @!visibility private
+  module DetectAUT
+
+    # @!visibility private
+    module XamarinStudio
+
+      # @!visibility private
+      def xamarin_project?
+        solution_directory != nil
+      end
+
+      # @!visibility private
+      def solution_directory
+        solution = RunLoop::Environment.solution
+
+        if solution && !File.exist?(solution)
+          raise_solution_missing(solution)
+        end
+
+        # SOLUTION defined and exists
+        return File.dirname(solution) if solution
+
+        solution_dir = find_solution_directory
+        return nil if solution_dir.nil?
+
+        solution_dir
+      end
+
+      # @!visibility private
+      def find_solution_directory
+        pwd = Dir.pwd
+        solutions = Dir.glob("#{pwd}/*.sln")
+
+        if solutions.empty?
+          solutions = Dir.glob("#{pwd}/../*.sln")
+        end
+
+        return nil if solutions.empty?
+
+        File.expand_path(File.dirname(solutions.first))
+      end
+    end
+  end
+end
+

data/lib/run_loop/detect_aut/xcode.rb

@@ -0,0 +1,136 @@
+module RunLoop
+  # @!visibility private
+  module DetectAUT
+    # @!visibility private
+    module Xcode
+
+      # @!visibility private
+      def xcode_project?
+        xcodeproj != nil
+      end
+
+      # @!visibility private
+      def xcodeproj
+        xcodeproj = RunLoop::Environment.xcodeproj
+
+        if xcodeproj && !File.directory?(xcodeproj)
+          raise_xcodeproj_missing(xcodeproj)
+        end
+
+        # XCODEPROJ defined and exists
+        return xcodeproj if xcodeproj
+
+        projects = find_xcodeproj
+
+        return nil if projects.empty?
+        return projects[0] if projects.count == 1
+
+        raise_multiple_xcodeproj(projects)
+      end
+
+      # @!visibility private
+      def find_xcodeproj
+        Dir.glob("#{Dir.pwd}/**/*.xcodeproj")
+      end
+
+      # @!visibility private
+      def detect_xcode_apps
+        dirs_to_search = derived_data_search_dirs
+
+        dir_from_prefs = xcode_preferences_search_dir
+        if dir_from_prefs
+          dirs_to_search << dir_from_prefs
+        end
+
+        apps = []
+        dirs_to_search.each do |dir|
+          # defined in detect_aut/apps.rb
+          candidates = candidate_apps(dir)
+          apps = apps.concat(candidates)
+        end
+
+        return apps, dirs_to_search
+      end
+
+      # @!visibility private
+      PLIST_KEYS = {
+        :workspace => "WorkspacePath",
+        :shared_build => "IDESharedBuildFolderName",
+        :custom_build => "IDECustomBuildProductsPath"
+      }
+
+      # @!visibility private
+      # TODO Needs unit tests
+      def derived_data_search_dirs
+        project = xcodeproj
+        project_name = File.basename(project)
+        matches = []
+
+        # WorkspacePath could be a .xcodeproj or .xcworkspace
+        #
+        # # Exact match.
+        #     xcodeproj = path/to/MyApp/MyApp.xcodeproj
+        # WorkspacePath = path/to/MyApp/MyApp.xcodeproj
+        #
+        # # CocoaPods projects are often configured like this.  As are legacy
+        # # projects that have been added to a new workspace.
+        #     xcodeproj = path/to/MyApp/MyApp.xcodeproj
+        # WorkspacePath = path/to/MyApp/MyApp.xcworkspace
+        #
+        # # This is the Xcode default when creating new iOS project
+        #     xcodeproj = path/to/MyApp/MyApp/MyApp.xcodeproj
+        # WorkspacePath = path/to/MyApp/MyApp.xcworkspace
+        key = PLIST_KEYS[:workspace]
+        Dir.glob("#{derived_data}/*/info.plist") do |plist|
+          workspace = pbuddy.plist_read(key, plist)
+          if workspace == project
+            matches << File.dirname(plist)
+          else
+            base_dir = File.dirname(workspace)
+            if File.exist?(File.join(base_dir, project_name))
+              matches << File.dirname(plist)
+            elsif !Dir.glob("#{File.dirname(workspace)}/*/#{project_name}").empty?
+              matches << File.dirname(plist)
+            elsif !Dir.glob("#{File.dirname(workspace)}/**/#{project_name}").empty?
+              matches << File.dirname(plist)
+            end
+          end
+        end
+        matches
+      end
+
+      # @!visibility private
+      def xcode_preferences_search_dir
+        plist = xcode_preferences_plist
+
+        shared_build_folder = pbuddy.plist_read(PLIST_KEYS[:shared_build], plist)
+        custom_build_folder = pbuddy.plist_read(PLIST_KEYS[:custom_build], plist)
+
+        if shared_build_folder
+          File.join(derived_data, shared_build_folder, "Products")
+        elsif custom_build_folder
+          File.join(File.dirname(xcodeproj), custom_build_folder)
+        else
+          nil
+        end
+      end
+
+      # @!visibility private
+      def derived_data
+        RunLoop::Environment.derived_data ||
+          File.expand_path("~/Library/Developer/Xcode/DerivedData")
+      end
+
+      # @!visibility private
+      def xcode_preferences_plist
+        File.expand_path('~/Library/Preferences/com.apple.dt.Xcode.plist')
+      end
+
+      # @!visibility private
+      def pbuddy
+        @pbuddy ||= RunLoop::PlistBuddy.new
+      end
+    end
+  end
+end
+

data/lib/run_loop/environment.rb

@@ -38,6 +38,49 @@ module RunLoop
       ENV["DEVICE_ENDPOINT"]
     end
 
+    # Returns the value of XCODEPROJ which can be used to specify an Xcode
+    # project directory (my.xcodeproj).
+    #
+    # This is useful if your project has multiple xcodeproj directories.
+    #
+    # Most users should not set this variable.
+    def self.xcodeproj
+      value = ENV["XCODEPROJ"]
+      if value.nil? || value == ""
+        return nil
+      else
+        File.expand_path(value)
+      end
+    end
+
+    # Returns the value of DERIVED_DATA which can be used to specify an
+    # alternative DerivedData directory.
+    #
+    # The default is ~/Library/Xcode/DerivedData, but Xcode allows you to
+    # change this value.
+    def self.derived_data
+      value = ENV["DERIVED_DATA"]
+      if value.nil? || value == ""
+        nil
+      else
+        File.expand_path(value)
+      end
+    end
+
+    # Returns the value of SOLUTION which can be used to specify a
+    # Xamarin Studio .sln
+    #
+    # This is useful if your project has multiple solutions (.sln)
+    # and Calabash cannot detect the correct one.
+    def self.solution
+      value = ENV["SOLUTION"]
+      if value.nil? || value == ""
+        nil
+      else
+        File.expand_path(value)
+      end
+    end
+
     # Returns the value of TRACE_TEMPLATE; the Instruments template to use
     # during testing.
     def self.trace_template

data/lib/run_loop/ipa.rb

@@ -45,6 +45,11 @@ module RunLoop
       app.executable_name
     end
 
+    # Returns the arches for the binary.
+    def arches
+      app.arches
+    end
+
     # Inspects the app's executables for the server version
     # @return[RunLoop::Version] a version instance
     def calabash_server_version

data/lib/run_loop/otool.rb

@@ -42,7 +42,7 @@ must exist and not be a directory.
     # @!visibility private
     def arch_info
       args = ["otool", "-hv", "-arch", "all", path]
-      opts = { :log_cmd => true }
+      opts = { :log_cmd => false }
 
       hash = xcrun.exec(args, opts)
 

data/lib/run_loop/version.rb

@@ -1,5 +1,5 @@
 module RunLoop
-  VERSION = "2.0.7"
+  VERSION = "2.0.8"
 
   # 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: 2.0.7
+  version: 2.0.8
 platform: ruby
 authors:
 - Karl Krukow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-26 00:00:00.000000000 Z
+date: 2016-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -296,6 +296,10 @@ files:
 - lib/run_loop/codesign.rb
 - lib/run_loop/core.rb
 - lib/run_loop/core_simulator.rb
+- lib/run_loop/detect_aut/detect.rb
+- lib/run_loop/detect_aut/errors.rb
+- lib/run_loop/detect_aut/xamarin_studio.rb
+- lib/run_loop/detect_aut/xcode.rb
 - lib/run_loop/device.rb
 - lib/run_loop/directory.rb
 - lib/run_loop/dot_dir.rb
@@ -369,3 +373,4 @@ specification_version: 4
 summary: The bridge between Calabash iOS and Xcode command-line tools like instruments
   and simctl.
 test_files: []
+has_rdoc: