<!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>[53430] trunk/tests/phpunit: Build/Test Tools: Fix comments odd/even instabilities (test leaks).</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/53430">53430</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/53430","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>2022-05-23 11:54:28 +0000 (Mon, 23 May 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: Fix comments odd/even instabilities (test leaks).
The odd / even class attribute global variables are causing issues in comments tests when a new test is added or an existing test is modified. To stabilize the odd / even comment tests, the comment global variables are added to the base test class' `tear_down()` using the same patterns as the other global resets. This change ensures each comment test starts at the same state. In doing so, the expected odd / even class attributes are no longer affected by previous tests, i.e. test leaks.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/53172">[53172]</a>.
Props hellofromTonya, zieladam, peterwilsoncc.
See <a href="https://core.trac.wordpress.org/ticket/54725">#54725</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunktestsphpunitincludesabstracttestcasephp">trunk/tests/phpunit/includes/abstract-testcase.php</a></li>
<li><a href="#trunktestsphpunittestsblocksrenderCommentTemplatephp">trunk/tests/phpunit/tests/blocks/renderCommentTemplate.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-05-22 15:15:47 UTC (rev 53429)
+++ trunk/tests/phpunit/includes/abstract-testcase.php 2022-05-23 11:54:28 UTC (rev 53430)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -174,6 +174,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $GLOBALS[ $global ] = null;
</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">+ // Reset comment globals.
+ $comment_globals = array( 'comment_alt', 'comment_depth', 'comment_thread_alt' );
+ foreach ( $comment_globals as $global ) {
+ $GLOBALS[ $global ] = null;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="cx" style="display: block; padding: 0 10px"> * Reset $wp_sitemap global so that sitemap-related dynamic $wp->public_query_vars
</span><span class="cx" style="display: block; padding: 0 10px"> * are added when the next test runs.
</span></span></pre></div>
<a id="trunktestsphpunittestsblocksrenderCommentTemplatephp"></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/blocks/renderCommentTemplate.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/blocks/renderCommentTemplate.php 2022-05-22 15:15:47 UTC (rev 53429)
+++ trunk/tests/phpunit/tests/blocks/renderCommentTemplate.php 2022-05-23 11:54:28 UTC (rev 53430)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -20,12 +20,45 @@
</span><span class="cx" style="display: block; padding: 0 10px"> private static $comment_ids;
</span><span class="cx" style="display: block; padding: 0 10px"> private static $per_page = 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">+ /**
+ * Array of the comments options and their original values.
+ * Used to reset the options after each test.
+ *
+ * @var array
+ */
+ private static $original_options;
+
+ public static function set_up_before_class() {
+ parent::set_up_before_class();
+
+ // Store the original option values.
+ $options = array(
+ 'comment_order',
+ 'comments_per_page',
+ 'default_comments_page',
+ 'page_comments',
+ 'previous_default_page',
+ 'thread_comments_depth',
+ );
+ foreach ( $options as $option ) {
+ static::$original_options[ $option ] = get_option( $option );
+ }
+ }
+
+ public function tear_down() {
+ // Reset the comment options to their original values.
+ foreach ( static::$original_options as $option => $original_value ) {
+ update_option( $option, $original_value );
+ }
+
+ parent::tear_down();
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function set_up() {
</span><span class="cx" style="display: block; padding: 0 10px"> parent::set_up();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> update_option( 'page_comments', true );
</span><span class="cx" style="display: block; padding: 0 10px"> update_option( 'comments_per_page', self::$per_page );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- update_option( 'comment_order', 'ASC' );
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> self::$custom_post = self::factory()->post->create_and_get(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -109,7 +142,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> build_comment_query_vars_from_block( $block )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- update_option( 'page_comments', true );
</del><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">@@ -187,9 +219,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> build_comment_query_vars_from_block( $block )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- update_option( 'comments_per_page', $comments_per_page );
- update_option( 'default_comments_page', $default_comments_page );
</del><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">@@ -308,7 +337,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> '',
</span><span class="cx" style="display: block; padding: 0 10px"> <<<END
</span><span class="cx" style="display: block; padding: 0 10px"> <ol class="wp-block-comment-template">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <li id="comment-{$top_level_ids[0]}" class="comment odd alt thread-odd thread-alt depth-1">
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <li id="comment-{$top_level_ids[0]}" class="comment even thread-even depth-1">
</ins><span class="cx" style="display: block; padding: 0 10px"> <div class="wp-block-comment-author-name">
</span><span class="cx" style="display: block; padding: 0 10px"> <a rel="external nofollow ugc" href="http://example.com/author-url/" target="_self" >
</span><span class="cx" style="display: block; padding: 0 10px"> Test
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -318,7 +347,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <p>Hello world</p>
</span><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><span class="cx" style="display: block; padding: 0 10px"> <ol>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <li id="comment-{$first_level_ids[0]}" class="comment even depth-2">
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <li id="comment-{$first_level_ids[0]}" class="comment odd alt depth-2">
</ins><span class="cx" style="display: block; padding: 0 10px"> <div class="wp-block-comment-author-name">
</span><span class="cx" style="display: block; padding: 0 10px"> <a rel="external nofollow ugc" href="http://example.com/author-url/" target="_self" >
</span><span class="cx" style="display: block; padding: 0 10px"> Test
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -328,7 +357,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <p>Hello world</p>
</span><span class="cx" style="display: block; padding: 0 10px"> </div>
</span><span class="cx" style="display: block; padding: 0 10px"> <ol>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <li id="comment-{$second_level_ids[0]}" class="comment odd alt depth-3">
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <li id="comment-{$second_level_ids[0]}" class="comment even depth-3">
</ins><span class="cx" style="display: block; padding: 0 10px"> <div class="wp-block-comment-author-name">
</span><span class="cx" style="display: block; padding: 0 10px"> <a rel="external nofollow ugc" href="http://example.com/author-url/" target="_self" >
</span><span class="cx" style="display: block; padding: 0 10px"> Test
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -340,7 +369,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> </li>
</span><span class="cx" style="display: block; padding: 0 10px"> </ol>
</span><span class="cx" style="display: block; padding: 0 10px"> </li>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <li id="comment-{$first_level_ids[1]}" class="comment even depth-2">
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <li id="comment-{$first_level_ids[1]}" class="comment odd alt depth-2">
</ins><span class="cx" style="display: block; padding: 0 10px"> <div class="wp-block-comment-author-name">
</span><span class="cx" style="display: block; padding: 0 10px"> <a rel="external nofollow ugc" href="http://example.com/author-url/" target="_self" >
</span><span class="cx" style="display: block; padding: 0 10px"> Test
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -390,7 +419,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $expected_content = "<p>Paragraph One</p>\n<p>P2L1<br />\nP2L2</p>\n<p><a href=\"https://example.com/\" rel=\"nofollow ugc\">https://example.com/</a></p>\n";
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '<ol class="wp-block-comment-template"><li id="comment-' . self::$comment_ids[0] . '" class="comment odd alt thread-even depth-1"><div class="wp-block-comment-content">' . $expected_content . '</div></li></ol>',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '<ol class="wp-block-comment-template"><li id="comment-' . self::$comment_ids[0] . '" class="comment even thread-even depth-1"><div class="wp-block-comment-content">' . $expected_content . '</div></li></ol>',
</ins><span class="cx" style="display: block; padding: 0 10px"> $block->render()
</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">@@ -475,7 +504,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'wp_get_current_commenter', $commenter_filter );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '<ol class="wp-block-comment-template"><li id="comment-' . self::$comment_ids[0] . '" class="comment even thread-odd thread-alt depth-1"><div class="wp-block-comment-author-name"><a rel="external nofollow ugc" href="http://example.com/author-url/" target="_self" >Test</a></div><div class="wp-block-comment-content"><p>Hello world</p></div></li><li id="comment-' . $unapproved_comment[0] . '" class="comment odd alt thread-even depth-1"><div class="wp-block-comment-author-name">Visitor</div><div class="wp-block-comment-content"><p><em class="comment-awaiting-moderation">Your comment is awaiting moderation.</em></p>Hi there! My comment needs moderati
on.</div></li></ol>',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '<ol class="wp-block-comment-template"><li id="comment-' . self::$comment_ids[0] . '" class="comment even thread-even depth-1"><div class="wp-block-comment-author-name"><a rel="external nofollow ugc" href="http://example.com/author-url/" target="_self" >Test</a></div><div class="wp-block-comment-content"><p>Hello world</p></div></li><li id="comment-' . $unapproved_comment[0] . '" class="comment odd alt thread-odd thread-alt depth-1"><div class="wp-block-comment-author-name">Visitor</div><div class="wp-block-comment-content"><p><em class="comment-awaiting-moderation">Your comment is awaiting moderation.</em></p>Hi there! My comment needs moderatio
n.</div></li></ol>',
</ins><span class="cx" style="display: block; padding: 0 10px"> str_replace( array( "\n", "\t" ), '', $block->render() ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'Should include unapproved comments when filter applied'
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -484,7 +513,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Test it again and ensure the unmoderated comment doesn't leak out.
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '<ol class="wp-block-comment-template"><li id="comment-' . self::$comment_ids[0] . '" class="comment even thread-odd thread-alt depth-1"><div class="wp-block-comment-author-name"><a rel="external nofollow ugc" href="http://example.com/author-url/" target="_self" >Test</a></div><div class="wp-block-comment-content"><p>Hello world</p></div></li></ol>',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '<ol class="wp-block-comment-template"><li id="comment-' . self::$comment_ids[0] . '" class="comment even thread-even depth-1"><div class="wp-block-comment-author-name"><a rel="external nofollow ugc" href="http://example.com/author-url/" target="_self" >Test</a></div><div class="wp-block-comment-content"><p>Hello world</p></div></li></ol>',
</ins><span class="cx" style="display: block; padding: 0 10px"> str_replace( array( "\n", "\t" ), '', $block->render() ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'Should not include any unapproved comments after removing filter'
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span></span></pre>
</div>
</div>
</body>
</html>