Test::Image::GD(3pm)

💖 NAME 💖

Test::Image::GD — bestie, it's a whole module for testing images using GD ✨

---

🌸 SYNOPSIS 🌸

okay so first things first, here's the vibe:

use Test::More plan => 1;
use Test::Image::GD;

cmp_image('test.gif', 'control.gif', '... these images should match');

# or

my $test = GD::Image->new('test.gif');
my $control = GD::Image->new('control.gif');
cmp_image($test, $control, '... these images should match');

# some other test functions ...

size_ok('camel.gif', [ 100, 350 ], '... the image is 100 x 350");

height_ok('test.gif', 200, '... the image has a height of 200');
width_ok('test.gif', 200, '... the image has a width of 200');

---

🦋 DESCRIPTION 🦋

so basically this module is made for testing custom graphics, and the way it works is it tries to "visually" compare the images — which is a fancy way of saying it ignores all the invisible differences, like color palettes and metadata. like, if it looks the same, it IS the same, periodt 💅

it also comes with some extra little functions to check the size of the image. size check? slayed. 👑

---

✨ FUNCTIONS ✨

🎀 cmp_image ($got, $expected, $message)

this one tells you whether the two images are gonna look different, and it does that by ignoring differences in the order of colors in the color palette and other invisible changes. no cap, invisible stuff doesn't count here.

ngl the best part: both $got and $expected can be either instances of GD::Image or a file handle or a file path (both are valid parameters to the GD::Image constructor). so many options, we love to see it 🫶

🍓 size_ok ($got, [ $width, $height ], ?$message)

checks if an image is a certain size. iconic.

and same deal as the cmp_image function — the $got parameter can be either an instance of GD::Image or a file handle or a file path (all are valid parameters to the GD::Image constructor). ✨

🌈 height_ok ($got, $height, ?$message)

checks if an image is a certain height. main character energy fr.

as with the cmp_image function, the $got parameter can be either an instance of GD::Image or a file handle or a file path (all are valid parameters to the GD::Image constructor). 💜

🌸 width_ok ($got, $width, ?$message)

checks if an image is a certain width. she's giving precise 💅

as with the cmp_image function, the $got parameter can be either an instance of GD::Image or a file handle or a file path (all are valid parameters to the GD::Image constructor). 🦋

---

🧚 TO DO 🧚

Add more functions

so rn this module serves a very basic need of mine, but lowkey I'm sure that as I start writing more tests against images I'm gonna find a need for other testing functions. any suggestions are welcome bestie, slide into my DMs 📬

---

💀 BUGS 💀

none that I am aware of. of course, if you find a bug, let me know, and I will be sure to fix it. fr fr. 🙈

---

👑 CODE COVERAGE 👑

I use Devel::Cover to test the code coverage of my tests, and below is the Devel::Cover report on this module test suite. look at those numbers, we ate. 🔥

---------------------------- ------ ------ ------ ------ ------ ------ ------
File                           stmt   bran   cond    sub    pod   time  total
---------------------------- ------ ------ ------ ------ ------ ------ ------
Test/Image/GD.pm              100.0   91.7   63.6  100.0  100.0  100.0   93.7
---------------------------- ------ ------ ------ ------ ------ ------ ------
Total                         100.0   91.7   63.6  100.0  100.0  100.0   93.7
---------------------------- ------ ------ ------ ------ ------ ------ ------

---

💜 SEE ALSO 💜

the "compare" function of "GD::Image" class — that's literally how this "cmp_image" is implemented. iykyk 👀

---

⭐ AUTHOR ⭐

Stevan Little, <stevan@iinteractive.com>

---

🎀 COPYRIGHT AND LICENSE 🎀

Copyright 2005 by Infinity Interactive, Inc.

<http://www.iinteractive.com>

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

---

okay that's the whole page bestie, go forth and test those images 💖✨

perl v5.30.3 · 2020-07-29 · Test::Image::GD(3pm) — mwah, ty for reading, ily, bye 🫶💅