Changeset 9980

Timestamp:

06/29/2015 09:42:43 PM (9 years ago)

Author:

boonebgorges

Message:

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 #6540.

Location:

trunk/tests/phpunit

Files:

• includes/testcase.php (modified) (4 diffs)
• testcases/blogs/class-bp-blogs-blog.php (modified) (5 diffs)

trunk/tests/phpunit/includes/testcase.php

@@ -14 +14 @@
     protected static $cached_SERVER_NAME = null;
 
+    /**
+     * A flag indicating whether an autocommit has been detected inside of a test.
+     *
+     * @since BuddyPress (2.4.0)
+     *
+     * @var bool
+     */
+    protected $autocommitted = false;
+
     public static function setUpBeforeClass() {
         // Fake WP mail globals, to avoid errors
@@ -23 +32 @@
         parent::setUp();
 
-        // 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 );
-            }
-        }
-
-
         $this->factory = new BP_UnitTest_Factory;
 
         // Fixes warnings in multisite functions
         $_SERVER['REMOTE_ADDR'] = '';
+        global $wpdb;
+
+        // Clean up after autocommits.
+        add_action( 'bp_blogs_recorded_existing_blogs', array( $this, 'set_autocommit_flag' ) );
+    }
+
+    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();
     }
 
@@ -54 +80 @@
 
         parent::clean_up_global_scope();
-    }
-
-    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 );
-                }
-            }
-        }
     }
 
@@ -449 +455 @@
         @rmdir( $dir );
     }
+
+    /**
+     * 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;
+    }
 }

trunk/tests/phpunit/testcases/blogs/class-bp-blogs-blog.php

@@ -28 +28 @@
 
         $this->assertEquals( array( $b ), $blog_ids );
-
-        $this->set_current_user( $old_user );
-        wpmu_delete_blog( $b, true );
     }
 
@@ -61 +58 @@
         $this->assertEquals( array( $b ), $blog_ids );
         $this->assertEquals( 1, $blogs['total'] );
-
-        $this->set_current_user( $old_user );
-        wpmu_delete_blog( $b, true );
     }
 
@@ -89 +83 @@
 
         $this->assertEquals( array( $b ), $blog_ids );
-
-        $this->set_current_user( $old_user );
-        wpmu_delete_blog( $b, true );
     }
 
@@ -120 +111 @@
 
         $this->assertEquals( array( $b ), $blog_ids );
-
-        $this->set_current_user( $old_user );
-        wpmu_delete_blog( $b, true );
     }
 
@@ -182 +170 @@
 
         $this->set_current_user( $old_user );
-
-        foreach ( $bs as $d ) {
-            wpmu_delete_blog( $d, true );
-        }
     }
 }