calabash-cucumber 0.16.4 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 016c8a3a27e8b446b227901e7f276da121de8ea7
-  data.tar.gz: 86aeca1d34e5697bcc0de385ef2d9fc2c9814807
+  metadata.gz: 21ca53be02da9a57cb4baffd965a8ce32d959a80
+  data.tar.gz: 30ff3a6acafdca9a4d45b5855418e37d122a0cc0
 SHA512:
-  metadata.gz: 57b0a72c1d5e1594105c4b9dbe8807ed98cb3b5e0dfb85df19e7ea3e018555971549b58e1353d9524addef4a7c49a38150507335178361a13876059bd32c853d
-  data.tar.gz: 962e4026c8acc4a669f0ee029c3661ea402aff169e0026357f09cb6448579bc8e874dfb0c4f44699ddd0d428622bf3643ed1e37ffe830dd5843b2c4c922bae17
+  metadata.gz: b20587099e1b708a242899de712604b6e675768a453a09f91ba5f5dd4b4a4e088c72343ff6577b40a945c9eaca58fd3ef54af5a2711af20c16090844ae353629
+  data.tar.gz: 2b532a1873a5b4a56c141b363b0e9acb46b6012b228fe34f19afb78ab40066444df869ced45d35ffd300e5b90e604729ded46827441546cc6bf79b3a1a8d9d82

data/bin/calabash-ios-generate.rb

@@ -2,22 +2,73 @@
 def calabash_scaffold
   if File.exists?(@features_dir)
     puts "A features directory already exists. Stopping..."
-    #puts "Run calabash-ios update for update instructions."
     exit 1
   end
+
   msg("Question") do
-    puts "I'm about to create a subdirectory called features."
-    puts "features will contain all your calabash tests."
-    puts "Please hit return to confirm that's what you want."
+    puts "I'm about to create a features directory here:"
+    puts ""
+    puts "#{ENV["PWD"]}/features"
+    puts ""
+    puts "This directory will contain all of your calabash tests."
+    puts "Shall I proceed? (Y/n)"
   end
-  exit 2 unless STDIN.gets.chomp == ''
 
-  FileUtils.cp_r(@source_dir, @features_dir)
+  response = STDIN.gets.chomp.downcase
+  proceed = response == "" || response == "y"
+
+  puts ""
 
-  msg("Info") do
-    puts "Features subdirectory created. \n"
-    puts "Make sure you've build your -cal scheme in XCode and "
-    puts "try executing \n\ncucumber"
+  if !proceed
+    puts "Skipping installation of features/ directory"
+  else
+    FileUtils.cp_r(@source_dir, @features_dir)
+    puts "Created: #{ENV["PWD"]}/features"
+    puts ""
   end
 
+  gemfile = File.join(ENV["PWD"], "Gemfile")
+
+  version = Calabash::Cucumber::VERSION
+  gemline = "gem \"calabash-cucumber\", \">= #{version}\", \"< 2.0\"\n"
+
+  if File.exist?(gemfile)
+    printf "Found a Gemfile..."
+    contents = File.read(gemfile).force_encoding('utf-8')
+    if contents[/calabash-cucumber/, 0]
+      puts "and it contains calabash-cucumber!"
+      puts ""
+    else
+      puts "but it doesn't contain calabash-cucumber!"
+      puts "You'll have to add it yourself"
+      puts ""
+      puts "> #{gemline}"
+      puts ""
+    end
+  else
+    msg("Question") do
+      puts "I want to create a Gemfile for you."
+      puts "Shall I proceed? (Y/n)"
+
+      response = STDIN.gets.chomp.downcase
+      proceed = response == "" || response == "y"
+
+      puts ""
+
+      if !proceed
+        puts "Skipping installation of Gemfile"
+      else
+        File.open(gemfile, "w") do |file|
+          file.write("source \"https://rubygems.org\"\n")
+          file.write("\n")
+          file.write(gemline)
+          file.write("\n")
+        end
+        puts "Created: #{gemfile}"
+        puts""
+      end
+    end
+  end
+  puts "My work is done here."
 end
+

data/features-skeleton/sample.feature

@@ -0,0 +1,7 @@
+Feature: Sample Feature
+
+Scenario: Sample Scenario
+  Given the app has launched
+  And I have done a specific thing
+  When I do something
+  Then something should happen

data/features-skeleton/steps/sample_steps.rb

@@ -0,0 +1,45 @@
+Given(/^the app has launched$/) do
+  wait_for do
+    !query("*").empty?
+  end
+end
+
+And(/^I have done a specific thing$/) do
+  # Example: Given I am logged in
+  #  wait_for do
+  #    !query("* marked:'username'").empty?
+  #  end
+  #
+  #  touch("* marked:'username'")
+  #  wait_for_keyboard
+  #  keyboard_enter_text("cleveruser27")
+  #
+  #  touch("* marked:'password'")
+  #  wait_for_keyboard
+  #  keyboard_enter_text("pa$$w0rd")
+  #
+  #  wait_for_element_exists("* marked:'Login'")
+  #  touch("* marked:'Login'")
+
+  # Remember: any Ruby is allowed in your step definitions
+  did_something = true
+
+  unless did_something
+    fail 'Expected to have done something'
+  end
+end
+
+When(/^I do something$/) do
+  # Example: When I create a new entry
+  #  tap("* marked:'new_entry'")
+  #  wait_for_keyboard
+  #  keyboard_enter_text("* marked:'entry_title'", 'My Entry')
+  #
+  #  tap("* marked:'submit'")
+end
+
+Then(/^something should happen$/) do
+  # Example: Then I should see the entry on my home page
+  #  wait_for_element_exists("* text:'My Entry'")
+end
+

data/features-skeleton/support/01_launch.rb

@@ -1,46 +1,44 @@
-########################################
-#                                      #
-#       Important Note                 #
-#                                      #
-#   When running calabash-ios tests at #
-#   www.xamarin.com/test-cloud         #
-#   the  methods invoked by            #
-#   CalabashLauncher are overridden.   #
-#   It will automatically ensure       #
-#   running on device, installing apps #
-#   etc.                               #
-#                                      #
-########################################
-
 require 'calabash-cucumber/launcher'
 
+# You can find examples of more complicated launch hooks in these
+# two repositories:
+#
+# https://github.com/calabash/ios-smoke-test-app/blob/master/CalSmokeApp/features/support/01_launch.rb
+# https://github.com/calabash/ios-webview-test-app/blob/master/CalWebViewApp/features/support/01_launch.rb
 
-# APP_BUNDLE_PATH = "#{ENV['HOME']}/Library/Developer/Xcode/DerivedData/??/Build/Products/Calabash-iphonesimulator/??.app"
-# You may uncomment the above to overwrite the APP_BUNDLE_PATH
-# However the recommended approach is to let Calabash find the app itself
-# or set the environment variable APP_BUNDLE_PATH
+module Calabash::Launcher
+  @@launcher = nil
 
+  def self.launcher
+    @@launcher ||= Calabash::Cucumber::Launcher.new
+  end
 
-Before do |scenario|
-  @calabash_launcher = Calabash::Cucumber::Launcher.new
-  unless @calabash_launcher.calabash_no_launch?
-    @calabash_launcher.relaunch
-    @calabash_launcher.calabash_notify(self)
+  def self.launcher=(launcher)
+    @@launcher = launcher
   end
 end
 
+Before do |scenario|
+  launcher = Calabash::Launcher.launcher
+  options = {
+    # Add launch options here.
+  }
+
+  launcher.relaunch(options)
+  launcher.calabash_notify(self)
+end
+
 After do |scenario|
-  unless @calabash_launcher.calabash_no_stop?
+  # Calabash can shutdown the app cleanly by calling the app life cycle methods
+  # in the UIApplicationDelegate.  This is really nice for CI environments, but
+  # not so good for local development.
+  #
+  # See the documentation for NO_STOP for a nice debugging workflow
+  #
+  # http://calabashapi.xamarin.com/ios/file.ENVIRONMENT_VARIABLES.html#label-NO_STOP
+  # http://calabashapi.xamarin.com/ios/Calabash/Cucumber/Core.html#console_attach-instance_method
+  unless launcher.calabash_no_stop?
     calabash_exit
-    if @calabash_launcher.active?
-      @calabash_launcher.stop
-    end
   end
 end
 
-at_exit do
-  launcher = Calabash::Cucumber::Launcher.new
-  if launcher.simulator_target?
-    launcher.simulator_launcher.stop unless launcher.calabash_no_stop?
-  end
-end

data/features-skeleton/support/dry_run.rb

@@ -0,0 +1,2 @@
+require 'calabash-cucumber'
+

data/features-skeleton/support/env.rb

@@ -6,3 +6,4 @@ require 'calabash-cucumber/cucumber'
 # require 'calabash-cucumber/wait_helpers'
 # require 'calabash-cucumber/operations'
 # World(Calabash::Cucumber::Operations)
+

data/features-skeleton/support/patches/cucumber.rb

@@ -0,0 +1,15 @@
+# override cucumber pending on the XTC
+if ENV['XAMARIN_TEST_CLOUD'] == '1'
+  module Cucumber
+    module RbSupport
+      def pending(message = 'TODO')
+        raise "PENDING: #{message}"
+      end
+
+      def ask(message, _)
+        raise "Cannot ask: '#{message}'; User interaction is not allowed on the XTC"
+      end
+    end
+  end
+  World(Cucumber::RbSupport)
+end

data/lib/calabash-cucumber.rb

@@ -1,3 +1,7 @@
+require "calabash-cucumber/logging"
+require "calabash-cucumber/dot_dir"
+require "calabash-cucumber/store/preferences"
+require "calabash-cucumber/usage_tracker.rb"
 require 'calabash-cucumber/core'
 require 'calabash-cucumber/tests_helpers'
 require 'calabash-cucumber/keyboard_helpers'

data/lib/calabash-cucumber/actions/instruments_actions.rb

@@ -15,11 +15,6 @@ class Calabash::Cucumber::InstrumentsActions
     query_action(options, :uia_tap_offset)
   end
 
-  # @!visibility private
-  def wait_tap(options)
-    uia_wait_tap(options[:query], options)
-  end
-
   # @!visibility private
   def double_tap(options)
     query_action(options, :uia_double_tap_offset)

data/lib/calabash-cucumber/actions/playback_actions.rb

@@ -13,11 +13,6 @@ class Calabash::Cucumber::PlaybackActions
     playback('touch', options)
   end
 
-  # @!visibility private
-  def wait_tap(options)
-    touch(options)
-  end
-
   # @!visibility private
   def double_tap(options)
     playback('double_tap', options)
@@ -111,4 +106,4 @@ class Calabash::Cucumber::PlaybackActions
   def error_message(gesture)
     "Gesture: '#{gesture}' not supported unless running with instruments."
   end
-end
+end

data/lib/calabash-cucumber/connection_helpers.rb

@@ -3,6 +3,8 @@ require 'calabash-cucumber/connection'
 module Calabash
   module Cucumber
 
+    class ResponseError < RuntimeError ; end
+
     # @!visibility private
     module ConnectionHelpers
 
@@ -16,6 +18,53 @@ module Calabash
         Calabash::Cucumber::Connection.instance
       end
 
+      # @!visibility private
+      def response_body_to_hash(body)
+        if body.nil? || body == ""
+          raise ResponseError,
+            "Server replied with an empty response.  Your app has probably crashed"
+        end
+
+        begin
+          hash = JSON.parse(body)
+        rescue TypeError, JSON::ParserError => e
+          raise ResponseError,
+%Q{Could not parse server response '#{body}':
+
+#{e}
+
+This usually means your app has crashed.
+}
+        end
+
+        outcome = hash['outcome']
+
+        case outcome
+          when 'FAILURE'
+            reason = hash['reason']
+            if reason.nil? || reason.empty?
+              hash['reason'] = 'Server provided no reason.'
+            end
+
+            details = hash['details']
+            if details.nil? || details.empty?
+              hash['details'] = 'Server provided no details.'
+            end
+
+          when 'SUCCESS'
+            if !hash.has_key?('results')
+              raise ResponseError,
+%Q{Server responded with '#{outcome}'
+but response #{hash} does not contain 'results' key
+}
+            end
+          else
+            raise ResponseError,
+%Q{Server responded with an invalid outcome: '#{hash["outcome"]}'}
+        end
+        hash
+      end
+
     end
   end
-end
+end

data/lib/calabash-cucumber/core.rb

@@ -161,7 +161,7 @@ module Calabash
       # If the view is not visible `touch` will fail. If the view is animating
       # `touch` will *silently* fail.
       # By default, taps the center of the view.
-      # @see #wait_tap
+      # @see Calabash::Cucumber::WaitHelpers#wait_tap
       # @see Calabash::Cucumber::Operations#tap_mark
       # @see #tap_point
       # @param {String} uiquery query describing view to tap. Note `nil` is allowed and is interpreted as
@@ -178,7 +178,7 @@ module Calabash
       end
 
       # Performs the `tap` gesture on an absolute coordinate.
-      # @see #wait_tap
+      # @see Calabash::Cucumber::WaitHelpers#wait_tap
       # @see Calabash::Cucumber::Operations#tap_mark
       # @see #touch
       # @param {Numeric} x x-coordinate to tap
@@ -188,33 +188,6 @@ module Calabash
         touch(nil, offset: {x:x, y:y})
       end
 
-      # Performs the `tap` gesture on the (first) view that matches query `uiquery`.
-      #
-      # As opposed to `touch`, `wait_tap` is a high-level method that combines:
-      #
-      # 1. waiting for the view to appear,
-      # 2. waiting for animations to complete on the view (and it's parents) and
-      # 3. actually tapping the view.
-      #
-      # This removes the common boiler-plate trio: `wait_for_element_exists`,
-      # `wait_for_none_animating`, `touch`.
-      #
-      # By default, taps the center of the view.
-      # @see #touch
-      # @see #tap_point
-      # @param {String} uiquery query describing view to tap. Note `nil` is not allowed.
-      # @param {Hash} options option for modifying the details of the touch
-      # @option options {Hash} :offset (nil) optional offset to tap point. Offset has an `:x` and `:y` key
-      #   the tap will be performed on the center of the view plus the offset.
-      # @option options {Hash} :timeout (30) maximum number of seconds to wait for the view to appear
-      # @option options {Hash} :frequency (0.2) polling frequency to for checking if the view is present (>= 0.1)
-      # @return {Array<Hash>} serialized version of the tapped view
-      def wait_tap(uiquery, options={})
-        # noinspection RubyUnusedLocalVariable
-        _uiquery, options = extract_query_and_options(uiquery, options)
-        launcher.actions.wait_tap(options)
-      end
-
       # Performs the "double tap" gesture on the (first) view that matches query `uiquery`.
       #
       # @note This assumes the view is visible and not animating.
@@ -653,11 +626,67 @@ module Calabash
         views_touched
       end
 
-      # Sends app to background. Simulates pressing the home button.
-      # @param {Fixnum} secs number of seconds to be in the background
-      #  `should not be more than 60 secs`
-      def send_app_to_background(secs)
-        launcher.actions.send_app_to_background(secs)
+      # Sends the app to the background.
+      #
+      # Sending the app to the background for more than 60 seconds may
+      # cause unpredicatable results.
+      #
+      # @param [Numeric] seconds How long to send the app to the background.
+      # @raise [ArgumentError] if `seconds` argument is < 1.0
+      def send_app_to_background(seconds)
+        if seconds < 1.0
+          raise ArgumentError, "Seconds '#{seconds}' must be >= 1.0"
+        end
+
+        parameters = {
+          :duration => seconds
+        }
+
+        begin
+          body = http({:method => :post, :path => "suspend"}, parameters)
+          result = response_body_to_hash(body)
+        rescue RuntimeError => e
+          raise RuntimeError, e
+        end
+
+        if result["outcome"] != "SUCCESS"
+          raise RuntimeError,
+            %Q{Could not send app to background:
+ reason => '#{result["reason"]}'
+details => '#{result["details"]}'
+            }
+        end
+        result["results"]
+      end
+
+      # Cause the device to shake.
+      #
+      # @param [Numeric] seconds How long to shake the device
+      # @raise [ArgumentError] if `seconds` argument is <= 0.0
+      def shake(seconds)
+        if seconds <= 0.0
+          raise ArgumentError, "Seconds '#{seconds}' must be >= 0.0"
+        end
+
+        parameters = {
+          :duration => seconds
+        }
+
+        begin
+          body = http({:method => :post, :path => "shake"}, parameters)
+          result = response_body_to_hash(body)
+        rescue RuntimeError => e
+          raise RuntimeError, e
+        end
+
+        if result["outcome"] != "SUCCESS"
+          raise RuntimeError,
+%Q{Could not shake the device:
+ reason => '#{result["reason"]}'
+details => '#{result["details"]}'
+            }
+        end
+        result["results"]
       end
 
       # Simulates gps location of the device/simulator.
@@ -798,50 +827,43 @@ module Calabash
 
       # Calls a method on the app's AppDelegate object.
       #
-      # This is an escape hatch for calling an arbitrary hook inside
-      # (the test build) of your app.  Commonly used to "go around" the UI for
-      # speed purposes or reset the app to a good known state.
+      # Use this to call an arbitrary Objective-C or Swift method in your
+      # app's UIApplicationDelegate.
       #
-      # You must create a method on you app delegate of the form:
+      # Commonly used to "go around" the UI speed purposes or reset the app to
+      # a good known state.
       #
-      #     - (NSString *) calabashBackdoor:(NSString *)aIgnorable;
+      # @note For methods that take arguments, don't forget to include the
+      #   trailing ":"
       #
-      # or if you want to pass parameters
-      #
-      #     - (NSString *) calabashBackdoor:(NSDictionary *)params;
-      # @example
-      #   backdoor("calabashBackdoor:", '')
-      # @example
-      #   backdoor("calabashBackdoor:", {example:'param'})
-      # @param {String} selector the selector to perform on the app delegate
-      # @param {Object} argument the argument to pass to the selector
-      # @return {Object} the result of performing the selector with the argument (serialized)
-      def backdoor(selector, argument)
-
-        unless selector.end_with?(':')
-          messages =
-                [
-                     "Selector '#{selector}' is missing a trailing ':'",
-                     'Valid backdoor selectors must take one argument.',
-                     "Before 0.15.0, the server will append a trailing ':'.",
-                     ' After 0.15.0, this behavior is scheduled to change.',
-                     '',
-                     'http://developer.xamarin.com/guides/testcloud/calabash/working-with/backdoors/#backdoor_in_iOS',
-                     ''
-                ]
-          _deprecated('0.15.0', messages.join("\n"), :warn)
-        end
-
-        json = {
+      # @param [String] selector the selector to perform on the app delegate
+      # @param [Object] argument the argument to pass to the selector
+      # @return [Object] the result of performing the selector with the argument
+      def backdoor(selector, *arguments)
+        parameters = {
               :selector => selector,
-              :arg => argument
+              :arguments => arguments
         }
-        res = http({:method => :post, :path => 'backdoor'}, json)
-        res = JSON.parse(res)
-        if res['outcome'] != 'SUCCESS'
-          screenshot_and_raise "backdoor #{json} failed because:\n\n#{res['reason']}\n#{res['details']}"
+
+        begin
+          body = http({:method => :post, :path => "backdoor"}, parameters)
+          result = response_body_to_hash(body)
+        rescue RuntimeError => e
+          raise RuntimeError, e
+        end
+
+        if result["outcome"] != "SUCCESS"
+           raise RuntimeError,
+%Q{backdoor call failed:
+ selector => '#{selector}'
+arguments => '#{arguments}'
+   reason => '#{result["reason"]}'
+
+#{result["details"]}
+
+}
         end
-        res['result']
+        result["results"]
       end
 
       # Attempts to shut the app down gracefully by simulating the transition