images

THIS PROJECT IS ARCHIVED. ALL PACKAGES IN THIS REPO HAVE MOVED INTO THE MAIN APPIUM REPO at https://github.com/appium/appium

Note:

• Package names have not changed, but the directory names all have the -plugin suffix. They still live in the packages/ subdir.
• As of this writing (April 14 2022), the packages are not in the master branch--they are in the 2.0 branch--but will be in the default branch (main) in the near future.

---

Appium Images Plugin

This is an official Appium plugin designed to facilitate image comparison, visual testing, and image-based functional testing.

Features

1. Image Comparison (docs) - A new Appium command and route that allows sending in two different images and comparing them in various ways.
2. Finding Elements by Image (docs) - Using a template image, find a matching screen region of an app and interact with it via standard Appium element semantics.

Prerequisites

• Appium Server 2.0+

Installation - Server

Install the plugin using Appium's plugin CLI:

appium plugin install images

Installation - Client

No special action is needed to make the features available in the various Appium clients, as this plugin used to be a core Appium feature and its commands are already supported in the official clients.

Activation

The plugin will not be active unless turned on when invoking the Appium server:

appium --use-plugins=images

Usage

Check the docs links above for usage for each of the features provided.