appium_lib 3.0.3 → 4.0.0

data/lib/appium_lib/common/patch.rb

@@ -89,47 +89,18 @@ def patch_webdriver_bridge
       path_str   = path.sub(path_match[0], '') unless path_match.nil?
 
       puts "#{verb} #{path_str}"
-      unless command_hash.nil? || command_hash.length == 0
-        print_command = {}
-        # For complex_find, we pass a whole array
-        if command_hash.kind_of? Array
-          print_command[:args]   = [command_hash.clone]
-          print_command[:script] = 'complex_find' if command == :complex_find
-        else
-          print_command = command_hash.clone
-        end
+      # must check to see if command_hash is a hash. sometimes it's not.
+      if command_hash.is_a?(Hash) && !command_hash.empty?
+        print_command = command_hash.clone
+
         print_command.delete :args if print_command[:args] == []
 
-        mobile_find = 'mobile: find'
-        if print_command[:script] == mobile_find
-          args = print_command[:args]
-          puts "#{mobile_find}" #" #{args}"
-
-          # [[[[3, "sign"]]]] => [[[3, "sign"]]]
-          #
-          # [[[[4, "android.widget.EditText"], [7, "z"]], [[4, "android.widget.EditText"], [3, "z"]]]]
-          # => [[[4, "android.widget.EditText"], [7, "z"]], [[4, "android.widget.EditText"], [3, "z"]]]
-          args       = args[0]
-          option     = args[0].to_s.downcase
-          has_option = !option.match(/all|scroll/).nil?
-          puts option if has_option
-
-          start = has_option ? 1 : 0
-
-          start.upto(args.length-1) do |selector_index|
-            selectors      = args[selector_index]
-            selectors_size = selectors.length
-            selectors.each_index do |pair_index|
-              pair = selectors[pair_index]
-              res  = $driver.dynamic_code_to_string pair[0], pair[1]
-
-              if selectors_size == 1 || pair_index >= selectors_size - 1
-                puts res
-              elsif selectors_size > 1 && pair_index < selectors_size
-                print res + '.'
-              end
-            end
-          end # start.upto
+        if print_command[:using] === '-android uiautomator'
+          value                 = print_command[:value].split(';').map { |v| "#{v};" }
+          print_command[:value] = value.length == 1 ? value[0] : value
+
+          # avoid backslash escape quotes in strings. "\"a\"" => "a"
+          puts print_command.ai.gsub('\"', '"')
         else
           ap print_command
         end

data/lib/appium_lib/common/version.rb

@@ -1,5 +1,5 @@
 module Appium
   # Version and Date are defined on the 'Appium' module, not 'Appium::Common'
-  VERSION = '3.0.3' unless defined? ::Appium::VERSION
-  DATE    = '2014-06-02' unless defined? ::Appium::DATE
+  VERSION = '4.0.0' unless defined? ::Appium::VERSION
+  DATE    = '2014-07-05' unless defined? ::Appium::DATE
 end

data/lib/appium_lib/device/device.rb

@@ -6,6 +6,7 @@ module Appium
 
     NoArgMethods = {
       post: {
+        open_notifications:   'session/:session_id/appium/device/open_notifications',
         shake:                'session/:session_id/appium/device/shake',
         launch:               'session/:session_id/appium/app/launch',
         close_app:            'session/:session_id/appium/app/close',
@@ -15,7 +16,6 @@ module Appium
       get:  {
         current_activity:   'session/:session_id/appium/device/current_activity',
         current_context:    'session/:session_id/context',
-        available_contexts: 'session/:session_id/contexts',
       }
     }
 
@@ -44,18 +44,6 @@ module Appium
     # @!method toggle_flight_mode
     #   toggle flight mode on or off
 
-    #@!method complex_find
-    #  Find an element by a complex array of criteria.  Available criteria
-    #  are listed in [link here].  Criteria are formed by creating an array
-    #  of arrays, each containing a selector and that selector's value.
-    #
-    #  ```ruby
-    #  complex_find [[[2, 'Sau'], [14, true]]] # => Find a clickable element
-    #                                          #    whose names starts with 'Sau'
-    #  ```
-    #  @param mod (Symbol) If present, will be the 0th element in the selector array.
-    #  @param selectors (Array<Object>) The selectors to find elements with.
-
     # @!method hide_keyboard
     #   Hide the onscreen keyboard
     #   @param close_key (String) the name of the key which closes the keyboard.
@@ -65,10 +53,17 @@ module Appium
     #  hide_keyboard('Finished') # Close a keyboard with the 'Finished' button
     #  ```
 
-    # @!method key_event
-    # Send a key event to the device.
-    # @param key (integer) The key to send.
-    # @param metastate (String) The state the metakeys should be in when sending the key.
+    # @!method press_keycode
+    # Press keycode on the device.
+    # http://developer.android.com/reference/android/view/KeyEvent.html
+    # @param key (integer) The key to press.
+    # @param metastate (String) The state the metakeys should be in when pressing the key.
+
+    # @!method long_press_keycode
+    # Long press keycode on the device.
+    # http://developer.android.com/reference/android/view/KeyEvent.html
+    # @param key (integer) The key to long press.
+    # @param metastate (String) The state the metakeys should be in when long pressing the key.
 
     # @!method push_file
     #   Place a file in a specific location on the device.
@@ -85,6 +80,14 @@ module Appium
     #   pull_file 'Shenanigans.app/some/file' #=> Get 'some/file' from the install location of Shenanigans.app
     #   ```
 
+    # @!method pull_folder
+    #   Retrieve a folder from the device.
+    #   @param path (String) absolute path to the folder
+    #
+    #   ```ruby
+    #   pull_folder '/data/local/tmp' #=> Get the folder at that path
+    #   ```
+
     # @!method end_coverage
     #   Android only;  Ends the test coverage and writes the results to the given path on device.
     #   @param path (String) Path on the device to write too.
@@ -97,6 +100,13 @@ module Appium
           pair.each_pair { |command, path| add_endpoint_method command, path, verb }
         end
 
+        add_endpoint_method(:available_contexts, 'session/:session_id/contexts', :get) do
+          def available_contexts
+            # return empty array instead of nil on failure
+            execute(:available_contexts, {}) || []
+          end
+        end
+
         add_endpoint_method(:app_strings, 'session/:session_id/appium/app/strings') do
           def app_strings language=nil
             opts = language ? { language: language } : {}
@@ -141,16 +151,30 @@ module Appium
         end
 
         add_endpoint_method(:hide_keyboard, 'session/:session_id/appium/device/hide_keyboard') do
-          def hide_keyboard(close_key='Done')
-            execute :hide_keyboard, {}, keyName: close_key
+          def hide_keyboard(close_key=nil)
+            # Android can only tapOutside.
+            if $driver.device_is_android?
+             return execute :hide_keyboard, {}, { strategy: :tapOutside }
+            end
+
+            close_key ||= 'Done' # default to Done key.
+            $driver.hide_ios_keyboard close_key
+          end
+        end
+
+        add_endpoint_method(:press_keycode, 'session/:session_id/appium/device/press_keycode') do
+          def press_keycode(key, metastate=nil)
+            args             = { keycode: key }
+            args[:metastate] = metastate if metastate
+            execute :press_keycode, {}, args
           end
         end
 
-        add_endpoint_method(:key_event, 'session/:session_id/appium/device/keyevent') do
-          def key_event(key, metastate=nil)
+        add_endpoint_method(:long_press_keycode, 'session/:session_id/appium/device/long_press_keycode') do
+          def long_press_keycode(key, metastate=nil)
             args             = { keycode: key }
             args[:metastate] = metastate if metastate
-            execute :key_event, {}, args
+            execute :long_press_keycode, {}, args
           end
         end
 
@@ -161,30 +185,6 @@ module Appium
           end
         end
 
-        add_endpoint_method(:complex_find, 'session/:session_id/appium/app/complex_find') do
-          def complex_find(opts)
-            # allow: complex_find([[[3, 'app']]])
-            opts      = { selectors: opts } if opts.is_a?(Array)
-            mode      = opts.fetch :mode, false # mode can be 'all' or 'scroll'
-            selectors = opts.fetch :selectors, false
-            raise 'Complex find must have selectors' unless selectors
-            selectors = selectors.dup.insert(0, mode) if mode # must dupe before insert
-
-            ids = execute :complex_find, {}, selectors
-            ids = [ids] unless ids.is_a? Array # wrap single result in an array
-
-            # mode can be set directly in the selectors
-            find_all = mode == 'all' || selectors.first == 'all'
-
-            result = ids.map do |id|
-              resolved_id = element_id_from(id)
-              Selenium::WebDriver::Element.new self, resolved_id
-            end
-            # when not finding all, don't return an array
-            return find_all ? result : result.first
-          end
-        end
-
         add_endpoint_method(:push_file, 'session/:session_id/appium/device/push_file') do
           def push_file(path, filedata)
             encoded_data = Base64.encode64 filedata
@@ -199,6 +199,14 @@ module Appium
           end
         end
 
+        # TODO TEST ME
+        add_endpoint_method(:pull_folder, 'session/:session_id/appium/device/pull_folder') do
+          def pull_folder(path)
+            data = execute :pull_folder, {}, path: path
+            Base64.decode64 data
+          end
+        end
+
         # TODO TEST ME
         add_endpoint_method(:end_coverage, 'session/:session_id/appium/app/end_test_coverage') do
           def end_coverage(path, intent)
@@ -247,12 +255,6 @@ module Appium
 
       # @private
       def create_bridge_command(method, verb, path)
-        # Don't clobber methods that are moved into Selenium
-        if selenium_has method
-          log_reimplemented_warning(method, path)
-          return
-        end
-
         Selenium::WebDriver::Remote::Bridge.class_eval do
           command method, verb, path
           if block_given?
@@ -263,24 +265,6 @@ module Appium
         end
       end
 
-      # @private
-      def selenium_has(method)
-        Selenium::WebDriver::Remote::Bridge.method_defined? method
-      end
-
-      # @private
-      def log_reimplemented_warning(method, path)
-        msg = "Selenium::WebDriver has now implemented the `#{method}` method."
-        if Selenium::WebDriver::Remote::COMMANDS[method][1] == path
-          msg << " It may no longer function as expected"
-        else
-          msg << " It no longer uses the same endpoint,"
-          msg << " so it probably won't do what you expect anymore."
-        end
-        msg << " Raise an issue at http://www.github.com/appium/ruby_lib if so."
-        Appium::Logger.warn msg
-      end
-
       # @!method accessiblity_id_find
       #   find_element/s with their accessibility_id
       #

data/lib/appium_lib/driver.rb

@@ -24,7 +24,6 @@ require_relative 'ios/element/text'
 require_relative 'ios/mobile_methods'
 
 # android
-require_relative 'android/dynamic'
 require_relative 'android/helper'
 require_relative 'android/patch'
 require_relative 'android/element/alert'
@@ -210,7 +209,17 @@ module Appium
     # made available via the driver_attributes method
 
     # The amount to sleep in seconds before every webdriver http call.
-    attr_accessor :global_webdriver_http_sleep
+    attr_accessor :global_webdriver_http_sleep,
+                  :caps,
+                  :custom_url,
+                  :export_session,
+                  :default_wait,
+                  :last_waits,
+                  :sauce_username,
+                  :sauce_access_key,
+                  :appium_port,
+                  :appium_device,
+                  :appium_debug
 
     # Creates a new driver
     #
@@ -251,7 +260,7 @@ module Appium
       @sauce_username   = nil if !@sauce_username || (@sauce_username.is_a?(String) && @sauce_username.empty?)
       @sauce_access_key = appium_lib_opts.fetch :sauce_access_key, ENV['SAUCE_ACCESS_KEY']
       @sauce_access_key = nil if !@sauce_access_key || (@sauce_access_key.is_a?(String) && @sauce_access_key.empty?)
-      @port             = appium_lib_opts.fetch :port, 4723
+      @appium_port      = appium_lib_opts.fetch :port, 4723
 
       # Path to the .apk, .app or .app.zip.
       # The path can be local or remote for Sauce.
@@ -260,13 +269,14 @@ module Appium
       end
 
       # https://code.google.com/p/selenium/source/browse/spec-draft.md?repo=mobile
-      @device = @caps[:platformName]
-      @device = @device.is_a?(Symbol) ? @device : @device.downcase.strip.intern if @device
-      raise "platformName must be set. Not found in options: #{opts}" unless @device
-      raise 'platformName must be Android or iOS' unless [:android, :ios].include?(@device)
+      @appium_device = @caps[:platformName]
+      @appium_device = @appium_device.is_a?(Symbol) ? @appium_device : @appium_device.downcase.strip.intern if @appium_device
+      raise "platformName must be set. Not found in options: #{opts}" unless @appium_device
+      raise 'platformName must be Android or iOS' unless [:android, :ios].include?(@appium_device)
 
       # load common methods
       extend Appium::Common
+      extend Appium::Device
       if device_is_android?
         # load Android specific methods
         extend Appium::Android
@@ -280,12 +290,12 @@ module Appium
 
       # enable debug patch
       # !!'constant' == true
-      @debug = appium_lib_opts.fetch :debug, !!defined?(Pry)
+      @appium_debug = appium_lib_opts.fetch :debug, !!defined?(Pry)
 
-      if @debug
+      if @appium_debug
         ap opts unless opts.empty?
-        puts "Debug is: #{@debug}"
-        puts "Device is: #{@device}"
+        puts "Debug is: #{@appium_debug}"
+        puts "Device is: #{@appium_device}"
         patch_webdriver_bridge
       end
 
@@ -297,9 +307,6 @@ module Appium
       # Subsequent drivers do not trigger promotion.
       unless @@loaded
         @@loaded = true
-        # load device methods exactly once
-        extend Appium::Device
-
         # Promote only on Minitest::Spec (minitest 5) by default
         Appium.promote_appium_methods ::Minitest::Spec
       end
@@ -316,9 +323,9 @@ module Appium
                      last_waits:       @last_waits,
                      sauce_username:   @sauce_username,
                      sauce_access_key: @sauce_access_key,
-                     port:             @port,
-                     device:           @device,
-                     debug:            @debug,
+                     port:             @appium_port,
+                     device:           @appium_device,
+                     debug:            @appium_debug,
       }
 
       # Return duplicates so attributes are immutable
@@ -329,7 +336,7 @@ module Appium
     end
 
     def device_is_android?
-      @device == :android
+      @appium_device == :android
     end
 
     # Returns the server's version info
@@ -352,6 +359,9 @@ module Appium
     # @return [String] APP_PATH as an absolute path
     def self.absolute_app_path app_path
       raise 'APP_PATH not set!' if app_path.nil? || app_path.empty?
+      # may be absolute path to file on remote server.
+      # if the file is on the remote server then we can't check if it exists
+      return app_path if @custom_url
       # Sauce storage API. http://saucelabs.com/docs/rest#storage
       return app_path if app_path.start_with? 'sauce-storage:'
       return app_path if app_path.match(/^http/) # public URL for Sauce
@@ -379,7 +389,7 @@ module Appium
       if !@sauce_username.nil? && !@sauce_access_key.nil?
         "http://#{@sauce_username}:#{@sauce_access_key}@ondemand.saucelabs.com:80/wd/hub"
       else
-        "http://127.0.0.1:#{@port}/wd/hub"
+        "http://127.0.0.1:#{@appium_port}/wd/hub"
       end
     end
 

data/lib/appium_lib/ios/helper.rb

@@ -132,7 +132,7 @@ module Appium
       end
       # current_context may be nil which breaks start_with
       if current_context && current_context.start_with?('WEBVIEW')
-        s = get_source
+        s      = get_source
         parser = @android_html_parser ||= Nokogiri::HTML::SAX::Parser.new(Common::HTMLElements.new)
         parser.document.reset
         parser.document.filter = class_name
@@ -354,5 +354,54 @@ module Appium
     def xpaths_visible_exact element, value
       xpaths string_visible_exact element, value
     end
+
+    # @private
+    # If there's no keyboard, then do nothing.
+    # If there's no close key, fallback to window tap.
+    # If close key is present then tap it.
+    # @param close_key [String] close key to tap. Default value is 'Done'
+    # @return [void]
+    def hide_ios_keyboard close_key='Done'
+=begin
+Find the top left corner of the keyboard and move up 10 pixels (origin.y - 10)
+now swipe down until the end of the window - 10 pixels.
+-10 to ensure we're not going outside the window bounds.
+
+Swiping inside the keyboard will not dismiss it.
+
+Don't use window.tap. See https://github.com/appium/appium-uiauto/issues/28
+=end
+      dismiss_keyboard = (<<-JS).strip
+      if (!au.mainApp().keyboard().isNil()) {
+        var key = au.mainApp().keyboard().buttons()['#{close_key}']
+        if (key.isNil()) {
+          var startY = au.mainApp().keyboard().rect().origin.y - 10;
+          var endY = au.mainWindow().rect().size.height - 10;
+          au.flickApp(0, startY, 0, endY);
+        } else {
+          key.tap();
+        }
+        au.delay(1000);
+      }
+      JS
+
+      ignore do
+        # wait 5 seconds for a wild keyboard to appear. if the textfield is disabled
+        # then setValue will work, however the keyboard will never display
+        # because users are normally not allowed to type into it.
+        wait_true(5) do
+          execute_script '!au.mainApp().keyboard().isNil()'
+        end
+
+        # dismiss keyboard
+        execute_script dismiss_keyboard
+      end
+
+      # wait 5 seconds for keyboard to go away.
+      # if the keyboard isn't dismissed then wait_true will error.
+      wait_true(5) do
+        execute_script 'au.mainApp().keyboard().isNil()'
+      end
+    end
   end # module Ios
 end # module Appium