appium_lib 3.0.3 → 4.0.0

data/docs/migration.md

@@ -1,3 +1,9 @@
+### Breaking Changes in 4.0
+
+           Old | New
+            :--|:--
+`key_event`    | `press_keycode`
+
 ### Breaking Changes in 2.0
 
 In 2.0, the e_* methods have been renamed.

data/ios_tests/Rakefile

@@ -36,9 +36,6 @@ task :ios, :args, :test_file do |args, test_file|
   # args = android
   # test_file = {:args=>"ok"}
   test_file         = test_file[:args]
-  path              = File.expand_path('appium.txt', Rake.application.original_dir)
-  ENV['APPIUM_TXT'] = path
-  puts "Rake appium.txt path is: #{path}"
   cmd = 'bundle exec ruby ./lib/run.rb ios'
   cmd += %Q( "#{test_file}") if test_file
   bash cmd

data/ios_tests/appium.txt

@@ -1,5 +1,6 @@
 [caps]
 platformName = "ios"
+deviceName ="iPhone Simulator"
 app = "./UICatalog.app"
 
 [appium_lib]

data/ios_tests/lib/common.rb

@@ -0,0 +1,30 @@
+
+# common methods
+def back_click(opts={})
+  opts        ||= {}
+  search_wait = opts.fetch(:wait, 60 * 1.7)
+  # iOS may have multiple 'back' buttons
+  # select the first displayed? back button.
+  wait(search_wait) do
+    button_exact('Back').click
+  end
+end
+
+def leave_textfields
+  back_click
+  screen.must_equal catalog
+end
+
+def go_to_textfields
+  screen.must_equal catalog
+  wait_true { text('textfield').click; screen == 'TextFields' } # wait for screen transition
+  screen.must_equal 'TextFields'
+end
+
+def screen
+  $driver.find_element(:class, 'UIANavigationBar').name
+end
+
+def catalog
+  'UICatalog'
+end

data/ios_tests/lib/ios/specs/device/device.rb

@@ -76,8 +76,13 @@ describe 'device/device' do
     pinch 75
   end
 
-  t 'file movement' do
+  t 'pull_file' do
     read_file = pull_file 'Library/AddressBook/AddressBook.sqlitedb'
     read_file.start_with?('SQLite format').must_equal true
   end
+
+  t 'pull_folder' do
+    data = pull_folder 'Library/AddressBook'
+    data.length.must_be :>, 1
+  end
 end

data/ios_tests/lib/ios/specs/driver.rb

@@ -21,9 +21,8 @@ describe 'driver' do
     # skip this test if we're using Sauce
     # the storage API doesn't have an on disk file
     skip if is_sauce
-    # __FILE__ is '(eval)' so use env var set by the Rakefile
-    path = ENV['APPIUM_TXT']
-    opts = Appium.load_appium_txt file: path, verbose: true
+    appium_txt = File.expand_path(File.join(Dir.pwd, 'lib'))
+    opts       = Appium.load_appium_txt file: appium_txt, verbose: true
 
     actual   = ''
     actual   = File.basename opts[:caps][:app] if opts && opts[:caps]
@@ -37,6 +36,7 @@ describe 'driver' do
       actual              = driver_attributes
       actual[:caps][:app] = File.basename actual[:caps][:app]
       expected            = { caps:             { platformName: 'ios',
+                                                  deviceName:   'iPhone Simulator',
                                                   app:          'UICatalog.app' },
                               custom_url:       false,
                               export_session:   false,

data/ios_tests/lib/ios/specs/ios/element/alert.rb

@@ -29,11 +29,6 @@ describe 'ios/element/alert' do
     end
   end
 
-  # iOS 7 is not using the alert methods. alert is nil.
-  def ios7_alert_detected
-    execute_script 'UIATarget.localTarget().frontMostApp().alert().isNil()'
-  end
-
   t 'alert_accept' do
     alert_accept
   end

data/ios_tests/lib/ios/specs/ios/element/textfield.rb

@@ -33,6 +33,11 @@ describe 'ios/element/textfield' do
     textfields.length.must_equal 4
   end
 
+  t 'predicate textfields' do
+    textfield_count = execute_script(%Q(au.mainApp().getAllWithPredicate("type contains[c] 'textfield'", true))).length
+    textfield_count.must_equal 4
+  end
+
   t 'first_textfield' do
     first_textfield.text.must_equal enter_text
   end
@@ -110,6 +115,11 @@ describe 'ios/element/textfield' do
     textfields_exact('does not exist').length.must_equal 0
   end
 
+  t 'hide_keyboard' do
+    first_textfield.click
+    hide_keyboard
+  end
+
   t 'after_last' do
     after_last
   end

data/ios_tests/lib/run.rb

@@ -1,106 +1,4 @@
-require 'rubygems'
-require 'spec'
-require 'hashdiff'
-
-require_relative '../../lib/appium_lib'
-
-=begin
-Run all Android tests:
-  ruby run.rb android
-
-Run only the view album test:
-  ruby run.rb ios view_album
-=end
-
-# Sanity check
-a = OpenStruct.new x: 'ok'
-raise 'x issue' unless a.x == 'ok'
-
-# common methods
-def back_click(opts={})
-  opts        ||= {}
-  search_wait = opts.fetch(:wait, 60 * 1.7)
-  # iOS may have multiple 'back' buttons
-  # select the first displayed? back button.
-  wait(search_wait) do
-    button_exact('Back').click
-  end
-end
-
-def leave_textfields
-  back_click
-  screen.must_equal catalog
-end
-
-def go_to_textfields
-  screen.must_equal catalog
-  wait_true { text('textfield').click; screen == 'TextFields' } # wait for screen transition
-  screen.must_equal 'TextFields'
-end
-
-def screen
-  $driver.find_element(:class, 'UIANavigationBar').name
-end
-
-def catalog
-  'UICatalog'
-end
-
-##
-
-caps = Appium.load_appium_txt file: File.expand_path('..', __FILE__), verbose: true
-caps = caps.merge({ appium_lib: { debug: true, wait: 30 } })
-
-dir     = File.expand_path '..', __FILE__
-device  = ARGV[0].downcase.strip
-devices = %w[ android selendroid ios ]
-raise 'Expected android, selendroid or ios as first argument' unless devices.include? device
-
-one_test   = ARGV[1]
-test_dir   = "/#{device}/"
-
-caps[:app] = ENV['SAUCE_PATH'] if ENV['SAUCE_USERNAME'] && ENV['SAUCE_ACCESS_KEY']
-
-trace_files = []
-
-if one_test
-  unless File.exists? one_test
-    # ensure ext is .rb
-    one_test = File.join(File.dirname(one_test),
-                         File.basename(one_test, '.*') + '.rb')
-    one_test = File.join(dir, test_dir + 'specs/', one_test)
-  else
-    one_test = File.expand_path one_test
-  end
-  raise "\nTest #{one_test} does not exist.\n" unless File.exists?(one_test)
-  Appium::Driver.new(caps).start_driver
-  # require support (common.rb)
-  Dir.glob(File.join dir, test_dir + '/*.rb') do |test|
-    require test
-    trace_files << test
-  end
-  puts "Loading one test: #{one_test}"
-  require one_test
-  trace_files << one_test
-else
-  # require all
-  Dir.glob(File.join dir, test_dir + '**/*.rb') do |test|
-    # load all tests
-    trace_files << test
-    puts "  #{File.basename(test, '.*')}"
-    require test
-  end
-  Appium::Driver.new(caps).start_driver
-end
-
-trace_files.map! do |f|
-  f = File.expand_path f
-  # ensure all traced files end in .rb
-  f = File.join(File.dirname(f), File.basename(f, '.*') + '.rb')
-  f
-end
-
-# Exit after tests.
-Minitest.after_run { $driver.x if $driver }
-# Run Minitest. Provide test file array for tracing.
-Minitest.run_specs({ :trace => trace_files })
+# ios tests have a set of common helper methods
+require_relative 'common'
+# run file is identical to android
+require_relative '../../android_tests/lib/run'

data/lib/appium_lib.rb

@@ -2,7 +2,7 @@
 Encoding.default_external = Encoding::UTF_8
 Encoding.default_internal = Encoding::UTF_8
 
-require 'Forwardable' unless defined? Forwardable
+require 'forwardable' unless defined? Forwardable
 require_relative 'appium_lib/rails/duplicable'
 
 $driver = nil
@@ -25,4 +25,4 @@ def self.method_missing method, *args, &block
 end
 
 require_relative 'appium_lib/logger'
-require_relative 'appium_lib/driver'
+require_relative 'appium_lib/driver'

data/lib/appium_lib/android/element/button.rb

@@ -11,24 +11,12 @@ module Appium
       button_index       = opts.fetch :button_index, false
       image_button_index = opts.fetch :image_button_index, false
 
-      # complex_find(...)
-      # 4 = className(String className)
-      # 9 = instance(final int instance)
-
       if button_index && image_button_index
-        [
-          # className().instance()
-          [[4, Button], [9, button_index]],
-          # className().instance()
-          [[4, ImageButton], [9, image_button_index]]
-        ]
+        "new UiSelector().className(#{Button}).instance(#{button_index});" +
+        "new UiSelector().className(#{ImageButton}).instance(#{image_button_index});"
       else
-        [
-          # className()
-          [[4, Button]],
-          # className()
-          [[4, ImageButton]]
-        ]
+        "new UiSelector().className(#{Button});" +
+        "new UiSelector().className(#{ImageButton});"
       end
     end
 
@@ -59,10 +47,10 @@ module Appium
         index = value
         raise "#{index} is not a valid index. Must be >= 1" if index <= 0
 
-        return complex_find _button_visible_selectors index: index
+        return find_element :uiautomator, _button_visible_selectors(index: index)
       end
 
-      complex_find _button_contains_string value
+      find_element :uiautomator, _button_contains_string(value)
     end
 
     # Find all buttons containing value.
@@ -70,14 +58,14 @@ module Appium
     # @param value [String] the value to search for
     # @return [Array<Button>]
     def buttons value=false
-      return complex_find mode: 'all', selectors: _button_visible_selectors unless value
-      complex_find mode: 'all', selectors: _button_contains_string(value)
+      return find_elements :uiautomator, _button_visible_selectors unless value
+      find_elements :uiautomator, _button_contains_string(value)
     end
 
     # Find the first button.
     # @return [Button]
     def first_button
-      complex_find _button_visible_selectors button_index: 0, image_button_index: 0
+      find_element :uiautomator, _button_visible_selectors(button_index: 0, image_button_index: 0)
     end
 
     # Find the last button.
@@ -86,25 +74,27 @@ module Appium
       # uiautomator index doesn't support last
       # and it's 0 indexed
       button_index       = tags(Button).length
-      button_index       -= 1 if button_index >= 0
+      button_index       -= 1 if button_index > 0
       image_button_index = tags(ImageButton).length
-      image_button_index -= 1 if image_button_index >= 0
+      image_button_index -= 1 if image_button_index > 0
 
-      complex_find _button_visible_selectors button_index: button_index, image_button_index: image_button_index
+      find_element :uiautomator,
+                   _button_visible_selectors(button_index: button_index,
+                                            image_button_index: image_button_index)
     end
 
     # Find the first button that exactly matches value.
     # @param value [String] the value to match exactly
     # @return [Button]
     def button_exact value
-      complex_find _button_exact_string value
+      find_element :uiautomator, _button_exact_string(value)
     end
 
     # Find all buttons that exactly match value.
     # @param value [String] the value to match exactly
     # @return [Array<Button>]
     def buttons_exact value
-      complex_find mode: 'all', selectors: _button_exact_string(value)
+      find_elements :uiautomator, _button_exact_string(value)
     end
   end # module Android
 end # module Appium

data/lib/appium_lib/android/element/generic.rb

@@ -29,30 +29,33 @@ module Appium
       complex_finds_exact '*', value
     end
 
+    # @private
+     def scroll_uiselector content
+       "new UiScrollable(new UiSelector().scrollable(true).instance(0)).scrollIntoView(#{content}.instance(0));"
+     end
+
     # Scroll to the first element containing target text or description.
     # @param text [String] the text to search for in the text value and content description
     # @return [Element] the element scrolled to
     def scroll_to text
-      args =
-        # textContains(text)
-        [[3, text]],
-          # descriptionContains(text)
-          [[7, text]]
+      text = %Q("#{text}")
+
+      args = scroll_uiselector("new UiSelector().textContains(#{text})") +
+             scroll_uiselector("new UiSelector().descriptionContains(#{text})")
 
-      complex_find mode: 'scroll', selectors: args
+      find_element :uiautomator, args
     end
 
     # Scroll to the first element with the exact target text or description.
     # @param text [String] the text to search for in the text value and content description
     # @return [Element] the element scrolled to
     def scroll_to_exact text
-      args =
-        # text(text)
-        [[1, text]],
-          # description(text)
-          [[5, text]]
+      text = %Q("#{text}")
+
+      args = scroll_uiselector("new UiSelector().text(#{text})") +
+             scroll_uiselector("new UiSelector().description(#{text})")
 
-      complex_find mode: 'scroll', selectors: args
+      find_element :uiautomator, args
     end
   end # module Android
 end # module Appium

data/lib/appium_lib/android/helper.rb

@@ -3,8 +3,7 @@ module Appium
     # @private
     # http://nokogiri.org/Nokogiri/XML/SAX.html
     class AndroidElements < Nokogiri::XML::SAX::Document
-      # TODO: Support strings.xml ids
-      attr_reader :result, :keys
+      attr_reader :result, :keys, :instance
 
       def filter
         @filter
@@ -20,17 +19,22 @@ module Appium
       def initialize
         reset
         @filter = false
+        @instance = Hash.new -1
       end
 
       def reset
         @result = ''
         @keys   = %w[text resource-id content-desc]
+        @instance = Hash.new -1
       end
 
       # http://nokogiri.org/Nokogiri/XML/SAX/Document.html
       def start_element name, attrs = []
         return if filter && !name.downcase.include?(filter)
 
+        # instance numbers start at 0.
+        number = instance[name] += 1
+
         attributes = {}
 
         attrs.each do |key, value|
@@ -75,7 +79,7 @@ module Appium
         string  += "  id: #{id}\n" unless id.nil?
         string  += "  strings.xml: #{string_ids}" unless string_ids.nil?
 
-        @result += "\n#{name}\n#{string}" unless attributes.empty?
+        @result += "\n#{name} (#{number})\n#{string}" unless attributes.empty?
       end
     end # class AndroidElements
 
@@ -92,10 +96,12 @@ module Appium
       else
         parser = @android_webview_parser ||= Nokogiri::XML::SAX::Parser.new(AndroidElements.new)
       end
-      parser.document.reset
+      parser.document.reset # ensure document is reset before parsing
       parser.document.filter = class_name
       parser.parse source
-      parser.document.result
+      result = parser.document.result
+      parser.document.reset # clean up any created objects after parsing
+      result
     end
 
     # Intended for use with console.
@@ -157,14 +163,18 @@ module Appium
     # @param index [Integer] the index
     # @return [Element] the found element of type class_name
     def ele_index class_name, index
+      results = tags(class_name)
       if index == 'last()'
-        index = tags(class_name).length
+        index = results.length
         index -= 1 if index >= 0
       else
         raise 'Index must be >= 1' unless index >= 1
         index -= 1 if index >= 1
       end
-      complex_find [[[4, class_name], [9, index]]]
+
+      # uiautomator has issues with index/instance so calculate the index
+      # client side.
+      results[index]
     end
 
     # Find the first element that matches class_name
@@ -206,32 +216,19 @@ module Appium
     # @param value [String] the value to search for
     # @return [String]
     def string_visible_contains class_name, value
-      #  4  = className(String className)
-      # 29  = resourceId(String id
-      #  7  = descriptionContains(String desc)
-      #  3  = textContains(String text)
-      # todo: textContains isn't case insensitive
-      # descriptionContains is case insensitive
+      value = %Q("#{value}")
 
       if class_name == '*'
-        return [
-          # resourceId()
-          [[29, value]],
-          # descriptionContains()
-          [[7, value]],
-          # textContains()
-          [[3, value]]
-        ]
+        return "new UiSelector().resourceId(#{value});" +
+          "new UiSelector().descriptionContains(#{value});" +
+          "new UiSelector().textContains(#{value});"
       end
 
-      [
-        # className().resourceId()
-        [[4, class_name], [29, value]],
-        # className().descriptionContains()
-        [[4, class_name], [7, value]],
-        # className().textContains()
-        [[4, class_name], [3, value]]
-      ]
+      class_name = %Q("#{class_name}")
+
+      "new UiSelector().className(#{class_name}).resourceId(#{value});" +
+        "new UiSelector().className(#{class_name}).descriptionContains(#{value});" +
+        "new UiSelector().className(#{class_name}).textContains(#{value});"
     end
 
     # Find the first element that contains value
@@ -239,7 +236,7 @@ module Appium
     # @param value [String] the value to search for
     # @return [Element]
     def complex_find_contains element, value
-      complex_find string_visible_contains element, value
+      find_element :uiautomator, string_visible_contains(element, value)
     end
 
     # Find all elements containing value
@@ -247,7 +244,7 @@ module Appium
     # @param value [String] the value to search for
     # @return [Array<Element>]
     def complex_finds_contains element, value
-      complex_find mode: 'all', selectors: string_visible_contains(element, value)
+      find_elements :uiautomator, string_visible_contains(element, value)
     end
 
     # @private
@@ -256,30 +253,19 @@ module Appium
     # @param value [String] the value to search for
     # @return [String]
     def string_visible_exact class_name, value
-      #  4  = className(String className)
-      # 29  = resourceId(String id
-      #  5  = description(String desc)
-      #  1  = text(String text)
+      value = %Q("#{value}")
 
       if class_name == '*'
-        return [
-          # resourceId()
-          [[29, value]],
-          # description()
-          [[5, value]],
-          # text()
-          [[1, value]]
-        ]
+        return "new UiSelector().resourceId(#{value});" +
+          "new UiSelector().description(#{value});" +
+          "new UiSelector().text(#{value});"
       end
 
-      [
-        # className().resourceId()
-        [[4, class_name], [29, value]],
-        # className().description()
-        [[4, class_name], [5, value]],
-        # className().text()
-        [[4, class_name], [1, value]]
-      ]
+      class_name = %Q("#{class_name}")
+
+      "new UiSelector().className(#{class_name}).resourceId(#{value});" +
+        "new UiSelector().className(#{class_name}).description(#{value});" +
+        "new UiSelector().className(#{class_name}).text(#{value});"
     end
 
     # Find the first element exactly matching value
@@ -287,7 +273,7 @@ module Appium
     # @param value [String] the value to search for
     # @return [Element]
     def complex_find_exact class_name, value
-      complex_find string_visible_exact class_name, value
+      find_element :uiautomator, string_visible_exact(class_name, value)
     end
 
     # Find all elements exactly matching value
@@ -295,7 +281,7 @@ module Appium
     # @param value [String] the value to search for
     # @return [Element]
     def complex_finds_exact class_name, value
-      complex_find mode: 'all', selectors: string_visible_exact(class_name, value)
+      find_elements :uiautomator, string_visible_exact(class_name, value)
     end
   end # module Android
 end # module Appium