fix instance variables of device and automation_name (#570)

* fix instance variables of device and automation_name

* fix type

* refactoring a bit

* add tests more

Author: KazuCocoa

lib/appium_lib_core/driver.rb

@@ -104,7 +104,7 @@ def initialize(capabilities)
     class Driver
       include Waitable
 
-      # Selenium webdriver capabilities
+      # Selenium webdriver capabilities, but the value is provided capabilities basis.
       # @return [Core::Base::Capabilities]
       attr_reader :caps
 
@@ -125,7 +125,7 @@ class Driver
 
       # Automation name sent to appium server or received by server.<br>
       # If automation_name is <code>nil</code>, it is not set both client side and server side.
-      # @return [Hash]
+      # @return [Symbol]
       attr_reader :automation_name
 
       # Custom URL for the selenium server. If set this attribute, ruby_lib_core try to handshake to the custom url.<br>
@@ -634,7 +634,7 @@ def get_appium_lib_opts(opts)
 
       # @private
       def get_app
-        @caps[:app] || @caps['app']
+        get_cap 'app'
       end
 
       # @private
@@ -678,17 +678,17 @@ def set_appium_lib_specific_values(appium_lib_opts)
       # @private
       def set_appium_device
         # https://code.google.com/p/selenium/source/browse/spec-draft.md?repo=mobile
-        @device = @caps[:platformName] || @caps['platformName']
+        @device = get_cap 'platformName'
         return @device unless @device
 
-        @device = convert_downcase @device
+        @device = convert_to_symbol(convert_downcase(@device))
       end
 
       # @private
       def set_automation_name
-        candidate = @caps[:automationName] || @caps['automationName']
+        candidate = get_cap 'automationName'
         @automation_name = candidate if candidate
-        @automation_name = convert_downcase @automation_name if @automation_name
+        @automation_name = convert_to_symbol(convert_downcase(@automation_name)) if @automation_name
       end
 
       # @private
@@ -700,9 +700,18 @@ def convert_downcase(value)
       def set_automation_name_if_nil
         return unless @automation_name.nil?
 
-        @automation_name = if @driver.capabilities['automationName']
-                             @driver.capabilities['automationName'].downcase.strip.intern
-                           end
+        automation_name = if @driver.capabilities['automationName']
+                            @driver.capabilities['automationName'].downcase.strip.intern
+                          end
+        @automation_name = convert_to_symbol automation_name
+      end
+
+      def get_cap(name)
+        name_with_prefix = "appium:#{name}"
+        @caps[convert_to_symbol name] ||
+          @caps[name] ||
+          @caps[convert_to_symbol name_with_prefix] ||
+          @caps[name_with_prefix]
       end
     end # class Driver
   end # module Core

test/unit/appium_lib_core_test.rb

@@ -64,6 +64,59 @@ def test_symbolize_keys_raise_argument_error
       assert_equal 'symbolize_keys requires a hash', e.message
     end
 
+    def test_core_instance_variables
+      opts = {
+        url: 'http://custom-host:8080/wd/hub.com',
+        caps: {
+          platformName: :ios,
+          platformVersion: '11.0',
+          deviceName: 'iPhone Simulator',
+          automationName: 'XCUITest',
+          app: '/path/to/MyiOS.app'
+        }
+      }
+      @core = Appium::Core.for(opts)
+      assert_equal 'http://custom-host:8080/wd/hub.com', @core.custom_url
+
+      assert_equal :ios, @core.device
+      assert_equal :xcuitest, @core.automation_name
+    end
+
+    def test_core_instance_variables_with_appium_prefix_hash
+      opts = {
+        url: 'http://custom-host:8080/wd/hub.com',
+        caps: {
+          'platformName': 'ios',
+          'appium:platformVersion': '11.0',
+          'appium:deviceName': 'iPhone Simulator',
+          'appium:automationName': 'XCUITest',
+          'appium:app': '/path/to/MyiOS.app'
+        }
+      }
+      @core = Appium::Core.for(opts)
+      assert_equal 'http://custom-host:8080/wd/hub.com', @core.custom_url
+
+      assert_equal :ios, @core.device
+      assert_equal :xcuitest, @core.automation_name
+    end
+
+    def test_core_instance_variables_with_appium_prefix_string
+      opts = {
+        url: 'http://custom-host:8080/wd/hub.com',
+        caps: {
+          'platformName' => 'ios',
+          'appium:platformVersion' => '11.0',
+          'appium:deviceName' => 'iPhone Simulator',
+          'appium:automationName' => 'XCUITest',
+          'appium:app' => '/path/to/MyiOS.app'
+        }
+      }
+      @core = Appium::Core.for(opts)
+      assert_equal 'http://custom-host:8080/wd/hub.com', @core.custom_url
+
+      assert_equal :ios, @core.device
+      assert_equal :xcuitest, @core.automation_name
+    end
     def test_url_param
       opts = {
         url: 'http://custom-host:8080/wd/hub.com',

test/unit/driver_test.rb

@@ -79,6 +79,38 @@ def test_verify_appium_core_base_capabilities_create_capabilities
       assert_equal 'someCapability2', caps[:someCapability2]
     end
 
+    def test_verify_appium_core_base_capabilities_create_capabilities_with_caps_hash
+      caps = ::Appium::Core::Base::Capabilities.new(platformName: 'ios',
+                                                    'appium:platformVersion': '11.4',
+                                                    'appium:automationName': 'XCUITest',
+                                                    'appium:app': 'test/functional/app/UICatalog.app.zip')
+
+      caps_with_json = JSON.parse(caps.to_json)
+      assert_equal 'ios', caps_with_json['platformName']
+      assert_equal 'XCUITest', caps_with_json['appium:automationName']
+      assert_equal 'test/functional/app/UICatalog.app.zip', caps_with_json['appium:app']
+
+      assert_equal 'ios', caps[:platformName]
+      assert_equal 'XCUITest', caps[:'appium:automationName']
+      assert_equal 'test/functional/app/UICatalog.app.zip', caps[:'appium:app']
+    end
+
+    def test_verify_appium_core_base_capabilities_create_capabilities_with_caps_string
+      caps = ::Appium::Core::Base::Capabilities.new('platformName' => 'ios',
+                                                    'appium:platformVersion' => '11.4',
+                                                    'appium:automationName' => 'XCUITest',
+                                                    'appium:app' => 'test/functional/app/UICatalog.app.zip')
+
+      caps_with_json = JSON.parse(caps.to_json)
+      assert_equal 'ios', caps_with_json['platformName']
+      assert_equal 'XCUITest', caps_with_json['appium:automationName']
+      assert_equal 'test/functional/app/UICatalog.app.zip', caps_with_json['appium:app']
+
+      assert_equal 'ios', caps['platformName']
+      assert_equal 'XCUITest', caps['appium:automationName']
+      assert_equal 'test/functional/app/UICatalog.app.zip', caps['appium:app']
+    end
+
     def test_default_wait
       assert_equal 5, @core.default_wait
     end