calabash-cucumber 0.9.169.pre2 → 0.9.169.pre5

data/lib/calabash-cucumber/launcher.rb

@@ -1,21 +1,32 @@
-require 'calabash-cucumber/launch/simulator_helper'
+require 'calabash-cucumber/launch/simulator_launcher'
+require 'calabash-cucumber/utils/simulator_accessibility'
 require 'sim_launcher'
 require 'calabash-cucumber/device'
 require 'calabash-cucumber/actions/instruments_actions'
 require 'calabash-cucumber/actions/playback_actions'
 require 'run_loop'
 require 'cfpropertylist'
+require 'calabash-cucumber/version'
+require 'calabash-cucumber/utils/logging'
+
 
 class Calabash::Cucumber::Launcher
 
+  include Calabash::Cucumber::Logging
+  include Calabash::Cucumber::SimulatorAccessibility
+
   KNOWN_PRIVACY_SETTINGS = {:photos => 'kTCCServicePhotos', :calendar => 'kTCCServiceCalendar', :address_book => 'kTCCServiceAddressBook'}
 
+  @@launcher = nil
+
+  SERVER_VERSION_NOT_AVAILABLE = '0.0.0'
+  @@server_version = nil
+
   attr_accessor :run_loop
   attr_accessor :device
   attr_accessor :actions
   attr_accessor :launch_args
-
-  @@launcher = nil
+  attr_accessor :simulator_launcher
 
   class StartError < RuntimeError
     attr_accessor :error
@@ -33,6 +44,11 @@ class Calabash::Cucumber::Launcher
   end
 
 
+  def initialize
+    @simulator_launcher = Calabash::Cucumber::SimulatorLauncher.new
+    @@launcher = self
+  end
+
   def actions
     attach if @actions.nil?
     @actions
@@ -42,7 +58,6 @@ class Calabash::Cucumber::Launcher
     l = launcher
     return l if l && l.active?
     l.attach
-
   end
 
   def attach(max_retry=1, timeout=10)
@@ -94,11 +109,10 @@ class Calabash::Cucumber::Launcher
     @@launcher
   end
 
-  def initialize
-    @@launcher = self
-  end
-
   def ios_major_version
+    # pinging the app will set self.device
+    ping_app if self.device.nil?
+    # guard against Runtime errors
     return nil if device.nil? or device.ios_version.nil?
     device.ios_major_version
   end
@@ -109,14 +123,14 @@ class Calabash::Cucumber::Launcher
   end
 
   def reset_app_jail(sdk=nil, path=nil)
-    sdk ||= sdk_version || SimLauncher::SdkDetector.new().latest_sdk_version
-    path ||= Calabash::Cucumber::SimulatorHelper.app_bundle_or_raise(app_path)
+    sdk ||= sdk_version || self.simulator_launcher.sdk_detector.latest_sdk_version
+    path ||= self.simulator_launcher.app_bundle_or_raise(app_path)
 
     app = File.basename(path)
     directories_for_sdk_prefix(sdk).each do |dir|
       bundle = `find "#{dir}/Applications" -type d -depth 2 -name "#{app}" | head -n 1`
       next if bundle.empty? # Assuming we're already clean
-      if ENV['DEBUG']=='1'
+      if debug_logging?
         puts "Reset app state for #{bundle}"
       end
       sandbox = File.dirname(bundle)
@@ -134,7 +148,7 @@ class Calabash::Cucumber::Launcher
 
   # Call as update_privacy_settings('com.my.app', {:photos => {:allow => true}})
   def update_privacy_settings(bundle_id, opts={})
-    if ENV['DEBUG']=='1'
+    if debug_logging?
       puts "Update privacy settings #{bundle_id}, #{opts}"
     end
     unless File.exist?(`which sqlite3`.strip)
@@ -144,15 +158,15 @@ class Calabash::Cucumber::Launcher
 
       setting_name = KNOWN_PRIVACY_SETTINGS[setting_name] || setting_name
       allow = setting_options[:allow] == false ? false : true
-      sdk = setting_options[:sdk] || SimLauncher::SdkDetector.new().latest_sdk_version
+      sdk = setting_options[:sdk] || self.simulator_launcher.sdk_detector.latest_sdk_version
 
       dirs = directories_for_sdk_prefix(sdk)
-      if ENV['DEBUG']=='1'
+      if debug_logging?
         puts "About to update privacy setting #{setting_name} for #{bundle_id}, allow: #{allow} in sdk #{sdk}, #{dirs}"
       end
 
       dirs.each do |dir|
-        if ENV['DEBUG']=='1'
+        if debug_logging?
           puts "Setting access for #{bundle_id} for permission #{setting_name} to allow: #{allow}"
         end
         path_to_tcc_db = tcc_database_for_sdk_dir(dir)
@@ -167,7 +181,7 @@ class Calabash::Cucumber::Launcher
           sql = %Q['UPDATE access SET allowed=#{allowed_as_i} where client="#{bundle_id}" AND service="#{setting_name}";']
         end
 
-        if ENV['DEBUG']=='1'
+        if debug_logging?
           puts "Executing sql #{sql} on #{path_to_tcc_db}"
         end
 
@@ -211,7 +225,11 @@ class Calabash::Cucumber::Launcher
         :device => device_env,
         :no_stop => calabash_no_stop?,
         :no_launch => calabash_no_launch?,
-        :sdk_version => sdk_version
+        :sdk_version => sdk_version,
+        # do not advertise this to users!
+        # for example, don't include documentation about this
+        # this is used to instrument internal testing
+        :launch_retries => 5
     }
 
     #:device_target will be set
@@ -260,7 +278,7 @@ class Calabash::Cucumber::Launcher
       begin
         major = major.to_i
       rescue
-        warn("SDK_VERSION invalid #{sdk_version} - ignoring...")
+        calabash_warn("SDK_VERSION invalid #{sdk_version} - ignoring...")
       end
     end
     return :instruments if major && major >= 7 # Only instruments supported for iOS7+
@@ -270,8 +288,7 @@ class Calabash::Cucumber::Launcher
       return use_sim_launcher_env? ? :sim_launcher : :instruments
     end
 
-    sim_detector = SimLauncher::SdkDetector.new()
-    available = sim_detector.available_sdk_versions.reject { |v| v.start_with?('7') }
+    available = self.simulator_launcher.sdk_detector.available_sdk_versions.reject { |v| v.start_with?('7') }
     if available.include?(sdk_version)
       :sim_launcher
     else
@@ -304,7 +321,7 @@ class Calabash::Cucumber::Launcher
       else
         device_xamarin_build_dir = 'iPhone'
       end
-      args[:app] = Calabash::Cucumber::SimulatorHelper.app_bundle_or_raise(app_path, device_xamarin_build_dir)
+      args[:app] = self.simulator_launcher.app_bundle_or_raise(app_path, device_xamarin_build_dir)
     end
 
     args[:bundle_id] ||= detect_bundle_id_from_app_bundle(args)
@@ -324,18 +341,22 @@ class Calabash::Cucumber::Launcher
       end
     end
 
+    if simulator_target?(args)
+      enable_accessibility_on_simulators
+    end
+
     if run_with_instruments?(args)
       self.run_loop = new_run_loop(args)
       self.actions= Calabash::Cucumber::InstrumentsActions.new
     else
       # run with sim launcher
-      sdk = sdk_version || SimLauncher::SdkDetector.new().available_sdk_versions.reverse.find { |x| !x.start_with?('7') }
-      path = Calabash::Cucumber::SimulatorHelper.app_bundle_or_raise(app_path)
       self.actions= Calabash::Cucumber::PlaybackActions.new
-      Calabash::Cucumber::SimulatorHelper.relaunch(path, sdk, args[:device].to_s, args)
+      # why not just pass args - AFAICT args[:app] == app_path?
+      self.simulator_launcher.relaunch(app_path, sdk_version(), args)
     end
     self.launch_args = args
     ensure_connectivity
+    check_server_gem_compatibility
   end
 
   def detect_device_from_args(args)
@@ -360,13 +381,15 @@ class Calabash::Cucumber::Launcher
 
   end
 
+  # todo this method should be migrated to the Simulator Launcher
   def detect_app_bundle_from_args(args)
     if args[:device_target]=='simulator'
       device_xamarin_build_dir = 'iPhoneSimulator'
     else
       device_xamarin_build_dir = 'iPhone'
     end
-    Calabash::Cucumber::SimulatorHelper.detect_app_bundle(nil, device_xamarin_build_dir)
+    # is this really only applicable to the Xamarin IDE?
+    self.simulator_launcher.detect_app_bundle(nil, device_xamarin_build_dir)
   end
 
   def detect_bundle_id_from_app_bundle(args)
@@ -387,22 +410,31 @@ class Calabash::Cucumber::Launcher
   end
 
   def new_run_loop(args)
-    if RunLoop::Core.above_or_eql_version?('5.1', RunLoop::Core.xcode_version)
-      Calabash::Cucumber::SimulatorHelper.stop
+
+    # for stability, quit the simulator if Xcode version is > 5.1 and the
+    # target device is the simulator
+    target_is_sim = simulator_target?(args)
+    xcode_gte_51 = RunLoop::Core.above_or_eql_version?('5.1', RunLoop::Core.xcode_version)
+    if target_is_sim and xcode_gte_51
+      self.simulator_launcher.stop
     end
+
     last_err = nil
-    5.times do
+
+    num_retries = args[:launch_retries] || 5
+
+    num_retries.times do
       begin
         return RunLoop.run(args)
       rescue RunLoop::TimeoutError => e
         last_err = e
-        if ENV['CALABASH_FULL_CONSOLE_OUTPUT'] == '1'
+        if full_console_logging?
           puts 'retrying run loop...'
         end
-        Calabash::Cucumber::SimulatorHelper.stop
+        self.simulator_launcher.stop
       end
     end
-    Calabash::Cucumber::SimulatorHelper.stop
+    self.simulator_launcher.stop
     puts "Unable to start. Make sure you've set APP_BUNDLE_PATH to a build supported by this simulator version"
     raise StartError.new(last_err)
   end
@@ -413,8 +445,8 @@ class Calabash::Cucumber::Launcher
       timeout = (ENV['CONNECT_TIMEOUT'] || timeout).to_i
       retry_count = 0
       connected = false
-      if ENV['CALABASH_FULL_CONSOLE_OUTPUT'] == '1'
-        puts "Waiting for App to be ready"
+      if full_console_logging?
+        puts 'Waiting for App to be ready'
       end
       until connected do
         raise "MAX_RETRIES" if retry_count == max_retry_count
@@ -488,7 +520,7 @@ class Calabash::Cucumber::Launcher
 
   def detect_bundle_id
     begin
-      bundle_path = Calabash::Cucumber::SimulatorHelper.app_bundle_or_raise(app_path)
+      bundle_path = self.simulator_launcher.app_bundle_or_raise(app_path)
       plist_path = File.join(bundle_path, 'Info.plist')
       info_plist_as_hash(plist_path)['CFBundleIdentifier']
     rescue => e
@@ -508,8 +540,10 @@ class Calabash::Cucumber::Launcher
     (ENV['DEVICE_TARGET'] != nil) && (not simulator_target?)
   end
 
-  def simulator_target?
-    ENV['DEVICE_TARGET'] == 'simulator'
+  def simulator_target?(launch_args={})
+    value = ENV['DEVICE_TARGET'] || launch_args[:device_target]
+    return false if value.nil?
+    value.downcase.include?('simulator')
   end
 
   def sdk_version
@@ -556,6 +590,108 @@ class Calabash::Cucumber::Launcher
     msg.join("\n")
   end
 
+  # extracts server version from the app binary at +app_bundle_path+ by
+  # inspecting the binary's strings table.
+  #
+  # SPECIAL: sets the +@@server_version+ class variable to cache the server
+  # version because the server version will never change during runtime.
+  #
+  # @return [String] the server version
+  # @param [String] app_bundle_path file path (usually) to the application bundle
+  # @raise [RuntimeError] if there is no executable at +app_bundle_path+
+  # @raise [RuntimeError] if the server version cannot be extracted from any
+  #   binary at +app_bundle_path+
+  def server_version_from_bundle(app_bundle_path)
+    return @@server_version unless @@server_version.nil?
+    exe_paths = []
+    Dir.foreach(app_bundle_path) do |item|
+      next if item == '.' or item == '..'
+
+      full_path = File.join(app_bundle_path, item)
+      if File.executable?(full_path) and not File.directory?(full_path)
+        exe_paths << full_path
+      end
+    end
+
+    if exe_paths.empty?
+      calabash_warn "could not find executable in '#{app_bundle_path}'"
+
+      @@server_version = SERVER_VERSION_NOT_AVAILABLE
+      return @@server_version
+    end
+
+    server_version = nil
+    exe_paths.each do |path|
+      server_version_string = `strings #{path} | grep -E 'CALABASH VERSION'`.chomp!
+      if server_version_string
+        server_version = server_version_string.split(' ').last
+        break
+      end
+    end
+
+    unless server_version
+      calabash_warn('could not find server version by inspecting the binary strings table')
+
+      @@server_version = SERVER_VERSION_NOT_AVAILABLE
+      return @@server_version
+    end
+
+    @@server_version = server_version
+  end
+
+  # queries the server for its version.
+  #
+  # SPECIAL: sets the +@@server_version+ class variable to cache the server
+  # version because the server version will never change during runtime.
+  #
+  # @return [String] the server version
+  # @raise [RuntimeError] if the server cannot be reached
+  def server_version_from_server
+    return @@server_version unless @@server_version.nil?
+    ensure_connectivity if self.device == nil
+    @@server_version = self.device.server_version
+  end
+
+  # checks the server and gem version compatibility and generates a warning if
+  # the server and gem are not compatible.
+  #
+  # WIP:  this is a proof-of-concept implementation and requires _strict_
+  # equality.  in the future we should allow minimum framework compatibility.
+  #
+  # @return [nil] nothing to return
+  def check_server_gem_compatibility
+    app_bundle_path = self.launch_args[:app]
+    if File.directory?(app_bundle_path)
+      server_version = server_version_from_bundle(app_bundle_path)
+    else
+      server_version = server_version_from_server
+    end
+
+    if server_version == SERVER_VERSION_NOT_AVAILABLE
+      calabash_warn('server version could not be found - skipping compatibility check')
+      return nil
+    end
+
+    server_version = Calabash::Cucumber::Version.new(server_version)
+    gem_version = Calabash::Cucumber::Version.new(Calabash::Cucumber::VERSION)
+    min_server_version = Calabash::Cucumber::Version.new(Calabash::Cucumber::MIN_SERVER_VERSION)
+
+    if server_version < min_server_version
+      msgs = []
+      msgs << 'server version is not compatible with gem version'
+      msgs << 'please update your server and gem'
+      msgs << "       gem version: '#{gem_version}'"
+      msgs << "min server version: '#{min_server_version}'"
+      msgs << "    server version: '#{server_version}'"
+
+      calabash_warn("#{msgs.join("\n")}")
+    else
+      if full_console_logging?
+        calabash_info("gem #{gem_version} is compat with '#{server_version}'")
+      end
+    end
+    nil
+  end
 
 end
 

data/lib/calabash-cucumber/operations.rb

@@ -11,6 +11,7 @@ require 'set'
 require 'calabash-cucumber/version'
 require 'calabash-cucumber/date_picker'
 require 'calabash-cucumber/ipad_1x_2x'
+require 'calabash-cucumber/utils/logging'
 
 if not Object.const_defined?(:CALABASH_COUNT)
   #compatability with IRB
@@ -21,7 +22,9 @@ end
 module Calabash
   module Cucumber
     module Operations
+
       include Test::Unit::Assertions
+      include Calabash::Cucumber::Logging
       include Calabash::Cucumber::Core
       include Calabash::Cucumber::TestsHelpers
       include Calabash::Cucumber::WaitHelpers
@@ -64,10 +67,6 @@ module Calabash
         simple_touch(label, *args)
       end
 
-      def tap_mark(label, *args)
-        simple_touch(label, *args)
-      end
-
       def html(q)
         query(q).map { |e| e['html'] }
       end

data/lib/calabash-cucumber/playback_helpers.rb

@@ -1,8 +1,12 @@
+require 'calabash-cucumber/utils/logging'
+require 'calabash-cucumber/device'
 
 module Calabash
   module Cucumber
     module PlaybackHelpers
 
+      include Calabash::Cucumber::Logging
+
       DATA_PATH = File.expand_path(File.dirname(__FILE__))
 
       def recording_name_for(recording_name, os, device)
@@ -19,11 +23,6 @@ module Calabash
         directories.each { |dir|
           path = "#{dir}/#{recording}"
           if File.exists?(path)
-            # useful for debugging recordings, but too verbose for release
-            # suggest (yet) another variable CALABASH_DEBUG_PLAYBACK ?
-            #if ENV['CALABASH_FULL_CONSOLE_OUTPUT'] == '1'
-            #  puts "found compatible playback: '#{path}'"
-            #end
             return File.read(path)
           end
         }
@@ -40,18 +39,12 @@ module Calabash
       end
 
       def load_playback_data(recording_name, options={})
-        os = options['OS'] || ENV['OS']
         device = options['DEVICE'] || ENV['DEVICE'] || 'iphone'
 
-        unless os
-          if @calabash_launcher && @calabash_launcher.active?
-            major = @calabash_launcher.ios_major_version
-          else
-            major = Calabash::Cucumber::SimulatorHelper.ios_major_version
-          end
+        major = Calabash::Cucumber::Launcher.launcher.ios_major_version
 
-          unless major
-            raise <<EOF
+        unless major
+          raise <<EOF
           Unable to determine iOS major version
           Most likely you have updated your calabash-cucumber client
           but not your server. Please follow closely:
@@ -60,9 +53,8 @@ https://github.com/calabash/calabash-ios/wiki/B1-Updating-your-Calabash-iOS-vers
 
           If you are running version 0.9.120+ then please report this message as a bug.
 EOF
-          end
-          os = "ios#{major}"
         end
+        os = "ios#{major}"
 
         rec_dir = ENV['PLAYBACK_DIR'] || "#{Dir.pwd}/features/playback"
 
@@ -70,7 +62,7 @@ EOF
         data = find_compatible_recording(recording_name, os, rec_dir, device, candidates)
 
         if data.nil? and device=='ipad'
-          if ENV['CALABASH_FULL_CONSOLE_OUTPUT'] == '1'
+          if full_console_logging?
             puts "Unable to find recording for #{os} and #{device}. Trying with #{os} iphone"
           end
           data = find_compatible_recording(recording_name, os, rec_dir, 'iphone', candidates)
@@ -157,17 +149,11 @@ EOF
         end
 
         device = ENV['DEVICE'] || 'iphone'
-        os = ENV['OS']
 
-        unless os
-          if @calabash_launcher && @calabash_launcher.active?
-            major = @calabash_launcher.ios_major_version
-          else
-            major = Calabash::Cucumber::SimulatorHelper.ios_major_version
-          end
+        major = Calabash::Cucumber::Launcher.launcher.ios_major_version
 
-          unless major
-            raise <<EOF
+        unless major
+          raise <<EOF
           Unable to determine iOS major version
           Most likely you have updated your calabash-cucumber client
           but not your server. Please follow closely:
@@ -176,9 +162,9 @@ https://github.com/calabash/calabash-ios/wiki/B1-Updating-your-Calabash-iOS-vers
 
           If you are running version 0.9.120+ then please report this message as a bug.
 EOF
-          end
-          os = "ios#{major}"
+
         end
+        os = "ios#{major}"
 
         file_name = "#{file_name}_#{os}_#{device}.base64"
         system('/usr/bin/plutil -convert binary1 -o _recording_binary.plist _recording.plist')
@@ -187,7 +173,7 @@ EOF
 
         rec_dir = ENV['PLAYBACK_DIR'] || "#{Dir.pwd}/features/playback"
         unless File.directory?(rec_dir)
-          if ENV['CALABASH_FULL_CONSOLE_OUTPUT'] == '1'
+          if full_console_logging?
             puts "creating playback directory at '#{rec_dir}'"
           end
           system("mkdir -p #{rec_dir}")