<!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>[51865] branches/5.4/tests/phpunit/includes: Build/Test Tools: Fix test forward-compatibility layer.</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/51865">51865</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/51865","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-09-24 14:20:53 +0000 (Fri, 24 Sep 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 test forward-compatibility layer.

In <a href="https://core.trac.wordpress.org/changeset/51844">[51844]</a>, the test wrapper methods were not being called due to the names not being recognized as supported PHPUnit "hook" names for fixtures.

This commit:

- Fixes the problem by adding extra camelCase wrappers to the `WP_UnitTestCase` to call the methods in the right order.

- Adds wrappers for the `assertPreConditions()` and `assertPostConditions()` fixture methods to make the backport feature complete for the fixture wrappers.

Test wrapper methods call fix:

By adding method overloads for the PHPUnit native camelCase fixture methods and letting those call the (camelCase) parent method first and only calling the snake_case fixture methods after, the snake_case methods can be supported and the typical run order safeguarded.

As not all test classes will have declared snake_case fixture methods, the snake_case fixture methods are also declared in the `WP_UnitTestCase`. Why? This prevents having to wrap these method calls in `method_exists()` conditions checking for the existence of the snake_case methods in an unknown Test child class. And with the normal inheritance rules in combination with calling the method using `static`, the right method will be called anyway without fatal "calling undeclared method" errors.

Note: While it will be rare, there ''may'' be cases where a test class does not adhere to the normal execution order for fixtures, i.e. for the setup methods, parent first, own code second; and for the teardown methods, own code first, parent second. For example a test class which has "some code - `parent::setUp()` call - some more code" in their `setUp()` method. In those (rare) cases, the execution order of the code will now be changed, which may have side-effects. This rare case will be identified in the dev note.

Follow-up to <a href="https://core.trac.wordpress.org/changeset/51844">[51844]</a>.

Props bjorsch, swissspidy, jrf, hellofromTonya.

See <a href="https://core.trac.wordpress.org/ticket/53911">#53911</a>.</pre>

<h3>Modified Paths</h3>

<ul>

<li><a href="#branches54testsphpunitincludesphpunit7testcasephp">branches/5.4/tests/phpunit/includes/phpunit7/testcase.php</a></li>

<li><a href="#branches54testsphpunitincludestestcasephp">branches/5.4/tests/phpunit/includes/testcase.php</a></li>

</ul>

</div>

<div id="patch">

<h3>Diff</h3>

<a id="branches54testsphpunitincludesphpunit7testcasephp"></a>

<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.4/tests/phpunit/includes/phpunit7/testcase.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.4/tests/phpunit/includes/phpunit7/testcase.php 2021-09-24 14:09:02 UTC (rev 51864)

+++ branches/5.4/tests/phpunit/includes/phpunit7/testcase.php   2021-09-24 14:20:53 UTC (rev 51865)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -46,30 +46,80 @@

</span><span class="cx" style="display: block; padding: 0 10px">        use ExpectPHPException;

</span><span class="cx" style="display: block; padding: 0 10px"> 

</span><span class="cx" style="display: block; padding: 0 10px">        /**

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * Wrapper method for the `setUpBeforeClass()` method for forward-compatibility with WP 5.9.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * Wrapper method for the `set_up_before_class()` method for forward-compatibility with WP 5.9.

</ins><span class="cx" style="display: block; padding: 0 10px">          */

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        public static function set_up_before_class() {

-               static::setUpBeforeClass();

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public static function setUpBeforeClass() {

+               parent::setUpBeforeClass();

+               static::set_up_before_class();

</ins><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">        /**

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * Wrapper method for the `tearDownAfterClass()` method for forward-compatibility with WP 5.9.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * Wrapper method for the `tear_down_after_class()` method for forward-compatibility with WP 5.9.

</ins><span class="cx" style="display: block; padding: 0 10px">          */

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        public static function tear_down_after_class() {

-               static::tearDownAfterClass();

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public static function tearDownAfterClass() {

+               static::tear_down_after_class();

+               parent::tearDownAfterClass();

</ins><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">        /**

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * Wrapper method for the `setUp()` method for forward-compatibility with WP 5.9.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * Wrapper method for the `set_up()` method for forward-compatibility with WP 5.9.

</ins><span class="cx" style="display: block; padding: 0 10px">          */

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        public function set_up() {

-               static::setUp();

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function setUp() {

+               parent::setUp();

+               $this->set_up();

</ins><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">        /**

<del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-         * Wrapper method for the `tearDown()` method for forward-compatibility with WP 5.9.

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+  * Wrapper method for the `tear_down()` method for forward-compatibility with WP 5.9.

</ins><span class="cx" style="display: block; padding: 0 10px">          */

</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-        public function tear_down() {

-               static::tearDown();

</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function tearDown() {

+               $this->tear_down();

+               parent::tearDown();

</ins><span class="cx" style="display: block; padding: 0 10px">         }

</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+

+       /**

+        * Wrapper method for the `assert_pre_conditions()` method for forward-compatibility with WP 5.9.

+        */

+       protected function assertPreConditions() {

+               parent::assertPreConditions();

+               $this->assert_pre_conditions();

+       }

+

+       /**

+        * Wrapper method for the `assert_post_conditions()` method for forward-compatibility with WP 5.9.

+        */

+       protected function assertPostConditions() {

+               parent::assertPostConditions();

+               $this->assert_post_conditions();

+       }

+

+       /**

+        * Placeholder method for forward-compatibility with WP 5.9.

+        */

+       public static function set_up_before_class() {}

+

+       /**

+        * Placeholder method for forward-compatibility with WP 5.9.

+        */

+       public static function tear_down_after_class() {}

+

+       /**

+        * Placeholder method for forward-compatibility with WP 5.9.

+        */

+       protected function set_up() {}

+

+       /**

+        * Placeholder method for forward-compatibility with WP 5.9.

+        */

+       protected function tear_down() {}

+

+       /**

+        * Placeholder method for forward-compatibility with WP 5.9.

+        */

+       protected function assert_pre_conditions() {}

+

+       /**

+        * Placeholder method for forward-compatibility with WP 5.9.

+        */

+       protected function assert_post_conditions() {}

</ins><span class="cx" style="display: block; padding: 0 10px"> }

</span></span></pre></div>

<a id="branches54testsphpunitincludestestcasephp"></a>

<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/5.4/tests/phpunit/includes/testcase.php</h4>

<pre class="diff"><span>

<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/5.4/tests/phpunit/includes/testcase.php  2021-09-24 14:09:02 UTC (rev 51864)

+++ branches/5.4/tests/phpunit/includes/testcase.php    2021-09-24 14:20:53 UTC (rev 51865)

</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -46,30 +46,80 @@

</span><span class="cx" style="display: block; padding: 0 10px">        use ExpectPHPException;

</span><span class="cx" style="display: block; padding: 0 10px"> 

</span><span class="cx" style="display: block; padding: 0 10px">        /**