<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[55066] trunk/tests/phpunit/tests: Tests: Move the test for `wp_save_image_file()` with a GD resource to a more appropriate place.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/55066">55066</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/55066","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-01-14 02:06:02 +0000 (Sat, 14 Jan 2023)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Tests: Move the test for `wp_save_image_file()` with a GD resource to a more appropriate place.
When passed a GD resource as `$image`, `wp_save_image_file()` should throw a deprecated argument notice:
{{{
Function wp_save_image_file was called with an argument that is deprecated since version 3.5.0!
$image needs to be a WP_Image_Editor object.
}}}
The test verifies that the notice is thrown as expected.
Includes:
* Removing the `Tests_Functions_Deprecated` class. It appears to be initially intended for testing deprecated functions or arguments, but this was later superseded by the `@expectedDeprecated` annotation.
* Removing a redundant test for `wp_save_image_file()` **not** throwing a deprecation notice when passed a `WP_Image_Editor` instance. This is already covered by `test_wp_save_image_file()`, which would fail if there is an unexpected deprecation notice.
Follow-up to [1061/tests], <a href="https://core.trac.wordpress.org/changeset/25408">[25408]</a>, <a href="https://core.trac.wordpress.org/changeset/25409">[25409]</a>, <a href="https://core.trac.wordpress.org/changeset/53529">[53529]</a>.
See <a href="https://core.trac.wordpress.org/ticket/56793">#56793</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsimagefunctionsphp">trunk/tests/phpunit/tests/image/functions.php</a></li>
</ul>
<h3>Removed Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsfunctionsdeprecatedphp">trunk/tests/phpunit/tests/functions/deprecated.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunittestsfunctionsdeprecatedphp"></a>
<div class="delfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Deleted: trunk/tests/phpunit/tests/functions/deprecated.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/functions/deprecated.php 2023-01-13 22:11:04 UTC (rev 55065)
+++ trunk/tests/phpunit/tests/functions/deprecated.php 2023-01-14 02:06:02 UTC (rev 55066)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,185 +0,0 @@
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-<?php
-
-/**
- * Test cases for deprecated functions, arguments, and files
- *
- * @package WordPress
- * @subpackage Unit Tests
- *
- * @since 3.5.0
- *
- * @group functions.php
- * @group deprecated
- */
-class Tests_Functions_Deprecated extends WP_UnitTestCase {
-
- /**
- * List of functions that have been passed through _deprecated_function().
- *
- * @var string[]
- */
- protected $_deprecated_functions = array();
-
- /**
- * List of arguments that have been passed through _deprecated_argument().
- *
- * @var string[]
- */
- protected $_deprecated_arguments = array();
-
- /**
- * List of files that have been passed through _deprecated_file().
- *
- * @var string[]
- */
- protected $_deprecated_files = array();
-
- /**
- * Sets up the test fixture.
- */
- public function set_up() {
- parent::set_up();
- $this->_deprecated_functions = array();
- $this->_deprecated_arguments = array();
- $this->_deprecated_files = array();
- add_action( 'deprecated_function_run', array( $this, 'deprecated_function' ), 10, 3 );
- add_action( 'deprecated_function_trigger_error', '__return_false' );
- add_action( 'deprecated_argument_run', array( $this, 'deprecated_argument' ), 10, 3 );
- add_action( 'deprecated_argument_trigger_error', '__return_false' );
- add_action( 'deprecated_file_included', array( $this, 'deprecated_file' ), 10, 4 );
- add_action( 'deprecated_file_trigger_error', '__return_false' );
- }
-
- /**
- * Tears down the test fixture.
- */
- public function tear_down() {
- remove_action( 'deprecated_function_run', array( $this, 'deprecated_function' ), 10, 3 );
- remove_action( 'deprecated_function_trigger_error', '__return_false' );
- remove_action( 'deprecated_argument_run', array( $this, 'deprecated_argument' ), 10, 3 );
- remove_action( 'deprecated_argument_trigger_error', '__return_false' );
- remove_action( 'deprecated_file_included', array( $this, 'deprecated_argument' ), 10, 4 );
- remove_action( 'deprecated_file_trigger_error', '__return_false' );
- parent::tear_down();
- }
-
- /**
- * Catches functions that have passed through _deprecated_function().
- *
- * @param string $function_name
- * @param string $replacement
- * @param float $version
- */
- public function deprecated_function( $function_name, $replacement, $version ) {
- $this->_deprecated_functions[] = array(
- 'function' => $function_name,
- 'replacement' => $replacement,
- 'version' => $version,
- );
- }
-
- /**
- * Catches arguments that have passed through _deprecated_argument().
- *
- * @param string $argument
- * @param string $message
- * @param float $version
- */
- public function deprecated_argument( $argument, $message, $version ) {
- $this->_deprecated_arguments[] = array(
- 'argument' => $argument,
- 'message' => $message,
- 'version' => $version,
- );
- }
-
- /**
- * Catches arguments that have passed through _deprecated_argument().
- *
- * @param string $argument
- * @param string $message
- * @param float $version
- */
- public function deprecated_file( $file, $version, $replacement, $message ) {
- $this->_deprecated_files[] = array(
- 'file' => $file,
- 'version' => $version,
- 'replacement' => $replacement,
- 'message' => $message,
- );
- }
-
- /**
- * Checks if something was deprecated.
- *
- * @param string $type argument|function|file
- * @param string $name
- * @return array|false
- */
- protected function was_deprecated( $type, $name ) {
- switch ( $type ) {
- case 'argument':
- $search = $this->_deprecated_arguments;
- $key = 'argument';
- break;
- case 'function':
- $search = $this->_deprecated_functions;
- $key = 'function';
- break;
- default:
- $search = $this->_deprecated_files;
- $key = 'file';
- }
- foreach ( $search as $v ) {
- if ( $name === $v[ $key ] ) {
- return $v;
- }
- }
- return false;
- }
-
- /**
- * Tests that wp_save_image_file() has a deprecated argument when passed a GD resource.
- *
- * @ticket 6821
- * @expectedDeprecated wp_save_image_file
- * @requires function imagejpeg
- *
- * @covers ::wp_save_image_file
- */
- public function test_wp_save_image_file_deprecated_with_gd_resource() {
- // Call wp_save_image_file().
- require_once ABSPATH . 'wp-admin/includes/image-edit.php';
- $file = wp_tempnam();
- $img = imagecreatefromjpeg( DIR_TESTDATA . '/images/canola.jpg' );
- wp_save_image_file( $file, $img, 'image/jpeg', 1 );
- imagedestroy( $img );
- unlink( $file );
-
- // Check if the arg was deprecated.
- $check = $this->was_deprecated( 'argument', 'wp_save_image_file' );
- $this->assertNotEmpty( $check );
- }
-
- /**
- * Tests that wp_save_image_file() doesn't have a deprecated argument when passed a WP_Image_Editor.
- *
- * @ticket 6821
- * @requires function imagejpeg
- *
- * @covers ::wp_save_image_file
- */
- public function test_wp_save_image_file_not_deprecated_with_wp_image_editor() {
- // Call wp_save_image_file().
- require_once ABSPATH . 'wp-admin/includes/image-edit.php';
- $file = wp_tempnam();
- $img = wp_get_image_editor( DIR_TESTDATA . '/images/canola.jpg' );
- wp_save_image_file( $file, $img, 'image/jpeg', 1 );
- unset( $img );
- unlink( $file );
-
- // Check if the arg was deprecated.
- $check = $this->was_deprecated( 'argument', 'wp_save_image_file' );
- $this->assertFalse( $check );
- }
-}
</del></span></pre></div>
<a id="trunktestsphpunittestsimagefunctionsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/image/functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/image/functions.php 2023-01-13 22:11:04 UTC (rev 55065)
+++ trunk/tests/phpunit/tests/image/functions.php 2023-01-14 02:06:02 UTC (rev 55066)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -328,6 +328,29 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Tests that wp_save_image_file() throws a deprecated argument notice when passed a GD resource.
+ *
+ * @ticket 6821
+ * @expectedDeprecated wp_save_image_file
+ * @requires function imagejpeg
+ *
+ * @covers ::wp_save_image_file
+ */
+ public function test_wp_save_image_file_deprecated_argument_with_gd_resource() {
+ require_once ABSPATH . 'wp-admin/includes/image-edit.php';
+
+ // Call wp_save_image_file().
+ $file = wp_tempnam();
+ $img = imagecreatefromjpeg( DIR_TESTDATA . '/images/canola.jpg' );
+ $ret = wp_save_image_file( $file, $img, 'image/jpeg', 1 );
+
+ imagedestroy( $img );
+ unlink( $file );
+
+ $this->assertTrue( $ret, 'Image failed to save.' );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Tests that a passed mime type overrides the extension in the filename when saving an image.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @dataProvider data_image_editor_engine_classes
</span></span></pre>
</div>
</div>
</body>
</html>