<!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>[BuddyPress][9980] trunk/tests/phpunit: More targeted cleanup for unit tests that use `bp_blogs_record_existing_blogs()`.</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 { 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="http://buddypress.trac.wordpress.org/changeset/9980">9980</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/9980","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-06-29 21:42:43 +0000 (Mon, 29 Jun 2015)</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'>More targeted cleanup for unit tests that use `bp_blogs_record_existing_blogs()`.
`bp_blogs_record_existing_blogs()` uses `TRUNCATE`, which closes the MySQL
transaction started by the WP automated test suite. As a result, fixtures
created before the `TRUNCATE` are not properly rolled back during `tearDown()`.
Previously, the workaround for the problem had been heavy-handed: the wholesale
deletion of certain content during every test setup/teardown. The new technique
is to detect when a known autocommit has taken place - as it does in
`bp_blogs_record_existing_blogs()` - and to do a more targeted cleanup only in
these cases.
This allows us to dispense with various instances of blog fixture cleanup in
existing tests.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/6540">#6540</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunktestsphpunitincludestestcasephp">trunk/tests/phpunit/includes/testcase.php</a></li>
<li><a href="#trunktestsphpunittestcasesblogsclassbpblogsblogphp">trunk/tests/phpunit/testcases/blogs/class-bp-blogs-blog.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunitincludestestcasephp"></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/testcase.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/testcase.php 2015-06-29 21:42:38 UTC (rev 9979)
+++ trunk/tests/phpunit/includes/testcase.php 2015-06-29 21:42:43 UTC (rev 9980)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13,6 +13,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected $temp_has_bp_moderate = array();
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $cached_SERVER_NAME = null;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * A flag indicating whether an autocommit has been detected inside of a test.
+ *
+ * @since BuddyPress (2.4.0)
+ *
+ * @var bool
+ */
+ protected $autocommitted = false;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public static function setUpBeforeClass() {
</span><span class="cx" style="display: block; padding: 0 10px"> // Fake WP mail globals, to avoid errors
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'wp_mail', array( 'BP_UnitTestCase', 'setUp_wp_mail' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -22,26 +31,43 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function setUp() {
</span><span class="cx" style="display: block; padding: 0 10px"> parent::setUp();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // There's a bug in the multisite tests that causes the
- // transaction rollback to fail for the first user created,
- // which busts every other attempt to create users. This is a
- // hack workaround.
- global $wpdb;
- if ( is_multisite() ) {
- $user_1 = get_user_by( 'login', 'user 1' );
- if ( $user_1 ) {
- $wpdb->delete( $wpdb->users, array( 'ID' => $user_1->ID ) );
- clean_user_cache( $user_1 );
- }
- }
-
-
</del><span class="cx" style="display: block; padding: 0 10px"> $this->factory = new BP_UnitTest_Factory;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Fixes warnings in multisite functions
</span><span class="cx" style="display: block; padding: 0 10px"> $_SERVER['REMOTE_ADDR'] = '';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ global $wpdb;
+
+ // Clean up after autocommits.
+ add_action( 'bp_blogs_recorded_existing_blogs', array( $this, 'set_autocommit_flag' ) );
</ins><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">+ public function tearDown() {
+ global $wpdb;
+
+ remove_action( 'bp_blogs_recorded_existing_blogs', array( $this, 'set_autocommit_flag' ) );
+
+ parent::tearDown();
+
+ // If we detect that a COMMIT has been triggered during the test, clean up blog and user fixtures.
+ if ( $this->autocommitted ) {
+ if ( is_multisite() ) {
+ foreach ( $wpdb->get_col( "SELECT blog_id FROM $wpdb->blogs WHERE blog_id != 1" ) as $blog_id ) {
+ wpmu_delete_blog( $blog_id, true );
+ }
+ }
+
+ foreach ( $wpdb->get_col( "SELECT ID FROM $wpdb->users WHERE ID != 1" ) as $user_id ) {
+ if ( is_multisite() ) {
+ wpmu_delete_user( $user_id );
+ } else {
+ wp_delete_user( $user_id );
+ }
+ }
+ }
+
+ $this->commit_transaction();
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> function clean_up_global_scope() {
</span><span class="cx" style="display: block; padding: 0 10px"> buddypress()->bp_nav = buddypress()->bp_options_nav = buddypress()->action_variables = buddypress()->canonical_stack = buddypress()->unfiltered_uri = $GLOBALS['bp_unfiltered_uri'] = array();
</span><span class="cx" style="display: block; padding: 0 10px"> buddypress()->current_component = buddypress()->current_item = buddypress()->current_action = buddypress()->current_member_type = '';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -55,26 +81,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> parent::clean_up_global_scope();
</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">- function tearDown() {
- parent::tearDown();
-
- /**
- * Sites created by the WP_UnitTest_Factory_For_Blog sometimes are not removed when the current
- * transaction is rolled back. This requires further investigation to understand the root cause
- * but for now, we'll empty out the blogs table manually.
- */
- global $wpdb;
-
- if ( is_multisite() ) {
- $blogs = wp_get_sites();
- foreach ( $blogs as $blog ) {
- if ( (int) $blog['blog_id'] !== 1 ) {
- wpmu_delete_blog( $blog['blog_id'], true );
- }
- }
- }
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> function assertPreConditions() {
</span><span class="cx" style="display: block; padding: 0 10px"> parent::assertPreConditions();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -448,4 +454,13 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> @rmdir( $dir );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Set a flag that an autocommit has taken place inside of a test method.
+ *
+ * @since BuddyPress (2.4.0)
+ */
+ public function set_autocommit_flag() {
+ $this->autocommitted = true;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestcasesblogsclassbpblogsblogphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/testcases/blogs/class-bp-blogs-blog.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/testcases/blogs/class-bp-blogs-blog.php 2015-06-29 21:42:38 UTC (rev 9979)
+++ trunk/tests/phpunit/testcases/blogs/class-bp-blogs-blog.php 2015-06-29 21:42:43 UTC (rev 9980)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -27,9 +27,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $blog_ids = wp_list_pluck( $blogs['blogs'], 'blog_id' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( array( $b ), $blog_ids );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- $this->set_current_user( $old_user );
- wpmu_delete_blog( $b, 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">@@ -60,9 +57,6 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( array( $b ), $blog_ids );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 1, $blogs['total'] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- $this->set_current_user( $old_user );
- wpmu_delete_blog( $b, 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"> public function test_search_blogs() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -88,9 +82,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $blog_ids = wp_list_pluck( $blogs['blogs'], 'blog_id' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( array( $b ), $blog_ids );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- $this->set_current_user( $old_user );
- wpmu_delete_blog( $b, 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">@@ -119,9 +110,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $blog_ids = wp_list_pluck( $blogs['blogs'], 'blog_id' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( array( $b ), $blog_ids );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- $this->set_current_user( $old_user );
- wpmu_delete_blog( $b, 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">@@ -181,9 +169,5 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( 2 == count( $blogs['blogs'] ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->set_current_user( $old_user );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- foreach ( $bs as $d ) {
- wpmu_delete_blog( $d, true );
- }
</del><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>