lupka / phpunit-compare-images
PHPUnit assertions for comparing image similarity.
Installs: 57 780
Dependents: 5
Suggesters: 0
Security: 0
Stars: 5
Watchers: 2
Forks: 2
Open Issues: 0
Type:package
Requires (Dev)
- ext-imagick: *
- phpunit/phpunit: >=5.2
This package is auto-updated.
Last update: 2024-10-25 19:50:03 UTC
README
PHPUnit assertions for assessing image similarity.
IMPORTANT: You may run into issues comparing different-sized images depending on your setup. I haven't been able to assess for certain what the issue is, but comparing different sized images works fine for me locally on OSX, but my tests fail in Travis CI if I use images with different sizes.
Installation
composer require lupka/phpunit-compare-images
Usage
Add the CompareImagesTrait
trait to your test class to enable the use of the assertions.
<?php use Lupka\PHPUnitCompareImages\CompareImagesTrait; class YourTestCase extends PHPUnit_Framework_TestCase { use CompareImagesTrait; ... }
Assertions
This package includes several assertions.
The first two parameters of each assertion are the images to be compared, which can either be Imagick objects or string file paths.
assertImageSimilarity
assertImageSimilarity($image1, $image2, $threshold = 0)
Will fail if the two images ARE NOT within the given similarity threshold.
assertImageDifference
assertImageDifference($image1, $image2, $threshold = 0)
Will fail if the two images ARE within the given similarity threshold.
assertImagesSame
assertImagesSame($image1, $image2)
Will fail if the two images ARE NOT exactly the same.
assertImagesDifferent
assertImagesDifferent($image1, $image2)
Will fail if the two images ARE exactly the same.
What does $threshold mean?
The $threshold
value on the assertImageSimilarity and assertImageDifference functions are compared directly to the result of the compareImages function of PHP's Imagick class. Below our some examples of what threshold you would need to use variety of different comparisons.
Threshold: 0
Images are identical.
Threshold: 0.234
Different images.
Threshold: 0.033
Slightly cropped version of same image.
Threshold: 1
Black vs. white
Notes/Links
- PHP.net Imagick Compare docs: http://php.net/manual/en/imagick.compareimages.php