calabash-cucumber 0.18.2 → 0.19.0.pre1

data/lib/calabash-cucumber/environment.rb

@@ -2,13 +2,117 @@ module Calabash
   module Cucumber
     module Environment
 
-      def self.device_target
-        value = ENV["DEVICE_TARGET"]
+      require "run_loop"
 
-        if value.nil? || value == ""
-          nil
-        else
+      # @!visibility private
+      DEFAULTS = {
+        # The endpoint of the app under test
+        :aut_endpoint => "http://127.0.0.1:37265/",
+        :http_connection_retries => 10,
+        :http_connection_timeout => 60
+      }
+
+      # @!visibility private
+      def self.xtc?
+        RunLoop::Environment.xtc?
+      end
+
+      # @!visibility private
+      def self.xcode
+        return nil if self.xtc?
+        @@xcode ||= RunLoop::Xcode.new
+      end
+
+      # @!visibility private
+      def self.simctl
+        return nil if self.xtc?
+        @@simctl ||= RunLoop::SimControl.new
+      end
+
+      # @!visibility private
+      def self.instruments
+        return nil if self.xtc?
+        @@instruments ||= RunLoop::Instruments.new
+      end
+
+      # @!visibility private
+      def self.device_endpoint
+        value = RunLoop::Environment.device_endpoint
+        if value
           value
+        else
+          DEFAULTS[:aut_endpoint]
+        end
+      end
+
+      # @!visibility private
+      def self.http_connection_retries
+        value = ENV["MAX_CONNECT_RETRIES"]
+        if value && value != ""
+          value.to_i
+        else
+          DEFAULTS[:http_connection_retries]
+        end
+      end
+
+      # @!visibility private
+      def self.http_connection_timeout
+        value = ENV["CONNECTION_TIMEOUT"]
+        if value && value != ""
+          value.to_i
+        else
+          DEFAULTS[:http_connection_timeout]
+        end
+      end
+
+      # @!visibility private
+      def self.reset_between_scenarios?
+        ENV["RESET_BETWEEN_SCENARIOS"] == "1"
+      end
+
+      # @!visibility private
+      def self.quit_app_after_scenario?
+        value = ENV["QUIT_APP_AFTER_SCENARIO"]
+
+        if value == "0"
+          false
+        elsif value == "1"
+          true
+        else
+          !self.no_stop?
+        end
+      end
+
+      private
+
+      # @visibility private
+      # @deprecated 0.19.0 - replaced with QUIT_APP_AFTER_SCENARIO
+      #
+      # Silently deprecated.  Deprecate in 0.20.0.
+      def self.no_stop?
+        value = ENV["NO_STOP"]
+        if value
+          return_value = value == "1"
+
+=begin
+          if return_value
+            replacement = "$ QUIT_APP_AFTER_SCENARIO=0"
+          else
+            replacement = "$ QUIT_APP_AFTER_SCENARIO=1"
+          end
+          RunLoop.deprecated("0.19.0",
+%Q{The 'NO_STOP' env variable has been been replaced with: QUIT_APP_AFTER_SCENARIO
+
+Please replace NO_STOP with QUIT_APP_AFTER_SCENARIO.
+
+#{replacement}
+
+The default behavior is to quit the app after each scenario.
+})
+=end
+          return_value
+        else
+          false
         end
       end
     end

data/lib/calabash-cucumber/environment_helpers.rb

@@ -1,6 +1,5 @@
 require 'calabash-cucumber/device'
 require 'calabash-cucumber/launcher'
-require 'calabash-cucumber/utils/logging'
 
 module Calabash
   module Cucumber
@@ -13,8 +12,6 @@ module Calabash
     #  be set.
     module EnvironmentHelpers
 
-      include Calabash::Cucumber::Logging
-
       # Are the uia* methods available?
       #
       # @note
@@ -133,10 +130,6 @@ module Calabash
 
       # The iOS version on the device under test.
       #
-      # @note
-      #  **WARNING:** The `OS` env variable has been deprecated and should
-      #  never be set.
-      #
       # @raise [RuntimeError] If the server cannot be reached.
       # @return [RunLoop::Version] The version of the iOS running on the device.
       def ios_version
@@ -160,55 +153,30 @@ module Calabash
 
       # Is the device under test running iOS 5?
       #
-      # @note
-      #  **WARNING:** The `OS` env variable has been deprecated and should
-      #  never be set.
-      #
-      # @note
-      #  **WARNING:* Setting the `OS` env variable will override the value returned
-      #  by querying the device.
       # @raise [RuntimeError] if the server cannot be reached
       # @return [Boolean] true if device under test is running iOS 5
       def ios5?
-        _OS_ENV.eql?(_canonical_os_version(:ios5)) || _default_device_or_create().ios5?
+         _default_device_or_create.ios5?
       end
 
       # Is the device under test running iOS 6?
       #
-      # @note
-      #  **WARNING:** The `OS` env variable has been deprecated and should
-      #  never be set.
-      #
-      # @note
-      #  **WARNING:* Setting the `OS` env variable will override the value returned
-      #  by querying the device.
       # @raise [RuntimeError] if the server cannot be reached
       # @return [Boolean] true if device under test is running iOS 6
       def ios6?
-        _OS_ENV.eql?(_canonical_os_version(:ios6)) || _default_device_or_create().ios6?
+        _default_device_or_create.ios6?
       end
 
       # Is the device under test running iOS 7?
       #
-      # @note
-      #  **WARNING:** The `OS` env variable has been deprecated and should
-      #  never be set.
-      #
-      # @note
-      #  **WARNING:* Setting the `OS` env variable will override the value returned
-      #  by querying the device.
       # @raise [RuntimeError] if the server cannot be reached
       # @return [Boolean] true if device under test is running iOS 7
       def ios7?
-        _OS_ENV.eql?(_canonical_os_version(:ios7)) || _default_device_or_create().ios7?
+        _default_device_or_create.ios7?
       end
 
       # Is the device under test running iOS 8?
       #
-      # @note
-      #  **WARNING:** The `OS` env variable has been deprecated and should
-      #  never be set.
-      #
       # @raise [RuntimeError] if the server cannot be reached
       # @return [Boolean] true if device under test is running iOS 8
       def ios8?
@@ -217,10 +185,6 @@ module Calabash
 
       # Is the device under test running iOS 9?
       #
-      # @note
-      #  **WARNING:** The `OS` env variable has been deprecated and should
-      #  never be set.
-      #
       # @raise [RuntimeError] if the server cannot be reached
       # @return [Boolean] true if device under test is running iOS 9
       def ios9?
@@ -237,13 +201,6 @@ module Calabash
         _default_device_or_create.iphone_app_emulated_on_ipad?
       end
 
-      # @deprecated 0.9.168 replaced with `iphone_4in?`
-      # @see #iphone_4in?
-      def iphone_5?
-        _deprecated('0.9.168', "use 'iphone_4in?' instead", :warn)
-        iphone_4in?
-      end
-
       private
       # @!visibility private
       # Returns the device that is currently being tested against.
@@ -256,29 +213,10 @@ module Calabash
       def _default_device_or_create
         device = default_device
         if device.nil?
-          device = Calabash::Cucumber::Device.new(nil, server_version())
+          device = Calabash::Cucumber::Device.new(nil, server_version)
         end
         device
       end
-
-      # Returns the value of the environmental variable OS.
-      #
-      # @note
-      #  The `OS` env has been deprecated for some time.  It should never be set.
-      def _OS_ENV
-        ENV['OS']
-      end
-
-      # @!visibility private
-      CANONICAL_IOS_VERSIONS = {:ios5 => 'ios5',
-                                :ios6 => 'ios6',
-                                :ios7 => 'ios7'}
-
-
-      # Returns the canonical value iOS versions as strings.
-      def _canonical_os_version(key)
-        CANONICAL_IOS_VERSIONS[key]
-      end
     end
   end
 end

data/lib/calabash-cucumber/http/http.rb

@@ -0,0 +1,114 @@
+module Calabash
+  module Cucumber
+
+    # Raised when a connection to the embedded server cannot be made.
+    class ServerNotRespondingError < RuntimeError; end
+
+    # @!visibility private
+    class HTTP
+
+      require "json"
+      require "calabash-cucumber/environment"
+      require "run_loop"
+
+      # @!visibility private
+      def self.ping_app
+        endpoint = Calabash::Cucumber::Environment.device_endpoint
+        url = URI.parse(endpoint)
+
+        http = Net::HTTP.new(url.host, url.port)
+        response = http.start do |sess|
+          sess.request(Net::HTTP::Get.new("version"))
+        end
+
+        body = nil
+        success = response.is_a?(Net::HTTPSuccess)
+        if success
+          json = response.body
+          begin
+            body = JSON.parse(json)
+          rescue TypeError, JSON::ParserError => _
+            success = false
+          end
+        end
+
+        http.finish if http and http.started?
+
+        return success, body
+      end
+
+      # @!visibility private
+      def self.ensure_connectivity(options={})
+
+        default_options = {
+          :http_connection_retry => Calabash::Cucumber::Environment.http_connection_retries,
+          :http_connection_timeout => Calabash::Cucumber::Environment.http_connection_timeout
+        }
+
+        merged_options = default_options.merge(options)
+
+        max_retry_count = merged_options[:http_connection_retry]
+        timeout = merged_options[:http_connection_timeout]
+
+        start_time = Time.now
+        last_error = nil
+
+        max_retry_count.times do |try|
+          RunLoop.log_debug("Trying to connect to Calabash Server: #{try + 1} of #{max_retry_count}")
+
+          # Subtract the aggregate time we've spent thus far to make sure we're
+          # not exceeding the request timeout across retries.
+          time_diff = start_time + timeout - Time.now
+
+          if time_diff <= 0
+            break
+          end
+
+          begin
+            success, body = self.ping_app
+            return success, body if success
+          rescue => e
+            last_error = e
+          ensure
+            sleep(1)
+          end
+        end
+
+        self.raise_on_no_connectivity(last_error)
+      end
+
+      private
+
+      def self.raise_on_no_connectivity(last_error)
+        if Calabash::Cucumber::Environment.xtc?
+          raise Calabash::Cucumber::ServerNotRespondingError,
+%Q[Could not connect to the Calabash Server.
+
+#{last_error}
+
+Please contact: testcloud-support@xamarin.com
+]
+        else
+          endpoint = Calabash::Cucumber::Environment.device_endpoint
+          raise Calabash::Cucumber::ServerNotRespondingError,
+%Q[Could not connect to the Calabash Server @ #{endpoint}.
+
+See these two guides for help.
+
+* https://github.com/calabash/calabash-ios/wiki/Testing-on-Physical-Devices
+* https://github.com/calabash/calabash-ios/wiki/Testing-on-iOS-Simulators
+
+1. Make sure your application is linked with Calabash.
+2. Make sure there is not a firewall blocking traffic on #{endpoint}.
+3. Make sure #{endpoint} is correct.
+
+If your app is crashing at launch, find a crash report to determine the cause.
+
+]
+        end
+
+      end
+    end
+  end
+end
+

data/lib/calabash-cucumber/http_helpers.rb

@@ -6,6 +6,8 @@ module Calabash
     # @!visibility private
     module HTTPHelpers
 
+      require "calabash-cucumber/environment"
+
       # @!visibility private
       CAL_HTTP_RETRY_COUNT=3
 
@@ -33,7 +35,7 @@ module Calabash
 
       # @!visibility private
       def url_for(verb)
-        url = URI.parse(ENV['DEVICE_ENDPOINT']|| "http://localhost:37265")
+        url = URI.parse(Calabash::Cucumber::Environment.device_endpoint)
         path = url.path
         if path.end_with? "/"
           path = "#{path}#{verb}"

data/lib/calabash-cucumber/ipad_1x_2x.rb

@@ -206,13 +206,11 @@ module Calabash
       #
       # @example Here is an example of how to use this function in your `Before` launch hooks.
       #  Before do |scenario|
-      #    @calabash_launcher = Calabash::Cucumber::Launcher.new
-      #    unless @calabash_launcher.calabash_no_launch?
-      #      @calabash_launcher.relaunch
-      #      @calabash_launcher.calabash_notify(self)
-      #      # ensure emulated apps are at 1x
-      #      ensure_ipad_emulation_1x
-      #    end
+      #    launcher = Calabash::Cucumber::Launcher.new
+      #    launcher.relaunch
+      #    # ensure emulated apps are at 1x
+      #    ensure_ipad_emulation_1x
+      #
       #    # do other stuff to prepare the test environment
       #  end
       #

data/lib/calabash-cucumber/keyboard_helpers.rb

@@ -1,13 +1,10 @@
 require 'calabash-cucumber/core'
 require 'calabash-cucumber/tests_helpers'
-require 'calabash-cucumber/playback_helpers'
 require 'calabash-cucumber/environment_helpers'
-require 'calabash-cucumber/utils/logging'
 
 module Calabash
   module Cucumber
 
-
     # Raised when there is a problem involving a keyboard mode.  There are
     # three keyboard modes:  docked, split, and undocked.
     #
@@ -52,7 +49,6 @@ module Calabash
     module KeyboardHelpers
 
       include Calabash::Cucumber::TestsHelpers
-      include Calabash::Cucumber::Logging
 
       # @!visibility private
       KEYPLANE_NAMES = {
@@ -168,13 +164,6 @@ module Calabash
         end
       end
 
-      # @deprecated 0.9.163 replaced with `wait_for_keyboard`
-      # @see #wait_for_keyboard
-      def await_keyboard
-        _deprecated('0.9.163', "use 'wait_for_keyboard' instead", :warn)
-        wait_for_keyboard
-      end
-
       # @!visibility private
       # returns an array of possible ipad keyboard modes
       def _ipad_keyboard_modes
@@ -291,12 +280,6 @@ module Calabash
       # @option opts [Float] :wait_after_char ('POST_ENTER_KEYBOARD' or 0.05)
       #  how long to wait after a character is typed.
       def keyboard_enter_char(chr, opts={})
-        unless opts.is_a?(Hash)
-         msg = "you should no longer pass a boolean as the second arg; pass {:should_screenshot => '#{opts}'}  hash instead"
-         _deprecated('0.9.163', msg, :warn)
-         opts = {:should_screenshot => opts}
-        end
-
         default_opts = {:should_screenshot => true,
                         # introduce a small wait to avoid skipping characters
                         # keep this as short as possible
@@ -450,33 +433,6 @@ module Calabash
         keyboard_enter_char 'Return'
       end
 
-      # @deprecated 0.10.0 replaced with `tap_keyboard_action_key`
-      # @see #tap_keyboard_action_key
-      #
-      # Touches the keyboard action key.
-      #
-      # The action key depends on the keyboard.  Some examples include:
-      #
-      # * Return
-      # * Next
-      # * Go
-      # * Join
-      # * Search
-      #
-      # @note
-      #  Not all keyboards have an action key.  For example, numeric keyboards
-      #  do not have an action key.
-      #
-      # @raise [RuntimeError] if the text cannot be typed.
-      def done
-        _deprecated("0.10.0",
-%Q{Use tap_keyboard_action_key
-
-The `done` method will be removed in 0.19.0
-}, :warn)
-        tap_keyboard_action_key
-      end
-
       # @!visibility private
       # Returns the current keyplane.
       def _current_keyplane