feat: allow :capabilities as argument (#266)

* feat: allow :capabilities as arg

* tweak the test of tvos

Author: KazuCocoa

CHANGELOG.md

@@ -5,6 +5,20 @@ Read `release_notes.md` for commit level details.
 ## [Unreleased]
 
 ### Enhancements
+- `capabilities:` is available in addition to `desired_capabilities:` and `caps:` as a capability
+    ```ruby
+    # case 1
+    opts = { caps: { }, appium_lib: { } }
+    @driver = Appium::Core.for(opts).start_driver
+
+    # case 2
+    opts = { capabilities: { }, appium_lib: { } }
+    @driver = Appium::Core.for(opts).start_driver
+
+    # case 3
+    opts = { desired_capabilities: { }, appium_lib: { } }
+    @driver = Appium::Core.for(opts).start_driver
+    ```
 
 ### Bug fixes
 

lib/appium_lib_core/driver.rb

@@ -182,7 +182,9 @@ class Driver
 
       # Creates a new driver and extend particular methods
       # @param [Hash] opts A options include capabilities for the Appium Server and for the client.
-      # @option opts [Hash] :caps Appium capabilities. Prior than :desired_capabilities
+      # @option opts [Hash] :caps Appium capabilities.
+      # @option opts [Hash] :capabilities The same as :caps.
+      #                                   This param is for compatibility with Selenium WebDriver format
       # @option opts [Hash] :desired_capabilities The same as :caps.
       #                                           This param is for compatibility with Selenium WebDriver format
       # @option opts [Appium::Core::Options] :appium_lib Capabilities affect only ruby client
@@ -195,8 +197,8 @@ class Driver
       #
       #     # format 1
       #     @core = Appium::Core.for caps: {...}, appium_lib: {...}
-      #     # format 2. 'desired_capabilities:' is also available instead of 'caps:'. Either is fine.
-      #     @core = Appium::Core.for url: "http://127.0.0.1:8080/wd/hub", desired_capabilities: {...}, appium_lib: {...}
+      #     # format 2. 'capabilities:' or 'desired_capabilities:' is also available instead of 'caps:'.
+      #     @core = Appium::Core.for url: "http://127.0.0.1:8080/wd/hub", capabilities: {...}, appium_lib: {...}
       #     # format 3. 'appium_lib: {...}' can be blank
       #     @core = Appium::Core.for url: "http://127.0.0.1:8080/wd/hub", desired_capabilities: {...}
       #
@@ -226,9 +228,9 @@ class Driver
       #     @core.start_driver # Connect to 'http://127.0.0.1:8080/wd/hub' because of 'port: 8080'
       #
       #     # Start iOS driver with .zip file over HTTP
-      #     #  'desired_capabilities:' is also available instead of 'caps:'. Either is fine.
+      #     #  'desired_capabilities:' or 'capabilities:' is also available instead of 'caps:'. Either is fine.
       #     opts = {
-      #              desired_capabilities: {
+      #              capabilities: {
       #                platformName: :ios,
       #                platformVersion: '11.0',
       #                deviceName: 'iPhone Simulator',
@@ -541,7 +543,10 @@ def extend_for(device:, automation_name:)
       def validate_keys(opts)
         flatten_ops = flatten_hash_keys(opts)
 
-        raise Error::NoCapabilityError unless opts.member?(:caps) || opts.member?(:desired_capabilities)
+        # FIXME: Remove 'desired_capabilities' in the next major Selenium update
+        unless opts.member?(:caps) || opts.member?(:capabilities) || opts.member?(:desired_capabilities)
+          raise Error::NoCapabilityError
+        end
 
         if !opts.member?(:appium_lib) && flatten_ops.member?(:appium_lib)
           raise Error::CapabilityStructureError, 'Please check the value of appium_lib in the capability'
@@ -562,7 +567,8 @@ def flatten_hash_keys(hash, flatten_keys_result = [])
 
       # @private
       def get_caps(opts)
-        Core::Base::Capabilities.create_capabilities(opts[:caps] || opts[:desired_capabilities] || {})
+        # FIXME: Remove 'desired_capabilities' in the next major Selenium update
+        Core::Base::Capabilities.create_capabilities(opts[:caps] || opts[:capabilities] || opts[:desired_capabilities] || {})
       end
 
       # @private

test/functional/ios/tv_driver_test.rb

@@ -55,7 +55,8 @@ def test_launch_app
       assert result
 
       e1 = @driver.switch_to.active_element
-      assert_equal 'Settings', e1.label
+      label = e1.label
+      assert %w(Settings Music).include? label
     end
   end
 end

test/unit/driver_test.rb

@@ -23,8 +23,10 @@ def setup
     end
 
     class ExampleDriver
+      # for test
+      attr_reader :core
       def initialize(opts)
-        ::Appium::Core.for(opts)
+        @core = ::Appium::Core.for(opts)
       end
     end
 
@@ -37,13 +39,31 @@ def test_no_caps
     end
 
     def test_with_caps
-      opts = { caps: {} }
-      refute_nil ExampleDriver.new(opts)
+      opts = { caps: { automationName: 'xcuitest' } }
+      driver = ExampleDriver.new(opts)
+      refute_nil driver
+      assert_equal driver.core.caps[:automationName], 'xcuitest'
+    end
+
+    def test_with_capabilities
+      opts = { capabilities: { automationName: 'xcuitest' } }
+      driver = ExampleDriver.new(opts)
+      refute_nil driver
+      assert_equal driver.core.caps[:automationName], 'xcuitest'
+    end
+
+    def test_with_desired_capabilities
+      opts = { desired_capabilities: { automationName: 'xcuitest' } }
+      driver = ExampleDriver.new(opts)
+      refute_nil driver
+      assert_equal driver.core.caps[:automationName], 'xcuitest'
     end
 
     def test_with_caps_and_appium_lib
-      opts = { caps: {}, appium_lib: {} }
-      refute_nil ExampleDriver.new(opts)
+      opts = { caps: { automationName: 'xcuitest' }, appium_lib: {} }
+      driver = ExampleDriver.new(opts)
+      refute_nil driver
+      assert_equal driver.core.caps[:automationName], 'xcuitest'
     end
 
     def test_with_caps_and_wrong_appium_lib