add adding appium-prefix for W3C format (#34)

* add adding appium-prefix

* add tests for add_appium_prefix

* add the fixing into changelog

* add docs

Author: KazuCocoa

CHANGELOG.md

@@ -3,6 +3,7 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 ### Enhancements
+- Append `appium:` prefix for capabilities automatically due to W3C format.
 
 ### Bug fixes
 

appium_lib_core.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'selenium-webdriver', '~> 3.4', '>= 3.4.1'
+  spec.add_runtime_dependency 'selenium-webdriver', '~> 3.5'
   spec.add_runtime_dependency 'json', '>= 1.8'
 
   spec.add_development_dependency 'bundler', '~> 1.14'

lib/appium_lib_core/common/base/bridge.rb

@@ -2,6 +2,16 @@ module Appium
   module Core
     class Base
       class Bridge < ::Selenium::WebDriver::Remote::Bridge
+        # Almost same as self.handshake in ::Selenium::WebDriver::Remote::Bridge
+        #
+        # Implements protocol handshake which:
+        #
+        #   1. Creates session with driver.
+        #   2. Sniffs response.
+        #   3. Based on the response, understands which dialect we should use.
+        #
+        # @return [CoreBridgeMJSONWP, CoreBridgeW3C]
+        #
         def self.handshake(**opts)
           desired_capabilities = opts.delete(:desired_capabilities)
 
@@ -25,15 +35,50 @@ def self.handshake(**opts)
           end
         end
 
+        # Append `appium:` prefix for Appium following W3C spec
+        # https://www.w3.org/TR/webdriver/#dfn-validate-capabilities
+        #
+        # @param [::Selenium::WebDriver::Remote::W3C::Capabilities, Hash] capabilities A capability
+        # @return [::Selenium::WebDriver::Remote::W3C::Capabilities]
+        def add_appium_prefix(capabilities)
+          w3c_capabilities = ::Selenium::WebDriver::Remote::W3C::Capabilities.new
+
+          capabilities = capabilities.__send__(:capabilities) unless capabilities.is_a?(Hash)
+          capabilities.each do |name, value|
+            next if value.nil?
+            next if value.is_a?(String) && value.empty?
+
+            capability_name = name.to_s
+            w3c_name = appium_prefix?(capability_name, w3c_capabilities) ? name : "appium:#{capability_name}"
+
+            w3c_capabilities[w3c_name] = value
+          end
+
+          w3c_capabilities
+        end
+
         private
 
+        APPIUM_PREFIX = 'appium:'.freeze
+        def appium_prefix?(capability_name, w3c_capabilities)
+          snake_cased_capability_names = ::Selenium::WebDriver::Remote::W3C::Capabilities::KNOWN.map(&:to_s)
+          camel_cased_capability_names = snake_cased_capability_names.map(&w3c_capabilities.method(:camel_case))
+
+          snake_cased_capability_names.include?(capability_name) ||
+            camel_cased_capability_names.include?(capability_name) ||
+            capability_name.start_with?(APPIUM_PREFIX)
+        end
+
         # Use capabilities directory because Appium's capability is based on W3C one.
-        # Called in bridge.create_session(desired_capabilities)
+        # Called in bridge.create_session(desired_capabilities) from Parent class
         def merged_capabilities(desired_capabilities)
+          new_caps = add_appium_prefix(desired_capabilities)
+          w3c_capabilities = ::Selenium::WebDriver::Remote::W3C::Capabilities.from_oss(new_caps)
+
           {
             desiredCapabilities: desired_capabilities,
             capabilities: {
-              firstMatch: [desired_capabilities]
+              firstMatch: [w3c_capabilities]
             }
           }
         end

test/unit/common_test.rb

@@ -0,0 +1,72 @@
+require 'test_helper'
+
+# $ rake test:unit TEST=test/unit/common_test.rb
+class AppiumLibCoreTest
+  class Common
+    class AppiumCoreBaseBridgeTest < Minitest::Test
+      def setup
+        @bridge = Appium::Core::Base::Bridge.new
+      end
+
+      def test_add_appium_prefix_compatible_with_oss
+        cap = {
+          platformName: :ios,
+          automationName: 'XCUITest',
+          app: 'test/functional/app/UICatalog.app',
+          platformVersion: '10.3',
+          deviceName: 'iPhone Simulator',
+          useNewWDA: true,
+          some_capability: 'some_capability'
+        }
+        base_caps = Appium::Core::Base::Capabilities.create_capabilities(cap)
+
+        expected = {
+          proxy: nil,
+          platformName: :ios,
+          'appium:automationName' => 'XCUITest',
+          'appium:app' => 'test/functional/app/UICatalog.app',
+          'appium:platformVersion' => '10.3',
+          'appium:deviceName' => 'iPhone Simulator',
+          'appium:useNewWDA' => true,
+          'appium:some_capability' => 'some_capability'
+        }
+
+        assert_equal expected, @bridge.add_appium_prefix(base_caps).__send__(:capabilities)
+      end
+
+      def test_add_appium_prefix_already_have_appium_prefix
+        cap = {
+          platformName: :ios,
+          automationName: 'XCUITest',
+          'appium:app' => 'test/functional/app/UICatalog.app',
+          platformVersion: '10.3',
+          deviceName: 'iPhone Simulator',
+          useNewWDA: true,
+          some_capability: 'some_capability'
+        }
+        base_caps = Appium::Core::Base::Capabilities.create_capabilities(cap)
+
+        expected = {
+          proxy: nil,
+          platformName: :ios,
+          'appium:automationName' => 'XCUITest',
+          'appium:app' => 'test/functional/app/UICatalog.app',
+          'appium:platformVersion' => '10.3',
+          'appium:deviceName' => 'iPhone Simulator',
+          'appium:useNewWDA' => true,
+          'appium:some_capability' => 'some_capability'
+        }
+
+        assert_equal expected, @bridge.add_appium_prefix(base_caps).__send__(:capabilities)
+      end
+
+      def test_add_appium_prefix_has_no_parameter
+        cap = {}
+        base_caps = Appium::Core::Base::Capabilities.create_capabilities(cap)
+        expected = { proxy: nil }
+
+        assert_equal expected, @bridge.add_appium_prefix(base_caps).__send__(:capabilities)
+      end
+    end
+  end
+end