summaryrefslogtreecommitdiffstatshomepage
path: root/tests/phpunit/includes/abstract-testcase.php
diff options
context:
space:
mode:
Diffstat (limited to 'tests/phpunit/includes/abstract-testcase.php')
-rw-r--r--tests/phpunit/includes/abstract-testcase.php1110
1 files changed, 1110 insertions, 0 deletions
diff --git a/tests/phpunit/includes/abstract-testcase.php b/tests/phpunit/includes/abstract-testcase.php
new file mode 100644
index 0000000000..e84f80d1c3
--- /dev/null
+++ b/tests/phpunit/includes/abstract-testcase.php
@@ -0,0 +1,1110 @@
+<?php
+
+require_once dirname( __FILE__ ) . '/factory.php';
+require_once dirname( __FILE__ ) . '/trac.php';
+
+/**
+ * Defines a basic fixture to run multiple tests.
+ *
+ * Resets the state of the WordPress installation before and after every test.
+ *
+ * Includes utility functions and assertions useful for testing WordPress.
+ *
+ * All WordPress unit tests should inherit from this class.
+ */
+abstract class WP_UnitTestCase_Base extends PHPUnit_Framework_TestCase {
+
+ protected static $forced_tickets = array();
+ protected $expected_deprecated = array();
+ protected $caught_deprecated = array();
+ protected $expected_doing_it_wrong = array();
+ protected $caught_doing_it_wrong = array();
+
+ protected static $hooks_saved = array();
+ protected static $ignore_files;
+
+ function __isset( $name ) {
+ return 'factory' === $name;
+ }
+
+ function __get( $name ) {
+ if ( 'factory' === $name ) {
+ return self::factory();
+ }
+ }
+
+ /**
+ * Fetches the factory object for generating WordPress fixtures.
+ *
+ * @return WP_UnitTest_Factory The fixture factory.
+ */
+ protected static function factory() {
+ static $factory = null;
+ if ( ! $factory ) {
+ $factory = new WP_UnitTest_Factory();
+ }
+ return $factory;
+ }
+
+ public static function get_called_class() {
+ if ( function_exists( 'get_called_class' ) ) {
+ return get_called_class();
+ }
+
+ // PHP 5.2 only
+ $backtrace = debug_backtrace();
+ // [0] WP_UnitTestCase::get_called_class()
+ // [1] WP_UnitTestCase::setUpBeforeClass()
+ if ( 'call_user_func' === $backtrace[2]['function'] ) {
+ return $backtrace[2]['args'][0][0];
+ }
+ return $backtrace[2]['class'];
+ }
+
+ public static function setUpBeforeClass() {
+ global $wpdb;
+
+ $wpdb->suppress_errors = false;
+ $wpdb->show_errors = true;
+ $wpdb->db_connect();
+ ini_set( 'display_errors', 1 );
+
+ 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();
+ }
+
+ public static function tearDownAfterClass() {
+ parent::tearDownAfterClass();
+
+ _delete_all_data();
+ self::flush_cache();
+
+ $c = self::get_called_class();
+ if ( ! method_exists( $c, 'wpTearDownAfterClass' ) ) {
+ self::commit_transaction();
+ return;
+ }
+
+ call_user_func( array( $c, 'wpTearDownAfterClass' ) );
+
+ self::commit_transaction();
+ }
+
+ 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 $wp_rewrite;
+
+ $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->reset_post_statuses();
+ $this->reset__SERVER();
+
+ if ( $wp_rewrite->permalink_structure ) {
+ $this->set_permalink_structure( '' );
+ }
+ }
+
+ $this->start_transaction();
+ $this->expectDeprecated();
+ add_filter( 'wp_die_handler', array( $this, 'get_wp_die_handler' ) );
+ }
+
+ /**
+ * Detect post-test failure conditions.
+ *
+ * We use this method to detect expectedDeprecated and expectedIncorrectUsage annotations.
+ *
+ * @since 4.2.0
+ */
+ protected function assertPostConditions() {
+ $this->expectedDeprecated();
+ }
+
+ /**
+ * After a test method runs, reset any state in WordPress the test method might have changed.
+ */
+ function tearDown() {
+ global $wpdb, $wp_query, $wp;
+ $wpdb->query( 'ROLLBACK' );
+ if ( is_multisite() ) {
+ while ( ms_is_switched() ) {
+ restore_current_blog();
+ }
+ }
+ $wp_query = new WP_Query();
+ $wp = new WP();
+
+ // Reset globals related to the post loop and `setup_postdata()`.
+ $post_globals = array( 'post', 'id', 'authordata', 'currentday', 'currentmonth', 'page', 'pages', 'multipage', 'more', 'numpages' );
+ foreach ( $post_globals as $global ) {
+ $GLOBALS[ $global ] = null;
+ }
+
+ $this->unregister_all_meta_keys();
+ remove_theme_support( 'html5' );
+ 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 );
+ }
+
+ function clean_up_global_scope() {
+ $_GET = array();
+ $_POST = array();
+ self::flush_cache();
+ }
+
+ /**
+ * 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' );
+ }
+ }
+
+ /**
+ * Allow tests to be skipped when Multisite is not in use.
+ *
+ * Use in conjunction with the ms-required group.
+ */
+ public function skipWithoutMultisite() {
+ if ( ! is_multisite() ) {
+ $this->markTestSkipped( 'Test only runs on Multisite' );
+ }
+ }
+
+ /**
+ * Allow tests to be skipped when Multisite is in use.
+ *
+ * Use in conjunction with the ms-excluded group.
+ */
+ public function skipWithMultisite() {
+ if ( is_multisite() ) {
+ $this->markTestSkipped( 'Test does not run on Multisite' );
+ }
+ }
+
+ /**
+ * 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( array(), 'objects' ) as $pt ) {
+ if ( empty( $pt->tests_no_auto_unregister ) ) {
+ _unregister_post_type( $pt->name );
+ }
+ }
+ 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();
+ }
+
+ /**
+ * Unregister non-built-in post statuses.
+ */
+ protected function reset_post_statuses() {
+ foreach ( get_post_stati( array( '_builtin' => false ) ) as $post_status ) {
+ _unregister_post_status( $post_status );
+ }
+ }
+
+ /**
+ * Reset `$_SERVER` variables
+ */
+ protected function reset__SERVER() {
+ tests_reset__SERVER();
+ }
+
+ /**
+ * Saves the action and filter-related globals so they can be restored later.
+ *
+ * Stores $wp_actions, $wp_current_filter, and $wp_filter on a class variable
+ * so they can be restored on tearDown() using _restore_hooks().
+ *
+ * @global array $wp_actions
+ * @global array $wp_current_filter
+ * @global array $wp_filter
+ * @return void
+ */
+ protected function _backup_hooks() {
+ $globals = array( 'wp_actions', 'wp_current_filter' );
+ foreach ( $globals as $key ) {
+ self::$hooks_saved[ $key ] = $GLOBALS[ $key ];
+ }
+ self::$hooks_saved['wp_filter'] = array();
+ foreach ( $GLOBALS['wp_filter'] as $hook_name => $hook_object ) {
+ self::$hooks_saved['wp_filter'][ $hook_name ] = clone $hook_object;
+ }
+ }
+
+ /**
+ * 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 $wp_actions
+ * @global array $wp_current_filter
+ * @global array $wp_filter
+ * @return void
+ */
+ protected function _restore_hooks() {
+ $globals = array( 'wp_actions', 'wp_current_filter' );
+ foreach ( $globals as $key ) {
+ if ( isset( self::$hooks_saved[ $key ] ) ) {
+ $GLOBALS[ $key ] = self::$hooks_saved[ $key ];
+ }
+ }
+ if ( isset( self::$hooks_saved['wp_filter'] ) ) {
+ $GLOBALS['wp_filter'] = array();
+ foreach ( self::$hooks_saved['wp_filter'] as $hook_name => $hook_object ) {
+ $GLOBALS['wp_filter'][ $hook_name ] = clone $hook_object;
+ }
+ }
+ }
+
+ static function flush_cache() {
+ global $wp_object_cache;
+ $wp_object_cache->group_ops = array();
+ $wp_object_cache->stats = array();
+ $wp_object_cache->memcache_debug = array();
+ $wp_object_cache->cache = array();
+ if ( method_exists( $wp_object_cache, '__remoteset' ) ) {
+ $wp_object_cache->__remoteset();
+ }
+ wp_cache_flush();
+ wp_cache_add_global_groups( array( 'users', 'userlogins', 'usermeta', 'user_meta', 'useremail', 'userslugs', 'site-transient', 'site-options', 'blog-lookup', 'blog-details', 'rss', 'global-posts', 'blog-id-cache', 'networks', 'sites', 'site-details', 'blog_meta' ) );
+ wp_cache_add_non_persistent_groups( array( 'comment', 'counts', 'plugins' ) );
+ }
+
+ /**
+ * Clean up any registered meta keys.
+ *
+ * @since 5.1.0
+ *
+ * @global array $wp_meta_keys
+ */
+ function unregister_all_meta_keys() {
+ global $wp_meta_keys;
+ if ( ! is_array( $wp_meta_keys ) ) {
+ return;
+ }
+ foreach ( $wp_meta_keys as $object_type => $type_keys ) {
+ foreach ( $type_keys as $object_subtype => $subtype_keys ) {
+ foreach ( $subtype_keys as $key => $value ) {
+ unregister_meta_key( $object_type, $key, $object_subtype );
+ }
+ }
+ }
+ }
+
+ function start_transaction() {
+ global $wpdb;
+ $wpdb->query( 'SET autocommit = 0;' );
+ $wpdb->query( 'START TRANSACTION;' );
+ add_filter( 'query', array( $this, '_create_temporary_tables' ) );
+ add_filter( 'query', array( $this, '_drop_temporary_tables' ) );
+ }
+
+ /**
+ * Commit the queries in a transaction.
+ *
+ * @since 4.1.0
+ */
+ public static function commit_transaction() {
+ global $wpdb;
+ $wpdb->query( 'COMMIT;' );
+ }
+
+ 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( trim( $query ), 0, 10 ) ) {
+ return substr_replace( trim( $query ), 'DROP TEMPORARY TABLE', 0, 10 );
+ }
+ return $query;
+ }
+
+ function get_wp_die_handler( $handler ) {
+ return array( $this, 'wp_die_handler' );
+ }
+
+ function wp_die_handler( $message ) {
+ if ( ! is_scalar( $message ) ) {
+ $message = '0';
+ }
+
+ throw new WPDieException( $message );
+ }
+
+ function expectDeprecated() {
+ $annotations = $this->getAnnotations();
+ foreach ( array( 'class', 'method' ) as $depth ) {
+ if ( ! empty( $annotations[ $depth ]['expectedDeprecated'] ) ) {
+ $this->expected_deprecated = array_merge( $this->expected_deprecated, $annotations[ $depth ]['expectedDeprecated'] );
+ }
+ if ( ! empty( $annotations[ $depth ]['expectedIncorrectUsage'] ) ) {
+ $this->expected_doing_it_wrong = array_merge( $this->expected_doing_it_wrong, $annotations[ $depth ]['expectedIncorrectUsage'] );
+ }
+ }
+ add_action( 'deprecated_function_run', array( $this, 'deprecated_function_run' ) );
+ add_action( 'deprecated_argument_run', array( $this, 'deprecated_function_run' ) );
+ add_action( 'deprecated_hook_run', array( $this, 'deprecated_function_run' ) );
+ add_action( 'doing_it_wrong_run', array( $this, 'doing_it_wrong_run' ) );
+ add_action( 'deprecated_function_trigger_error', '__return_false' );
+ add_action( 'deprecated_argument_trigger_error', '__return_false' );
+ add_action( 'deprecated_hook_trigger_error', '__return_false' );
+ add_action( 'doing_it_wrong_trigger_error', '__return_false' );
+ }
+
+ function expectedDeprecated() {
+ $errors = array();
+
+ $not_caught_deprecated = array_diff( $this->expected_deprecated, $this->caught_deprecated );
+ foreach ( $not_caught_deprecated as $not_caught ) {
+ $errors[] = "Failed to assert that $not_caught triggered a deprecated notice";
+ }
+
+ $unexpected_deprecated = array_diff( $this->caught_deprecated, $this->expected_deprecated );
+ foreach ( $unexpected_deprecated as $unexpected ) {
+ $errors[] = "Unexpected deprecated notice for $unexpected";
+ }
+
+ $not_caught_doing_it_wrong = array_diff( $this->expected_doing_it_wrong, $this->caught_doing_it_wrong );
+ foreach ( $not_caught_doing_it_wrong as $not_caught ) {
+ $errors[] = "Failed to assert that $not_caught triggered an incorrect usage notice";
+ }
+
+ $unexpected_doing_it_wrong = array_diff( $this->caught_doing_it_wrong, $this->expected_doing_it_wrong );
+ foreach ( $unexpected_doing_it_wrong as $unexpected ) {
+ $errors[] = "Unexpected incorrect usage notice for $unexpected";
+ }
+
+ // Perform an assertion, but only if there are expected or unexpected deprecated calls or wrongdoings
+ if ( ! empty( $this->expected_deprecated ) ||
+ ! empty( $this->expected_doing_it_wrong ) ||
+ ! empty( $this->caught_deprecated ) ||
+ ! empty( $this->caught_doing_it_wrong ) ) {
+ $this->assertEmpty( $errors, implode( "\n", $errors ) );
+ }
+ }
+
+ /**
+ * Declare an expected `_deprecated_function()` or `_deprecated_argument()` call from within a test.
+ *
+ * @since 4.2.0
+ *
+ * @param string $deprecated Name of the function, method, class, or argument that is deprecated. Must match
+ * first parameter of the `_deprecated_function()` or `_deprecated_argument()` call.
+ */
+ public function setExpectedDeprecated( $deprecated ) {
+ array_push( $this->expected_deprecated, $deprecated );
+ }
+
+ /**
+ * Declare an expected `_doing_it_wrong()` call from within a test.
+ *
+ * @since 4.2.0
+ *
+ * @param string $deprecated Name of the function, method, or class that appears in the first argument of the
+ * source `_doing_it_wrong()` call.
+ */
+ public function setExpectedIncorrectUsage( $doing_it_wrong ) {
+ array_push( $this->expected_doing_it_wrong, $doing_it_wrong );
+ }
+
+ /**
+ * PHPUnit 6+ compatibility shim.
+ *
+ * @param mixed $exception
+ * @param string $message
+ * @param int|string $code
+ */
+ public function setExpectedException( $exception, $message = '', $code = null ) {
+ if ( method_exists( 'PHPUnit_Framework_TestCase', 'setExpectedException' ) ) {
+ parent::setExpectedException( $exception, $message, $code );
+ } else {
+ $this->expectException( $exception );
+ if ( '' !== $message ) {
+ $this->expectExceptionMessage( $message );
+ }
+ if ( null !== $code ) {
+ $this->expectExceptionCode( $code );
+ }
+ }
+ }
+
+ function deprecated_function_run( $function ) {
+ if ( ! in_array( $function, $this->caught_deprecated ) ) {
+ $this->caught_deprecated[] = $function;
+ }
+ }
+
+ function doing_it_wrong_run( $function ) {
+ if ( ! in_array( $function, $this->caught_doing_it_wrong ) ) {
+ $this->caught_doing_it_wrong[] = $function;
+ }
+ }
+
+ function assertWPError( $actual, $message = '' ) {
+ $this->assertInstanceOf( 'WP_Error', $actual, $message );
+ }
+
+ function assertNotWPError( $actual, $message = '' ) {
+ if ( is_wp_error( $actual ) && '' === $message ) {
+ $message = $actual->get_error_message();
+ }
+ $this->assertNotInstanceOf( 'WP_Error', $actual, $message );
+ }
+
+ function assertIXRError( $actual, $message = '' ) {
+ $this->assertInstanceOf( 'IXR_Error', $actual, $message );
+ }
+
+ function assertNotIXRError( $actual, $message = '' ) {
+ if ( $actual instanceof IXR_Error && '' === $message ) {
+ $message = $actual->message;
+ }
+ $this->assertNotInstanceOf( 'IXR_Error', $actual, $message );
+ }
+
+ function assertEqualFields( $object, $fields ) {
+ foreach ( $fields as $field_name => $field_value ) {
+ if ( $object->$field_name != $field_value ) {
+ $this->fail();
+ }
+ }
+ }
+
+ function assertDiscardWhitespace( $expected, $actual ) {
+ $this->assertEquals( preg_replace( '/\s*/', '', $expected ), preg_replace( '/\s*/', '', $actual ) );
+ }
+
+ /**
+ * Asserts that the contents of two un-keyed, single arrays are equal, without accounting for the order of elements.
+ *
+ * @since 3.5.0
+ *
+ * @param array $expected Expected array.
+ * @param array $actual Array to check.
+ */
+ function assertEqualSets( $expected, $actual ) {
+ sort( $expected );
+ sort( $actual );
+ $this->assertEquals( $expected, $actual );
+ }
+
+ /**
+ * Asserts that the contents of two keyed, single arrays are equal, without accounting for the order of elements.
+ *
+ * @since 4.1.0
+ *
+ * @param array $expected Expected array.
+ * @param array $actual Array to check.
+ */
+ function assertEqualSetsWithIndex( $expected, $actual ) {
+ ksort( $expected );
+ ksort( $actual );
+ $this->assertEquals( $expected, $actual );
+ }
+
+ /**
+ * Asserts that the given variable is a multidimensional array, and that all arrays are non-empty.
+ *
+ * @since 4.8.0
+ *
+ * @param array $array Array to check.
+ */
+ function assertNonEmptyMultidimensionalArray( $array ) {
+ $this->assertTrue( is_array( $array ) );
+ $this->assertNotEmpty( $array );
+
+ foreach ( $array as $sub_array ) {
+ $this->assertTrue( is_array( $sub_array ) );
+ $this->assertNotEmpty( $sub_array );
+ }
+ }
+
+ /**
+ * Sets the global state to as if a given URL has been requested.
+ *
+ * This sets:
+ * - The super globals.
+ * - The globals.
+ * - The query variables.
+ * - The main query.
+ *
+ * @since 3.5.0
+ *
+ * @param string $url The URL for the request.
+ */
+ function go_to( $url ) {
+ // note: the WP and WP_Query classes like to silently fetch parameters
+ // from all over the place (globals, GET, etc), which makes it tricky
+ // to run them more than once without very carefully clearing everything
+ $_GET = $_POST = array();
+ foreach ( array( 'query_string', 'id', 'postdata', 'authordata', 'day', 'currentmonth', 'page', 'pages', 'multipage', 'more', 'numpages', 'pagenow' ) as $v ) {
+ if ( isset( $GLOBALS[ $v ] ) ) {
+ unset( $GLOBALS[ $v ] );
+ }
+ }
+ $parts = parse_url( $url );
+ if ( isset( $parts['scheme'] ) ) {
+ $req = isset( $parts['path'] ) ? $parts['path'] : '';
+ if ( isset( $parts['query'] ) ) {
+ $req .= '?' . $parts['query'];
+ // parse the url query vars into $_GET
+ parse_str( $parts['query'], $_GET );
+ }
+ } else {
+ $req = $url;
+ }
+ if ( ! isset( $parts['query'] ) ) {
+ $parts['query'] = '';
+ }
+
+ $_SERVER['REQUEST_URI'] = $req;
+ unset( $_SERVER['PATH_INFO'] );
+
+ self::flush_cache();
+ unset( $GLOBALS['wp_query'], $GLOBALS['wp_the_query'] );
+ $GLOBALS['wp_the_query'] = new WP_Query();
+ $GLOBALS['wp_query'] = $GLOBALS['wp_the_query'];
+
+ $public_query_vars = $GLOBALS['wp']->public_query_vars;
+ $private_query_vars = $GLOBALS['wp']->private_query_vars;
+
+ $GLOBALS['wp'] = new WP();
+ $GLOBALS['wp']->public_query_vars = $public_query_vars;
+ $GLOBALS['wp']->private_query_vars = $private_query_vars;
+
+ _cleanup_query_vars();
+
+ $GLOBALS['wp']->main( $parts['query'] );
+ }
+
+ /**
+ * Allows tests to be skipped on single or multisite installs by using @group annotations.
+ *
+ * This is a custom extension of the PHPUnit requirements handling.
+ *
+ * Contains legacy code for skipping tests that are associated with an open Trac ticket. Core tests no longer
+ * support this behaviour.
+ *
+ * @since 3.5.0
+ */
+ protected function checkRequirements() {
+ parent::checkRequirements();
+
+ $annotations = $this->getAnnotations();
+
+ $groups = array();
+ if ( ! empty( $annotations['class']['group'] ) ) {
+ $groups = array_merge( $groups, $annotations['class']['group'] );
+ }
+ if ( ! empty( $annotations['method']['group'] ) ) {
+ $groups = array_merge( $groups, $annotations['method']['group'] );
+ }
+
+ if ( ! empty( $groups ) ) {
+ if ( in_array( 'ms-required', $groups, true ) ) {
+ $this->skipWithoutMultisite();
+ }
+
+ if ( in_array( 'ms-excluded', $groups, true ) ) {
+ $this->skipWithMultisite();
+ }
+ }
+
+ // 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;
+ }
+ $tickets = PHPUnit_Util_Test::getTickets( get_class( $this ), $this->getName( false ) );
+ foreach ( $tickets as $ticket ) {
+ if ( is_numeric( $ticket ) ) {
+ $this->knownWPBug( $ticket );
+ } elseif ( 'Plugin' == substr( $ticket, 0, 6 ) ) {
+ $ticket = substr( $ticket, 6 );
+ if ( $ticket && is_numeric( $ticket ) ) {
+ $this->knownPluginBug( $ticket );
+ }
+ }
+ }
+ }
+
+ /**
+ * Skips the current test if there is an open Trac ticket associated with it.
+ *
+ * @since 3.5.0
+ *
+ * @param int $ticket_id Ticket number.
+ */
+ function knownWPBug( $ticket_id ) {
+ if ( WP_TESTS_FORCE_KNOWN_BUGS || in_array( $ticket_id, self::$forced_tickets ) ) {
+ return;
+ }
+ if ( ! TracTickets::isTracTicketClosed( 'https://core.trac.wordpress.org', $ticket_id ) ) {
+ $this->markTestSkipped( sprintf( 'WordPress Ticket #%d is not fixed', $ticket_id ) );
+ }
+ }
+
+ /**
+ * Skips the current test if there is an open Unit Test Trac ticket associated with it.
+ *
+ * @since 3.5.0
+ *
+ * @deprecated No longer used since the Unit Test Trac was merged into the Core Trac.
+ *
+ * @param int $ticket_id Ticket number.
+ */
+ function knownUTBug( $ticket_id ) {
+ return;
+ }
+
+ /**
+ * Skips the current test if there is an open Plugin Trac ticket associated with it.
+ *
+ * @since 3.5.0
+ *
+ * @param int $ticket_id Ticket number.
+ */
+ function knownPluginBug( $ticket_id ) {
+ if ( WP_TESTS_FORCE_KNOWN_BUGS || in_array( 'Plugin' . $ticket_id, self::$forced_tickets ) ) {
+ return;
+ }
+ if ( ! TracTickets::isTracTicketClosed( 'https://plugins.trac.wordpress.org', $ticket_id ) ) {
+ $this->markTestSkipped( sprintf( 'WordPress Plugin Ticket #%d is not fixed', $ticket_id ) );
+ }
+ }
+
+ /**
+ * Adds a Trac ticket number to the `$forced_tickets` property.
+ *
+ * @since 3.5.0
+ *
+ * @param int $ticket Ticket number.
+ */
+ public static function forceTicket( $ticket ) {
+ self::$forced_tickets[] = $ticket;
+ }
+
+ /**
+ * Custom preparations for the PHPUnit process isolation template.
+ *
+ * When restoring global state between tests, PHPUnit defines all the constants that were already defined, and then
+ * includes included files. This does not work with WordPress, as the included files define the constants.
+ *
+ * This method defines the constants after including files.
+ *
+ * @param Text_Template $template
+ */
+ function prepareTemplate( Text_Template $template ) {
+ $template->setVar( array( 'constants' => '' ) );
+ $template->setVar( array( 'wp_constants' => PHPUnit_Util_GlobalState::getConstantsAsString() ) );
+ parent::prepareTemplate( $template );
+ }
+
+ /**
+ * Creates a unique temporary file name.
+ *
+ * The directory in which the file is created depends on the environment configuration.
+ *
+ * @since 3.5.0
+ *
+ * @return string|bool Path on success, else false.
+ */
+ function temp_filename() {
+ $tmp_dir = '';
+ $dirs = array( 'TMP', 'TMPDIR', 'TEMP' );
+ foreach ( $dirs as $dir ) {
+ if ( isset( $_ENV[ $dir ] ) && ! empty( $_ENV[ $dir ] ) ) {
+ $tmp_dir = $dir;
+ break;
+ }
+ }
+ if ( empty( $tmp_dir ) ) {
+ $tmp_dir = '/tmp';
+ }
+ $tmp_dir = realpath( $tmp_dir );
+ return tempnam( $tmp_dir, 'wpunit' );
+ }
+
+ /**
+ * Checks each of the WP_Query is_* functions/properties against expected boolean value.
+ *
+ * Any properties that are listed by name as parameters will be expected to be true; all others are
+ * expected to be false. For example, assertQueryTrue('is_single', 'is_feed') means is_single()
+ * and is_feed() must be true and everything else must be false to pass.
+ *
+ * @since 2.5.0
+ * @since 3.8.0 Moved from `Tests_Query_Conditionals` to `WP_UnitTestCase`.
+ *
+ * @param string $prop,... Any number of WP_Query properties that are expected to be true for the current request.
+ */
+ function assertQueryTrue() {
+ global $wp_query;
+ $all = array(
+ 'is_404',
+ 'is_admin',
+ 'is_archive',
+ 'is_attachment',
+ 'is_author',
+ 'is_category',
+ 'is_comment_feed',
+ 'is_date',
+ 'is_day',
+ 'is_embed',
+ 'is_feed',
+ 'is_front_page',
+ 'is_home',
+ 'is_month',
+ 'is_page',
+ 'is_paged',
+ 'is_post_type_archive',
+ 'is_posts_page',
+ 'is_preview',
+ 'is_robots',
+ 'is_search',
+ 'is_single',
+ 'is_singular',
+ 'is_tag',
+ 'is_tax',
+ 'is_time',
+ 'is_trackback',
+ 'is_year',
+ );
+ $true = func_get_args();
+
+ foreach ( $true as $true_thing ) {
+ $this->assertContains( $true_thing, $all, "Unknown conditional: {$true_thing}." );
+ }
+
+ $passed = true;
+ $message = '';
+
+ foreach ( $all as $query_thing ) {
+ $result = is_callable( $query_thing ) ? call_user_func( $query_thing ) : $wp_query->$query_thing;
+
+ if ( in_array( $query_thing, $true ) ) {
+ if ( ! $result ) {
+ $message .= $query_thing . ' is false but is expected to be true. ' . PHP_EOL;
+ $passed = false;
+ }
+ } elseif ( $result ) {
+ $message .= $query_thing . ' is true but is expected to be false. ' . PHP_EOL;
+ $passed = false;
+ }
+ }
+
+ if ( ! $passed ) {
+ $this->fail( $message );
+ }
+ }
+
+ /**
+ * Selectively deletes a file.
+ *
+ * Does not delete a file if its path is set in the `$ignore_files` property.
+ *
+ * @param string $file File path.
+ */
+ 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" );
+ }
+ }
+
+ /**
+ * Selectively deletes files from a directory.
+ *
+ * Does not delete files if their paths are set in the `$ignore_files` property.
+ *
+ * @param string $path Directory path.
+ */
+ function rmdir( $path ) {
+ $files = $this->files_in_dir( $path );
+ foreach ( $files as $file ) {
+ if ( ! in_array( $file, self::$ignore_files ) ) {
+ $this->unlink( $file );
+ }
+ }
+ }
+
+ /**
+ * Deletes files added to the `uploads` directory during tests.
+ *
+ * This method works in tandem with the `setUp()` and `rmdir()` methods:
+ * - `setUp()` scans the `uploads` directory before every test, and stores its contents inside of the
+ * `$ignore_files` property.
+ * - `rmdir()` and its helper methods only delete files that are not listed in the `$ignore_files` property. If
+ * called during `tearDown()` in tests, this will only delete files added during the previously run test.
+ */
+ function remove_added_uploads() {
+ $uploads = wp_upload_dir();
+ $this->rmdir( $uploads['basedir'] );
+ }
+
+ /**
+ * Returns a list of all files contained inside a directory.
+ *
+ * @since 4.0.0
+ *
+ * @param string $dir Path to the directory to scan.
+ *
+ * @return array List of file paths.
+ */
+ 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;
+ }
+
+ /**
+ * Returns a list of all files contained inside the `uploads` directory.
+ *
+ * @since 4.0.0
+ *
+ * @return array List of file paths.
+ */
+ 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;
+ }
+
+ /**
+ * Deletes all directories contained inside a directory.
+ *
+ * @since 4.1.0
+ *
+ * @param string $path Path to the directory to scan.
+ */
+ function delete_folders( $path ) {
+ $this->matched_dirs = array();
+ if ( ! is_dir( $path ) ) {
+ return;
+ }
+
+ $this->scandir( $path );
+ foreach ( array_reverse( $this->matched_dirs ) as $dir ) {
+ rmdir( $dir );
+ }
+ rmdir( $path );
+ }
+
+ /**
+ * Retrieves all directories contained inside a directory and stores them in the `$matched_dirs` property. Hidden
+ * directories are ignored.
+ *
+ * This is a helper for the `delete_folders()` method.
+ *
+ * @since 4.1.0
+ *
+ * @param string $dir Path to the directory to scan.
+ */
+ function scandir( $dir ) {
+ foreach ( scandir( $dir ) as $path ) {
+ if ( 0 !== strpos( $path, '.' ) && is_dir( $dir . '/' . $path ) ) {
+ $this->matched_dirs[] = $dir . '/' . $path;
+ $this->scandir( $dir . '/' . $path );
+ }
+ }
+ }
+
+ /**
+ * Converts a microtime string into a float.
+ *
+ * @since 4.1.0
+ *
+ * @param string $microtime Time string generated by `microtime()`.
+ *
+ * @return float `microtime()` output as a float.
+ */
+ protected function _microtime_to_float( $microtime ) {
+ $time_array = explode( ' ', $microtime );
+ return array_sum( $time_array );
+ }
+
+ /**
+ * Deletes a user from the database in a Multisite-agnostic way.
+ *
+ * @since 4.3.0
+ *
+ * @param int $user_id User ID.
+ *
+ * @return bool True if the user was deleted.
+ */
+ public static function delete_user( $user_id ) {
+ if ( is_multisite() ) {
+ return wpmu_delete_user( $user_id );
+ } else {
+ return wp_delete_user( $user_id );
+ }
+ }
+
+ /**
+ * Resets permalinks and flushes rewrites.
+ *
+ * @since 4.4.0
+ *
+ * @global WP_Rewrite $wp_rewrite
+ *
+ * @param string $structure Optional. Permalink structure to set. Default empty.
+ */
+ public function set_permalink_structure( $structure = '' ) {
+ global $wp_rewrite;
+
+ $wp_rewrite->init();
+ $wp_rewrite->set_permalink_structure( $structure );
+ $wp_rewrite->flush_rules();
+ }
+
+ /**
+ * Creates an attachment post from an uploaded file.
+ *
+ * @since 4.4.0
+ *
+ * @param array $upload Array of information about the uploaded file, provided by wp_upload_bits().
+ * @param int $parent_post_id Optional. Parent post ID.
+ *
+ * @return int|WP_Error The attachment ID on success. The value 0 or WP_Error on failure.
+ */
+ function _make_attachment( $upload, $parent_post_id = 0 ) {
+ $type = '';
+ if ( ! empty( $upload['type'] ) ) {
+ $type = $upload['type'];
+ } else {
+ $mime = wp_check_filetype( $upload['file'] );
+ if ( $mime ) {
+ $type = $mime['type'];
+ }
+ }
+
+ $attachment = array(
+ 'post_title' => basename( $upload['file'] ),
+ 'post_content' => '',
+ 'post_type' => 'attachment',
+ 'post_parent' => $parent_post_id,
+ 'post_mime_type' => $type,
+ 'guid' => $upload['url'],
+ );
+
+ $id = wp_insert_attachment( $attachment, $upload['file'], $parent_post_id );
+ wp_update_attachment_metadata( $id, wp_generate_attachment_metadata( $id, $upload['file'] ) );
+ return $id;
+ }
+
+ /**
+ * Updates the modified and modified GMT date of a post in the database.
+ *
+ * @since 4.8.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param int $post_id Post ID.
+ * @param string $date Post date, in the format YYYY-MM-DD HH:MM:SS.
+ *
+ * @return int|false 1 on success, or false on error.
+ */
+ protected function update_post_modified( $post_id, $date ) {
+ global $wpdb;
+ return $wpdb->update(
+ $wpdb->posts,
+ array(
+ 'post_modified' => $date,
+ 'post_modified_gmt' => $date,
+ ),
+ array(
+ 'ID' => $post_id,
+ ),
+ array(
+ '%s',
+ '%s',
+ ),
+ array(
+ '%d',
+ )
+ );
+ }
+}
generated by cgit v1.2.3 (git 2.39.1) at 2025-05-03 22:06:40 +0000