<!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>[55006] trunk/tests/phpunit/tests/functions/wpNonceField.php: Tests: Correct a flaky `wp_nonce_field()` test.</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/55006">55006</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/55006","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-12-19 14:43:02 +0000 (Mon, 19 Dec 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'>Tests: Correct a flaky `wp_nonce_field()` test.
The test for `wp_nonce_field()` with a custom action name verifies that the nonce value matches the one returned by `wp_create_nonce()` with the same action name.
The created nonce, in turn, depends on `wp_nonce_tick()`, which returns a different result in the first and the second half of the nonce's lifespan, one day by default:
* 00:00:01 to 12:00:00 - First tick
* 12:00:01 to 00:00:00 - Second tick
In practice, due to a delay between initializing data providers and running the actual tests, it is possible for the nonce tick to change in the process, for example if the test suite run starts at 11:59:30, and the affected test runs at 12:00:30, causing a test failure.
This commit reduces the chance of a race condition by moving the `wp_create_nonce()` call from the data provider into the test itself.
Includes wrapping long lines with the expected results for better readability.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/54420">[54420]</a>.
Props NekoJonez, SergeyBiryukov.
See <a href="https://core.trac.wordpress.org/ticket/56793">#56793</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsfunctionswpNonceFieldphp">trunk/tests/phpunit/tests/functions/wpNonceField.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunittestsfunctionswpNonceFieldphp"></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/functions/wpNonceField.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/functions/wpNonceField.php 2022-12-18 23:59:51 UTC (rev 55005)
+++ trunk/tests/phpunit/tests/functions/wpNonceField.php 2022-12-19 14:43:02 UTC (rev 55006)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -15,7 +15,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_wp_nonce_field() {
</span><span class="cx" style="display: block; padding: 0 10px"> wp_nonce_field();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->expectOutputRegex( '#^<input type="hidden" id="_wpnonce" name="_wpnonce" value=".{10}" /><input type="hidden" name="_wp_http_referer" value="" />$#' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->expectOutputRegex(
+ '#^<input type="hidden" id="_wpnonce" name="_wpnonce" value=".{10}" />' .
+ '<input type="hidden" name="_wp_http_referer" value="" />$#'
+ );
</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">@@ -29,6 +32,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $expected_regexp The expected regular expression.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_wp_nonce_field_return( $action, $name, $referer, $expected_regexp ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( -1 !== $action ) {
+ $nonce_value = wp_create_nonce( $action );
+ $expected_regexp = str_replace( '%%NONCE_VALUE%%', $nonce_value, $expected_regexp );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertMatchesRegularExpression( $expected_regexp, wp_nonce_field( $action, $name, $referer, false ) );
</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">@@ -43,31 +51,39 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'action' => -1,
</span><span class="cx" style="display: block; padding: 0 10px"> 'name' => '_wpnonce',
</span><span class="cx" style="display: block; padding: 0 10px"> 'referer' => true,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'expected_regexp' => '#^<input type="hidden" id="_wpnonce" name="_wpnonce" value=".{10}" /><input type="hidden" name="_wp_http_referer" value="" />$#',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'expected_regexp' =>
+ '#^<input type="hidden" id="_wpnonce" name="_wpnonce" value=".{10}" />' .
+ '<input type="hidden" name="_wp_http_referer" value="" />$#',
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'action_name' => array(
+ 'action' => 'action_name',
+ 'name' => '_wpnonce',
+ 'referer' => true,
+ 'expected_regexp' =>
+ '#^<input type="hidden" id="_wpnonce" name="_wpnonce" value="%%NONCE_VALUE%%" />' .
+ '<input type="hidden" name="_wp_http_referer" value="" />$#',
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'nonce_name' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'action' => -1,
</span><span class="cx" style="display: block; padding: 0 10px"> 'name' => 'nonce_name',
</span><span class="cx" style="display: block; padding: 0 10px"> 'referer' => true,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'expected_regexp' => '#^<input type="hidden" id="nonce_name" name="nonce_name" value=".{10}" /><input type="hidden" name="_wp_http_referer" value="" />$#',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'expected_regexp' =>
+ '#^<input type="hidden" id="nonce_name" name="nonce_name" value=".{10}" />' .
+ '<input type="hidden" name="_wp_http_referer" value="" />$#',
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'action_name' => array(
- 'action' => 'action_name',
- 'name' => '_wpnonce',
- 'referer' => true,
- 'expected_regexp' => '#^<input type="hidden" id="_wpnonce" name="_wpnonce" value="' . wp_create_nonce( 'action_name' ) . '" /><input type="hidden" name="_wp_http_referer" value="" />$#',
- ),
</del><span class="cx" style="display: block; padding: 0 10px"> 'no_referer' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'action' => -1,
</span><span class="cx" style="display: block; padding: 0 10px"> 'name' => '_wpnonce',
</span><span class="cx" style="display: block; padding: 0 10px"> 'referer' => false,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'expected_regexp' => '#^<input type="hidden" id="_wpnonce" name="_wpnonce" value=".{10}" />$#',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'expected_regexp' =>
+ '#^<input type="hidden" id="_wpnonce" name="_wpnonce" value=".{10}" />$#',
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> '& in name' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'action' => -1,
</span><span class="cx" style="display: block; padding: 0 10px"> 'name' => 'a&b',
</span><span class="cx" style="display: block; padding: 0 10px"> 'referer' => false,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'expected_regexp' => '#^<input type="hidden" id="a\&b" name="a\&b" value=".{10}" />$#',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'expected_regexp' =>
+ '#^<input type="hidden" id="a\&b" name="a\&b" value=".{10}" />$#',
</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>