wordpress-develop/tests/phpunit/tests/image/base.php
Sergey Biryukov ddb409edca Build/Test Tools: Implement use of the void solution.
> PHPUnit 8.0.0 introduced a `void` return type declaration to the "fixture" methods – `setUpBeforeClass()`, `setUp()`, `tearDown()` and `tearDownAfterClass()`. As the `void` return type was not introduced until PHP 7.1, this makes it more difficult to create cross-version compatible tests when using fixtures, due to signature mismatches.
>
> The `Yoast\PHPUnitPolyfills\TestCases\TestCase` overcomes the signature mismatch by having two versions. The correct one will be loaded depending on the PHPUnit version being used.
>
> When using this TestCase, if an individual test, or another TestCase which extends this TestCase, needs to overload any of the "fixture" methods, it should do so by using a snake_case variant of the original fixture method name, i.e. `set_up_before_class()`, `set_up()`, `assert_pre_conditions()`, `assert_post_conditions()`, `tear_down()`, and `tear_down_after_class()`.
>
> The snake_case methods will automatically be called by PHPUnit.
>
> > IMPORTANT: The snake_case methods should not call the PHPUnit parent, i.e. do not use `parent::setUp()` from within an overloaded `set_up()` method. If necessary, DO call `parent::set_up()`.

Reference: https://github.com/Yoast/PHPUnit-Polyfills#testcases

This commit renames all declared fixture methods, and calls to parent versions of those fixture methods, from camelCase to snake_case.

Follow-up to [51559-51567].

Props jrf, hellofromTonya, johnbillion, netweb, dd32, pputzer, SergeyBiryukov.
See #46149.

git-svn-id: https://develop.svn.wordpress.org/trunk@51568 602fd350-edb4-49c9-b593-d223f7449a82
2021-08-07 10:29:41 +00:00

84 lines
2.2 KiB
PHP

<?php
/**
* @group image
*/
abstract class WP_Image_UnitTestCase extends WP_UnitTestCase {
/**
* Set the image editor engine according to the unit test's specification
*/
public function set_up() {
parent::set_up();
if ( ! call_user_func( array( $this->editor_engine, 'test' ) ) ) {
$this->markTestSkipped( sprintf( 'The image editor engine %s is not supported on this system.', $this->editor_engine ) );
}
add_filter( 'wp_image_editors', array( $this, 'setEngine' ), 10, 2 );
}
/**
* Override the image editor engine
*
* @return string
*/
public function setEngine( $editors ) {
return array( $this->editor_engine );
}
/**
* Helper assertion for testing alpha on images using GD library
*
* @param string $image_path
* @param array $point array(x,y)
* @param int $alpha
*/
protected function assertImageAlphaAtPointGD( $image_path, $point, $alpha ) {
$im = imagecreatefrompng( $image_path );
$rgb = imagecolorat( $im, $point[0], $point[1] );
$colors = imagecolorsforindex( $im, $rgb );
$this->assertSame( $alpha, $colors['alpha'] );
}
/**
* Helper assertion for testing alpha on images using Imagick
*
* @param string $image_path
* @param array $point array(x,y)
* @param int $expected
*/
protected function assertImageAlphaAtPointImagick( $image_path, $point, $expected ) {
$im = new Imagick( $image_path );
$pixel = $im->getImagePixelColor( $point[0], $point[1] );
$color = $pixel->getColorValue( imagick::COLOR_ALPHA );
$this->assertSame( $expected, $color );
}
/**
* Helper assertion to check actual image dimensions on disk
*
* @param string $filename Image filename.
* @param int $width Width to verify.
* @param int $height Height to verify.
*/
protected function assertImageDimensions( $filename, $width, $height ) {
$detected_width = 0;
$detected_height = 0;
$image_size = getimagesize( $filename );
if ( isset( $image_size[0] ) ) {
$detected_width = $image_size[0];
}
if ( isset( $image_size[1] ) ) {
$detected_height = $image_size[1];
}
$this->assertSame( $width, $detected_width );
$this->assertSame( $height, $detected_height );
}
}