saucelabs/screenshot-stitching

Name: screenshot-stitching

Owner: Sauce Labs

Description: Stitches together images to provide a long screenshot of a webpage on an iOS device

Created: 2015-11-04 10:55:22.0

Updated: 2017-10-12 14:13:44.0

Pushed: 2016-07-08 12:48:35.0

Homepage: null

Size: 95

Language: Java

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Screenshot Stitching example on TestObject

This script will visit a list of websites on a TestObject iOS device, and save a “stitched screenshot” of each one, saving the results locally.

Instructions

The test reads environment variables for configuration:

• TESTOBJECT_API_KEY (required)
• TESTOBJECT_APP_ID (default is 1, match this up to the ID in the App Versions section of your app on TestObject)
• TESTOBJECT_DEVICE (default is iPhone_6S_Plus_16GB_real_ABP_off_private)
• TESTOBJECT_APPIUM_VERSION (default is 1.4.16)
• WEBSITE_LIST_FILE (default is websites.txt)
• SKIP_EXISTING_SCREENSHOTS (default is false)

Testing with ABP off

The defaults are set to test with ABP off. You are still free to modify settings via environment variables if you wish.

Testing with ABP on

• Set TESTOBJECT_APP_ID to comma separated list of values, the first element of which is the ID of your web test, and the second of which is the ID of the Adblock Plus app, which will be installed as a dependency. For example, TESTOBJECT_APP_ID=1,2
• Set TESTOBJECT_DEVICE to iPhone_6S_Plus_16GB_real_ABP_on_private

Running test

• Set environment variables, as in the Instructions section
• To compile and run from source: gradle clean test
• Or to run a release build, java -jar screenshot-stitching-1.3.1-all.jar
• The test will run through each URL in websites.txt (a newline separated list), and save each screenshot to iPhone_6S_Plus_16GB_real_ABP_off_private/http.www.example.com/restofurl.png

Notes

• To crop out the top and bottom Safari UI elements of the screenshot, hardcoded values are used on our backend for now, which are designed to work with an iPhone 6S Plus. Using this command on other devices may provide unexpected results.
• Some websites have a header or footer which is fixed in position. We make no attempt to mitigate this, and as a result you'll likely see the header/footer element repeated in each screenshot.
• You can also skip existing screenshots by passing in the --skipExistingScreenshots parameter, though this does not with the gradle build.