Changeset 11739

Timestamp:

11/03/2017 09:11:52 PM (9 years ago)

Author:

boonebgorges

Message:

Ensure that shared user fixtures are fully cleaned up.

It's not possible to inherit WP 4.4's user cleanup between tests, because
the the deletion routine runs after the core test suite has unhooked
certain actions (such as BP's that are hooked to delete_user). So
we are forced to run necessary cleanup tasks in our own delete_user()
method, and ensure that it's this method that is called in every case
where we're cleaning up after statically generated shared fixtures.
Otherwise leftover content in the activity table can leak to other
tests.

See #7620.

Location:

trunk/tests/phpunit

Files:

• includes/testcase.php (modified) (3 diffs)
• testcases/core/class-bp-media-extractor.php (modified) (1 diff)
• testcases/core/suggestions-nonauth.php (modified) (2 diffs)
• testcases/core/suggestions.php (modified) (1 diff)
• testcases/groups/functions/bpGetUserGroups.php (modified) (1 diff)
• testcases/groups/functions/groupsCreateGroup.php (modified) (1 diff)
• testcases/groups/functions/groupsIsUser.php (modified) (1 diff)
• testcases/groups/types.php (modified) (2 diffs)

trunk/tests/phpunit/includes/testcase.php

@@ -26 +26 @@
         protected $deactivated_components = array();
 
+        /**
+         * Cribbed from WP so that the self::factory() call comes from this class.
+         *
+         * @since 3.0.0
+         */
         public static function setUpBeforeClass() {
+                global $wpdb;
 
                 // Fake WP mail globals, to avoid errors
@@ -32 +38 @@
                 add_filter( 'wp_mail_from', array( 'BP_UnitTestCase', 'tearDown_wp_mail' ) );
 
-                parent::setUpBeforeClass();
+                $c = self::get_called_class();
+                if ( ! method_exists( $c, 'wpSetUpBeforeClass' ) ) {
+                        self::commit_transaction();
+                        return;
+                }
+
+                call_user_func( array( $c, 'wpSetUpBeforeClass' ), self::factory() );
+
+                self::commit_transaction();
         }
 
@@ -92 +106 @@
                 }
                 $this->deactivated_components = array();
+        }
+
+        /**
+         * Multisite-agnostic way to delete a user from the database.
+         *
+         * @since 3.0.0
+         */
+        public static function delete_user( $user_id ) {
+                $deleted = parent::delete_user( $user_id );
+
+                // When called in tearDownAfterClass(), BP's cleanup functions may no longer be hooked.
+                if ( bp_is_active( 'activity' ) ) {
+                        bp_activity_remove_all_user_data( $user_id );
+                }
+
+                return $deleted;
         }
 

trunk/tests/phpunit/testcases/core/class-bp-media-extractor.php

@@ -8 +8 @@
         public static $richtext        = '';
 
-
-        public static function setUpBeforeClass() {
-                parent::setUpBeforeClass();
-
+        public static function wpSetUpBeforeClass( $f ) {
                 self::$media_extractor = new BP_Media_Extractor();
                 self::$richtext        = "Hello world.

trunk/tests/phpunit/testcases/core/suggestions-nonauth.php

@@ -11 +11 @@
         protected static $user_ids     = array();
 
-        public static function setUpBeforeClass() {
-                parent::setUpBeforeClass();
-
+        public static function wpSetUpBeforeClass( $factory ) {
                 $users = array(
                         // user_login, display_name
@@ -28 +26 @@
                         array( 'zoom',        'Lisa Smithy' ),
                 );
-
-                $factory = new BP_UnitTest_Factory();
 
                 // Create some dummy users.

trunk/tests/phpunit/testcases/core/suggestions.php

@@ -13 +13 @@
         protected static $user_ids     = array();
 
-        public static function setUpBeforeClass() {
-                parent::setUpBeforeClass();
-
-                $factory = new BP_UnitTest_Factory();
-
+        public static function wpSetUpBeforeClass( $factory ) {
                 self::$old_user_id  = get_current_user_id();
                 self::$current_user = $factory->user->create( array(

trunk/tests/phpunit/testcases/groups/functions/bpGetUserGroups.php

@@ -14 +14 @@
         }
 
-        public static function setUpBeforeClass() {
+        public static function wpSetUpBeforeClass( $f ) {
                 $f = new BP_UnitTest_Factory();
 

trunk/tests/phpunit/testcases/groups/functions/groupsCreateGroup.php

@@ -11 +11 @@
         public static function wpSetUpBeforeClass( $factory ) {
                 self::$user_id = $factory->user->create();
+        }
+
+        public static function wpTearDownAfterClass() {
+                self::delete_user( self::$user_id );
         }
 

trunk/tests/phpunit/testcases/groups/functions/groupsIsUser.php

@@ -11 +11 @@
         static $groups;
 
-        public static function setUpBeforeClass() {
-                $f = new BP_UnitTest_Factory();
-
+        public static function wpSetUpBeforeClass( $f ) {
                 self::$user = $f->user->create( array(
                         'user_login' => 'groups_is_user',

trunk/tests/phpunit/testcases/groups/types.php

@@ -14 +14 @@
         }
 
-        public static function setUpBeforeClass() {
-                $f = new BP_UnitTest_Factory();
-
+        public static function wpSetUpBeforeClass( $f ) {
                 self::$u1 = $f->user->create( array(
                         'user_email' => 'group-types-tests@example.com',
@@ -23 +21 @@
         }
 
-        public static function tearDownAfterClass() {
-                if ( is_multisite() ) {
-                        wpmu_delete_user( self::$u1 );
-                } else {
-                        wp_delete_user( self::$u1 );
-                }
+        public static function wpTearDownAfterClass() {
+                self::delete_user( self::$u1 );
         }