Changeset 47338 for branches/3.8/tests/phpunit/includes/testcase.php

Timestamp:

02/21/2020 01:05:39 PM (7 years ago)

Author:

SergeyBiryukov

Message:

Build/Test Tools: Fix the Travis CI build for the 3.8 branch.

Among other fixes, this backports [26871], [26909-26910], [26940], [27086], [27168], [28799], [28873], [28943], [28961], [28964], [28966-28967], [29120], [29251], [29503], [29860], [29869], [29954], [30001], [30160], [30282], [30285], [30289-30291], [30513-30514], [30516-30521], [30524], [30526], [30529-30530], [31253-31254], [31257-31259], [31622], [40241], [40255], [40257], [40259], [40269], [40271], [40446], [40449], [40457], [40604], [40538], [40833], [41082], [41303], [41306], [44993].

See #49485.

Location:

branches/3.8

Files:

• . (modified) (1 prop)
• tests/phpunit/includes/testcase.php (modified) (11 diffs)

branches/3.8/tests/phpunit/includes/testcase.php

@@ -12 +12 @@
         protected $caught_doing_it_wrong = array();
 
+        protected static $hooks_saved = array();
+        protected static $ignore_files;
+
         /**
          * @var WP_UnitTest_Factory
@@ -19 +22 @@
         function setUp() {
                 set_time_limit(0);
+
+                if ( ! self::$ignore_files ) {
+                        self::$ignore_files = $this->scan_user_uploads();
+                }
+
+                if ( ! self::$hooks_saved ) {
+                        $this->_backup_hooks();
+                }
 
                 global $wpdb;
@@ -27 +38 @@
                 $this->factory = new WP_UnitTest_Factory;
                 $this->clean_up_global_scope();
+
+                /*
+                 * When running core tests, ensure that post types and taxonomies
+                 * are reset for each test. We skip this step for non-core tests,
+                 * given the large number of plugins that register post types and
+                 * taxonomies at 'init'.
+                 */
+                if ( defined( 'WP_RUN_CORE_TESTS' ) && WP_RUN_CORE_TESTS ) {
+                        $this->reset_post_types();
+                        $this->reset_taxonomies();
+                }
+
                 $this->start_transaction();
                 $this->expectDeprecated();
                 add_filter( 'wp_die_handler', array( $this, 'get_wp_die_handler' ) );
+        }
+
+        /**
+         * Unregister existing post types and register defaults.
+         *
+         * Run before each test in order to clean up the global scope, in case
+         * a test forgets to unregister a post type on its own, or fails before
+         * it has a chance to do so.
+         */
+        protected function reset_post_types() {
+                foreach ( get_post_types() as $pt ) {
+                        _unregister_post_type( $pt );
+                }
+                create_initial_post_types();
+        }
+
+        /**
+         * Unregister existing taxonomies and register defaults.
+         *
+         * Run before each test in order to clean up the global scope, in case
+         * a test forgets to unregister a taxonomy on its own, or fails before
+         * it has a chance to do so.
+         */
+        protected function reset_taxonomies() {
+                foreach ( get_taxonomies() as $tax ) {
+                        _unregister_taxonomy( $tax );
+                }
+                create_initial_taxonomies();
         }
 
@@ -36 +87 @@
                 $this->expectedDeprecated();
                 $wpdb->query( 'ROLLBACK' );
-                remove_filter( 'dbdelta_create_queries', array( $this, '_create_temporary_tables' ) );
+                if ( is_multisite() ) {
+                        while ( ms_is_switched() ) {
+                                restore_current_blog();
+                        }
+                }
+                remove_filter( 'query', array( $this, '_create_temporary_tables' ) );
                 remove_filter( 'query', array( $this, '_drop_temporary_tables' ) );
                 remove_filter( 'wp_die_handler', array( $this, 'get_wp_die_handler' ) );
+                $this->_restore_hooks();
+                wp_set_current_user( 0 );
         }
 
@@ -47 +105 @@
         }
 
+        /**
+         * Allow tests to be skipped on some automated runs
+         *
+         * For test runs on Travis for something other than trunk/master 
+         * we want to skip tests that only need to run for master.
+         */
+        public function skipOnAutomatedBranches() {
+                // gentenv can be disabled
+                if ( ! function_exists( 'getenv' ) ) {
+                        return false;
+                }
+
+                // https://docs.travis-ci.com/user/environment-variables/#Default-Environment-Variables
+                $travis_branch       = getenv( 'TRAVIS_BRANCH' );
+                $travis_pull_request = getenv( 'TRAVIS_PULL_REQUEST' );
+
+                if ( false !== $travis_pull_request && 'master' !== $travis_branch ) {
+                        $this->markTestSkipped( 'For automated test runs, this test is only run on trunk/master' );
+                }
+        }
+
+        /**
+         * Saves the action and filter-related globals so they can be restored later.
+         *
+         * Stores $merged_filters, $wp_actions, $wp_current_filter, and $wp_filter
+         * on a class variable so they can be restored on tearDown() using _restore_hooks().
+         *
+         * @global array $merged_filters
+         * @global array $wp_actions
+         * @global array $wp_current_filter
+         * @global array $wp_filter
+         * @return void
+         */
+        protected function _backup_hooks() {
+                $globals = array( 'merged_filters', 'wp_actions', 'wp_current_filter', 'wp_filter' );
+                foreach ( $globals as $key ) {
+                        self::$hooks_saved[ $key ] = $GLOBALS[ $key ];
+                }
+        }
+
+        /**
+         * Restores the hook-related globals to their state at setUp()
+         * so that future tests aren't affected by hooks set during this last test.
+         *
+         * @global array $merged_filters
+         * @global array $wp_actions
+         * @global array $wp_current_filter
+         * @global array $wp_filter
+         * @return void
+         */
+        protected function _restore_hooks() {
+                $globals = array( 'merged_filters', 'wp_actions', 'wp_current_filter', 'wp_filter' );
+                foreach ( $globals as $key ) {
+                        if ( isset( self::$hooks_saved[ $key ] ) ) {
+                                $GLOBALS[ $key ] = self::$hooks_saved[ $key ];
+                        }
+                }
+        }
+        
         function flush_cache() {
                 global $wp_object_cache;
@@ -65 +182 @@
                 $wpdb->query( 'SET autocommit = 0;' );
                 $wpdb->query( 'START TRANSACTION;' );
-                add_filter( 'dbdelta_create_queries', array( $this, '_create_temporary_tables' ) );
+                add_filter( 'query', array( $this, '_create_temporary_tables' ) );
                 add_filter( 'query', array( $this, '_drop_temporary_tables' ) );
         }
 
-        function _create_temporary_tables( $queries ) {
-                return str_replace( 'CREATE TABLE', 'CREATE TEMPORARY TABLE', $queries );
+        function _create_temporary_tables( $query ) {
+                if ( 'CREATE TABLE' === substr( trim( $query ), 0, 12 ) )
+                        return substr_replace( trim( $query ), 'CREATE TEMPORARY TABLE', 0, 12 );
+                return $query;
         }
 
         function _drop_temporary_tables( $query ) {
-                if ( 'DROP TABLE' === substr( $query, 0, 10 ) )
-                        return 'DROP TEMPORARY TABLE ' . substr( $query, 10 );
+                if ( 'DROP TABLE' === substr( trim( $query ), 0, 10 ) )
+                        return substr_replace( trim( $query ), 'DROP TEMPORARY TABLE', 0, 10 );
                 return $query;
         }
@@ -206 +325 @@
         protected function checkRequirements() {
                 parent::checkRequirements();
+
+                // Core tests no longer check against open Trac tickets, but others using WP_UnitTestCase may do so.
+                if ( defined( 'WP_RUN_CORE_TESTS' ) && WP_RUN_CORE_TESTS ) {
+                        return;
+                }
+
                 if ( WP_TESTS_FORCE_KNOWN_BUGS )
                         return;
@@ -230 +355 @@
                 if ( WP_TESTS_FORCE_KNOWN_BUGS || in_array( $ticket_id, self::$forced_tickets ) )
                         return;
-                if ( ! TracTickets::isTracTicketClosed( 'http://core.trac.wordpress.org', $ticket_id ) )
+                if ( ! TracTickets::isTracTicketClosed( 'https://core.trac.wordpress.org', $ticket_id ) )
                         $this->markTestSkipped( sprintf( 'WordPress Ticket #%d is not fixed', $ticket_id ) );
         }
@@ -240 +365 @@
                 if ( WP_TESTS_FORCE_KNOWN_BUGS || in_array( 'UT' . $ticket_id, self::$forced_tickets ) )
                         return;
-                if ( ! TracTickets::isTracTicketClosed( 'http://unit-tests.trac.wordpress.org', $ticket_id ) )
+                if ( ! TracTickets::isTracTicketClosed( 'https://unit-tests.trac.wordpress.org', $ticket_id ) )
                         $this->markTestSkipped( sprintf( 'Unit Tests Ticket #%d is not fixed', $ticket_id ) );
         }
@@ -250 +375 @@
                 if ( WP_TESTS_FORCE_KNOWN_BUGS || in_array( 'Plugin' . $ticket_id, self::$forced_tickets ) )
                         return;
-                if ( ! TracTickets::isTracTicketClosed( 'http://plugins.trac.wordpress.org', $ticket_id ) )
+                if ( ! TracTickets::isTracTicketClosed( 'https://plugins.trac.wordpress.org', $ticket_id ) )
                         $this->markTestSkipped( sprintf( 'WordPress Plugin Ticket #%d is not fixed', $ticket_id ) );
         }
@@ -328 +453 @@
                 $this->assertTrue( $passed, $message );
         }
+
+        function unlink( $file ) {
+                $exists = is_file( $file );
+                if ( $exists && ! in_array( $file, self::$ignore_files ) ) {
+                        //error_log( $file );
+                        unlink( $file );
+                } elseif ( ! $exists ) {
+                        $this->fail( "Trying to delete a file that doesn't exist: $file" );
+                }
+        }
+
+        function rmdir( $path ) {
+                $files = $this->files_in_dir( $path );
+                foreach ( $files as $file ) {
+                        if ( ! in_array( $file, self::$ignore_files ) ) {
+                                $this->unlink( $file );
+                        }
+                }
+        }
+
+        function remove_added_uploads() {
+                // Remove all uploads.
+                $uploads = wp_upload_dir();
+                $this->rmdir( $uploads['basedir'] );
+        }
+
+        function files_in_dir( $dir ) {
+                $files = array();
+
+                $iterator = new RecursiveDirectoryIterator( $dir );
+                $objects = new RecursiveIteratorIterator( $iterator );
+                foreach ( $objects as $name => $object ) {
+                        if ( is_file( $name ) ) {
+                                $files[] = $name;
+                        }
+                }
+
+                return $files;
+        }
+
+        function scan_user_uploads() {
+                static $files = array();
+                if ( ! empty( $files ) ) {
+                        return $files;
+                }
+
+                $uploads = wp_upload_dir();
+                $files = $this->files_in_dir( $uploads['basedir'] );
+                return $files;
+        }
 }