appium_lib 9.0.0 → 9.1.0

data/docs/ios_xcuitest.md

@@ -5,21 +5,49 @@
 - How to migrate XCUITest from UIAutomation
     - [Migrating your iOS tests from UIAutomation](https://github.com/appium/appium/blob/v1.6.2/docs/en/advanced-concepts/migrating-to-xcuitest.md)
 
-
-### Elements
+## find elements
 - supported elements by find_element is:
     - [appium-xcuitest-driver](https://github.com/appium/appium-xcuitest-driver/blob/master/lib/commands/find.js#L17)
     - [WebDriverAgent](https://github.com/facebook/WebDriverAgent/blob/8346199212bffceab24192e81bc0118d65132466/WebDriverAgentLib/Commands/FBFindElementCommands.m#L111)
 - Mapping
     - https://github.com/facebook/WebDriverAgent/blob/master/WebDriverAgentLib/Utilities/FBElementTypeTransformer.m#L19
 
-### XPath
+### with except for XPath
+#### examples
+- [button_class](https://github.com/appium/ruby_lib/blob/master/lib/appium_lib/ios/element/button.rb#L8), [static_text_class](https://github.com/appium/ruby_lib/blob/master/lib/appium_lib/ios/element/text.rb#L8), [text_field_class](https://github.com/appium/ruby_lib/blob/master/lib/appium_lib/ios/element/textfield.rb#L10) and [secure_text_field_class](https://github.com/appium/ruby_lib/blob/master/lib/appium_lib/ios/element/textfield.rb#L15) provide class name.
+    - If `automationName` is `Appium`, then they provide `UIAxxxx`
+    - If `automationName` is `XCUITest`, then they provide `XCUIElementTypexxx`
+
+```ruby
+find_element(:class, button_class) # Return a element of XCUIElementTypeButton for XCUITest
+```
+
+- [tag/s](https://github.com/appium/ruby_lib/blob/ac03116756a72fbd624fa32ea886123b955d7089/lib/appium_lib/android/helper.rb#L238) is alias of `find_element :class, element`
+
+- `accessibility_id`
+
+```ruby
+find_element(:accessibility_id, element) # Return a element which has accessibilityIdentifier, `element`.
+```
+
+### with XPath
 - It is better to avoid XPath strategy.
     - https://github.com/appium/appium/blob/v1.6.2/docs/en/advanced-concepts/migrating-to-xcuitest.md#xpath-locator-strategy
-      > Try not to use XPath locators unless there is absolutely no other alternatives. In general, xpath locators might be times slower, than other types of locators like accessibility id, class name and predicate (up to 100 times slower in some special cases). They are so slow, because xpath location is not natively supported by Apple's XCTest framework.
+        - > Try not to use XPath locators unless there is absolutely no other alternatives. In general, xpath locators might be times slower, than other types of locators like accessibility id, class name and predicate (up to 100 times slower in some special cases). They are so slow, because xpath location is not natively supported by Apple's XCTest framework.
     - Improved performance a bit
         - https://github.com/appium/appium/issues/6842
         - https://github.com/facebook/WebDriverAgent/issues/306
 - XPath in WebDriverAgent
     - https://github.com/facebook/WebDriverAgent/blob/2158a8d0f305549532f1338fe1e4628cfbd53cd9/WebDriverAgentLib/Categories/XCElementSnapshot%2BFBHelpers.m#L57
 
+#### examples
+- `button/s(value)`, `textfield/s(value)`, `text/s(value)` uses XPath in their method. So, these methods are slower than other find_element directly.
+
+```ruby
+button(value) # Return a XCUIElementTypeButton element which has `value` text.
+textfield(value) # Return a XCUIElementTypeSecureTextField or XCUIElementTypeTextField element which has `value` text.
+text(value) # Return a XCUIElementTypeStaticText element which has `value` text.
+```
+
+## Other actions
+Basically, other actions such as `type` is compatible with `automationName = Appium`. 

data/ios_tests/lib/common.rb

@@ -38,91 +38,47 @@ module UI
     end
 
     def self.navbar
-      if xcuitest?
-        'XCUIElementTypeNavigationBar'
-      else
-        'UIANavigationBar'
-      end
+      xcuitest? ? 'XCUIElementTypeNavigationBar' : 'UIANavigationBar'
     end
 
     def self.button
-      if xcuitest?
-        'XCUIElementTypeButton'
-      else
-        'UIAButton'
-      end
+      xcuitest? ? 'XCUIElementTypeButton' : 'UIAButton'
     end
 
     def self.static_text
-      if xcuitest?
-        'XCUIElementTypeStaticText'
-      else
-        'UIAStaticText'
-      end
+      xcuitest? ? 'XCUIElementTypeStaticText' : 'UIAStaticText'
     end
 
     def self.text_field
-      if xcuitest?
-        'XCUIElementTypeTextField'
-      else
-        'UIATextField'
-      end
+      xcuitest? ? 'XCUIElementTypeTextField' : 'UIATextField'
     end
 
     def self.secure_text_field
-      if xcuitest?
-        'XCUIElementTypeSecureTextField'
-      else
-        'UIASecureTextField'
-      end
+      xcuitest? ? 'XCUIElementTypeSecureTextField' : 'UIASecureTextField'
     end
 
     def self.picker
-      if xcuitest?
-        'XCUIElementTypePicker'
-      else
-        'UIAPicker'
-      end
+      xcuitest? ? 'XCUIElementTypePicker' : 'UIAPicker'
     end
 
     def self.action_sheet
-      if xcuitest?
-        'XCUIElementTypeActionSheet'
-      else
-        'UIActionSheet'
-      end
+      xcuitest? ? 'XCUIElementTypeActionSheet' : 'UIActionSheet'
     end
 
     def self.table
-      if xcuitest?
-        'XCUIElementTypeTable'
-      else
-        'UIATable'
-      end
+      xcuitest? ? 'XCUIElementTypeTable' : 'UIATable'
     end
 
     def self.table_cell
-      if xcuitest?
-        'XCUIElementTypeCell'
-      else
-        'UIATableCell'
-      end
+      xcuitest? ? 'XCUIElementTypeCell' : 'UIATableCell'
     end
 
     def self.other
-      if xcuitest?
-        'XCUIElementTypeOther'
-      else
-        fail 'unknown UIA element: other'
-      end
+      xcuitest? ? 'XCUIElementTypeOther' : raise('unknown UIA element: other')
     end
 
     def self.status_bar
-      if xcuitest?
-        'XCUIElementTypeStatusBar'
-      else
-        'UIAStatusBar'
-      end
+      xcuitest? ? 'XCUIElementTypeStatusBar' : 'UIAStatusBar'
     end
   end
 end

data/ios_tests/lib/ios/specs/common/command.rb

@@ -0,0 +1,44 @@
+# rake ios[common/command]
+describe 'common/command.rb' do
+  def before_first
+    screen.must_equal catalog
+  end
+
+  t 'before_first' do
+    before_first
+  end
+
+  t 'check all command no arg' do
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:shake).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:launch_app).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:close_app).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:reset).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:device_locked?).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:device_time).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:current_context).must_equal true
+  end
+
+  t 'check all command with arg' do
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:available_contexts).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:app_strings).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:lock).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:install_app).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:remove_app).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:app_installed?).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:background_app).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:start_activity).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:set_context).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:hide_keyboard).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:press_keycode).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:long_press_keycode).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:set_immediate_value).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:push_file).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:pull_file).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:pull_folder).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:touch_id).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:get_settings).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:update_settings).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:touch_actions).must_equal true
+    Selenium::WebDriver::Remote::Bridge.method_defined?(:multi_touch).must_equal true
+  end
+end

data/ios_tests/lib/ios/specs/common/helper.rb

@@ -24,12 +24,12 @@ describe 'common/helper.rb' do
     wait(wait_opts) { nil }
 
     # failed wait should error
-    proc { wait(wait_opts) { fail } }.must_raise Selenium::WebDriver::Error::TimeOutError
+    proc { wait(wait_opts) { raise } }.must_raise Selenium::WebDriver::Error::TimeOutError
 
     # regular rescue will not handle exceptions outside of StandardError hierarchy
     # must rescue Exception explicitly to rescue everything
-    proc { wait(wait_opts) { fail NoMemoryError } }.must_raise Selenium::WebDriver::Error::TimeOutError
-    proc { wait(timeout: 0.2, interval: 0.0) { fail NoMemoryError } }.must_raise Selenium::WebDriver::Error::TimeOutError
+    proc { wait(wait_opts) { raise NoMemoryError } }.must_raise Selenium::WebDriver::Error::TimeOutError
+    proc { wait(timeout: 0.2, interval: 0.0) { raise NoMemoryError } }.must_raise Selenium::WebDriver::Error::TimeOutError
 
     # invalid keys are rejected
     proc { wait(invalidkey: 2) { true } }.must_raise RuntimeError
@@ -40,8 +40,8 @@ describe 'common/helper.rb' do
     ignore { true }
     ignore { false }
     ignore { nil }
-    ignore { fail }
-    ignore { fail NoMemoryError }
+    ignore { raise }
+    ignore { raise NoMemoryError }
   end
 
   # wait_true is a success unless the value is not true
@@ -54,12 +54,12 @@ describe 'common/helper.rb' do
     proc { wait_true(wait_opts) { nil } }.must_raise Selenium::WebDriver::Error::TimeOutError
 
     # raise should error
-    proc { wait_true(wait_opts) { fail } }.must_raise Selenium::WebDriver::Error::TimeOutError
+    proc { wait_true(wait_opts) { raise } }.must_raise Selenium::WebDriver::Error::TimeOutError
 
     # regular rescue will not handle exceptions outside of StandardError hierarchy
     # must rescue Exception explicitly to rescue everything
-    proc { wait_true(wait_opts) { fail NoMemoryError } }.must_raise Selenium::WebDriver::Error::TimeOutError
-    proc { wait_true(timeout: 0.2, interval: 0.0) { fail NoMemoryError } }
+    proc { wait_true(wait_opts) { raise NoMemoryError } }.must_raise Selenium::WebDriver::Error::TimeOutError
+    proc { wait_true(timeout: 0.2, interval: 0.0) { raise NoMemoryError } }
       .must_raise Selenium::WebDriver::Error::TimeOutError
 
     # invalid keys are rejected

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

@@ -18,7 +18,7 @@ describe 'device/device' do
   end
 
   t 'lock' do
-    fail NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
+    raise NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
 
     lock 5
     tag(UI::Inventory.button).name.must_equal 'SlideToUnlock'
@@ -34,14 +34,14 @@ describe 'device/device' do
   end
 
   t 'app_installed' do
-    fail NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
+    raise NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
 
     installed = app_installed? 'Derrp'
     installed.must_equal false
   end
 
   t 'shake' do
-    fail NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
+    raise NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
 
     shake
   end
@@ -87,7 +87,7 @@ describe 'device/device' do
   t 'pull_file' do
     # Selenium::WebDriver::Error::UnknownError: An unknown server-side error occurred while processing the command.
     # Original error: Cannot read property 'getDir' of undefined
-    fail NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
+    raise NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
 
     read_file = pull_file 'Library/AddressBook/AddressBook.sqlitedb'
     read_file.start_with?('SQLite format').must_equal true
@@ -96,7 +96,7 @@ describe 'device/device' do
   t 'pull_folder' do
     # Selenium::WebDriver::Error::UnknownError: An unknown server-side error occurred while processing the command.
     # Original error: Cannot read property 'getDir' of undefined
-    fail NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
+    raise NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
 
     data = pull_folder 'Library/AddressBook'
     data.length.must_be :>, 1

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

@@ -33,13 +33,16 @@ describe 'driver' do
   describe 'Appium::Driver attributes' do
     t 'verify all attributes' do
       2.times { set_wait 30 } # must set twice to validate last_waits
-      actual              = driver_attributes
-      actual[:caps][:app] = File.basename actual[:caps][:app]
-      expected            = { caps:             { platformName: 'ios',
-                                                  platformVersion: '10.1',
-                                                  automationName: 'XCUITest',
-                                                  deviceName:   'iPhone Simulator',
-                                                  app:          'UICatalog.app' },
+      actual                = driver_attributes
+      caps_app_for_teardown = actual[:caps][:app]
+      actual[:caps][:app]   = File.basename actual[:caps][:app]
+
+      expected_caps       = ::Appium::Driver::Capabilities.init_caps_for_appium(platformName:    'ios',
+                                                                                platformVersion: '10.1',
+                                                                                automationName:  'XCUITest',
+                                                                                deviceName:      'iPhone Simulator',
+                                                                                app:             'UICatalog.app')
+      expected            = { caps:             expected_caps,
                               custom_url:       false,
                               export_session:   false,
                               default_wait:     30,
@@ -54,19 +57,35 @@ describe 'driver' do
       if actual != expected
         diff    = HashDiff.diff expected, actual
         diff    = "diff (expected, actual):\n#{diff}"
+
+        actual[:caps][:app] = caps_app_for_teardown
         # example:
         # change :ios in expected to match 'ios' in actual
         # [["~", "caps.platformName", :ios, "ios"]]
         message = "\n\nactual:\n\n: #{actual.ai}expected:\n\n#{expected.ai}\n\n#{diff}"
-        fail message
+        raise message
       end
+
+      actual_selenium_caps = actual[:caps][:automationName]
+      actual_selenium_caps.must_equal 'XCUITest'
+      actual[:caps][:app] = caps_app_for_teardown
     end
 
     t 'verify attributes are immutable' do
+      driver_attributes[:custom_url] = true
+      expected                       = false
+      driver_attributes[:custom_url].must_equal expected
+    end
+
+    t 'verify attribute of :caps are not immutable becuse it depends on Selenium' do
+      # immutability depends on Selenium
+      for_clean_up                   = driver_attributes[:caps][:app].dup
       driver_attributes[:caps][:app] = 'fake'
-      actual                         = File.basename driver_attributes[:caps][:app]
-      expected                       = 'UICatalog.app'
-      actual.must_equal expected
+      expected                       = 'fake'
+      driver_attributes[:caps][:app].must_equal expected
+
+      # clean up
+      driver_attributes[:caps][:app] = for_clean_up
     end
 
     t 'no_wait' do
@@ -188,12 +207,12 @@ describe 'driver' do
     # returns true unless an error is raised
     t 'exists' do
       exists(0, 0) { true }.must_equal true
-      exists(0, 0) { fail 'error' }.must_equal false
+      exists(0, 0) { raise 'error' }.must_equal false
     end
 
     # simple integration sanity test to check for unexpected exceptions
     t 'set_location' do
-      fail NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
+      raise NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
       set_location latitude: 55, longitude: -72, altitude: 33
     end
 
@@ -209,12 +228,12 @@ describe 'driver' do
 
     # settings
     t 'get settings' do
-      fail NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
+      raise NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
       get_settings.wont_be_nil
     end
 
     t 'update settings' do
-      fail NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
+      raise NotImplementedError, "XCUITest(Appium1.6.2) doesn't support yet" if UI::Inventory.xcuitest?
 
       update_settings cyberdelia: 'open'
       get_settings['cyberdelia'].must_equal 'open'

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

@@ -34,7 +34,7 @@ describe 'ios/element/textfield' do
   end
 
   t 'predicate textfields' do
-    fail NotImplementedError, "XCUITest(Appium1.6.2) doesn't support UIAutomation script" if UI::Inventory.xcuitest?
+    raise NotImplementedError, "XCUITest(Appium1.6.2) doesn't support UIAutomation script" if UI::Inventory.xcuitest?
 
     textfield_count = execute_script(%(au.mainApp().getAllWithPredicate("type contains[c] 'textfield'", true))).length
     textfield_count.must_equal 4

data/ios_tests/readme.md

@@ -1,7 +1,7 @@
 ruby_lib_ios
 =====================
 
-ruby_lib's iOS tests. Requires `Ruby 1.9.3` or better.
+ruby_lib's iOS tests. Requires `Ruby 2.2+` or better.
 
 - `rake install` Install gems required to run the tests.
 - `rake ios` Run all tests.

data/ios_tests/upload/sauce_storage.rb

@@ -38,9 +38,9 @@ class SauceStorage
   end
 
   def upload(file_path)
-    file_name = File.basename file_path
-    file      = File.new file_path
-    local_md5 = Digest::MD5.hexdigest File.read file_path
+    file_name  = File.basename file_path
+    file       = File.new file_path
+    local_md_5 = Digest::MD5.hexdigest File.read file_path
 
     files.each do |f|
       if f['md5'] == local_md5
@@ -50,16 +50,18 @@ class SauceStorage
     end
 
     url        = "#{@url}/#{file_name}?overwrite=plz"
-    remote_md5 = JSON.parse(RestClient.post url, file, content_type: 'application/octet-stream')['md5']
+    json = RestClient.post(url, file, content_type: 'application/octet-stream')
+    remote_md_5 = JSON.parse(json)['md5']
     if @debug
       puts "Uploaded #{file_path}"
-      puts " local_md5: #{local_md5}"
-      puts "remote_md5: #{remote_md5}"
+      puts " local_md5: #{local_md_5}"
+      puts "remote_md5: #{remote_md_5}"
     end
-    local_md5 == remote_md5
+    local_md_5 == remote_md_5
   end
 
   def files
-    JSON.parse(RestClient.get @url)['files']
+    get = RestClient.get @url
+    JSON.parse(get)['files']
   end
 end

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

@@ -1,8 +1,8 @@
 # UIAButton methods
 module Appium
   module Android
-    Button      = 'android.widget.Button'
-    ImageButton = 'android.widget.ImageButton'
+    Button      = 'android.widget.Button'.freeze
+    ImageButton = 'android.widget.ImageButton'.freeze
 
     private
 
@@ -45,7 +45,7 @@ module Appium
       # Android needs to combine button and image button to match iOS.
       if value.is_a? Numeric
         index = value
-        fail "#{index} is not a valid index. Must be >= 1" if index <= 0
+        raise "#{index} is not a valid index. Must be >= 1" if index <= 0
 
         return find_element :uiautomator, _button_visible_selectors(index: index)
       end