add finger print feature (#142)

* add finger print feature

* update changelog

* fixrubocop

Author: KazuCocoa

CHANGELOG.md

@@ -3,6 +3,7 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 ### Enhancements
+- Add finger print feature for Android emulators [#13](https://github.com/appium/ruby_lib_core/issues/13)
 
 ### Bug fixes
 

lib/appium_lib_core/android/device.rb

@@ -3,6 +3,7 @@
 require_relative 'device/network'
 require_relative 'device/performance'
 require_relative 'device/screen'
+require_relative 'device/auth_finger_print'
 
 module Appium
   module Core
@@ -324,6 +325,7 @@ def end_coverage(path, intent)
             Network.add_methods
             Clipboard.add_methods
             Emulator.add_methods
+            AuthenticatesByFinger.add_methods
           end
         end
       end # module Device

lib/appium_lib_core/android/device/auth_finger_print.rb

@@ -0,0 +1,30 @@
+module Appium
+  module Core
+    module Android
+      module Device
+        module AuthenticatesByFinger
+          # @!method finger_print(finger_id)
+          #     Authenticate users by using their finger print scans on supported emulators.
+          #
+          # @param [Integer] finger_id Finger prints stored in Android Keystore system (from 1 to 10)
+          #
+          # @example
+          #
+          #   @driver.finger_print 1
+          #
+          def self.add_methods
+            ::Appium::Core::Device.add_endpoint_method(:finger_print) do
+              def finger_print(finger_id)
+                unless (1..10).cover? finger_id.to_i
+                  raise ArgumentError, "finger_id should be integer between 1 to 10. Not #{finger_id}"
+                end
+
+                execute(:finger_print, {}, { fingerprintId: finger_id.to_i })
+              end
+            end
+          end # def self.emulator_commands
+        end # module Emulator
+      end # module Device
+    end # module Android
+  end # module Core
+end # module Appium

lib/appium_lib_core/common/command/common.rb

@@ -42,6 +42,7 @@ module Commands
         pull_folder:                [:post, 'session/:session_id/appium/device/pull_folder'.freeze],
         get_clipboard:              [:post, 'session/:session_id/appium/device/get_clipboard'.freeze],
         set_clipboard:              [:post, 'session/:session_id/appium/device/set_clipboard'.freeze],
+        finger_print:               [:post, 'session/:session_id/appium/device/finger_print'.freeze],
         get_settings:               [:get,  'session/:session_id/appium/settings'.freeze],
         update_settings:            [:post, 'session/:session_id/appium/settings'.freeze],
         stop_recording_screen:      [:post, 'session/:session_id/appium/stop_recording_screen'.freeze],

test/test_helper.rb

@@ -9,8 +9,9 @@
 require 'minitest'
 
 $VERBOSE = nil
+Appium::Logger.level = ::Logger::FATAL # Show Logger logs only they are fatal
 
-Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
+Minitest::Reporters.use! Minitest::Reporters::ProgressReporter.new
 
 ROOT_REPORT_PATH = "#{Dir.pwd}/test/report".freeze
 START_AT = Time.now.strftime('%Y-%m-%d-%H%M%S').freeze

test/unit/android/webdriver/mjsonwp/commands_test.rb

@@ -116,6 +116,21 @@ def test_session_capabilities
 
             assert_requested(:get, SESSION.to_s, times: 1)
           end
+
+          def test_finger_print
+            stub_request(:post, "#{SESSION}/appium/device/finger_print")
+              .with(body: { fingerprintId: 1 }.to_json)
+              .to_return(headers: HEADER, status: 200, body: { value: { finger: 'name' } }.to_json)
+
+            error = assert_raises ArgumentError do
+              @driver.finger_print 0
+            end
+            assert_equal 'finger_id should be integer between 1 to 10. Not 0', error.message
+
+            @driver.finger_print 1
+
+            assert_requested(:post, "#{SESSION}/appium/device/finger_print", times: 1)
+          end
         end # class CommandsTest
       end # module MJSONWP
     end # module WebDriver

test/unit/android/webdriver/w3c/commands_test.rb

@@ -110,6 +110,21 @@ def test_session_capabilities
 
             assert_requested(:get, SESSION.to_s, times: 1)
           end
+
+          def test_finger_print
+            stub_request(:post, "#{SESSION}/appium/device/finger_print")
+              .with(body: { fingerprintId: 1 }.to_json)
+              .to_return(headers: HEADER, status: 200, body: { value: { finger: 'name' } }.to_json)
+
+            error = assert_raises ArgumentError do
+              @driver.finger_print 0
+            end
+            assert_equal 'finger_id should be integer between 1 to 10. Not 0', error.message
+
+            @driver.finger_print 1
+
+            assert_requested(:post, "#{SESSION}/appium/device/finger_print", times: 1)
+          end
         end # class CommandsTest
       end # module W3C
     end # module WebDriver

test/unit/script/commands_test.rb

@@ -22,23 +22,23 @@ def test_get_all_command_path
 
     # depends on webdriver-version... (number of commands)
     def test_implemented_mjsonwp_commands
-      assert_equal 145, @c.implemented_mjsonwp_commands.length
+      assert_equal 146, @c.implemented_mjsonwp_commands.length
       assert_equal ['session/:session_id/contexts', [:get]], @c.implemented_mjsonwp_commands.first
 
       # pick up an arbitrary command
       assert_equal %i(get post), @c.implemented_mjsonwp_commands['session/:session_id/alert_text']
     end
 
     def test_implemented_w3c_commands
-      assert_equal 118, @c.implemented_w3c_commands.length
+      assert_equal 119, @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 59, @c.implemented_core_commands.length
+      assert_equal 60, @c.implemented_core_commands.length
       assert_equal ['session/:session_id/contexts', [:get]], @c.implemented_core_commands.first
 
       # pick up an arbitrary command