Files
appium/packages/images-plugin
Christopher Hiller f6e6d7234e Publish
- appium@2.0.0-beta.41
 - @appium/base-driver@8.6.0
 - @appium/base-plugin@1.10.0
 - @appium/doctor@1.16.23
 - @appium/docutils@0.0.8
 - @appium/eslint-config-appium@6.0.3
 - @appium/execute-driver-plugin@2.0.3
 - @appium/fake-driver@4.0.2
 - @appium/fake-plugin@2.0.4
 - @appium/gulp-plugins@7.0.3
 - @appium/images-plugin@1.3.3
 - @appium/opencv@1.0.10
 - @appium/relaxed-caps-plugin@1.0.0-beta.10
 - @appium/schema@0.0.8
 - @appium/support@2.59.3
 - @appium/test-support@1.4.0
 - @appium/types@0.3.0
 - @appium/universal-xml-plugin@1.0.0-beta.12
2022-07-28 14:34:54 -07:00
..
2022-04-14 14:30:00 -07:00
2022-05-26 12:07:17 -07:00
2022-07-18 15:58:21 -07:00
2022-07-28 14:34:54 -07:00
2022-04-14 14:30:00 -07:00
2022-07-28 14:34:54 -07:00
2022-04-14 14:30:00 -07:00

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

  • OpenCV 3.x native libraries
  • opencv4nodejs NPM module: install with npm i -g opencv4nodejs. By default the preinstall script of this module also downloads and makes all the required OpenCV libs from source, but this requires developer tools to be available on the host system.
  • 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.