<!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>[51544] trunk: Build/Test Tools: Use a custom autoloader for the PHPUnit 9.x mock object classes.</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/51544">51544</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/51544","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-04 19:24:14 +0000 (Wed, 04 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 a custom autoloader for the PHPUnit 9.x mock object classes.
This prevents the classes from being loaded automatically via the `autoload-dev` directives when a Composer-installed PHPUnit 5.x or 6.x version is used, as that would break the test run.
It is expected that this autoloader will be removed soon, as it should no longer be needed when the PHPUnit version constraints are widened.
Notes:
* The autoloader file will be loaded from the Test bootstrap.
* The autoloader will always be registered and directed to queue itself _before_ the Composer autoload file (which will already have been registered).
* The autoloader will only actually load the WP copies of the files/classes when PHP 8.0 in combination with PHPUnit 7.x is detected. In all other cases, the autoloader will bow out, which effectively then defers to the Composer autoload file to load the files as shipped with the installed PHPUnit version.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/48957">[48957]</a>, <a href="https://core.trac.wordpress.org/changeset/49037">[49037]</a>, <a href="https://core.trac.wordpress.org/changeset/51543">[51543]</a>.
Props jrf.
See <a href="https://core.trac.wordpress.org/ticket/47381">#47381</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkcomposerjson">trunk/composer.json</a></li>
<li><a href="#trunktestsphpunitincludesbootstrapphp">trunk/tests/phpunit/includes/bootstrap.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunitincludesclassmockobjectautoloadphp">trunk/tests/phpunit/includes/class-mockobject-autoload.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkcomposerjson"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/composer.json</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/composer.json 2021-08-04 18:55:38 UTC (rev 51543)
+++ trunk/composer.json 2021-08-04 19:24:14 UTC (rev 51544)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -19,20 +19,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "phpcompatibility/phpcompatibility-wp": "~2.1.2",
</span><span class="cx" style="display: block; padding: 0 10px"> "phpunit/phpunit": "^5.7 || ^6.5 || ^7.5"
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "autoload-dev": {
- "files": [
- "tests/phpunit/includes/phpunit7/MockObject/Builder/NamespaceMatch.php",
- "tests/phpunit/includes/phpunit7/MockObject/Builder/ParametersMatch.php",
- "tests/phpunit/includes/phpunit7/MockObject/InvocationMocker.php",
- "tests/phpunit/includes/phpunit7/MockObject/MockMethod.php"
- ],
- "exclude-from-classmap": [
- "vendor/phpunit/phpunit/src/Framework/MockObject/Builder/NamespaceMatch.php",
- "vendor/phpunit/phpunit/src/Framework/MockObject/Builder/ParametersMatch.php",
- "vendor/phpunit/phpunit/src/Framework/MockObject/InvocationMocker.php",
- "vendor/phpunit/phpunit/src/Framework/MockObject/MockMethod.php"
- ]
- },
</del><span class="cx" style="display: block; padding: 0 10px"> "scripts": {
</span><span class="cx" style="display: block; padding: 0 10px"> "compat": "@php ./vendor/squizlabs/php_codesniffer/bin/phpcs --standard=phpcompat.xml.dist --report=summary,source",
</span><span class="cx" style="display: block; padding: 0 10px"> "format": "@php ./vendor/squizlabs/php_codesniffer/bin/phpcbf --report=summary,source",
</span></span></pre></div>
<a id="trunktestsphpunitincludesbootstrapphp"></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/bootstrap.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/bootstrap.php 2021-08-04 18:55:38 UTC (rev 51543)
+++ trunk/tests/phpunit/includes/bootstrap.php 2021-08-04 19:24:14 UTC (rev 51544)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -46,6 +46,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> exit( 1 );
</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">+// Register a custom autoloader for the PHPUnit 9.x Mockobject classes for compatibility with PHP 8.0.
+require_once __DIR__ . '/class-mockobject-autoload.php';
+spl_autoload_register( 'MockObject_Autoload::load', true, true );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // If running core tests, check if all the required PHP extensions are loaded before running the test suite.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( defined( 'WP_RUN_CORE_TESTS' ) && WP_RUN_CORE_TESTS ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $required_extensions = array(
</span></span></pre></div>
<a id="trunktestsphpunitincludesclassmockobjectautoloadphp"></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/class-mockobject-autoload.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/class-mockobject-autoload.php (rev 0)
+++ trunk/tests/phpunit/includes/class-mockobject-autoload.php 2021-08-04 19:24:14 UTC (rev 51544)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,63 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * Custom autoloader for the PHPUnit 9.x MockObject classes.
+ *
+ * Hack around PHPUnit < 9.3 mocking not being compatible with PHP 8.
+ *
+ * This is a temporary solution until the PHPUnit version constraints are widened.
+ *
+ * @since 5.9.0
+ */
+final class MockObject_Autoload {
+
+ /**
+ * A list of the classes this autoloader handles.
+ *
+ * @var string[] => true
+ */
+ private static $supported_classes = array(
+ 'PHPUnit\Framework\MockObject\Builder\NamespaceMatch' => '/phpunit7/MockObject/Builder/NamespaceMatch.php',
+ 'PHPUnit\Framework\MockObject\Builder\ParametersMatch' => '/phpunit7/MockObject/Builder/ParametersMatch.php',
+ 'PHPUnit\Framework\MockObject\InvocationMocker' => '/phpunit7/MockObject/InvocationMocker.php',
+ 'PHPUnit\Framework\MockObject\MockMethod' => '/phpunit7/MockObject/MockMethod.php',
+ );
+
+ /**
+ * Loads a class.
+ *
+ * @param string $class_name The name of the class to load.
+ * @return bool
+ */
+ public static function load( $class_name ) {
+
+ if ( isset( self::$supported_classes[ $class_name ] ) === false ) {
+ // Bow out, not a class this autoloader handles.
+ return false;
+ }
+
+ if ( PHP_VERSION_ID < 80000 ) {
+ // This autoloader is only needed when the tests are being run on PHP >= 8.0.
+ // Let the standard Composer autoloader handle things otherwise.
+ return false;
+ }
+
+ if ( class_exists( 'PHPUnit\Runner\Version' ) === false // PHPUnit < 6.0.
+ || ( version_compare( \PHPUnit\Runner\Version::id(), '7.0.0', '<' )
+ && version_compare( \PHPUnit\Runner\Version::id(), '8.0.0', '>=' ) )
+ ) {
+ // This autoloader is only needed when the tests are being run on PHPUnit 7.
+ return false;
+ }
+
+ $relative_path = self::$supported_classes[ $class_name ];
+ $file = \realpath( __DIR__ . $relative_path );
+
+ if ( false === $file || @\file_exists( $file ) === false ) {
+ return false;
+ }
+
+ require_once $file;
+ return true;
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/includes/class-mockobject-autoload.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></div>
</body>
</html>