appium_lib 16.1.1 → 16.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c66c0b6201b3992cdcc6ba0a8cf83c8cb6e65fa6c8f7da6680de52731966e6e8
-  data.tar.gz: e3de25d8e982c830b27bc59fb623d51527676c9d68b43d89232295e4bed425b8
+  metadata.gz: 1ce9ba5f66a01f14337c06877b4cca232bd6607f0022c89e0fde1dbcd5c2d56a
+  data.tar.gz: df68401640b09c89449a78e9d3e4fa35116355aa85f3975b0c2a32e6724bbdd0
 SHA512:
-  metadata.gz: 2c378306be4f0b4e17136607908023126a4f1332d2d9663cab3e0550ab3c527e9421b31beaa942a5497ce2d686c8d9269b7d0c2d0bfb1c68d79ea32f7b12a0ac
-  data.tar.gz: 7c5d11692392a07a3b9b2c96b990131eff58eb776d6277c338c9388beb8ba1d47aa28f31f261eb39cef934114f97be41eeee7a17266837baa71a9ca63771a5d9
+  metadata.gz: 0b1a1d43c3463f70046e92e03de743ebb47b1d3bd0c4fc713a73af17e20be036377a2c2affa10b049308c1c898c3311ff310bbbd9b2cfc6c1eb00099058eef9e
+  data.tar.gz: 68cdfe45b0bba432f098c8080628f55879eba3161fb7dd94175f4cc142e8762343dfc30afe62239895d24dc351171f210e8c458efb0bb005c645ed50168fd250

data/.github/workflows/functional-test.yml

@@ -14,11 +14,12 @@ concurrency:
 
 jobs:
   ios_test:
-    runs-on: macos-14
+    runs-on: macos-15
+    timeout-minutes: 90
     env:
-          XCODE_VERSION: 15.3
-          IOS_VERSION: 17.4
-          IOS_DEVICE_NAME: iPhone 15 Plus
+          XCODE_VERSION: 16.4
+          IOS_VERSION: 18.5
+          IOS_DEVICE_NAME: iPhone 16 Plus
 
     steps:
     - uses: actions/checkout@v6
@@ -34,7 +35,7 @@ jobs:
         xcode-version: ${{ env.XCODE_VERSION }}
     - run: defaults write com.apple.iphonesimulator PasteboardAutomaticSync -bool false
 
-    - uses: futureware-tech/simulator-action@v4
+    - uses: futureware-tech/simulator-action@v5
       with:
       # https://github.com/actions/runner-images/blob/main/images/macos/macos-14-arm64-Readme.md
         model: ${{ env.IOS_DEVICE_NAME }}
@@ -57,15 +58,22 @@ jobs:
         appium plugin install execute-driver
         nohup appium --use-plugins=images,execute-driver --relaxed-security --log-timestamp --log-no-colors > appium.log &
 
+    - run: |
+        npx appium driver run xcuitest download-wda-sim --platform=ios --outdir=${{ github.workspace }}/wda
+      name: Downloading prebuilt WDA
+
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
         ruby-version: 4.0
     - run: |
         bundle install
-        rake ios
+        bundle exec rake ios
       name: Run tests
+      timeout-minutes: 60
       working-directory: ios_tests
+      env:
+        LOCAL_PREBUILT_WDA: ${{ github.workspace }}/wda/WebDriverAgentRunner-Runner.app
 
     - name: Save server output
       if: ${{ always() }}
@@ -75,3 +83,88 @@ jobs:
         path: |
           appium.log
           test/report/
+
+  android_test:
+    runs-on: ubuntu-latest
+    timeout-minutes: 90
+    env:
+      API_LEVEL: 35
+      ARCH: x86_64
+
+    steps:
+    - uses: actions/checkout@v6
+
+    - name: Set up Java
+      uses: actions/setup-java@v5
+      with:
+        distribution: temurin
+        java-version: '17'
+
+    - name: Install Node.js
+      uses: actions/setup-node@v6
+      with:
+        node-version: 'lts/*'
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 4.0
+
+    - name: Install appium
+      run: |
+        npm install -g appium
+        npm install -g mjpeg-consumer
+
+    - name: Start appium
+      run: |
+        appium driver install uiautomator2
+        appium plugin install images
+        appium plugin install execute-driver
+        nohup appium --use-plugins=images,execute-driver --relaxed-security --log-timestamp --log-no-colors > appium.log &
+
+    - name: Enable KVM group perms
+      run: |
+        echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
+        sudo udevadm control --reload-rules
+        sudo udevadm trigger --name-match=kvm
+
+    - name: AVD cache
+      uses: actions/cache@v5
+      id: avd-cache
+      with:
+        path: |
+          ~/.android/avd/*
+          ~/.android/adb*
+        key: avd-${{ env.API_LEVEL }}
+
+    - name: Create AVD snapshot for cache
+      if: steps.avd-cache.outputs.cache-hit != 'true'
+      uses: reactivecircus/android-emulator-runner@v2
+      with:
+        api-level: ${{ env.API_LEVEL }}
+        arch: ${{ env.ARCH }}
+        target: google_apis
+        force-avd-creation: false
+        emulator-options: -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
+        disable-animations: false
+        script: echo "Generated AVD snapshot for caching."
+
+    - name: run tests
+      uses: reactivecircus/android-emulator-runner@v2
+      with:
+        api-level: ${{ env.API_LEVEL }}
+        arch: ${{ env.ARCH }}
+        script: cd android_tests;bundle install;bundle exec rake --tasks;bundle exec rake android
+        target: google_apis
+        profile: Nexus 5X
+        disable-spellchecker: true
+        disable-animations: true
+
+    - name: Save server output
+      if: ${{ always() }}
+      uses: actions/upload-artifact@master
+      with:
+        name: appium-android_test_with_other_deps.log
+        path: |
+          appium.log
+          test/report/

data/.github/workflows/pr-title.yml

@@ -0,0 +1,10 @@
+name: Conventional Commits
+on:
+  pull_request:
+    types: [opened, edited, synchronize, reopened]
+
+jobs:
+  lint:
+    uses: appium/appium-workflows/.github/workflows/pr-title.yml@main
+    with:
+      config-preset: angular

data/CHANGELOG.md

@@ -3,6 +3,9 @@ Commit based release not is [release_notes.md](./release_notes.md)
 
 Release tags are https://github.com/appium/ruby_lib/releases .
 
+## [16.2.0] - 2026-04-19
+- Define device methods (`lock`, `unlock`, `hide_keyboard`, `push_file`, `pull_file`, `background_app`, `shake`, etc.) natively on `Appium::Driver` via `def_delegators :driver`, replacing the implicit delegation previously set up by `extend ::Appium::Core::Device`. Paves the way for `ruby_lib_core` to drop its static compatibility list (appium/ruby_lib_core#97).
+
 ## 16.1.1 - 2025-12-28
 - Add deprecated mark for start_logs_broadcast/stop_logs_broadcast to use BiDi instead
 

data/Gemfile

@@ -16,11 +16,10 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'appium_thor', '~> 2.0'
-gem 'fakefs', '~> 3.0.0'
 gem 'hashdiff', '~> 1.2.0'
 gem 'minitest', '~> 5.0'
 gem 'minitest-reporters', '~> 1.1'
 gem 'pry'
 gem 'rake', '~> 13.0'
-gem 'rubocop', '1.82.0'
+gem 'rubocop', '1.86.1'
 gem 'yard', '~> 0.9.11'

data/appium_lib.gemspec

@@ -13,8 +13,7 @@ Gem::Specification.new do |s|
   s.homepage      = 'https://github.com/appium/ruby_lib' # published as appium_lib
   s.require_paths = ['lib']
 
-  # TODO: We must remove start_logs_broadcast/stop_logs_broadcast to bump the appium_lib_core version to v12+.
-  s.add_dependency 'appium_lib_core', '>= 9.2.1', '< 12.0'
+  s.add_dependency 'appium_lib_core', '>= 9.2.1', '< 13.0'
   s.add_dependency 'nokogiri', '~> 1.8', '>= 1.8.1'
   s.add_dependency 'tomlrb', '>= 1.1', '< 3.0'
 

data/lib/appium_lib/android/common/command/command.rb

@@ -30,37 +30,6 @@ module Appium
         # --relaxed-security
         @driver.execute_script 'mobile: shell', args
       end
-
-      # @deprecated Please use BiDi implementation via `$driver.driver.bidi` directly instead.
-      #
-      # Starts Android logcat broadcast websocket
-      #
-      # @param [String] logcat_file A file path to write messages from a logcat WebSocket client
-      #
-      # @example
-      #
-      #   start_logs_broadcast 'outputfile.log' #=> #<Appium::Android::Command::WsLogcat:...>
-      #
-      def start_logs_broadcast(logcat_file = 'logcat.log')
-        @driver.execute_script 'mobile: startLogsBroadcast'
-
-        socket_url = "ws://#{URI.parse(server_url).host}:#{@core.port}/ws/session/#{@driver.session_id}/appium/device/logcat"
-        @logcat_client = ::Appium::Common::Command::WsLogcat.new(url: socket_url, output_file: logcat_file)
-      end
-
-      # @deprecated Please use BiDi implementation directly instead.
-      #
-      # Stop Android logcat broadcast websocket
-      #
-      # @example
-      #
-      #   stop_logs_broadcast #=> nil
-      #
-      def stop_logs_broadcast
-        @logcat_client.close
-
-        @driver.execute_script 'mobile: stopLogsBroadcast'
-      end
     end
   end
 end

data/lib/appium_lib/common/command.rb

@@ -12,8 +12,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative 'command/ws_logcat'
-
 module Appium
   module Common
     module Command

data/lib/appium_lib/driver.rb

@@ -40,6 +40,33 @@ require 'uri'
 
 module Appium
   class Driver
+    extend Forwardable
+
+    # Methods forwarded to the underlying Appium::Core::Base::Driver instance
+    # (exposed via `#driver`). Previously these were wired up implicitly by
+    # `extend ::Appium::Core::Device` through a static compatibility list in
+    # `ruby_lib_core` (see appium/ruby_lib_core#97). Defining them here lets
+    # `ruby_lib_core` eventually drop that list.
+    CORE_BRIDGE_METHODS = %i[
+      take_element_screenshot save_viewport_screenshot
+      lock device_locked? unlock
+      hide_keyboard is_keyboard_shown
+      ime_activate ime_available_engines ime_active_engine ime_activated ime_deactivate
+      get_settings update_settings
+      within_context current_context available_contexts set_context
+      push_file pull_file pull_folder
+      keyevent press_keycode long_press_keycode
+      match_images_features find_image_occurrence get_images_similarity compare_images
+      app_strings background_app
+      install_app remove_app app_installed? activate_app terminate_app
+      app_state
+      stop_recording_screen stop_and_save_recording_screen
+      shake device_time
+      execute_cdp
+    ].freeze
+
+    def_delegators :driver, *CORE_BRIDGE_METHODS
+
     # @private
     class << self
       def convert_to_symbol(value)

data/lib/appium_lib/ios/xcuitest/bridge.rb

@@ -27,7 +27,6 @@ module Appium
           target.extend Appium::Ios::Xcuitest::Gesture
           target.extend Appium::Ios::Xcuitest::MultiAppHandler
           target.extend Appium::Ios::Xcuitest::Element
-          target.extend Appium::Ios::Xcuitest::Command
           target.extend Appium::Ios::Xcuitest::GetContext
         end
       end

data/lib/appium_lib/ios/xcuitest/command.rb

@@ -17,42 +17,3 @@ require_relative 'command/gestures'
 require_relative 'command/source'
 require_relative 'command/multi_app_handler'
 require_relative 'command/get_context'
-
-module Appium
-  module Ios
-    module Xcuitest
-      module Command
-        # @deprecated Please use BiDi implementation via `$driver.driver.bidi` directly instead.
-        #
-        # Starts iOS syslog broadcast websocket
-        #
-        # @param [String] syslog_file A file path to write messages from a syslog WebSocket client
-        #
-        # @example
-        #
-        #   start_logs_broadcast 'outputfile.log' #=> #<Appium::Android::Command::WsLogcat:...>
-        #
-        def start_logs_broadcast(syslog_file = 'syslog.log')
-          @driver.execute_script 'mobile: startLogsBroadcast'
-
-          socket_url = "ws://#{URI.parse(server_url).host}:#{@core.port}/ws/session/#{@driver.session_id}/appium/device/syslog"
-          @logcat_client = ::Appium::Common::Command::WsLogcat.new(url: socket_url, output_file: syslog_file)
-        end
-
-        # @deprecated Please use BiDi implementation directly instead.
-        #
-        # Stop iOS syslog broadcast websocket
-        #
-        # @example
-        #
-        #   stop_logs_broadcast #=> nil
-        #
-        def stop_logs_broadcast
-          @logcat_client.close
-
-          @driver.execute_script 'mobile: stopLogsBroadcast'
-        end
-      end
-    end
-  end
-end

data/lib/appium_lib/version.rb

@@ -14,6 +14,6 @@
 
 module Appium
   # Version and Date are defined on the 'Appium' module, not 'Appium::Common'
-  VERSION = '16.1.1' unless defined? ::Appium::VERSION
-  DATE    = '2025-12-28' unless defined? ::Appium::DATE
+  VERSION = '16.2.0' unless defined? ::Appium::VERSION
+  DATE    = '2026-04-19' unless defined? ::Appium::DATE
 end

data/release_notes.md

@@ -1,3 +1,22 @@
+#### v16.2.0 2026-04-19
+
+- [939a204](https://github.com/appium/ruby_lib/commit/939a20461738c80f9a19bb9ee8fe41030ab6c91e) Release 16.2.0
+- [324b646](https://github.com/appium/ruby_lib/commit/324b646adcf182b92cad66bd53ec8f7b1892b34f) feat: define device methods natively on Appium::Driver (#1109)
+- [5e60d97](https://github.com/appium/ruby_lib/commit/5e60d973ca74fe25af3b58ad7dcf9ce46d209b08) chore: Update rubocop requirement from 1.86.0 to 1.86.1 (#1108)
+- [76a85fd](https://github.com/appium/ruby_lib/commit/76a85fde1c05b5a479179d07e062a2ca9b18d48d) chore: Bump actions/cache from 4 to 5 (#1107)
+- [555767c](https://github.com/appium/ruby_lib/commit/555767cf885f49705cfeea8be4688f7bddb08cd7) ci: add android (#1106)
+- [59a27af](https://github.com/appium/ruby_lib/commit/59a27af6c3c2bbfd37664e59d2a9e3322250199c) feat: drop deprecated start_logs_broadcast/stop_logs_broadcast methods (#1105)
+- [4bd31dc](https://github.com/appium/ruby_lib/commit/4bd31dc1b15de6dccb80a5eb2f70e5c592af7293) chore: Update rubocop requirement from 1.85.1 to 1.86.0 (#1104)
+- [070e4e3](https://github.com/appium/ruby_lib/commit/070e4e34294e1d2a6bf57519493e4f47d96a7fae) chore: Update rubocop requirement from 1.85.0 to 1.85.1 (#1103)
+- [e624cea](https://github.com/appium/ruby_lib/commit/e624cea7ab88fd543f77d63517eb0fc4b3d138fe) chore: Bump futureware-tech/simulator-action from 4 to 5 (#1102)
+- [6192589](https://github.com/appium/ruby_lib/commit/6192589e4379e4405d6dbf0c99fb583544be996c) chore: Update rubocop requirement from 1.84.2 to 1.85.0 (#1101)
+- [211cb0b](https://github.com/appium/ruby_lib/commit/211cb0bfb746b51db6f24d27a7d1ae8153fc6937) chore: Update rubocop requirement from 1.84.1 to 1.84.2 (#1100)
+- [56e092d](https://github.com/appium/ruby_lib/commit/56e092de3ff7c4c29a2cf9f63672563f60f5457f) chore: Update rubocop requirement from 1.84.0 to 1.84.1 (#1099)
+- [858cacb](https://github.com/appium/ruby_lib/commit/858cacb2675dcfd7935bee7c8fc9dbfd6eae60c1) chore: Update rubocop requirement from 1.82.1 to 1.84.0 (#1098)
+- [0451b50](https://github.com/appium/ruby_lib/commit/0451b50e15723b649d92f4f1476d5b575ed92482) ci: add pr title check
+- [d5a27a8](https://github.com/appium/ruby_lib/commit/d5a27a8de9fcca37accd851686c6a8a90a40b374) chore: Update rubocop requirement from 1.82.0 to 1.82.1 (#1097)
+
+
 #### v16.1.1 2025-12-28
 
 - [2efaf09](https://github.com/appium/ruby_lib/commit/2efaf0937dfaf3759d370607fdea05c890df634a) Release 16.1.1

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib
 version: !ruby/object:Gem::Version
-  version: 16.1.1
+  version: 16.2.0
 platform: ruby
 authors:
 - code@bootstraponline.com
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-28 00:00:00.000000000 Z
+date: 2026-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: appium_lib_core
@@ -20,7 +20,7 @@ dependencies:
         version: 9.2.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -30,7 +30,7 @@ dependencies:
         version: 9.2.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -84,6 +84,7 @@ files:
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/dependabot.yml"
 - ".github/workflows/functional-test.yml"
+- ".github/workflows/pr-title.yml"
 - ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".rubocop.yml"
@@ -121,7 +122,6 @@ files:
 - lib/appium_lib/android/uiautomator2/helper.rb
 - lib/appium_lib/appium.rb
 - lib/appium_lib/common/command.rb
-- lib/appium_lib/common/command/ws_logcat.rb
 - lib/appium_lib/common/device.rb
 - lib/appium_lib/common/helper.rb
 - lib/appium_lib/common/http_client.rb

data/lib/appium_lib/common/command/ws_logcat.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-module Appium
-  module Common
-    module Command
-      # TODO: Remove this implementation after dropping start_logs_broadcast
-      class WsLogcat < ::Appium::Core::WebSocket
-        def initialize(url:, output_file: 'logcat.log')
-          super(url: url)
-          @output_file = output_file
-        end
-
-        def handle_message_data(data)
-          File.open(@output_file, 'a') { |f| f.write("#{data}\n") }
-        end
-      end
-    end
-  end
-end