Skip to main content

Compare GUi with RobotFramework

Project description

WatchUI

Basic Info

Custom library for comparing images with use in Robot Framework.

What is here?

  • Test robot/test.robot - file with examples how to use keywords
  • WatchUI/WatchUI.py - file with keywords

What you need

Pip install

WatchUI

  1. Open CMD
  2. Start pip install WatchUI
  3. Now you can download WatchUI.py from repository or import WatchUI to new python file more here
  4. If you download WatchUI.py: You must first enter the path in Settings => Library path, where path is the path to the WatchUI.py file

Manual Install

Main

How to install in RF

  • Download git file (Mainly ./Python/WatchUI.py)
  • Enter the path in Settings => Library path, where path is the path to the WatchUI.py file
  • Now you can start using keywords listed below. Keep in mind that you need to have all dependencies installed.

Description Keyword

Images must have same resolution!!!!

  • In folder Robot framework you can find some example
Keyword Arguments Documentation
Compare images path1,
path2,
save_folder=
This compares two images. If there are differences it saves an image with the differences highlighted into the folder.

path1 = path to the first image to be compared

path2 = path to the second image to be compared
save_folder= the path where you want to save the image with the highlighted differences. Default folder is ../Compare_images

Example: Compare two images ../image1.png ../Image2.png

Compare screen path1,
save_folder=
Compares a saved image with what is displayed on the screen. If there is a difference it saves an image with the differences highlighted to the save_folder

path1 = path to the image to be compared to screen
save_folder= the path where you want to save the image with the highlighted differences. Default folder is ../Compare_screen

Example: Compare screen ../image1.png
Create area x1, y1, x2, y2,
save_folder=
Creates a cut-out area of what is displayed on the screen and saves it in the folder: ../Create area

x1 a y1 = x and y coordinates for the upper left corner of the square

x2 and y2 = x and y coordinates for the bottom right corner of the square
save_folder= the path where you want to save the image with the cut out area. Default folder is ../Create_area

Example: Create area 0 0 25 25

Compare screen areas x1, y1, x2, y2,
path1,
save_folder=
Compares area of the screen with a previously created cut out image area.

x1 and y1 = x and y coordinates for the upper left corner of the region

x2 and y2 = x and y coordinates for the bottom right corner of the region
path1 = the path to an already created image (region) with which we want to compare the region selected at screen
save_folder= path where you want to save the image with the highlighted differences. Default folder is ../Compare_screen_areas

Example: Compare screen areas 0 0 25 25 ../Crop_Image1.png
Compare screen without areas path1
*args,
save_folder=
Compares pictures (screenshot and image file) with areas to be ignored

x1 and y1 = x and y coordinates for the upper left corner of the area to be ignored

x2 and y2 = coordinates for the lower right corner of the area to be ignored
save_folder= the path where you want to save the image with the highlighted differences. Default folder is ../Compare_screen_without_areas

Attention! It is always necessary to enter in order x1 y1 x2 y2 x1 y1 x2 y2 etc ...

Example: Compare screen without areas ../Image1.png 0 0 30 40 50 50 100 100
Creates 2 ignored parts at 0,0, 30,40 and 50, 50, 100, 100
Create screens *resolution
save_folder=
screen_name=
Creates a screenshot of the screen with specified resolution. It is possible in one command to create an infinite number of screens with different resolutions. Screens are stored in the folder: ../Create_screens

*resolution = The specified resolution in width and height format, you can enter as many as needed
save_folder= path where you want to save the image with the highlighted differences. Default folder is ../Create_screens
screen_name= the path where you want to save the image with the highlighted differences. Default name is (it is not mandatory to set it up)

Example: compare making rescreens 800 600 1280 800 1440 900
Creates 3 screens in 800x600 1280x800 and 1440x900
Compare screen get information path1,
save_folder=,
folder_csv=
Compares an already saved image with what is displayed on the screen. If there is a difference, it saves an image with the highlighted differences to the: ../save_folder and creates a csv file with the coordinates and elements that exist on those coordinates

*path1 = path to the image to be compared

*path1 = path to the image to be compared
save_folder= path where you have save img
folder_csv= folder for csv file with save coordinates. Default folder is ../CSV_ERROR

Example: compare screen get information 1c.png
Compare img 1c.png with screen and save img with diff and save csv file with elements on this coordinates

Sample results

Image where the differences are stored + You can see two black box in left corner. These black box are ignored during comparison.

The red rectangles outlining missing elements on compared screens

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

WatchUI-0.16.1.tar.gz (7.2 kB view details)

Uploaded Source

Built Distribution

WatchUI-0.16.1-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file WatchUI-0.16.1.tar.gz.

File metadata

  • Download URL: WatchUI-0.16.1.tar.gz
  • Upload date:
  • Size: 7.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.7

File hashes

Hashes for WatchUI-0.16.1.tar.gz
Algorithm Hash digest
SHA256 3d08a3c14f290a40a0ac4e30bd2966470c0f965c6ae737379b139ebfcaaada6c
MD5 f36e10ea912ca803ab673ea098ec2bdd
BLAKE2b-256 73e22e76c78fc195b222b1cae2c63f9e0b19acf69b21827a376fc32dad99e204

See more details on using hashes here.

Provenance

File details

Details for the file WatchUI-0.16.1-py3-none-any.whl.

File metadata

  • Download URL: WatchUI-0.16.1-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.42.1 CPython/3.7.7

File hashes

Hashes for WatchUI-0.16.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ae1be83a13bf5bc26c416588d073b6031a89dbd5b94b1a5e84900c495d068cea
MD5 f9024b396d8682d4c7899c765754b4b0
BLAKE2b-256 fd8ec0f6d44e114ac60cf4c855bdc1a82193ae8d9e935e27d63f34fda0b37358

See more details on using hashes here.

Provenance

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