appium_lib_core 4.3.1 → 5.0.0.beta2

data/lib/appium_lib_core/common/base/bridge/w3c.rb

@@ -1,253 +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
-      class Bridge
-        class W3C < ::Selenium::WebDriver::Remote::W3C::Bridge
-          include Device::DeviceLock
-          include Device::Keyboard
-          include Device::ImeActions
-          include Device::Setting
-          include Device::Context
-          include Device::Value
-          include Device::FileManagement
-          include Device::KeyEvent
-          include Device::ImageComparison
-          include Device::AppManagement
-          include Device::AppState
-          include Device::ScreenRecord::Command
-          include Device::Device
-          include Device::TouchActions
-          include Device::ExecuteDriver
-          include Device::Orientation
-
-          def commands(command)
-            ::Appium::Core::Commands::W3C::COMMANDS[command]
-          end
-
-          # Returns all available sessions on the Appium server instance
-          def sessions
-            execute :get_all_sessions
-          end
-
-          # Perform touch actions for W3C module.
-          # Generate +touch+ pointer action here and users can use this via +driver.action+
-          # - https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/W3CActionBuilder.html
-          # - https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/PointerActions.html
-          # - https://seleniumhq.github.io/selenium/docs/api/rb/Selenium/WebDriver/KeyActions.html
-          #
-          # 'mouse' action is by default in the Ruby client. Appium server force the +mouse+ action to +touch+ once in
-          # the server side. So we don't consider the case.
-          #
-          # @example
-          #
-          #     element = @driver.find_element(:id, "some id")
-          #     @driver.action.click(element).perform # The 'click' is a part of 'PointerActions'
-          #
-          def action(async = false)
-            # Used for default duration of each touch actions
-            # Override from 250 milliseconds to 50 milliseconds
-            action_builder = super
-            action_builder.default_move_duration = 0.05
-            action_builder
-          end
-
-          # Port from MJSONWP
-          def get_timeouts
-            execute :get_timeouts
-          end
-
-          # Port from MJSONWP
-          def session_capabilities
-            ::Selenium::WebDriver::Remote::W3C::Capabilities.json_create execute(:get_capabilities)
-          end
-
-          # Port from MJSONWP
-          def send_keys_to_active_element(key)
-            text = ::Selenium::WebDriver::Keys.encode(key).join('')
-            execute :send_keys_to_active_element, {}, { value: text.split(//) }
-          end
-
-          # For Appium
-          # override
-          def page_source
-            # For W3C
-            # execute_script('var source = document.documentElement.outerHTML;' \
-            # 'if (!source) { source = new XMLSerializer().serializeToString(document); }' \
-            # 'return source;')
-            execute :get_page_source
-          end
-
-          # For Appium
-          # override
-          def element_displayed?(element)
-            # For W3C
-            # https://github.com/SeleniumHQ/selenium/commit/b618499adcc3a9f667590652c5757c0caa703289
-            # execute_atom :isDisplayed, element
-            execute :is_element_displayed, id: element.ref
-          end
-
-          # For Appium
-          # override
-          def element_attribute(element, name)
-            # For W3C in Selenium Client
-            # execute_atom :getAttribute, element, name
-            execute :get_element_attribute, id: element.ref, name: name
-          end
-
-          # For Appium
-          # override
-          def find_element_by(how, what, parent = nil)
-            how, what = convert_locators(how, what)
-
-            id = if parent
-                   execute :find_child_element, { id: parent }, { using: how, value: what }
-                 else
-                   execute :find_element, {}, { using: how, value: what }
-                 end
-            ::Selenium::WebDriver::Element.new self, element_id_from(id)
-          end
-
-          # For Appium
-          # override
-          def find_elements_by(how, what, parent = nil)
-            how, what = convert_locators(how, what)
-
-            ids = if parent
-                    execute :find_child_elements, { id: parent }, { using: how, value: what }
-                  else
-                    execute :find_elements, {}, { using: how, value: what }
-                  end
-
-            ids.map { |id| ::Selenium::WebDriver::Element.new self, element_id_from(id) }
-          end
-
-          # For Appium
-          # @param [Hash] id The id which can get as a response from server
-          # @return [::Selenium::WebDriver::Element]
-          def convert_to_element(id)
-            ::Selenium::WebDriver::Element.new self, element_id_from(id)
-          end
-
-          # For Appium
-          # override
-          # called in 'extend DriverExtensions::HasNetworkConnection'
-          def network_connection
-            execute :get_network_connection
-          end
-
-          # For Appium
-          # override
-          # called in 'extend DriverExtensions::HasNetworkConnection'
-          def network_connection=(type)
-            execute :set_network_connection, {}, { parameters: { type: type } }
-          end
-
-          # For Appium
-          # No implementation for W3C webdriver module
-          # called in 'extend DriverExtensions::HasLocation'
-          def location
-            obj = execute(:get_location) || {}
-            ::Selenium::WebDriver::Location.new obj['latitude'], obj['longitude'], obj['altitude']
-          end
-
-          # For Appium
-          # No implementation for W3C webdriver module
-          # called in +extend DriverExtensions::HasLocation+
-          # It has below code as well. We should consider the same context in Selenium 4 as backward compatibility.
-          #
-          #     def location=(loc)
-          #       # note: Location  = Struct.new(:latitude, :longitude, :altitude)
-          #       raise TypeError, "expected #{Location}, got #{loc.inspect}:#{loc.class}" unless loc.is_a?(Location)
-          #
-          #       @bridge.set_location loc.latitude, loc.longitude, loc.altitude
-          #     end
-          #
-          def set_location(lat, lon, alt = 0.0)
-            loc = { latitude: lat, longitude: lon, altitude: alt }
-            execute :set_location, {}, { location: loc }
-          end
-
-          #
-          # logs
-          #
-          # For Appium
-          # No implementation for W3C webdriver module
-          def available_log_types
-            types = execute :get_available_log_types
-            Array(types).map(&:to_sym)
-          end
-
-          # For Appium
-          # No implementation for W3C webdriver module
-          def log(type)
-            data = execute :get_log, {}, { type: type.to_s }
-
-            Array(data).map do |l|
-              begin
-                ::Selenium::WebDriver::LogEntry.new l.fetch('level', 'UNKNOWN'), l.fetch('timestamp'), l.fetch('message')
-              rescue KeyError
-                next
-              end
-            end
-          end
-
-          # For Appium
-          def log_event(vendor, event)
-            execute :post_log_event, {}, { vendor: vendor, event: event }
-          end
-
-          # For Appium
-          def log_events(type = nil)
-            args = {}
-            args['type'] = type unless type.nil?
-
-            execute :get_log_events, {}, args
-          end
-
-          def take_viewport_screenshot
-            execute_script('mobile: viewportScreenshot')
-          end
-
-          def take_element_screenshot(element)
-            execute :take_element_screenshot, id: element.ref
-          end
-
-          private
-
-          # Don't convert locators for Appium Client
-          # TODO: Only for Appium. Ideally, we'd like to keep the selenium-webdriver
-          def convert_locators(how, what)
-            # case how
-            # when 'class name'
-            #   how = 'css selector'
-            #   what = ".#{escape_css(what)}"
-            # when 'id'
-            #   how = 'css selector'
-            #   what = "##{escape_css(what)}"
-            # when 'name'
-            #   how = 'css selector'
-            #   what = "*[name='#{escape_css(what)}']"
-            # when 'tag name'
-            #   how = 'css selector'
-            # end
-            [how, what]
-          end
-        end # class W3C
-      end # class Bridge
-    end # class Base
-  end # module Core
-end # module Appium

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/mjsonwp.rb

@@ -1,28 +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 MJSONWP
-        COMMANDS = ::Appium::Core::Commands::COMMANDS.merge(::Appium::Core::Base::Commands::OSS).merge(
-          {
-            # W3C already has.
-            take_element_screenshot:    [:get, 'session/:session_id/element/:id/screenshot']
-          }
-        ).freeze
-      end # module MJSONWP
-    end # module Commands
-  end # module Core
-end # 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