add unit tests for forceMjsonwp

Author: KazuCocoa

lib/appium_lib_core/common/base/bridge.rb

@@ -5,6 +5,8 @@ class Bridge < ::Selenium::WebDriver::Remote::Bridge
         # Prefix for extra capability defined by W3C
         APPIUM_PREFIX = 'appium:'.freeze
 
+        FORCE_MJSONWP = :forceMjsonwp
+
         # Almost same as self.handshake in ::Selenium::WebDriver::Remote::Bridge
         #
         # Implements protocol handshake which:
@@ -161,7 +163,7 @@ def delete_force_mjsonwp(capabilities)
           capabilities.each do |name, value|
             next if value.nil?
             next if value.is_a?(String) && value.empty?
-            next if name == :forceMjsonwp
+            next if name == FORCE_MJSONWP
 
             w3c_capabilities[name] = value
           end
@@ -170,7 +172,7 @@ def delete_force_mjsonwp(capabilities)
         end
 
         def merged_capabilities(desired_capabilities)
-          force_mjsonwp = desired_capabilities[:forceMjsonwp]
+          force_mjsonwp = desired_capabilities[FORCE_MJSONWP]
           desired_capabilities = delete_force_mjsonwp(desired_capabilities) unless force_mjsonwp.nil?
 
           if force_mjsonwp

test/unit/common_test.rb

@@ -1,13 +1,105 @@
 require 'test_helper'
+require 'webmock/minitest'
 
 # $ rake test:unit TEST=test/unit/common_test.rb
 class AppiumLibCoreTest
   class Common
     class AppiumCoreBaseBridgeTest < Minitest::Test
+      include AppiumLibCoreTest::Mock
+
       def setup
         @bridge = Appium::Core::Base::Bridge.new
       end
 
+      RESPONSE_BASE_VALUE = {
+        sessionId: '1234567890',
+        capabilities: {
+          platformName: :android,
+          automationName: 'uiautomator2',
+          app: 'test/functional/app/api.apk',
+          platformVersion: '7.1.1',
+          deviceName: 'Android Emulator',
+          appPackage: 'io.appium.android.apis'
+        }
+      }.freeze
+
+      CAPS = {
+        platformName: :android,
+        automationName: 'uiautomator2',
+        app: "#{Dir.pwd}/test/functional/app/api.apk",
+        platformVersion: '7.1.1',
+        deviceName: 'Android Emulator',
+        appPackage: 'io.appium.android.apis'
+      }.freeze
+
+      APPIUM_PREFIX_CAPS = {
+        platformName: :android,
+        'appium:automationName' => 'uiautomator2',
+        'appium:app' => "#{Dir.pwd}/test/functional/app/api.apk",
+        'appium:platformVersion' => '7.1.1',
+        'appium:deviceName' => 'Android Emulator',
+        'appium:appPackage' => 'io.appium.android.apis'
+      }.freeze
+
+      def test_create_session_force_mjsonwp
+        response = {
+          status: 0, # To make bridge.dialect == :oss
+          value: RESPONSE_BASE_VALUE
+        }.to_json
+
+        stub_request(:post, 'http://127.0.0.1:4723/wd/hub/session')
+          .with(body: { desiredCapabilities: CAPS }.to_json)
+          .to_return(headers: Mock::HEADER, status: 200, body: response)
+
+        stub_request(:post, "#{Mock::SESSION}/timeouts/implicit_wait")
+          .with(body: { ms: 20_000 }.to_json)
+          .to_return(headers: Mock::HEADER, status: 200, body: { value: nil }.to_json)
+
+        driver = ::Appium::Core.for(self, { caps: CAPS.merge({ forceMjsonwp: true }), appium_lib: {} }).start_driver
+
+        assert_requested(:post, 'http://127.0.0.1:4723/wd/hub/session', times: 1)
+        assert_requested(:post, "#{Mock::SESSION}/timeouts/implicit_wait", body: { ms: 20_000 }.to_json, times: 1)
+        driver
+      end
+
+      def test_create_session_force_mjsonwp_false
+        response = { value: RESPONSE_BASE_VALUE }.to_json
+
+        stub_request(:post, 'http://127.0.0.1:4723/wd/hub/session')
+            .with(body: { desiredCapabilities: CAPS,
+                          capabilities: { alwaysMatch: APPIUM_PREFIX_CAPS, firstMatch: [{}] } }.to_json)
+            .to_return(headers: Mock::HEADER, status: 200, body: response)
+
+        stub_request(:post, "#{Mock::SESSION}/timeouts")
+            .with(body: { implicit: 20_000 }.to_json)
+            .to_return(headers: Mock::HEADER, status: 200, body: { value: nil }.to_json)
+
+        driver = ::Appium::Core.for(self, { caps: CAPS.merge({ forceMjsonwp: false }), appium_lib: {} }).start_driver
+
+        assert_requested(:post, 'http://127.0.0.1:4723/wd/hub/session', times: 1)
+        assert_requested(:post, "#{Mock::SESSION}/timeouts", body: { implicit: 20_000 }.to_json, times: 1)
+        driver
+      end
+
+      def test_create_session_w3c
+        response = { value: RESPONSE_BASE_VALUE }.to_json
+
+        stub_request(:post, 'http://127.0.0.1:4723/wd/hub/session')
+          .with(body: { desiredCapabilities: CAPS,
+                        capabilities: { alwaysMatch: APPIUM_PREFIX_CAPS, firstMatch: [{}] } }.to_json)
+          .to_return(headers: Mock::HEADER, status: 200, body: response)
+
+        stub_request(:post, "#{Mock::SESSION}/timeouts")
+          .with(body: { implicit: 20_000 }.to_json)
+          .to_return(headers: Mock::HEADER, status: 200, body: { value: nil }.to_json)
+
+        driver = ::Appium::Core.for(self, { caps: CAPS, appium_lib: {} }).start_driver
+
+        assert_requested(:post, 'http://127.0.0.1:4723/wd/hub/session', times: 1)
+        assert_requested(:post, "#{Mock::SESSION}/timeouts", body: { implicit: 20_000 }.to_json, times: 1)
+        driver
+      end
+
       def test_add_appium_prefix_compatible_with_oss
         cap = {
           platformName: :ios,