<!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>[52235] trunk: Build/Test Tools: Fix warnings from `stdClass::__invoke()` callback mocks in REST API tests.</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/52235">52235</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/52235","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>hellofromTonya</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-11-23 18:55:23 +0000 (Tue, 23 Nov 2021)</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'>Build/Test Tools: Fix warnings from `stdClass::__invoke()` callback mocks in REST API tests.
When running core tests on PHPUnit 8.x and 9.x, four non-blocking warnings were displayed for the REST API tests:
{{{
There were 4 warnings:
1) Tests_REST_Request::test_route_level_validate_callback
createPartialMock called with method(s) __invoke that do not exist in stdClass. This will not be allowed in future versions of PHPUnit.
2) Tests_REST_Request::test_route_level_validate_callback_no_parameter_callbacks
createPartialMock called with method(s) __invoke that do not exist in stdClass. This will not be allowed in future versions of PHPUnit.
3) Tests_REST_Request::test_route_level_validate_callback_is_not_executed_if_parameter_validation_fails
createPartialMock called with method(s) __invoke that do not exist in stdClass. This will not be allowed in future versions of PHPUnit.
4) Tests_REST_Server::test_callbacks_are_not_executed_if_request_validation_fails
createPartialMock called with method(s) __invoke that do not exist in stdClass. This will not be allowed in future versions of PHPUnit.
}}}
These warnings are due to the PHP native `stdClass` not having a `__invoke()` method declared.
This commit adds a `Mock_Invokable` reusable class and replaces the `stdClass` with this new class.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/48945">[48945]</a>, <a href="https://core.trac.wordpress.org/changeset/48947">[48947]</a>.
Props sourovroy, jrf.
Fixes <a href="https://core.trac.wordpress.org/ticket/53844">#53844</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkphpcsxmldist">trunk/phpcs.xml.dist</a></li>
<li><a href="#trunktestsphpunittestsrestapirestrequestphp">trunk/tests/phpunit/tests/rest-api/rest-request.php</a></li>
<li><a href="#trunktestsphpunittestsrestapirestserverphp">trunk/tests/phpunit/tests/rest-api/rest-server.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunitincludesmockinvokablephp">trunk/tests/phpunit/includes/mock-invokable.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkphpcsxmldist"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/phpcs.xml.dist</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/phpcs.xml.dist 2021-11-23 18:37:03 UTC (rev 52234)
+++ trunk/phpcs.xml.dist 2021-11-23 18:55:23 UTC (rev 52235)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -249,6 +249,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <element value="WP_REST_Test_Controller"/>
</span><span class="cx" style="display: block; padding: 0 10px"> <element value="WP_Image_Editor_Mock"/>
</span><span class="cx" style="display: block; padding: 0 10px"> <element value="WP_Filesystem_MockFS"/>
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <element value="Mock_Invokable"/>
</ins><span class="cx" style="display: block; padding: 0 10px"> <element value="MockPHPMailer"/>
</span><span class="cx" style="display: block; padding: 0 10px"> <element value="MockAction"/>
</span><span class="cx" style="display: block; padding: 0 10px"> <element value="WP_Object_Cache"/>
</span></span></pre></div>
<a id="trunktestsphpunitincludesmockinvokablephp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/includes/mock-invokable.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/mock-invokable.php (rev 0)
+++ trunk/tests/phpunit/includes/mock-invokable.php 2021-11-23 18:55:23 UTC (rev 52235)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,17 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * File for Mock_Invokable class.
+ *
+ * @package WordPress
+ * @subpackage UnitTests
+ */
+
+/**
+ * Class Mock_Invokable.
+ *
+ * This class is using to mock a class that has __invoke method.
+ */
+class Mock_Invokable {
+
+ public function __invoke() {}
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/includes/mock-invokable.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunktestsphpunittestsrestapirestrequestphp"></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/rest-api/rest-request.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-request.php 2021-11-23 18:37:03 UTC (rev 52234)
+++ trunk/tests/phpunit/tests/rest-api/rest-request.php 2021-11-23 18:55:23 UTC (rev 52235)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -18,6 +18,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->request = new WP_REST_Request();
</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">+ /**
+ * Called before setting up all tests.
+ */
+ public static function set_up_before_class() {
+ parent::set_up_before_class();
+
+ // Require files that need to load once.
+ require_once DIR_TESTROOT . '/includes/mock-invokable.php';
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_header() {
</span><span class="cx" style="display: block; padding: 0 10px"> $value = 'application/x-wp-example';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1014,7 +1024,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_query_params( array( 'test' => 'value' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $error = new WP_Error( 'error_code', __( 'Error Message' ), array( 'status' => 400 ) );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $callback = $this->createPartialMock( 'stdClass', array( '__invoke' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $callback = $this->createPartialMock( 'Mock_Invokable', array( '__invoke' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $callback->expects( self::once() )->method( '__invoke' )->with( self::identicalTo( $request ) )->willReturn( $error );
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_attributes(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1038,7 +1048,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_query_params( array( 'test' => 'value' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $error = new WP_Error( 'error_code', __( 'Error Message' ), array( 'status' => 400 ) );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $callback = $this->createPartialMock( 'stdClass', array( '__invoke' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $callback = $this->createPartialMock( 'Mock_Invokable', array( '__invoke' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $callback->expects( self::once() )->method( '__invoke' )->with( self::identicalTo( $request ) )->willReturn( $error );
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_attributes(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1056,7 +1066,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request();
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_query_params( array( 'test' => 'value' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $callback = $this->createPartialMock( 'stdClass', array( '__invoke' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $callback = $this->createPartialMock( 'Mock_Invokable', array( '__invoke' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $callback->expects( self::never() )->method( '__invoke' );
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_attributes(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapirestserverphp"></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/rest-api/rest-server.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-server.php 2021-11-23 18:37:03 UTC (rev 52234)
+++ trunk/tests/phpunit/tests/rest-api/rest-server.php 2021-11-23 18:55:23 UTC (rev 52235)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -35,6 +35,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> parent::tear_down();
</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">+ /**
+ * Called before setting up all tests.
+ */
+ public static function set_up_before_class() {
+ parent::set_up_before_class();
+
+ // Require files that need to load once.
+ require_once DIR_TESTROOT . '/includes/mock-invokable.php';
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_envelope() {
</span><span class="cx" style="display: block; padding: 0 10px"> $data = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'amount of arbitrary data' => 'alot',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1630,9 +1640,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @ticket 50244
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_callbacks_are_not_executed_if_request_validation_fails() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $callback = $this->createPartialMock( 'stdClass', array( '__invoke' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $callback = $this->createPartialMock( 'Mock_Invokable', array( '__invoke' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $callback->expects( self::never() )->method( '__invoke' );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $permission_callback = $this->createPartialMock( 'stdClass', array( '__invoke' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $permission_callback = $this->createPartialMock( 'Mock_Invokable', array( '__invoke' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $permission_callback->expects( self::never() )->method( '__invoke' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> register_rest_route(
</span></span></pre>
</div>
</div>
</body>
</html>