<!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>[51567] trunk: Build/Test Tools: Use the PHPUnit Polyfill TestCase as `void` workaround.</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/51567">51567</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/51567","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>2021-08-07 10:20:05 +0000 (Sat, 07 Aug 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: Use the PHPUnit Polyfill TestCase as `void` workaround.
> 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:
* Lets the `PHPUnit_Adapter_TestCase` extend the `Yoast\PHPUnitPolyfills\TestCases\TestCase`, which makes this solution for the `void` return type available to the WordPress test suite.
* Removes the individual import and trait `use` statements for the Polyfill traits. These are no longer necessary as the `Yoast\PHPUnitPolyfills\TestCases\TestCase` already includes those.
Follow-up to [51559-51566].
Props jrf, hellofromTonya, johnbillion, netweb, SergeyBiryukov.
See <a href="https://core.trac.wordpress.org/ticket/46149">#46149</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkphpcsxmldist">trunk/phpcs.xml.dist</a></li>
<li><a href="#trunktestsphpunitincludesphpunitadaptertestcasephp">trunk/tests/phpunit/includes/phpunit-adapter-testcase.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-08-06 21:55:31 UTC (rev 51566)
+++ trunk/phpcs.xml.dist 2021-08-07 10:20:05 UTC (rev 51567)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -235,6 +235,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <properties>
</span><span class="cx" style="display: block; padding: 0 10px"> <property name="custom_test_class_whitelist" type="array">
</span><span class="cx" style="display: block; padding: 0 10px"> <!-- Test case parent classes. -->
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <element value="PHPUnit_Adapter_TestCase"/>
</ins><span class="cx" style="display: block; padding: 0 10px"> <element value="WP_UnitTestCase"/>
</span><span class="cx" style="display: block; padding: 0 10px"> <element value="WP_Ajax_UnitTestCase"/>
</span><span class="cx" style="display: block; padding: 0 10px"> <element value="WP_Canonical_UnitTestCase"/>
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -267,6 +268,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <element value="WPProfiler"/>
</span><span class="cx" style="display: block; padding: 0 10px"> <element value="SpeedTrapListener"/>
</span><span class="cx" style="display: block; padding: 0 10px"> <element value="PHPUnit_Framework_Exception"/>
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <element value="Polyfill_TestCase"/>
</ins><span class="cx" style="display: block; padding: 0 10px"> </property>
</span><span class="cx" style="display: block; padding: 0 10px"> </properties>
</span><span class="cx" style="display: block; padding: 0 10px"> </rule>
</span></span></pre></div>
<a id="trunktestsphpunitincludesphpunitadaptertestcasephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/phpunit-adapter-testcase.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/phpunit-adapter-testcase.php 2021-08-06 21:55:31 UTC (rev 51566)
+++ trunk/tests/phpunit/includes/phpunit-adapter-testcase.php 2021-08-07 10:20:05 UTC (rev 51567)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,20 +1,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-use Yoast\PHPUnitPolyfills\Helpers\AssertAttributeHelper;
-use Yoast\PHPUnitPolyfills\Polyfills\AssertClosedResource;
-use Yoast\PHPUnitPolyfills\Polyfills\AssertEqualsSpecializations;
-use Yoast\PHPUnitPolyfills\Polyfills\AssertFileDirectory;
-use Yoast\PHPUnitPolyfills\Polyfills\AssertFileEqualsSpecializations;
-use Yoast\PHPUnitPolyfills\Polyfills\AssertionRenames;
-use Yoast\PHPUnitPolyfills\Polyfills\AssertIsType;
-use Yoast\PHPUnitPolyfills\Polyfills\AssertNumericType;
-use Yoast\PHPUnitPolyfills\Polyfills\AssertObjectEquals;
-use Yoast\PHPUnitPolyfills\Polyfills\AssertStringContains;
-use Yoast\PHPUnitPolyfills\Polyfills\EqualToSpecializations;
-use Yoast\PHPUnitPolyfills\Polyfills\ExpectException;
-use Yoast\PHPUnitPolyfills\Polyfills\ExpectExceptionMessageMatches;
-use Yoast\PHPUnitPolyfills\Polyfills\ExpectExceptionObject;
-use Yoast\PHPUnitPolyfills\Polyfills\ExpectPHPException;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+use Yoast\PHPUnitPolyfills\TestCases\TestCase as Polyfill_TestCase;
</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"> * PHPUnit adapter layer.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -22,24 +8,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * This class enhances the PHPUnit native `TestCase` with polyfills
</span><span class="cx" style="display: block; padding: 0 10px"> * for assertions and expectation methods added between PHPUnit 4.8 - 9.5.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Additionally, the Polyfill TestCase offers a workaround for the addition
+ * of the `void` return type to PHPUnit fixture methods by providing
+ * overloadable snake_case versions of the typical fixture method names and
+ * ensuring that PHPUnit handles those correctly.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * See {@link https://github.com/Yoast/PHPUnit-Polyfills} for full
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * documentation on the available polyfills.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * documentation on the available polyfills and other features.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-abstract class PHPUnit_Adapter_TestCase extends PHPUnit\Framework\TestCase {
-
- use AssertAttributeHelper;
- use AssertClosedResource;
- use AssertEqualsSpecializations;
- use AssertFileDirectory;
- use AssertFileEqualsSpecializations;
- use AssertionRenames;
- use AssertIsType;
- use AssertNumericType;
- use AssertObjectEquals;
- use AssertStringContains;
- use EqualToSpecializations;
- use ExpectException;
- use ExpectExceptionMessageMatches;
- use ExpectExceptionObject;
- use ExpectPHPException;
-}
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+abstract class PHPUnit_Adapter_TestCase extends Polyfill_TestCase {}
</ins></span></pre>
</div>
</div>
</body>
</html>