appium_lib_core 4.1.0 → 9.1.1

data/lib/appium_lib_core/common/command/common.rb

@@ -1,110 +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 Core
-    # ref: https://github.com/appium/appium-base-driver/blob/master/lib/mjsonwp/routes.js
-    module Commands
-      # Some commands differ for each driver.
-      COMMAND = {
-        # common
-        get_all_sessions:           [:get,  'sessions'],
-        available_contexts:         [:get,  'session/:session_id/contexts'],
-        set_context:                [:post, 'session/:session_id/context'],
-        current_context:            [:get,  'session/:session_id/context'],
-
-        touch_actions:              [:post, 'session/:session_id/touch/perform'],
-        multi_touch:                [:post, 'session/:session_id/touch/multi/perform'],
-
-        set_immediate_value:        [:post, 'session/:session_id/appium/element/:id/value'],
-        replace_value:              [:post, 'session/:session_id/appium/element/:id/replace_value'],
-
-        launch_app:                 [:post, 'session/:session_id/appium/app/launch'],
-        close_app:                  [:post, 'session/:session_id/appium/app/close'],
-        reset:                      [:post, 'session/:session_id/appium/app/reset'],
-        background_app:             [:post, 'session/:session_id/appium/app/background'],
-        app_strings:                [:post, 'session/:session_id/appium/app/strings'],
-
-        device_locked?:             [:post, 'session/:session_id/appium/device/is_locked'],
-        unlock:                     [:post, 'session/:session_id/appium/device/unlock'],
-        lock:                       [:post, 'session/:session_id/appium/device/lock'],
-        device_time:                [:get,  'session/:session_id/appium/device/system_time'],
-        install_app:                [:post, 'session/:session_id/appium/device/install_app'],
-        remove_app:                 [:post, 'session/:session_id/appium/device/remove_app'],
-        app_installed?:             [:post, 'session/:session_id/appium/device/app_installed'],
-        activate_app:               [:post, 'session/:session_id/appium/device/activate_app'],
-        terminate_app:              [:post, 'session/:session_id/appium/device/terminate_app'],
-        app_state:                  [:post, 'session/:session_id/appium/device/app_state'],
-        shake:                      [:post, 'session/:session_id/appium/device/shake'],
-        hide_keyboard:              [:post, 'session/:session_id/appium/device/hide_keyboard'],
-        press_keycode:              [:post, 'session/:session_id/appium/device/press_keycode'],
-        long_press_keycode:         [:post, 'session/:session_id/appium/device/long_press_keycode'],
-        # keyevent is only for Selendroid
-        keyevent:                   [:post, 'session/:session_id/appium/device/keyevent'],
-        push_file:                  [:post, 'session/:session_id/appium/device/push_file'],
-        pull_file:                  [:post, 'session/:session_id/appium/device/pull_file'],
-        pull_folder:                [:post, 'session/:session_id/appium/device/pull_folder'],
-        get_clipboard:              [:post, 'session/:session_id/appium/device/get_clipboard'],
-        set_clipboard:              [:post, 'session/:session_id/appium/device/set_clipboard'],
-        finger_print:               [:post, 'session/:session_id/appium/device/finger_print'],
-        get_settings:               [:get,  'session/:session_id/appium/settings'],
-        update_settings:            [:post, 'session/:session_id/appium/settings'],
-        stop_recording_screen:      [:post, 'session/:session_id/appium/stop_recording_screen'],
-        start_recording_screen:     [:post, 'session/:session_id/appium/start_recording_screen'],
-        compare_images:             [:post, 'session/:session_id/appium/compare_images'],
-        is_keyboard_shown:          [:get,  'session/:session_id/appium/device/is_keyboard_shown'],
-        execute_driver:             [:post, 'session/:session_id/appium/execute_driver'],
-        post_log_event:             [:post, 'session/:session_id/appium/log_event'],
-        get_log_events:             [:post, 'session/:session_id/appium/events']
-      }.freeze
-
-      COMMAND_ANDROID = {
-        open_notifications:         [:post, 'session/:session_id/appium/device/open_notifications'],
-        toggle_airplane_mode:       [:post, 'session/:session_id/appium/device/toggle_airplane_mode'],
-        start_activity:             [:post, 'session/:session_id/appium/device/start_activity'],
-        current_activity:           [:get,  'session/:session_id/appium/device/current_activity'],
-        current_package:            [:get,  'session/:session_id/appium/device/current_package'],
-        get_system_bars:            [:get,  'session/:session_id/appium/device/system_bars'],
-        get_display_density:        [:get,  'session/:session_id/appium/device/display_density'],
-        toggle_wifi:                [:post, 'session/:session_id/appium/device/toggle_wifi'],
-        toggle_data:                [:post, 'session/:session_id/appium/device/toggle_data'],
-        toggle_location_services:   [:post, 'session/:session_id/appium/device/toggle_location_services'],
-        end_coverage:               [:post, 'session/:session_id/appium/app/end_test_coverage'],
-        get_performance_data_types: [:post, 'session/:session_id/appium/performanceData/types'],
-        get_performance_data:       [:post, 'session/:session_id/appium/getPerformanceData'],
-        get_network_connection:     [:get,  'session/:session_id/network_connection'], # defined also in OSS
-        set_network_connection:     [:post, 'session/:session_id/network_connection'], # defined also in OSS
-
-        # only emulator
-        send_sms:                   [:post, 'session/:session_id/appium/device/send_sms'],
-        gsm_call:                   [:post, 'session/:session_id/appium/device/gsm_call'],
-        gsm_signal:                 [:post, 'session/:session_id/appium/device/gsm_signal'],
-        gsm_voice:                  [:post, 'session/:session_id/appium/device/gsm_voice'],
-        set_network_speed:          [:post, 'session/:session_id/appium/device/network_speed'],
-        set_power_capacity:         [:post, 'session/:session_id/appium/device/power_capacity'],
-        set_power_ac:               [:post, 'session/:session_id/appium/device/power_ac'],
-
-        # For chromium: https://chromium.googlesource.com/chromium/src/+/master/chrome/test/chromedriver/server/http_handler.cc
-        chrome_send_command:        [:post, 'session/:session_id/goog/cdp/execute']
-      }.freeze
-
-      COMMAND_IOS = {
-        touch_id:                   [:post, 'session/:session_id/appium/simulator/touch_id'],
-        toggle_touch_id_enrollment: [:post, 'session/:session_id/appium/simulator/toggle_touch_id_enrollment']
-      }.freeze
-
-      COMMANDS = {}.merge(COMMAND).merge(COMMAND_ANDROID).merge(COMMAND_IOS).freeze
-    end # module Commands
-  end # module Core
-end # module Appium

data/lib/appium_lib_core/common/command/w3c.rb

@@ -1,56 +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 Core
-    module Commands
-      module W3C
-        COMMANDS = ::Appium::Core::Commands::COMMANDS.merge(::Appium::Core::Base::Commands::W3C).merge(
-          {
-            # ::Appium::Core::Base::Commands::OSS has the following commands and Appium also use them.
-            # Delegated to ::Appium::Core::Base::Commands::OSS commands
-            status:                    [:get, 'status'], # https://w3c.github.io/webdriver/#dfn-status
-            is_element_displayed:      [:get, 'session/:session_id/element/:id/displayed'], # hint: https://w3c.github.io/webdriver/#element-displayedness
-
-            get_timeouts:              [:get, 'session/:session_id/timeouts'], # https://w3c.github.io/webdriver/#get-timeouts
-
-            # Add OSS commands to W3C commands. We can remove them if we would like to remove them from W3C module.
-            ### Session capability
-            get_capabilities:          [:get, 'session/:session_id'],
-
-            ### rotatable
-            get_screen_orientation:    [:get, 'session/:session_id/orientation'],
-            set_screen_orientation:    [:post, 'session/:session_id/orientation'],
-
-            get_location:              [:get, 'session/:session_id/location'],
-            set_location:              [:post, 'session/:session_id/location'],
-
-            ### For IME
-            ime_get_available_engines: [:get,  'session/:session_id/ime/available_engines'],
-            ime_get_active_engine:     [:get,  'session/:session_id/ime/active_engine'],
-            ime_is_activated:          [:get,  'session/:session_id/ime/activated'],
-            ime_deactivate:            [:post, 'session/:session_id/ime/deactivate'],
-            ime_activate_engine:       [:post, 'session/:session_id/ime/activate'],
-
-            send_keys_to_active_element: [:post, 'session/:session_id/keys'],
-
-            ### Logs
-            get_available_log_types:   [:get, 'session/:session_id/log/types'],
-            get_log:                   [:post, 'session/:session_id/log']
-          }
-        ).freeze
-      end # module W3C
-    end # module Commands
-  end # module Core
-end # module Appium

data/lib/appium_lib_core/common/device/value.rb

@@ -1,52 +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 Core
-    class Base
-      module Device
-        module Value
-          def set_immediate_value(element, *value)
-            execute :set_immediate_value, { id: element.ref }, generate_value_and_text(value)
-          end
-
-          def replace_value(element, *value)
-            execute :replace_value, { id: element.ref }, generate_value_and_text(value)
-          end
-
-          private
-
-          def generate_value_and_text(*value)
-            keys = ::Selenium::WebDriver::Keys.encode(*value)
-
-            if @file_detector
-              local_files = keys.first.split("\n").map { |key| @file_detector.call(Array(key)) }.compact
-              if local_files.any?
-                keys = local_files.map { |local_file| upload(local_file) }
-                keys = Array(keys.join("\n"))
-              end
-            end
-
-            # Keep .split(//) for backward compatibility for now
-            text = keys.join('')
-
-            # FIXME: further work for W3C. Over appium 1.15.0 or later
-            # { value: text.split(//), text: text }
-            { value: text.split(//) }
-          end
-        end # module Value
-      end # module Device
-    end # class Base
-  end # module Core
-end # module Appium

data/lib/appium_lib_core/common/touch_action/multi_touch.rb

@@ -1,56 +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 Core
-    # MultiTouch actions allow for multiple touches to happen at the same time,
-    # for instance, to simulate multiple finger swipes.
-    #
-    # Create a series of touch actions by themselves (without a +prepare()+), then
-    # add to a new MultiTouch action.  When ready, call +prepare()+ and all
-    # actions will be executed simultaneously.
-    #
-    # @example
-    #
-    #   @driver = Appium::Core.for(opts).start_driver
-    #   action_1 = Appium::Core::TouchAction.new(@driver).press(x: 45, y: 100).wait(600).release
-    #   action_2 = Appium::Core::TouchAction.new(@driver).tap(element: el, x: 50, y:5, count: 3)
-    #
-    #   multi_touch_action = MultiTouch.new(@driver)
-    #   multi_touch_action.add action_1
-    #   multi_touch_action.add action_2
-    #   multi_touch_action.perform
-    #
-    class MultiTouch
-      attr_reader :driver
-
-      def initialize(driver)
-        @actions = []
-        @driver = driver
-      end
-
-      # Add a touch_action to be performed
-      # @param chain (TouchAction) The action to add to the chain
-      def add(chain)
-        @actions << chain.actions
-      end
-
-      # Ask Appium to perform the actions
-      def perform
-        @driver.multi_touch @actions
-        @actions.clear
-      end
-    end # class MultiTouch
-  end # module Core
-end # module Appium

data/lib/appium_lib_core/common/touch_action/touch_actions.rb

@@ -1,203 +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 Core
-    # Perform a series of gestures, one after another.  Gestures are chained
-    # together and only performed when +perform()+ is called. Default is conducted by global driver.
-    #
-    # Each method returns the object itself, so calls can be chained.
-    #
-    # Consider to use W3C spec touch action like the followings.
-    # https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/W3CActionBuilder.html
-    # https://github.com/appium/ruby_lib_core/blob/master/test/functional/android/webdriver/w3c_actions_test.rb
-    # https://github.com/appium/ruby_lib_core/blob/master/test/functional/ios/webdriver/w3c_actions_test.rb
-    #
-    # @example
-    #
-    #   @driver = Appium::Core.for(opts).start_driver
-    #   action = Appium::Core::TouchAction.new(@driver).press(x: 45, y: 100).wait(600).release
-    #   action.perform
-    #   action = Appium::Core::TouchAction.new(@driver).swipe(....)
-    #   action.perform
-    #
-    class TouchAction
-      ACTIONS = %i(move_to long_press double_tap two_finger_tap press release tap wait perform).freeze
-      COMPLEX_ACTIONS = %i(swipe).freeze
-
-      attr_reader :actions, :driver
-
-      def initialize(driver)
-        @actions = []
-        @driver = driver
-      end
-
-      # Move to the given co-ordinates.
-      #
-      # +move_to+'s +x+ and +y+ have two case. One is working as coordinate, the other is working as offset.
-      #
-      # @param opts [Hash] Options
-      # @option opts [integer] :x x co-ordinate to move to if element isn't set. Works as an absolute if x is set with Element.
-      # @option opts [integer] :y y co-ordinate to move to if element isn't set. Works as an absolute if y is set with Element.
-      # @option opts [WebDriver::Element] Element to scope this move within.
-      def move_to(opts)
-        opts = args_with_ele_ref(opts)
-        chain_method(:moveTo, opts)
-      end
-
-      # Press down for a specific duration.
-      # Alternatively, you can use +press(...).wait(...).release()+ instead of +long_press+ if duration doesn't work well.
-      # https://github.com/appium/ruby_lib/issues/231#issuecomment-269895512
-      # e.g. Appium::Core::TouchAction.new.press(x: 280, y: 530).wait(2000).release.perform
-      #
-      # @param opts [Hash] Options
-      # @option opts [WebDriver::Element] element the element to press.
-      # @option opts [integer] x X co-ordinate to press on.
-      # @option opts [integer] y Y co-ordinate to press on.
-      # @option opts [integer] duration Number of milliseconds to press.
-      def long_press(opts)
-        args = opts.select { |k, _v| %i(element x y duration).include? k }
-        args = args_with_ele_ref(args)
-        chain_method(:longPress, args) # longPress is what the appium server expects
-      end
-
-      # Press a finger onto the screen.  Finger will stay down until you call +release+.
-      #
-      # @param opts [Hash] Options
-      # @option opts [WebDriver::Element] :element (Optional) Element to press within.
-      # @option opts [integer] :x x co-ordinate to press on
-      # @option opts [integer] :y y co-ordinate to press on
-      # @option opts [Float] pressure (iOS Only) press as force touch.
-      #                                          See the description of +force+ property on Apple's UITouch class
-      #                                          (https://developer.apple.com/documentation/uikit/uitouch?language=objc)
-      #                                          for more details on possible value ranges.
-      def press(opts)
-        args = opts.select { |k, _v| %i(element x y).include? k }
-        args = args_with_ele_ref(args)
-        args[:pressure] = opts.delete(:pressure) unless opts[:pressure].nil?
-        chain_method(:press, args)
-      end
-
-      # Remove a finger from the screen.
-      #
-      # @param opts [Hash] Options
-      # @option opts [WebDriver::Element] :element (Optional) Element to release from.
-      # @option opts [integer] :x x co-ordinate to release from
-      # @option opts [integer] :y y co-ordinate to release from
-      def release(opts = nil)
-        args = args_with_ele_ref(opts) if opts
-        chain_method(:release, args)
-      end
-
-      # Touch a point on the screen.
-      # Alternatively, you can use +press(...).release.perform+ instead of +tap(...).perform+.
-      #
-      # @param opts [Hash] Options
-      # @option opts [WebDriver::Element] :element (Optional) Element to restrict scope too.
-      # @option opts [integer] :x x co-ordinate to tap
-      # @option opts [integer] :y y co-ordinate to tap
-      # @option opts [integer] :fingers how many fingers to tap with (Default 1)
-      def tap(opts)
-        opts[:count] = opts.delete(:fingers) if opts[:fingers]
-        opts[:count] ||= 1
-        args = args_with_ele_ref opts
-        chain_method(:tap, args)
-      end
-
-      # Double tap an element on the screen
-      #
-      # @param opts [Hash] Options
-      # @option opts [WebDriver::Element] :element (Optional) Element to restrict scope too.
-      # @option opts [integer] :x x co-ordinate to tap
-      # @option opts [integer] :y y co-ordinate to tap
-
-      def double_tap(opts)
-        args = opts.select { |k, _v| %i(element x y).include? k }
-        args = args_with_ele_ref(args)
-        chain_method(:doubleTap, args) # doubleTap is what the appium server expects
-      end
-
-      # Two finger tap an element on the screen
-      #
-      # @param opts [Hash] Options
-      # @option opts [WebDriver::Element] :element (Optional) Element to restrict scope too.
-      # @option opts [integer] :x x co-ordinate to tap
-      # @option opts [integer] :y y co-ordinate to tap
-      def two_finger_tap(opts)
-        args = opts.select { |k, _v| %i(element x y).include? k }
-        args = args_with_ele_ref(args)
-        chain_method(:twoFingerTap, args) # twoFingerTap is what the appium server expects
-      end
-
-      # Pause for a number of milliseconds before the next action
-      # @param milliseconds [integer] Number of milliseconds to pause for
-      def wait(milliseconds)
-        args = { ms: milliseconds }
-        chain_method(:wait, args)
-      end
-
-      # Convenience method to perform a swipe.
-      #
-      # @param opts [Hash] Options
-      # @option opts [int] :start_x Where to start swiping, on the x axis.  Default 0.
-      # @option opts [int] :start_y Where to start swiping, on the y axis.  Default 0.
-      # @option opts [int] :end_x Move to the end, on the x axis.  Default 0.
-      # @option opts [int] :end_y Move to the end, on the y axis.  Default 0.
-      # @option opts [int] :duration How long the actual swipe takes to complete in milliseconds. Default 200.
-      def swipe(opts)
-        start_x = opts.fetch :start_x, 0
-        start_y = opts.fetch :start_y, 0
-        end_x   = opts.fetch :end_x, 0
-        end_y   = opts.fetch :end_y, 0
-
-        duration = opts.fetch :duration, 200
-
-        press x: start_x, y: start_y
-        wait(duration) if duration
-        move_to x: end_x, y: end_y
-
-        release
-
-        self
-      end
-
-      # Ask the driver to perform all actions in this action chain.
-      def perform
-        @driver.touch_actions @actions
-        @actions.clear
-        self
-      end
-
-      # Does nothing, currently.
-      def cancel
-        @actions << { action: cancel }
-        @driver.touch_actions @actions
-        self
-      end
-
-      private
-
-      def chain_method(method, args = nil)
-        action = args ? { action: method, options: args } : { action: method }
-        @actions << action
-        self
-      end
-
-      def args_with_ele_ref(args)
-        args[:element] = args[:element].ref if args.key? :element
-        args
-      end
-    end # class TouchAction
-  end # module Core
-end # module Appium

data/lib/appium_lib_core/ios/uiautomation/device.rb

@@ -1,44 +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 Core
-    module Ios
-      module Uiautomation
-        module Device
-          def self.add_methods
-            # UiAutomation, Override included method in bridge
-            ::Appium::Core::Device.add_endpoint_method(:hide_keyboard) do
-              def hide_keyboard(close_key = nil, strategy = nil)
-                option = {}
-
-                option[:key] = close_key || 'Done'        # default to Done key.
-                option[:strategy] = strategy || :pressKey # default to pressKey
-
-                execute :hide_keyboard, {}, option
-              end
-            end
-
-            # UiAutomation, Override included method in bridge
-            ::Appium::Core::Device.add_endpoint_method(:background_app) do
-              def background_app(duration = 0)
-                execute :background_app, {}, seconds: duration
-              end
-            end
-          end
-        end # module Device
-      end # module Uiautomation
-    end # module Ios
-  end # module Core
-end # module Appium

data/lib/appium_lib_core/ios/uiautomation/patch.rb

@@ -1,34 +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 Core
-    module Ios
-      module Uiautomation
-        # @private
-        # class_eval inside a method because class Selenium::WebDriver::Element
-        # will trigger as soon as the file is required. in contrast a method
-        # will trigger only when invoked.
-        def self.patch_webdriver_element
-          ::Selenium::WebDriver::Element.class_eval do
-            # Cross platform way of entering text into a textfield
-            def type(text, driver)
-              driver.execute_script %(au.getElement('#{ref}').setValue('#{text}');)
-            end # def type
-          end # Selenium::WebDriver::Element.class_eval
-        end # def patch_webdriver_element
-      end # module Uiautomation
-    end # module Ios
-  end # module Core
-end # module Appium