<!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>[53637] trunk/tests/phpunit/includes/abstract-testcase.php: Build/Test Tools: Include the actual `_doing_it_wrong()` message or deprecation notice in the output.</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/53637">53637</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/53637","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>2022-07-03 16:39:19 +0000 (Sun, 03 Jul 2022)</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: Include the actual `_doing_it_wrong()` message or deprecation notice in the output.
This aims to provide better context and more details if an unexpected `_doing_it_wrong()` message or deprecation notice is encountered during a test run.
Previously, this would display a message like `Unexpected incorrect usage notice for [...]`, but without any further details, making it harder to track down the actual issue.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/25402">[25402]</a>, <a href="https://core.trac.wordpress.org/changeset/25408">[25408]</a>, <a href="https://core.trac.wordpress.org/changeset/25785">[25785]</a>, <a href="https://core.trac.wordpress.org/changeset/37861">[37861]</a>, <a href="https://core.trac.wordpress.org/changeset/51872">[51872]</a>.
See <a href="https://core.trac.wordpress.org/ticket/55652">#55652</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunktestsphpunitincludesabstracttestcasephp">trunk/tests/phpunit/includes/abstract-testcase.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunitincludesabstracttestcasephp"></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/abstract-testcase.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/abstract-testcase.php 2022-07-02 22:52:38 UTC (rev 53636)
+++ trunk/tests/phpunit/includes/abstract-testcase.php 2022-07-03 16:39:19 UTC (rev 53637)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -502,17 +502,26 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( array( 'class', 'method' ) as $depth ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $annotations[ $depth ]['expectedDeprecated'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->expected_deprecated = array_merge( $this->expected_deprecated, $annotations[ $depth ]['expectedDeprecated'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->expected_deprecated = array_merge(
+ $this->expected_deprecated,
+ $annotations[ $depth ]['expectedDeprecated']
+ );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $annotations[ $depth ]['expectedIncorrectUsage'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->expected_doing_it_wrong = array_merge( $this->expected_doing_it_wrong, $annotations[ $depth ]['expectedIncorrectUsage'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->expected_doing_it_wrong = array_merge(
+ $this->expected_doing_it_wrong,
+ $annotations[ $depth ]['expectedIncorrectUsage']
+ );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_action( 'deprecated_function_run', array( $this, 'deprecated_function_run' ) );
- add_action( 'deprecated_argument_run', array( $this, 'deprecated_function_run' ) );
- add_action( 'deprecated_file_included', array( $this, 'deprecated_function_run' ) );
- add_action( 'deprecated_hook_run', array( $this, 'deprecated_function_run' ) );
- add_action( 'doing_it_wrong_run', array( $this, 'doing_it_wrong_run' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ add_action( 'deprecated_function_run', array( $this, 'deprecated_function_run' ), 10, 3 );
+ add_action( 'deprecated_argument_run', array( $this, 'deprecated_function_run' ), 10, 3 );
+ add_action( 'deprecated_file_included', array( $this, 'deprecated_function_run' ), 10, 4 );
+ add_action( 'deprecated_hook_run', array( $this, 'deprecated_function_run' ), 10, 4 );
+ add_action( 'doing_it_wrong_run', array( $this, 'doing_it_wrong_run' ), 10, 3 );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> add_action( 'deprecated_function_trigger_error', '__return_false' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'deprecated_argument_trigger_error', '__return_false' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'deprecated_file_trigger_error', '__return_false' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -528,24 +537,42 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function expectedDeprecated() {
</span><span class="cx" style="display: block; padding: 0 10px"> $errors = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $not_caught_deprecated = array_diff( $this->expected_deprecated, $this->caught_deprecated );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $not_caught_deprecated = array_diff(
+ $this->expected_deprecated,
+ array_keys( $this->caught_deprecated )
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $not_caught_deprecated as $not_caught ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $errors[] = "Failed to assert that $not_caught triggered a deprecated notice";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $errors[] = "Failed to assert that $not_caught triggered a deprecation notice";
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $unexpected_deprecated = array_diff( $this->caught_deprecated, $this->expected_deprecated );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $unexpected_deprecated = array_diff(
+ array_keys( $this->caught_deprecated ),
+ $this->expected_deprecated
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $unexpected_deprecated as $unexpected ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $errors[] = "Unexpected deprecated notice for $unexpected";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $errors[] = "Unexpected deprecation notice for $unexpected";
+ $errors[] = $this->caught_deprecated[ $unexpected ];
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $not_caught_doing_it_wrong = array_diff( $this->expected_doing_it_wrong, $this->caught_doing_it_wrong );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $not_caught_doing_it_wrong = array_diff(
+ $this->expected_doing_it_wrong,
+ array_keys( $this->caught_doing_it_wrong )
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $not_caught_doing_it_wrong as $not_caught ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $errors[] = "Failed to assert that $not_caught triggered an incorrect usage notice";
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $unexpected_doing_it_wrong = array_diff( $this->caught_doing_it_wrong, $this->expected_doing_it_wrong );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $unexpected_doing_it_wrong = array_diff(
+ array_keys( $this->caught_doing_it_wrong ),
+ $this->expected_doing_it_wrong
+ );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $unexpected_doing_it_wrong as $unexpected ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $errors[] = "Unexpected incorrect usage notice for $unexpected";
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $errors[] = $this->caught_doing_it_wrong[ $unexpected ];
</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"> // Perform an assertion, but only if there are expected or unexpected deprecated calls or wrongdoings.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -618,11 +645,84 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Adds a deprecated function to the list of caught deprecated calls.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $function The deprecated function.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $function The deprecated function.
+ * @param string $replacement The function that should have been called.
+ * @param string $version The version of WordPress that deprecated the function.
+ * @param string $message Optional. A message regarding the change.
</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 deprecated_function_run( $function ) {
- if ( ! in_array( $function, $this->caught_deprecated, true ) ) {
- $this->caught_deprecated[] = $function;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function deprecated_function_run( $function, $replacement, $version, $message = '' ) {
+ if ( ! isset( $this->caught_deprecated[ $function ] ) ) {
+ switch ( current_action() ) {
+ case 'deprecated_function_run':
+ if ( $replacement ) {
+ $message = sprintf(
+ 'Function %1$s is deprecated since version %2$s! Use %3$s instead.',
+ $function,
+ $version,
+ $replacement
+ );
+ } else {
+ $message = sprintf(
+ 'Function %1$s is deprecated since version %2$s with no alternative available.',
+ $function,
+ $version
+ );
+ }
+ break;
+
+ case 'deprecated_argument_run':
+ if ( $replacement ) {
+ $message = sprintf(
+ 'Function %1$s was called with an argument that is deprecated since version %2$s! %3$s',
+ $function,
+ $version,
+ $replacement
+ );
+ } else {
+ $message = sprintf(
+ 'Function %1$s was called with an argument that is deprecated since version %2$s with no alternative available.',
+ $function,
+ $version
+ );
+ }
+ break;
+
+ case 'deprecated_file_included':
+ if ( $replacement ) {
+ $message = sprintf(
+ 'File %1$s is deprecated since version %2$s! Use %3$s instead.',
+ $function,
+ $version,
+ $replacement
+ ) . ' ' . $message;
+ } else {
+ $message = sprintf(
+ 'File %1$s is deprecated since version %2$s with no alternative available.',
+ $function,
+ $version
+ ) . ' ' . $message;
+ }
+ break;
+
+ case 'deprecated_hook_run':
+ if ( $replacement ) {
+ $message = sprintf(
+ 'Hook %1$s is deprecated since version %2$s! Use %3$s instead.',
+ $function,
+ $version,
+ $replacement
+ ) . ' ' . $message;
+ } else {
+ $message = sprintf(
+ 'Hook %1$s is deprecated since version %2$s with no alternative available.',
+ $function,
+ $version
+ ) . ' ' . $message;
+ }
+ break;
+ }
+
+ $this->caught_deprecated[ $function ] = $message;
</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">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -630,10 +730,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Adds a function called in a wrong way to the list of `_doing_it_wrong()` calls.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $function The function to add.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $message A message explaining what has been done incorrectly.
+ * @param string $version The version of WordPress where the message was added.
</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 doing_it_wrong_run( $function ) {
- if ( ! in_array( $function, $this->caught_doing_it_wrong, true ) ) {
- $this->caught_doing_it_wrong[] = $function;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function doing_it_wrong_run( $function, $message, $version ) {
+ if ( ! isset( $this->caught_doing_it_wrong[ $function ] ) ) {
+ if ( $version ) {
+ $message .= ' ' . sprintf( '(This message was added in version %s.)', $version );
+ }
+
+ $this->caught_doing_it_wrong[ $function ] = $message;
</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">
</span></span></pre>
</div>
</div>
</body>
</html>