Skip to main content

A Robot Framework Library for image comparisons

Project description

ImageCompare Library for Robot Framework®

A library for simple screenshot comparison. Supports image files like .png and .jpg.

Image Parts can be ignored via simple coordinate masks or area masks.

See Keyword Documentation for more information.

Install robotframework-imagecompare

Installation via pip

  • pip install --upgrade robotframework-imagecompare

Examples

Check the /atest/Compare.robot test suite for some examples.

Testing with Robot Framework

*** Settings ***
Library    ImageCompare

*** Test Cases ***
Compare two Images and highlight differences
    Compare Images    Reference.jpg    Candidate.jpg

Use masks/placeholders to exclude parts from visual comparison

*** Settings ***
Library    ImageCompare

*** Test Cases ***
Compare two Images and ignore parts by using masks
    Compare Images    Reference.jpg    Candidate.jpg    placeholder_file=masks.json

Compare two PDF Docments and ignore parts by using masks
    Compare Images    Reference.jpg    Candidate.jpg    placeholder_file=masks.json

Different Mask Types to Ignore Parts When Comparing

Areas, Coordinates
[
    {
    "page": "1",
    "name": "Top Border",
    "type": "area",
    "location": "top",
    "percent":  5
    },
    {
    "page": "1",
    "name": "Left Border",
    "type": "area",
    "location": "left",
    "percent":  5
    },
    {
    "page": 1,
    "name": "Top Rectangle",
    "type": "coordinates",
    "x": 0,
    "y": 0,
    "height": 10,
    "width": 210,
    "unit": "mm"
    }
]

More info will be added soon

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

robotframework_imagecompare-0.2.0.tar.gz (11.3 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file robotframework_imagecompare-0.2.0.tar.gz.

File metadata

File hashes

Hashes for robotframework_imagecompare-0.2.0.tar.gz
Algorithm Hash digest
SHA256 a1b0a4e6719683172456bacdd496501dce420459e55b96e3813b74d13f9e50e7
MD5 deaacc952962699f003dcde200573887
BLAKE2b-256 df580dd8a779f80774435fc5ca6287e77f4f6b6634b964770c6240c03574a959

See more details on using hashes here.

File details

Details for the file robotframework_imagecompare-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for robotframework_imagecompare-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 42b916f7905fb95ec09d00514d02343629d1099defe5edf8d7f2febb7480e21b
MD5 70d7ec8fc26029e105c2a0977fce0f91
BLAKE2b-256 d00ee8889af20b4384a0afe5c1e99f96903d6c9e26f1ac3c1e68f5b8040fead1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page