add w3c touch action tests and some supports for w3c (#35)

* add w3c touch action tests

* remove new lines

* separate w3c bridge and use touch by default

* fix rubocop

* remove comment outs to confirm w3c

* fix command related issues

* catch incorrect parameter error

* add getting dialect and fix rubocop

* Update driver.rb

Author: KazuCocoa

.rubocop.yml

@@ -16,11 +16,13 @@ Metrics/PerceivedComplexity:
   Max: 8
 Style/Documentation:
   Enabled: false
-Style/AccessorMethodName:
-  Enabled: false
 Style/CommentedKeyword:
   Enabled: false
 Style/PercentLiteralDelimiters:
   Enabled: false
+Style/BracesAroundHashParameters:
+  Enabled: false
 Lint/NestedMethodDefinition:
   Enabled: false
+Naming/AccessorMethodName:
+  Enabled: false

appium_lib_core.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'yard', '~> 0.9'
+  spec.add_development_dependency 'yard', '~> 0.9.11'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-reporters', '~> 1.1'
   spec.add_development_dependency 'webmock', '~> 3.1.0'

lib/appium_lib_core/common/base.rb

@@ -1,6 +1,8 @@
 # The following files have selenium-webdriver related stuff.
 require_relative 'base/driver'
 require_relative 'base/bridge'
+require_relative 'base/msjsonwp_bridge'
+require_relative 'base/w3c_bridge'
 require_relative 'base/capabilities'
 require_relative 'base/http_default'
 require_relative 'base/search_context'

lib/appium_lib_core/common/base/bridge.rb

@@ -83,23 +83,6 @@ def merged_capabilities(desired_capabilities)
           }
         end
       end # class Bridge
-
-      class CoreBridgeMJSONWP < ::Selenium::WebDriver::Remote::OSS::Bridge
-        def commands(command)
-          ::Appium::Core::Commands::COMMANDS_EXTEND_MJSONWP[command]
-        end
-      end # class CoreBridgeMJSONWP
-
-      class CoreBridgeW3C < ::Selenium::WebDriver::Remote::W3C::Bridge
-        def commands(command)
-          case command
-          when :status, :is_element_displayed
-            ::Appium::Core::Commands::COMMANDS_EXTEND_MJSONWP[command]
-          else
-            ::Appium::Core::Commands::COMMANDS_EXTEND_W3C[command]
-          end
-        end
-      end # class CoreBridgeW3C
     end # class Base
   end # module Core
 end # module Appium

lib/appium_lib_core/common/base/driver.rb

@@ -20,10 +20,21 @@ def initialize(opts = {})
             extend ::Selenium::WebDriver::DriverExtensions::HasTouchScreen
             extend ::Selenium::WebDriver::DriverExtensions::HasLocation
             extend ::Selenium::WebDriver::DriverExtensions::HasNetworkConnection
+          elsif @bridge.dialect == :w3c
+            # TODO: Only for Appium. Ideally, we'd like to remove the below like selenium-webdriver
+            extend ::Selenium::WebDriver::DriverExtensions::HasTouchScreen
+            extend ::Selenium::WebDriver::DriverExtensions::HasLocation
+            extend ::Selenium::WebDriver::DriverExtensions::HasNetworkConnection
           end
           super(@bridge, listener: listener)
         end
 
+        # Get the dialect value
+        # @return [:oss|:w3c]
+        def dialect
+          @bridge.dialect
+        end
+
         # Get the device window's size.
         # @return [Selenium::WebDriver::Dimension]
         #

lib/appium_lib_core/common/base/msjsonwp_bridge.rb

@@ -0,0 +1,11 @@
+module Appium
+  module Core
+    class Base
+      class CoreBridgeMJSONWP < ::Selenium::WebDriver::Remote::OSS::Bridge
+        def commands(command)
+          ::Appium::Core::Commands::COMMANDS_EXTEND_MJSONWP[command]
+        end
+      end # class CoreBridgeMJSONWP
+    end # class Base
+  end # module Core
+end # module Appium

lib/appium_lib_core/common/base/w3c_bridge.rb

@@ -0,0 +1,65 @@
+module Appium
+  module Core
+    class Base
+      class CoreBridgeW3C < ::Selenium::WebDriver::Remote::W3C::Bridge
+        def commands(command)
+          ::Appium::Core::Commands::COMMANDS_EXTEND_W3C[command]
+        end
+
+        def action(async = false)
+          ::Selenium::WebDriver::W3CActionBuilder.new self,
+                                                      ::Selenium::WebDriver::Interactions.pointer(:touch, name: 'touch'),
+                                                      ::Selenium::WebDriver::Interactions.key('keyboard'),
+                                                      async
+        end
+        alias actions action
+
+        # 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
+
+        # 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
+
+        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 CoreBridgeW3C
+    end # class Base
+  end # module Core
+end # module Appium

lib/appium_lib_core/common/command.rb

@@ -43,8 +43,6 @@ module Commands
         hide_keyboard:              [:post, 'session/:session_id/appium/device/hide_keyboard'.freeze],
         press_keycode:              [:post, 'session/:session_id/appium/device/press_keycode'.freeze],
         long_press_keycode:         [:post, 'session/:session_id/appium/device/long_press_keycode'.freeze],
-        ## take_element_screenshot is for MJSONWP. W3C already has.
-        take_element_screenshot:    [:get,  'session/:session_id/element/:id/screenshot'.freeze],
         # keyevent is only for Selendroid
         keyevent:                   [:post, 'session/:session_id/appium/device/keyevent'.freeze],
         set_immediate_value:        [:post, 'session/:session_id/appium/element/:id/value'.freeze],
@@ -74,8 +72,27 @@ module Commands
       COMMANDS = {}.merge(COMMAND).merge(COMMAND_ANDROID).merge(COMMAND_IOS)
                    .merge(COMMAND_NO_ARG).freeze
 
-      COMMANDS_EXTEND_MJSONWP = COMMANDS.merge(::Appium::Core::Base::Commands::OSS).freeze
-      COMMANDS_EXTEND_W3C = COMMANDS.merge(::Appium::Core::Base::Commands::W3C).freeze
+      COMMANDS_EXTEND_MJSONWP = COMMANDS.merge(
+        {
+          # W3C already has.
+          take_element_screenshot:    [:get, 'session/:session_id/element/:id/screenshot'.freeze]
+        }
+      ).merge(::Appium::Core::Base::Commands::OSS).freeze
+      COMMANDS_EXTEND_W3C = COMMANDS.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'.freeze],
+          is_element_displayed:      [:get, 'session/:session_id/element/:id/displayed'.freeze],
+
+          # For IME
+          ime_get_available_engines: [:get,  'session/:session_id/ime/available_engines'.freeze],
+          ime_get_active_engine:     [:get,  'session/:session_id/ime/active_engine'.freeze],
+          ime_is_activated:          [:get,  'session/:session_id/ime/activated'.freeze],
+          ime_deactivate:            [:post, 'session/:session_id/ime/deactivate'.freeze],
+          ime_activate_engine:       [:post, 'session/:session_id/ime/activate'.freeze]
+        }
+      ).merge(::Appium::Core::Base::Commands::W3C).freeze
     end
   end
 end

lib/appium_lib_core/driver.rb

@@ -194,6 +194,15 @@ def set_implicit_wait_by_default(wait)
           raise e.message, ::Appium::Core::Error::ServerError
         end
 
+        Appium::Logger.debug(e.message)
+        {}
+      rescue Selenium::WebDriver::Error::WebDriverError => e
+        # FIXME: Temporary rescue until Appium support W3C's implicit wait
+        # https://github.com/jlipps/simple-wd-spec#set-timeouts
+        unless e.message.include?('Parameters were incorrect. We wanted {"required":["type","ms"]} and you sent ["implicit"]')
+          raise e.message, ::Appium::Core::Error::ServerError
+        end
+
         Appium::Logger.debug(e.message)
         {}
       end

test/functional/android/webdriver/w3c_actions_test.rb

@@ -0,0 +1,34 @@
+require 'test_helper'
+
+# $ rake test:func:android TEST=test/functional/android/webdriver/w3c_actions_test.rb
+# rubocop:disable Style/ClassVars
+class AppiumLibCoreTest
+  module WebDriver
+    class W3CActionsTest < AppiumLibCoreTest::Function::TestCase
+      def setup
+        @@core ||= ::Appium::Core.for(self, Caps::ANDROID_OPS)
+        @@driver ||= @@core.start_driver
+
+        @@driver.start_activity app_package: 'io.appium.android.apis',
+                                app_activity: '.ApiDemos'
+      end
+
+      def teardown
+        save_reports(@@driver)
+      end
+
+      def test_tap
+        skip if @@driver.dialect
+
+        el = @@core.wait { @@driver.find_element(:accessibility_id, 'Views') }
+        @@driver.action.click(el).perform
+
+        el = @@core.wait { @@driver.find_element(:accessibility_id, 'Custom') }
+        @@driver.action.click_and_hold(el).move_to_location(0, 700).release.perform
+
+        el = @@core.wait { @@driver.find_element(:accessibility_id, 'ImageButton') }
+        assert_equal 'ImageButton', el.name
+      end
+    end
+  end
+end

test/functional/ios/webdriver/w3c_actions_test.rb

@@ -0,0 +1,31 @@
+require 'test_helper'
+
+# $ rake test:func:ios TEST=test/functional/ios/webdriver/w3c_actions_test.rb
+# rubocop:disable Style/ClassVars
+class AppiumLibCoreTest
+  module WebDriver
+    class W3CActionsTest < AppiumLibCoreTest::Function::TestCase
+      def setup
+        @@core ||= ::Appium::Core.for(self, Caps::IOS_OPS)
+        @@driver ||= @@core.start_driver
+      end
+
+      def teardown
+        save_reports(@@driver)
+      end
+
+      def test_tap
+        skip if @@driver.dialect
+
+        el = @@core.wait { @@driver.find_element(:accessibility_id, 'Buttons') }
+        @@driver.action.click(el).perform
+
+        el = @@core.wait { @@driver.find_element(:name, 'Button with Image') }
+        @@driver.action.click_and_hold(el).move_to_location(0, 700).release.perform
+
+        el = @@core.wait { @@driver.find_element(:accessibility_id, 'ImageButton') }
+        assert_equal 'ImageButton', el.name
+      end
+    end
+  end
+end

test/unit/script/commands_test.rb

@@ -30,15 +30,15 @@ def test_implemented_mjsonwp_commands
     end
 
     def test_implemented_w3c_commands
-      assert_equal 89, @c.implemented_w3c_commands.length
+      assert_equal 96, @c.implemented_w3c_commands.length
       assert_equal ['session/:session_id/contexts', [:get]], @c.implemented_w3c_commands.first
 
       # pick up an arbitrary command
       assert_equal %i(get post), @c.implemented_w3c_commands['session/:session_id/alert/text']
     end
 
     def test_implemented_core_commands
-      assert_equal 44, @c.implemented_core_commands.length
+      assert_equal 43, @c.implemented_core_commands.length
       assert_equal ['session/:session_id/contexts', [:get]], @c.implemented_core_commands.first
 
       # pick up an arbitrary command