calabash 1.9.9.pre2 → 1.9.9.pre3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 145d0607c951c97fed6b885c1c492cbd86a79da4
-  data.tar.gz: 561bec553b18f3f8b98346548dc7e21812470740
+  metadata.gz: c93bdf73649617b8de5fe8e2e34fcf03a2f31f2e
+  data.tar.gz: 187f1e60ca6bf8005efa47ee03a9f6896c169599
 SHA512:
-  metadata.gz: e51ffc4e81c0e7ad3b0fa6e1855b1d584003313d64fd0b91bab00ed429d2371a01712baa488b48ccdcfacc6fcbaa876dcd7bfe5bf8d001f09fc48268e869da53
-  data.tar.gz: 4563da016a43db69eac0ef6c5316121abe87c872488d82c1aab508c49567ec75ad43704faff5e3552a0e1fe52e0d7580f4b4691f08e1edfb538b7d7e83745b98
+  metadata.gz: de02fd0467b70c2836fcca4859b803537365bf69ef6ae9c7f70f7f153ee877ecbaa1ec69a5941de2ba816874e9b9ad131af9b79642aef88c17a505d73df15af0
+  data.tar.gz: cd2a3b11e0ce8dcbc31236346f483440cfd61cdb00b12124ccf9c8922ee0373f5f940d2ea3e902308fca6f47c4bb8405816d5b9c238a2ac3c5ab6ad67e38c438

data/README.md

@@ -18,6 +18,25 @@ $ ./changing_old_files.sh
 
 Before Calabash is ready to be released, the old gems will exist outside version control. To make a change run the script `copy_repos.sh`. This will copy the Android and iOS repositories and extract them as files in the directory `old`. Then execute `changing_old_files.sh`. This script will move old files into their new directories. To make changes to "old files" e.g. move them, add your steps to `changing_old_files.sh` and execute it. To make code changes to old files, change them locally first to ensure they work. Then copy the change to the branch `united` on either iOS or Android. Commit the changes and push them upstream. `copy_repos.sh` will always download the newest files.
 
+## Rake
+
+**TODO** Release instructions for Android and iOS.
+
+```
+$ rake -T
+rake android:build     # Build the Android test server
+rake build             # Build calabash-1.9.9.pre2.gem into the pkg directory
+rake ctags             # Generate ctags in ./git/tags
+rake cucumber:android  # Run Android cucumber tests
+rake cucumber:ios      # Run iOS cucumber tests
+rake install           # Build and install calabash-1.9.9.pre2.gem into system gems
+rake release           # Create tag v1.9.9.pre2 and build and push calabash-1.9.9.pre2.gem to Rubygems
+rake spec              # Run RSpec code examples
+rake unit              # Run RSpec code examples
+rake yard              # Generate YARD Documentation
+rake yard:publish      # Generate and publish docs
+```
+
 ## Testing
 
 ### rspec

data/lib/calabash.rb

@@ -4,7 +4,6 @@
 # It is developed and maintained by Xamarin and is released under the Eclipse
 # Public License.
 module Calabash
-  require 'calabash/patch/run_loop'
   require 'calabash/version'
   require 'calabash/environment'
   require 'calabash/logger'
@@ -62,7 +61,7 @@ module Calabash
   #    page(LoginPage).method
   #  end
   #
-  # @param [Class] The page to instantiate
+  # @param [Class] page_class The page to instantiate
   # @return [Calabash::Page] An instance of the page class
   def page(page_class)
     if android?
@@ -98,14 +97,17 @@ module Calabash
     end
   end
 
+  # Is the app under test running on Android?
   def android?
     Android.const_defined?(:Device) && Device.default.is_a?(Android::Device)
   end
 
+  # Is the app under test running on iOS?
   def ios?
     IOS.const_defined?(:Device) && Device.default.is_a?(IOS::Device)
   end
 
+  # @!visibility private
   def self.new_embed_method!(method)
     EmbeddingContext.new_embed_method(method)
   end

data/lib/calabash/android/build/java_keystore.rb

@@ -3,6 +3,7 @@ require 'escape'
 module Calabash
   module Android
     module Build
+      # @!visibility private
       class JavaKeystore
         CALABASH_KEYSTORE_SETTINGS_FILENAME = 'calabash_keystore_settings.json'
 

data/lib/calabash/android/console_helpers.rb

@@ -1,4 +1,5 @@
 module Calabash
+  # @!visibility private
   module ConsoleHelpers
     def self.render(data, indentation)
       if visible?(data)

data/lib/calabash/android/defaults.rb

@@ -1,21 +1,31 @@
 module Calabash
   module Android
-    def self.setup_defaults!
-      setup_default_application!
-      setup_default_device!
-    end
+    module Defaults
+      # Sets up the default device and the default application based on the
+      # environment.
+      #
+      # @see Calabash::Android::Defaults#setup_default_application!
+      # @see Calabash::Android::Defaults#setup_default_device!
+      # @see Calabash::Environment
+      def setup_defaults!
+        setup_default_application!
+        setup_default_device!
+      end
 
-    def self.setup_default_application!
-      # Setup the default application
-      Calabash.default_application = Application.default_from_environment
-    end
+      # Sets up the default application based on the environment.
+      def setup_default_application!
+        # Setup the default application
+        Calabash.default_application = Application.default_from_environment
+      end
 
-    def self.setup_default_device!
-      # Setup the default device
-      identifier = Device.default_serial
-      server = Server.default
+      # Sets up the default device based on the environment.
+      def setup_default_device!
+        # Setup the default device
+        identifier = Device.default_serial
+        server = Server.default
 
-      Calabash.default_device = Device.new(identifier, server)
+        Calabash.default_device = Device.new(identifier, server)
+      end
     end
   end
 end

data/lib/calabash/android/device.rb

@@ -3,6 +3,7 @@ require 'json'
 module Calabash
   module Android
     # A representation of a Calabash Android device.
+    # @!visibility private
     class Device < ::Calabash::Device
       attr_reader :adb
 
@@ -15,6 +16,12 @@ module Calabash
         end
       end
 
+      # @!visibility private
+      def change_server(new_server)
+        super(new_server)
+        port_forward(new_server.endpoint.port, new_server.test_server_port)
+      end
+
       def self.default_serial
         serials = list_serials
 
@@ -156,7 +163,7 @@ module Calabash
           raise "mapping \"#{query}\" with \"#{method_name}\" failed because: #{result['reason']}\n#{result['details']}"
         end
 
-        result['results']
+        Calabash::QueryResult.create(result['results'], query)
       end
 
       def perform_action(action, *arguments)
@@ -350,18 +357,17 @@ module Calabash
         "/data/data/#{application.test_server.identifier}/files/calabash_finished.out"
       end
 
-      def calabash_server_failure_exists?(application)
-        cmd = "ls #{calabash_server_failure_file_path(application)}"
+      def adb_file_exists?(file)
+        cmd = "ls #{file}"
+        adb.shell(cmd, no_exit_code_check: true).chomp == file
+      end
 
-        adb.shell(cmd, no_exit_code_check: true).chomp ==
-            calabash_server_failure_file_path(application)
+      def calabash_server_failure_exists?(application)
+        adb_file_exists?(calabash_server_failure_file_path(application))
       end
 
       def calabash_server_finished_exists?(application)
-        cmd = "ls #{calabash_server_finished_file_path(application)}"
-
-        adb.shell(cmd, no_exit_code_check: true).chomp ==
-            calabash_server_finished_file_path(application)
+        adb_file_exists?(calabash_server_finished_file_path(application))
       end
 
       def read_calabash_sever_failure(application)
@@ -406,6 +412,20 @@ module Calabash
           raise "The test-server '#{application.test_server.identifier}' is not installed"
         end
 
+        installed_app = installed_apps.find{|app| app[:package] == application.identifier}
+        installed_app_md5_checksum = md5_checksum(installed_app[:path])
+
+        if application.md5_checksum != installed_app_md5_checksum
+          raise "The specified app is not the same as the installed app (#{application.md5_checksum} != #{installed_app_md5_checksum})."
+        end
+
+        installed_test_server = installed_apps.find{|app| app[:package] == application.test_server.identifier}
+        installed_test_server_md5_checksum = md5_checksum(installed_test_server[:path])
+
+        if application.test_server.md5_checksum != installed_test_server_md5_checksum
+          raise "The specified test-server is not the same as the installed test-server (#{application.test_server.md5_checksum} != #{installed_test_server_md5_checksum})."
+        end
+
         ensure_screen_on
 
         # Clear any old error reports
@@ -536,6 +556,10 @@ module Calabash
           raise ArgumentError, "No test server set for '#{application}'"
         end
 
+        unless app_installed?(application.identifier)
+          raise "The application #{application.identifier}' is not installed"
+        end
+
         unless app_installed?(application.test_server.identifier)
           raise "The test-server '#{application.test_server.identifier}' is not installed"
         end
@@ -746,7 +770,7 @@ module Calabash
         gesture = Gestures::Gesture.double_tap(gesture_options)
 
         execute_gesture(Gestures::Gesture.with_parameters(gesture,
-                                                          query_string: query.to_s,
+                                                          query: query,
                                                           timeout: options[:timeout]))
       end
 
@@ -785,7 +809,7 @@ module Calabash
         gesture = Gestures::Gesture.generate_swipe(from, to, time: duration)
 
         execute_gesture(Gestures::Gesture.with_parameters(gesture,
-                                                          query_string: query.to_s,
+                                                          query: query,
                                                           timeout: options[:timeout]))
       end
 
@@ -796,7 +820,7 @@ module Calabash
         gesture.gestures.first.touches[1].query = query_to
 
         execute_gesture(Gestures::Gesture.with_parameters(gesture,
-                                                          query_string: query_to,
+                                                          query: query_to,
                                                           timeout: options[:timeout]))
       end
 
@@ -813,7 +837,7 @@ module Calabash
         gesture = Gestures::Gesture.generate_swipe(from, to, time: duration, flick: true)
 
         execute_gesture(Gestures::Gesture.with_parameters(gesture,
-                                                          query_string: query.to_s,
+                                                          query: query,
                                                           timeout: options[:timeout]))
       end
 
@@ -822,7 +846,7 @@ module Calabash
         gesture = Gestures::Gesture.pinch(direction)
 
         execute_gesture(Gestures::Gesture.with_parameters(gesture,
-                                                          query_string: query.to_s,
+                                                          query: query,
                                                           timeout: options[:timeout]))
       end
 
@@ -842,15 +866,56 @@ module Calabash
 
       # @!visibility private
       def adb_install_app(application)
+        # Because of a bug in the latest version of ADB
+        # https://github.com/android/platform_system_core/blob/0f91887868e51de67bdf9aedc97fbcb044dc1969/adb/commandline.cpp#L1466
+        # ADB now uses rm -f ... to remove the temporary application on the
+        # device, but not all devices (below a certain OS) supports this flag.
+        # The user will be unable to install the app and instead receive:
+        # RuntimeError: Could not install app 'com.xamarin.xtcandroidsample.test': rm failed for -f, No such file or directory
+        # We have rewritten the way adb handles app installation. It's a 3-step
+        # procedure:
+        #  - Push the app binary to /data/local/tmp
+        #  - Install the app binary using pm
+        #  - Remove the temporary apk.
         @logger.log "Installing #{application.path}"
-        result = adb.command('install' , '-r', application.path, timeout: 60).lines.last
 
-        if result.downcase.chomp != 'success'
-          raise "Could not install app '#{application.identifier}': #{result.chomp}"
+        tmp_path = "/data/local/tmp/#{File.basename(application.path)}"
+
+        begin
+          adb.command('push', application.path, tmp_path, timeout: 60)
+        rescue ADB::ADBCallError => e
+          raise "Failed to push the application to the device storage: '#{e.message}'"
+        end
+
+        begin
+          result = nil
+
+          begin
+            result = adb.shell("pm install -r #{tmp_path}", timeout: 60)
+          rescue ADB::ADBCallError => e
+            raise "Failed to install the application on device: '#{e.message}'"
+          end
+
+          if result.lines.last.downcase.chomp != 'success'
+            raise "Could not install app '#{application.identifier}': #{result.chomp}"
+          end
+
+          unless installed_packages.include?(application.identifier)
+            raise "App '#{application.identifier}' was not installed"
+          end
+        rescue => e
+          begin
+            adb.shell("rm #{tmp_path}")
+          rescue ADB::ADBCallError => _
+          end
+
+          raise e
         end
 
-        unless installed_packages.include?(application.identifier)
-          raise "App '#{application.identifier}' was not installed"
+        begin
+          adb.shell("rm #{tmp_path}")
+        rescue ADB::ADBCallError => e
+          raise "Failed to remove the tmp apk from device: #{e.message}"
         end
       end
 

data/lib/calabash/android/environment.rb

@@ -10,7 +10,9 @@ end
 module Calabash
   module Android
     class Environment < Calabash::Environment
+      # @!visibility private
       class InvalidEnvironmentError < RuntimeError; end
+      # @!visibility private
       class InvalidJavaSDKHome < RuntimeError; end
 
       private

data/lib/calabash/android/gestures.rb

@@ -2,6 +2,7 @@ require 'json'
 
 module Calabash
   module Android
+    # @!visibility private
     module Gestures
       class MultiTouchGesture
         attr_reader :gestures
@@ -344,12 +345,12 @@ module Calabash
         flick("* id:'content'", from, to, options)
       end
 
-      # !@visibility private
+      # @!visibility private
       def _pinch_screen(direction, options={})
         Device.default.pinch(direction, "* id:'content'", options)
       end
 
-      # !@visibility private
+      # @!visibility private
       def _pinch_to_zoom(direction, query, options={})
         if direction == :out
           Device.default.pinch(:in, query, options)
@@ -360,7 +361,7 @@ module Calabash
         end
       end
 
-      # !@visibility private
+      # @!visibility private
       def _pinch_screen_to_zoom(direction, options={})
         _pinch_to_zoom(direction, "* id:'content'", options)
       end

data/lib/calabash/android/interactions.rb

@@ -1,5 +1,6 @@
 module Calabash
   module Android
+    # @!visibility private
     module Interactions
       # Go back.
       def go_back

data/lib/calabash/android/lib/.irbrc

@@ -1,50 +1,63 @@
+require 'irb/completion'
+require 'irb/ext/save-history'
+
+IRB.conf[:SAVE_HISTORY] = 100
+IRB.conf[:HISTORY_FILE] = '.irb-history'
+
+ARGV.concat [ '--readline',
+              '--prompt-mode',
+              'simple']
+
+begin
+  require 'pry'
+  Pry.config.history.file = '.pry-history'
+  require 'pry-nav'
+rescue LoadError => _
+
+end
+
+begin
+  require 'awesome_print'
+  AwesomePrint.irb!
+rescue LoadError => e
+  msg = ["Caught a LoadError: could not load 'awesome_print'",
+         "#{e}",
+         '',
+         'Use bundler (recommended) or uninstall awesome_print.',
+         '',
+         '# Use bundler (recommended)',
+         '$ bundle update',
+         '$ bundle exec calabash console [path to apk]',
+         '',
+         '# Uninstall',
+         '$ gem update --system',
+         '$ gem uninstall -Vax --force --no-abort-on-dependent awesome_print']
+  puts msg
+  exit(1)
+end
+
 begin
-    require 'irb/completion'
-    require 'irb/ext/save-history'
-
-    begin
-        require 'awesome_print'
-    rescue LoadError => e
-        msg = ["Caught a LoadError: could not load 'awesome_print'",
-             "#{e}",
-             '',
-             'Use bundler (recommended) or uninstall awesome_print.',
-             '',
-             '# Use bundler (recommended)',
-             '$ bundle update',
-             '$ bundle exec calabash console [path to apk]',
-             '',
-             '# Uninstall',
-             '$ gem update --system',
-             '$ gem uninstall -Vax --force --no-abort-on-dependent awesome_print']
-        puts msg
-        exit(1)
-    end
-
-    AwesomePrint.irb!
-
-    ARGV.concat [ '--readline',
-                  '--prompt-mode',
-                  'simple']
-
-    # 50 entries in the list
-    IRB.conf[:SAVE_HISTORY] = 50
-
-    # Store results in home directory with specified file name
-    IRB.conf[:HISTORY_FILE] = '.irb-history'
-
-    require 'calabash/android'
-
-    extend Calabash::Android
-    extend Calabash::ConsoleHelpers
-
-    Calabash::Android.setup_defaults!
-
-    Calabash.new_embed_method!(lambda {|*_| Calabash::Logger.info 'Embed is not available in the console.'})
-    Calabash::Screenshot.screenshot_directory_prefix = 'console_'
+  require 'calabash/android'
+
+  extend Calabash::Android
+  extend Calabash::ConsoleHelpers
+
+  Calabash::Android.setup_defaults!
+
+  embed_lambda = lambda do |*_|
+    Calabash::Logger.info 'Embed is not available in the console.'
+    true
+  end
+
+  Calabash.new_embed_method!(embed_lambda)
+
+  Calabash::Screenshot.screenshot_directory_prefix = 'console_'
+
+  puts_console_details
+  message_of_the_day
 rescue Exception => e
-    puts 'Unable to start console:'
-    puts "#{e.class}: #{e.message}"
-    puts "#{e.backtrace.join("\n")}"
-    exit(1)
-end
+  puts 'Unable to start console:'
+  puts "#{e.class}: #{e.message}"
+  puts "#{e.backtrace.join("\n")}"
+  exit(1)
+end