feat: append screenshot in element module as well (#297)

* feat: append screenshot in element module as well

* switch tests

* add screenshot

* update

* add screenshot

Author: KazuCocoa

CHANGELOG.md

@@ -5,6 +5,9 @@ Read `release_notes.md` for commit level details.
 ## [Unreleased]
 
 ### Enhancements
+- Add  `Element#screenshot`, `Element#screenshot_as` and `Element#save_screenshot` in Element module
+    - `Element#screenshot_as` and `Element#save_screenshot` are same as `Driver#element_screenshot_as` and `Driver#save_element_screenshot`
+    - `Element#screenshot` is same as `Element#screenshot_as(:base64)`
 
 ### Bug fixes
 

lib/appium_lib_core/common/base/driver.rb

@@ -27,7 +27,7 @@ class Driver < ::Selenium::WebDriver::Driver
         include ::Selenium::WebDriver::DriverExtensions::HasWebStorage
 
         include ::Appium::Core::Base::SearchContext
-        include ::Appium::Core::Base::TakeScreenshot
+        include ::Appium::Core::Base::TakesScreenshot
 
         # Private API.
         # Do not use this for general use. Used by flutter driver to get bridge for creating a new element

lib/appium_lib_core/common/base/screenshot.rb

@@ -15,7 +15,7 @@
 module Appium
   module Core
     class Base
-      module TakeScreenshot
+      module TakesScreenshot
         #
         # Save a PNG screenshot to the given path
         #

lib/appium_lib_core/patch.rb

@@ -21,6 +21,9 @@ class Selenium::WebDriver::Element
       # To extend Appium related SearchContext into ::Selenium::WebDriver::Element
       include ::Appium::Core::Base::SearchContext
 
+      # TODO: Probably can remove own TakesScreenshot since Selenium 4
+      include ::Appium::Core::Base::TakesScreenshot
+
       # Returns the value of attributes like below. Read each platform to know more details.
       #
       # uiautomator2: https://github.com/appium/appium-uiautomator2-server/blob/203cc7e57ce477f3cff5d95b135d1b3450a6033a/app/src/main/java/io/appium/uiautomator2/utils/Attribute.java#L19
@@ -99,6 +102,56 @@ def location_rel(driver)
         w = driver.window_size
         ::Selenium::WebDriver::Point.new "#{center_x} / #{w.width.to_f}", "#{center_y} / #{w.height.to_f}"
       end
+
+      # Return an element screenshot as base64
+      #
+      # @return String Base 64 encoded string
+      #
+      # @example
+      #
+      #     element.screenshot #=> "iVBORw0KGgoAAAANSUhEUgAABDgAAAB+CAIAAABOPDa6AAAAAX"
+      #
+      def screenshot
+        bridge.take_element_screenshot(self)
+      end
+
+      # Return an element screenshot in the given format
+      #
+      # @param [:base64, :png] format
+      # @return String screenshot
+      #
+      # @example
+      #
+      #     element.screenshot_as :base64 #=> "iVBORw0KGgoAAAANSUhEUgAABDgAAAB+CAIAAABOPDa6AAAAAX"
+      #
+      def screenshot_as(format)
+        case format
+        when :base64
+          bridge.take_element_screenshot(self)
+        when :png
+          bridge.take_element_screenshot(self).unpack('m')[0]
+        else
+          raise Core::Error::UnsupportedOperationError, "unsupported format: #{format.inspect}"
+        end
+      end
+
+      # Save an element screenshot to the given path
+      #
+      # @param [String] png_path A path to save the screenshot
+      # @return [File] Path to the element screenshot.
+      #
+      # @example
+      #
+      #   element.save_screenshot("fine_name.png")
+      #
+      def save_screenshot(png_path)
+        extension = File.extname(png_path).downcase
+        if extension != '.png'
+          ::Appium::Logger.warn 'name used for saved screenshot does not match file type. '\
+                                'It should end with .png extension'
+        end
+        File.open(png_path, 'wb') { |f| f << screenshot_as(:png) }
+      end
     end
   end # module Core
 end # module Appium

test/functional/android/android/image_comparison_test.rb

@@ -176,7 +176,7 @@ def test_template_scale_ratio
         @driver.rotation = :portrait
 
         el = @driver.find_element :accessibility_id, 'NFC'
-        @driver.save_element_screenshot el, 'test/functional/data/test_android_nfc.png'
+        el.save_screenshot 'test/functional/data/test_android_nfc.png'
 
         @driver.update_settings({ defaultImageTemplateScale: 4 })
 

test/functional/ios/ios/image_comparison_test.rb

@@ -139,7 +139,7 @@ def test_image_elements
         @@driver.update_settings({ fixImageTemplateScale: true })
 
         el = @@driver.find_element :accessibility_id, 'Buttons'
-        @@driver.save_element_screenshot el, 'test/functional/data/test_ios_button.png'
+        el.save_screenshot 'test/functional/data/test_ios_button.png'
 
         image_elements = @@driver.find_elements_by_image AppiumLibCoreTest.path_of('test/functional/data/test_ios_button.png')
         image_element = image_elements[0]

test/unit/common/element_test.rb

@@ -75,5 +75,25 @@ def test_replace
 
       assert_requested(:post, "#{SESSION}/appium/element/id/replace_value", times: 1)
     end
+
+    def test_element_screenshot_as
+      stub_request(:get, "#{SESSION}/element/id/screenshot")
+        .to_return(headers: HEADER, status: 200,
+                   body: { value: 'iVBORw0KGgoAAAANSUhEUgAABDgAAAB+CAIAAABOPDa6AAAAAX' }.to_json)
+
+      e = ::Selenium::WebDriver::Element.new(@driver.send(:bridge), 'id')
+      assert_equal 'iVBORw0KGgoAAAANSUhEUgAABDgAAAB+CAIAAABOPDa6AAAAAX', e.screenshot_as(:base64)
+      assert_requested(:get, "#{SESSION}/element/id/screenshot", times: 1)
+    end
+
+    def test_element_screenshot
+      stub_request(:get, "#{SESSION}/element/id/screenshot")
+        .to_return(headers: HEADER, status: 200,
+                   body: { value: 'iVBORw0KGgoAAAANSUhEUgAABDgAAAB+CAIAAABOPDa6AAAAAX' }.to_json)
+
+      e = ::Selenium::WebDriver::Element.new(@driver.send(:bridge), 'id')
+      assert_equal 'iVBORw0KGgoAAAANSUhEUgAABDgAAAB+CAIAAABOPDa6AAAAAX', e.screenshot
+      assert_requested(:get, "#{SESSION}/element/id/screenshot", times: 1)
+    end
   end
 end