Do appium take screenshot from specific element, similar to Selenium WebDriver?

[wellavelino]

This is a

• Bug report
• [ X] Question
• Freature Request

Summary

I’ve searched a way to take screenshot from specific element on mobile automation, using appium is possible?

Environment

• Appium version (or git revision): v1.7.1
• ruby_lib version: 9.7.5
• Mobile platform/version/device under test:
  Android/IOs

[mykola-mokhnach]

This is not supported natively now. However you could take the full page screenshot, get element rectangle and then crop the necessary area.

[KazuCocoa]

Thanks for the response! @mykola-mokhnach

@wellavelino As mentioned the above, currently the Appium has no feature to get screenshot only for particular elements.

[wellavelino]

@mykola-mokhnach thanks for you answer!

@KazuCocoa its a possible feature on future?

[KazuCocoa]

I'm not sure, but we can request a new feature(https://www.w3.org/TR/webdriver/#dfn-take-element-screenshot), I think.

[mykola-mokhnach]

@KazuCocoa this endpoint has recently been added to the base driver. It just needs to be implemented in drivers then

[wellavelino]

@mykola-mokhnach i can request this feature? this feature to become a nice to visual regression on mobile.

[KazuCocoa]

📝
https://github.com/appium/appium-base-driver/blob/090d94795add7a42d0fc25be6b8b04baff0d1134/lib/mjsonwp/routes.js#L510

[wellavelino]

@KazuCocoa looking again for this request i found this on ruby_lib_core

https://github.com/wellavelino/ruby_lib_core/blob/master/lib/appium_lib_core/common/device.rb#L582

I just needed implement on ruby_lib?

[KazuCocoa]

No.

ruby_lib just calls screenshot like below.

ruby_lib/lib/appium_lib/driver.rb

Lines 435 to 437 in f58dace

	def screenshot(png_save_path)
	@driver.save_screenshot png_save_path
	end

And you can access the @driver via

ruby_lib/lib/appium_lib/driver.rb

Line 71 in f58dace

attr_reader :driver

You can call core driver methods via:

$driver.driver.take_element_screenshot 'filename'
# or
driver.take_element_screenshot 'filename'

[wellavelino]

So what about this method?

ruby_lib/lib/appium_lib/driver.rb

Line 449 in f58dace

def element_screenshot(element, png_save_path)

[KazuCocoa]

ah, that is take_element_screenshot. It's the same thing.

[wellavelino]

@KazuCocoa the last question, i've tryng to use the take_element_screenshot and receive the following error:

on my class i have this implementation:

def take_element_screenshot element = find_element(:id, search_title_field) element_screenshot(element, File.path('../../screenshots')) end

uninitialized constant #<Class:Appium::Core::Device>::WebDriver (NameError) ./features/android/screens/BuscaScreen.rb:14:intake_element_screenshot'`

[HTTP] --> GET /wd/hub/session/5eb12084-9efe-4598-ae19-9732ba0ec4c4/element/8b474d4f-d0c5-45d6-9e70-27ca7f84285f/screenshot {} [debug] [MJSONWP] Calling AppiumDriver.getElementScreenshot() with args: ["8b474d4f-d0c5-45d6-9e70-27ca7f84285f","5eb12084-9efe-4598-ae19-9732ba0ec4c4"] [debug] [JSONWP Proxy] Proxying [GET /element/8b474d4f-d0c5-45d6-9e70-27ca7f84285f/screenshot] to [GET http://localhost:8200/wd/hub/session/b12a39cb-8dbc-4bb4-acef-2ebf5b6de1b5/element/8b474d4f-d0c5-45d6-9e70-27ca7f84285f/screenshot] with body: {} [debug] [JSONWP Proxy] Got response with status 200: "{\"sessionId\":\"b12a39cb-8dbc-4bb4-acef-2ebf5b6de1b5\",\"status\":0,\"value\":\"iVBORw0KGgoAAAANSUhEUgAAAkUAAAB2CAIAAABJbXC8AAAAA3NCSVQICAjb4U\\/gAAAIhUlEQVR4\\nnO3dy09aUQLH8cNTEFpFlKJYqQ\\/UVK2Lxoimxqirpvv+DfMvzB8z\\/0FXTbroJH0kTasVrdGmTxtF\\nKr7wQUQEryCzILlzBys4QEWO38\\/qXO65ntNNfzn3nodOURQBAECV01e6AwAAlAF5BgCQAXkGAJAB\\neQYAkAF5BgCQAXkGAJABeQYAkAF5BgCQAXkGAJABeQYAkAF5BgCQAXkGAJABeQYAkAF5BgCQAXkG\\nAJABeQYAkAF5BgCQAXkGAJABeQYAkAF5BgCQAXkGAJABeQYAkAF5BgCQAXkGAJABeQYAkAF5BgCQ\\nAXkGAJABeQYAkAF5BgCQAXkGAJABeQYAkAF5BgCQAXkGAJABeQYAkAF5BgCQAXkGAJABeQYAkAF5\\nBgCQAXkGAJCBsdId+K+1tTVFUdRLl8tVV1dXwf7s7u4eHBxkyyaT6d69exXsDAAgv+uSZysrK+\\/e\\nvVMvm5qa2tvbK9gfIcTq6urXr1+z5draWvIMAK6zwnm2uLioHTaVQq\\/XP3z48PzviURifn5evayv\\nr5+YmDAar0vWAgCuv8KZ8ePHj0QiUZbGLsqzQCBwfHycLdvt9omJCavVWpYWAQA3ROXngwSDwWAw\\nmC1bLJbx8fHbt29XtEcAgOpT4Xd6Jycnc3NzmUxGCGEymcbGxhobG3PqrK6uBgIB9fLp06dX2kUA\\nQDUonGd+vz+VSl109\\/j4WPvpa2BgoL6+\\/qLKen3ucDAQCMTjcSGEwWAYHR1taWk5\\/1QqlSrXC08A\\ngKwK51lbW1ueu5ubm9rL+vr6jo6OS7atKIrBYOjq6hJCuN1uJhAC... [debug] [MJSONWP] Responding to client with driver.getElementScreenshot() result: "iVBORw0KGgoAAAANSUhEUgAAAkUAAAB2CAIAAABJbXC8AAAAA3NCSVQICAjb4U/gAAAIhUlEQVR4\nnO3dy09aUQLH8cNTEFpFlKJYqQ/UVK2Lxoimxqirpvv+DfMvzB8z/0FXTbroJH0kTasVrdGmTxtF\nKr7wQUQEryCzILlzBys4QEWO38/qXO65ntNNfzn3nodOURQBAECV01e6AwAAlAF5BgCQAXkGAJAB\neQYAkAF5BgCQAXkGAJABeQYAkAF5BgCQAXkGAJABeQYAkAF5BgCQAXkGAJABeQYAkAF5BgCQAXkG\nAJABeQYAkAF5BgCQAXkGAJABeQYAkAF5BgCQAXkGAJABeQYAkAF5BgCQAXkGAJABeQYAkAF5BgCQ\nAXkGAJABeQYAkAF5BgCQAXkGAJABeQYAkAF5BgCQAXkGAJABeQYAkAF5BgCQAXkGAJABeQYAkAF5\nBgCQAXkGAJCBsdId+K+1tTVFUdRLl8tVV1dXwf7s7u4eHBxkyyaT6d69exXsDAAgv+uSZysrK+/e\nvVMvm5qa2tvbK9gfIcTq6urXr1+z5draWvIMAK6zwnm2uLioHTaVQq/XP3z48PzviURifn5evayv\nr5+YmDAar0vWAgCuv8KZ8ePHj0QiUZbGLsqzQCBwfHycLdvt9omJCavVWpYWAQA3ROXngwSDwWAw\nmC1bLJbx8fHbt29XtEcAgOpT4Xd6Jycnc3NzmUxGCGEymcbGxhobG3PqrK6uBgIB9fLp06dX2kUA\nQDUonGd+vz+VSl109/j4WPvpa2BgoL6+/qLKen3ucDAQCMTjcSGEwWAYHR1taWk5/1QqlSrXC08A\ngKwK51lbW1ueu5ubm9rL+vr6jo6OS7atKIrBYOjq6hJCuN1uJhACAIpWyfeNZrN5ZGSkgh0AAEij\n8vNBAAAoHWu8yiyVSu3v78fjcUVRLBaLzWY7P8MFAFB2lcyzpaWlnz9/Zss2m+3x48fqrZcvX8Zi\nsWw5nU...

[KazuCocoa]

the error is https://github.com/appium/ruby_lib_core/blob/master/lib/appium_lib_core/common/device.rb#L588 and the initialisation itself is ruby_lib_core side. You should set .png extention as the file name as same as screenshot method.

[wellavelino]

Nice!
Thank you so much @KazuCocoa, when i opened this issue i don't know about this method on ruby_lib.
Now can i use visual regression with appium :)