wordpress-develop/tests/phpunit/tests/image/intermediateSize.php

<?php
/**
 * @group image
 * @group media
 * @group upload
 */
class Tests_Image_Intermediate_Size extends WP_UnitTestCase {
	public function tear_down() {
		$this->remove_added_uploads();

		remove_image_size( 'test-size' );
		remove_image_size( 'false-height' );
		remove_image_size( 'false-width' );
		remove_image_size( 'off-by-one' );
		parent::tear_down();
	}

	public function _make_attachment( $file, $parent_post_id = 0 ) {
		$contents = file_get_contents( $file );
		$upload   = wp_upload_bits( wp_basename( $file ), null, $contents );

		return parent::_make_attachment( $upload, $parent_post_id );
	}

	public function test_make_intermediate_size_no_size() {
		$image = image_make_intermediate_size( DIR_TESTDATA . '/images/a2-small.jpg', 0, 0, false );

		$this->assertFalse( $image );
	}

	/**
	 * @requires function imagejpeg
	 */
	public function test_make_intermediate_size_width() {
		$image = image_make_intermediate_size( DIR_TESTDATA . '/images/a2-small.jpg', 100, 0, false );

		$this->assertIsArray( $image );
	}

	/**
	 * @requires function imagejpeg
	 */
	public function test_make_intermediate_size_height() {
		$image = image_make_intermediate_size( DIR_TESTDATA . '/images/a2-small.jpg', 0, 75, false );

		$this->assertIsArray( $image );
	}

	/**
	 * @requires function imagejpeg
	 */
	public function test_make_intermediate_size_successful() {
		$image = image_make_intermediate_size( DIR_TESTDATA . '/images/a2-small.jpg', 100, 75, true );

		unlink( DIR_TESTDATA . '/images/a2-small-100x75.jpg' );

		$this->assertIsArray( $image );
		$this->assertSame( 100, $image['width'] );
		$this->assertSame( 75, $image['height'] );
		$this->assertSame( 'image/jpeg', $image['mime-type'] );

		$this->assertArrayNotHasKey( 'path', $image );
	}

	/**
	 * @ticket 52867
	 * @requires function imagejpeg
	 */
	public function test_image_editor_output_format_filter() {
		add_filter(
			'image_editor_output_format',
			static function () {
				return array( 'image/jpeg' => 'image/webp' );
			}
		);

		$file   = DIR_TESTDATA . '/images/waffles.jpg';
		$image  = image_make_intermediate_size( $file, 100, 75, true );
		$editor = wp_get_image_editor( $file );

		unlink( DIR_TESTDATA . '/images/' . $image['file'] );
		remove_all_filters( 'image_editor_output_format' );

		if ( is_wp_error( $editor ) || ! $editor->supports_mime_type( 'image/webp' ) ) {
			$this->assertSame( 'image/jpeg', $image['mime-type'] );
		} else {
			$this->assertSame( 'image/webp', $image['mime-type'] );
		}
	}

	/**
	 * @ticket 17626
	 * @requires function imagejpeg
	 */
	public function test_get_intermediate_sizes_by_name() {
		add_image_size( 'test-size', 330, 220, true );

		$file = DIR_TESTDATA . '/images/waffles.jpg';
		$id   = $this->_make_attachment( $file, 0 );

		// Look for a size by name.
		$image = image_get_intermediate_size( $id, 'test-size' );

		// Cleanup.
		remove_image_size( 'test-size' );

		// Test for the expected string because the array will by definition
		// return with the correct height and width attributes.
		$this->assertStringContainsString( '330x220', $image['file'] );
	}

	/**
	 * @ticket 17626
	 * @requires function imagejpeg
	 */
	public function test_get_intermediate_sizes_by_array_exact() {
		// Only one dimention match shouldn't return false positive (see: #17626).
		add_image_size( 'test-size', 330, 220, true );
		add_image_size( 'false-height', 330, 400, true );
		add_image_size( 'false-width', 600, 220, true );

		$file = DIR_TESTDATA . '/images/waffles.jpg';
		$id   = $this->_make_attachment( $file, 0 );

		// Look for a size by array that exists.
		// Note: Staying larger than 300px to miss default medium crop.
		$image = image_get_intermediate_size( $id, array( 330, 220 ) );

		// Test for the expected string because the array will by definition
		// return with the correct height and width attributes.
		$this->assertStringContainsString( '330x220', $image['file'] );
	}

	/**
	 * @ticket 17626
	 * @requires function imagejpeg
	 */
	public function test_get_intermediate_sizes_by_array_nearest() {
		// If an exact size is not found, it should be returned.
		// If not, find nearest size that is larger (see: #17626).
		add_image_size( 'test-size', 450, 300, true );
		add_image_size( 'false-height', 330, 100, true );
		add_image_size( 'false-width', 150, 220, true );

		$file = DIR_TESTDATA . '/images/waffles.jpg';
		$id   = $this->_make_attachment( $file, 0 );

		// Look for a size by array that doesn't exist.
		// Note: Staying larger than 300px to miss default medium crop.
		$image = image_get_intermediate_size( $id, array( 330, 220 ) );

		// Test for the expected string because the array will by definition
		// return with the correct height and width attributes.
		$this->assertStringContainsString( '450x300', $image['file'] );
	}

	/**
	 * @ticket 17626
	 * @requires function imagejpeg
	 */
	public function test_get_intermediate_sizes_by_array_nearest_false() {
		// If an exact size is not found, it should be returned.
		// If not, find nearest size that is larger, otherwise return false (see: #17626).
		add_image_size( 'false-height', 330, 100, true );
		add_image_size( 'false-width', 150, 220, true );

		$file = DIR_TESTDATA . '/images/waffles.jpg';
		$id   = $this->_make_attachment( $file, 0 );

		// Look for a size by array that doesn't exist.
		// Note: Staying larger than 300px to miss default medium crop.
		$image = image_get_intermediate_size( $id, array( 330, 220 ) );

		// Test for the expected string because the array will by definition
		// return with the correct height and width attributes.
		$this->assertFalse( $image );
	}

	/**
	 * @ticket 17626
	 * @requires function imagejpeg
	 */
	public function test_get_intermediate_sizes_by_array_zero_height() {
		// Use this width.
		$width = 300;

		// Only one dimention match shouldn't return false positive (see: #17626).
		add_image_size( 'test-size', $width, 0, false );
		add_image_size( 'false-height', $width, 100, true );

		$file = DIR_TESTDATA . '/images/waffles.jpg';
		$id   = $this->_make_attachment( $file, 0 );

		$original = wp_get_attachment_metadata( $id );
		$image_w  = $width;
		$image_h  = round( ( $image_w / $original['width'] ) * $original['height'] );

		// Look for a size by array that exists.
		// Note: Staying larger than 300px to miss default medium crop.
		$image = image_get_intermediate_size( $id, array( $width, 0 ) );

		// Test for the expected string because the array will by definition
		// return with the correct height and width attributes.
		$this->assertStringContainsString( $image_w . 'x' . $image_h, $image['file'] );
	}

	/**
	 * @ticket 17626
	 * @ticket 34087
	 * @requires function imagejpeg
	 */
	public function test_get_intermediate_sizes_by_array_zero_width() {
		// 202 is the smallest height that will trigger a miss for 'false-height'.
		$height = 202;

		// Only one dimention match shouldn't return false positive (see: #17626).
		add_image_size( 'test-size', 0, $height, false );
		add_image_size( 'false-height', 300, $height, true );

		$file = DIR_TESTDATA . '/images/waffles.jpg';
		$id   = $this->_make_attachment( $file, 0 );

		$original = wp_get_attachment_metadata( $id );
		$image_h  = $height;
		$image_w  = round( ( $image_h / $original['height'] ) * $original['width'] );

		// Look for a size by array that exists.
		// Note: Staying larger than 300px to miss default medium crop.
		$image = image_get_intermediate_size( $id, array( 0, $height ) );

		// Test for the expected string because the array will by definition
		// return with the correct height and width attributes.
		$this->assertStringContainsString( $image_w . 'x' . $image_h, $image['file'] );
	}

	/**
	 * @ticket 17626
	 * @ticket 34087
	 * @requires function imagejpeg
	 */
	public function test_get_intermediate_sizes_should_match_size_with_off_by_one_aspect_ratio() {
		// Original is 600x400. 300x201 is close enough to match.
		$width  = 300;
		$height = 201;
		add_image_size( 'off-by-one', $width, $height, true );

		$file = DIR_TESTDATA . '/images/waffles.jpg';
		$id   = $this->_make_attachment( $file, 0 );

		$original = wp_get_attachment_metadata( $id );
		$image_h  = $height;
		$image_w  = round( ( $image_h / $original['height'] ) * $original['width'] );

		// Look for a size by array that exists.
		// Note: Staying larger than 300px to miss default medium crop.
		$image = image_get_intermediate_size( $id, array( 0, $height ) );

		$this->assertStringContainsString( $width . 'x' . $height, $image['file'] );
	}

	/**
	 * @ticket 34384
	 * @requires function imagejpeg
	 */
	public function test_get_intermediate_size_with_small_size_array() {
		// Add a hard cropped size that matches the aspect ratio we're going to test.
		add_image_size( 'test-size', 200, 100, true );

		$file = DIR_TESTDATA . '/images/waffles.jpg';
		$id   = $this->_make_attachment( $file, 0 );

		// Request a size by array that doesn't exist and is smaller than the 'thumbnail'.
		$image = image_get_intermediate_size( $id, array( 50, 25 ) );

		// We should get the 'test-size' file and not the thumbnail.
		$this->assertStringContainsString( '200x100', $image['file'] );
	}

	/**
	 * @ticket 34384
	 * @requires function imagejpeg
	 */
	public function test_get_intermediate_size_with_small_size_array_fallback() {
		$file = DIR_TESTDATA . '/images/waffles.jpg';
		$id   = $this->_make_attachment( $file, 0 );

		$original       = wp_get_attachment_metadata( $id );
		$thumbnail_file = $original['sizes']['thumbnail']['file'];

		// Request a size by array that doesn't exist and is smaller than the 'thumbnail'.
		$image = image_get_intermediate_size( $id, array( 50, 25 ) );

		// We should get the 'thumbnail' file as a fallback.
		$this->assertSame( $image['file'], $thumbnail_file );
	}
}