feat: work with Ruby 3 (#893)

* fix ios/driver

* fix web context in ios

* tweak more

* tweak tests

* renamed from tap to tap_once to avoid conflict in Ruby tap

* tweak ios

* fix more

* tweak

* fix tests

* fix rubocop

* update changelog

* tweak

* tweak tests

Author: KazuCocoa

CHANGELOG.md

@@ -5,11 +5,14 @@ Release tags are https://github.com/appium/ruby_lib/releases .
 
 ## Unreleased
 
+Support Ruby 3
+
 ### 1. Enhancements
 
 ### 2. Bug fixes
 
 ### 3. Deprecations
+- Rename `Appium::Ios::Xcuitest::Guesture#tap` to `Appium::Ios::Xcuitest::Guesture#one_finger_tap` to prevent conflicts with `tap` in Ruby
 
 ## 11.0.0 - 2020-12-19
 

android_tests/appium.txt

@@ -1,12 +1,13 @@
 [caps]
 automationName = "uiautomator2"
 platformName = "android"
-deviceName = "Nexus 7"
+deviceName = "Android emulator"
 app = "../test_apps/api.apk"
 appPackage = "io.appium.android.apis"
 appActivity = "io.appium.android.apis.ApiDemos"
 some_capability = "some_capability"
 
+
 [appium_lib]
 sauce_username = ""
 sauce_access_key = ""

android_tests/lib/android/specs/android/element/alert.rb

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rake android[android/element/alert]
+# rake "android[android/element/alert]"
 describe 'android/element/alert' do
   def open_alert
     # trigger the alert

android_tests/lib/android/specs/android/element/button.rb

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rake android['android/element/button']
+# rake "android[android/element/button]"
 describe 'android/element/button' do
   def before_first
     # nav to buttons activity
@@ -27,11 +27,7 @@ def after_last
   end
 
   def fade_in
-    if automation_name_is_espresso?
-      'Fade in'
-    else
-      'FADE IN'
-    end
+    'Fade in'
   end
 
   t { before_first }

android_tests/lib/android/specs/android/element/generic.rb

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rake android['android/element/generic']
+# rake "android[android/element/generic]"
 describe 'android/element/generic' do
   def content
     'Content'

android_tests/lib/android/specs/android/element/text.rb

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rake android['android/element/text']
+# rake "android[android/element/text]"
 describe 'android/element/text' do
   def must_raise_no_element
     proc { yield }.must_raise Selenium::WebDriver::Error::NoSuchElementError

android_tests/lib/android/specs/android/element/textfield.rb

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# rake "android[android/element/textfield]"
 describe 'android/element/textfield' do
   def must_raise_no_element
     proc { yield }.must_raise Selenium::WebDriver::Error::NoSuchElementError

android_tests/lib/android/specs/android/helper.rb

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rake android[android/helper]
+# rake "android[android/helper]"
 describe 'android/helper' do
   t 'tags' do
     wait { tags('android.widget.TextView').length.must_equal 13 }

android_tests/lib/android/specs/android/patch.rb

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rake android[android/patch]
+# rake "android[android/patch]"
 describe 'android/patch.rb' do
   t 'type' do
     # nav to textfield

android_tests/lib/android/specs/common/command/command.rb

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rake android[common/command/command]
+# rake "android[common/command/command]"
 describe 'common/command/command' do
   t 'command' do
     File.delete 'logcat.log' if File.exist? 'logcat.log'

android_tests/lib/android/specs/common/device.rb

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rake android[common/device]
+# rake "android[common/device]"
 describe 'common/device' do
   t 'get_performance_data_types' do
     expected = %w(batteryinfo cpuinfo memoryinfo networkinfo)

android_tests/lib/android/specs/common/device_touchaction.rb

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rake android[common/device_touchaction]
+# rake "android[common/device_touchaction]"
 describe 'common/device_touchaction' do
   def before_first
     wait { text('Accessibility') }

android_tests/lib/android/specs/common/element/window.rb

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rake android[common/element/window]
+# rake "android[common/element/window]"
 describe 'common/element/window' do
   # rubocop:disable Lint/UnifiedInteger
   t 'window_size' do

android_tests/lib/android/specs/common/helper.rb

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# rake "android[common/helper]"
 describe 'common/helper' do
   wait_opts = { timeout: 0.2, interval: 0.2 } # max_wait, interval
 

android_tests/lib/android/specs/common/patch.rb

@@ -16,6 +16,7 @@
 #   status # status patches are already tested in driver.rb
 #   execute # debug output for Pry
 
+# rake "android[common/patch]"
 describe 'common/patch' do
   # Attributes are busted in Android.
   # Blocked on https://github.com/appium/appium/issues/628

android_tests/lib/android/specs/common/web_context.rb

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 # Tests specifically for areas where the web_context differs in behaviour
-# rake android[common/web_context]
+# rake "android[common/web_context]"
 describe 'the web context' do
   # appium's context support is broken on android
 
@@ -36,8 +36,9 @@ def undo_setcontext_nav
       wait { find 'Views' }
     end
 
-    contexts        = available_contexts
-    webview_context = contexts.detect { |e| e.start_with?('WEBVIEW') }
+    wait_true { !available_contexts.detect { |e| e.start_with?('WEBVIEW') }.nil? }
+
+    webview_context = available_contexts.detect { |e| e.start_with?('WEBVIEW') }
 
     if webview_context.nil?
       undo_setcontext_nav

android_tests/lib/android/specs/device/touch_actions.rb

@@ -12,12 +12,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rake android[device/touch_actions]
+# rake "android[device/touch_actions]"
 describe 'device/touch_actions' do
   def swipe_till_text_visible(seen_text)
     start_x = window_size[:width] / 2
     start_y = window_size[:height] / 2
-    wait(timeout: 0.6) do
+    wait(timeout: 1.0) do
       # rubocop:disable Layout/LineLength
       # Example for Android's log
       # [0] pry(#<device/touch_actions>)> swipe start_x: start_x, start_y: start_y, end_x: start_y, end_y: start_y - 100
@@ -32,7 +32,7 @@ def swipe_till_text_visible(seen_text)
       # [AndroidBootstrap] [BOOTSTRAP LOG] [debug] Swiping from [x=600.0, y=919.0] to [x=600.0, y=819.0] with steps: 6
       # [debug] [AndroidBootstrap] Received command result from bootstrap
       # rubocop:enable Layout/LineLength
-      swipe start_x: start_x, start_y: start_y, end_x: 0.0, end_y: - 100
+      swipe start_x: start_x, start_y: start_y, end_x: 0.0, end_y: 10
       text(seen_text).displayed?
     end
   end
@@ -44,7 +44,7 @@ def swipe_till_text_visible(seen_text)
       text('animation').displayed?
     end
     text('animation').text.must_equal 'Animation'
-    swipe_till_text_visible('lists')
+    swipe_till_text_visible('Views')
   end
 end
 

android_tests/lib/android/specs/driver.rb

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rake android[driver]
+# rake "android[driver]"
 describe 'driver' do
   def sauce?
     ENV['UPLOAD_FILE'] && ENV['SAUCE_USERNAME']
@@ -48,7 +48,6 @@ def sauce?
 
     t 'verify all attributes' do
       actual = driver_attributes
-      caps_app_for_teardown = actual[:caps][:app]
       expected_app = File.absolute_path('../test_apps/api.apk')
 
       expected = {
@@ -74,7 +73,7 @@ def sauce?
       caps_with_json['app'].must_equal expected_app
       caps_with_json['appPackage'].must_equal 'io.appium.android.apis'
       caps_with_json['appActivity'].must_equal 'io.appium.android.apis.ApiDemos'
-      caps_with_json['deviceName'].must_equal 'Nexus 7'
+      caps_with_json['deviceName'].must_equal 'Android emulator'
       caps_with_json['someCapability'].must_equal 'some_capability'
 
       actual[:caps][:platformName].must_equal 'android'
@@ -87,17 +86,7 @@ def sauce?
       dup_actual = actual.dup
       dup_actual.delete(:caps)
 
-      if dup_actual != expected
-        diff    = HashDiff.diff expected, dup_actual
-        diff    = "diff (expected, actual):\n#{diff}"
-
-        dup_actual[:caps][:app] = caps_app_for_teardown if dup_actual.key? :caps
-        # example:
-        # change :ios in expected to match 'ios' in actual
-        # [["~", "caps.platformName", :ios, "ios"]]
-        message = "\n\nactual:\n\n: #{dup_actual}expected:\n\n#{expected}\n\n#{diff}"
-        raise message
-      end
+      raise "\n\nactual:\n\n: #{dup_actual}expected:\n\n#{expected}" if dup_actual != expected
     end
   end
 

android_tests/lib/android/specs/install.rb

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# rake "android[install]"
 describe 'install' do
   # To Do: Blocked on https://github.com/appium/appium/issues/3032
   def pkg

android_tests/lib/run.rb

@@ -71,6 +71,7 @@ def start_driver(caps)
 
   start_driver(caps)
 
+  # Ruby 3.0 sorts the Dir.glob order
   # require support (common.rb)
   file_name = File.join dir, "#{test_dir}/*.rb"
   Dir.glob(file_name) do |test|

grid/appium.txt.ios.example

@@ -1,7 +1,7 @@
 [caps]
 platformName = "ios"
 platformVersion = "11.4"
-deviceName ="iPhone Simulator"
+deviceName ="iPhone 11"
 automationName = 'XCUITest'
 app = "/absolute/path/to/UICatalog.app.zip"
 some_capability = "some_capability"

grid/config.json

@@ -2,7 +2,7 @@
   "capabilities":
   [
     {
-      "browserName": "iPhone Simulator",
+      "browserName": "iPhone 11",
       "version":"11.4",
       "platform":"ios",
       "maxInstances": 1

grid/hub_config_3.json

@@ -2,7 +2,7 @@
   "capabilities":
   [
     {
-      "browserName": "iPhone Simulator",
+      "browserName": "iPhone 11",
       "version":"11.4",
       "maxInstances": 1,
       "seleniumProtocol": "WebDriver"

ios_tests/appium.txt

@@ -1,7 +1,7 @@
 [caps]
 platformName = "ios"
-platformVersion = "12.4"
-deviceName ="iPhone Simulator"
+platformVersion = "14.2"
+deviceName ="iPhone 11"
 automationName = 'XCUITest'
 app = "../test_apps/UICatalog.app.zip"
 someCapability = "some_capability"

ios_tests/lib/common.rb

@@ -25,8 +25,8 @@ def leave_textfields
 def go_to_textfields
   screen.must_equal catalog
   wait_true do
-    automation_name_is_xcuitest? ? find_element(:name, 'TextFields').click : text('textfield').click
-    screen == 'TextFields' # wait for screen transition
+    automation_name_is_xcuitest? ? find_element(:name, 'Text Fields').click : text('textfield').click
+    screen == 'Text Fields' # wait for screen transition
   end
 end
 
@@ -75,6 +75,10 @@ def picker
     xcuitest? ? 'XCUIElementTypePicker' : 'UIAPicker'
   end
 
+  def picker_wheel
+    xcuitest? ? 'XCUIElementTypePickerWheel' : 'UIAPickerWheel'
+  end
+
   def action_sheet
     xcuitest? ? 'XCUIElementTypeActionSheet' : 'UIActionSheet'
   end

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

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rake ios[common/command/command]
+# rake "ios[common/command/command]"
 describe 'common/command/command' do
   t 'command' do
     File.delete 'syslog.log' if File.exist? 'syslog.log'

ios_tests/lib/ios/specs/common/element/window.rb

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-# rake ios[common/element/window]
+# rake "ios[common/element/window]"
 describe 'common/element/window' do
   def before_first
     screen.must_equal catalog