Build/Test Tools: Implement use of the void solution.

> PHPUnit 8.0.0 introduced a `void` return type declaration to the "fixture" methods – `setUpBeforeClass()`, `setUp()`, `tearDown()` and `tearDownAfterClass()`. As the `void` return type was not introduced until PHP 7.1, this makes it more difficult to create cross-version compatible tests when using fixtures, due to signature mismatches.
>
> The `Yoast\PHPUnitPolyfills\TestCases\TestCase` overcomes the signature mismatch by having two versions. The correct one will be loaded depending on the PHPUnit version being used.
>
> When using this TestCase, if an individual test, or another TestCase which extends this TestCase, needs to overload any of the "fixture" methods, it should do so by using a snake_case variant of the original fixture method name, i.e. `set_up_before_class()`, `set_up()`, `assert_pre_conditions()`, `assert_post_conditions()`, `tear_down()`, and `tear_down_after_class()`.
>
> The snake_case methods will automatically be called by PHPUnit.
>
> > IMPORTANT: The snake_case methods should not call the PHPUnit parent, i.e. do not use `parent::setUp()` from within an overloaded `set_up()` method. If necessary, DO call `parent::set_up()`.

Reference: https://github.com/Yoast/PHPUnit-Polyfills#testcases

This commit renames all declared fixture methods, and calls to parent versions of those fixture methods, from camelCase to snake_case.

Follow-up to [51559-51567].

Props jrf, hellofromTonya, johnbillion, netweb, dd32, pputzer, SergeyBiryukov.
See #46149.

git-svn-id: https://develop.svn.wordpress.org/trunk@51568 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov
2021-08-07 10:29:41 +00:00
parent cb6bf02638
commit ddb409edca
260 changed files with 726 additions and 726 deletions

View File

@@ -60,7 +60,7 @@ abstract class WP_UnitTestCase_Base extends PHPUnit_Adapter_TestCase {
/**
* Runs the routine before setting up all tests.
*/
public static function setUpBeforeClass() {
public static function set_up_before_class() {
global $wpdb;
$wpdb->suppress_errors = false;
@@ -68,7 +68,7 @@ abstract class WP_UnitTestCase_Base extends PHPUnit_Adapter_TestCase {
$wpdb->db_connect();
ini_set( 'display_errors', 1 );
parent::setUpBeforeClass();
parent::set_up_before_class();
$class = get_called_class();
@@ -82,8 +82,8 @@ abstract class WP_UnitTestCase_Base extends PHPUnit_Adapter_TestCase {
/**
* Runs the routine after all tests have been run.
*/
public static function tearDownAfterClass() {
parent::tearDownAfterClass();
public static function tear_down_after_class() {
parent::tear_down_after_class();
_delete_all_data();
self::flush_cache();
@@ -100,7 +100,7 @@ abstract class WP_UnitTestCase_Base extends PHPUnit_Adapter_TestCase {
/**
* Runs the routine before each test is executed.
*/
public function setUp() {
public function set_up() {
set_time_limit( 0 );
if ( ! self::$ignore_files ) {
@@ -140,7 +140,7 @@ abstract class WP_UnitTestCase_Base extends PHPUnit_Adapter_TestCase {
/**
* After a test method runs, resets any state in WordPress the test method might have changed.
*/
public function tearDown() {
public function tear_down() {
global $wpdb, $wp_query, $wp;
$wpdb->query( 'ROLLBACK' );
if ( is_multisite() ) {
@@ -535,7 +535,7 @@ abstract class WP_UnitTestCase_Base extends PHPUnit_Adapter_TestCase {
*
* @since 4.2.0
*/
protected function assertPostConditions() {
protected function assert_post_conditions() {
$this->expectedDeprecated();
}

View File

@@ -115,8 +115,8 @@ abstract class WP_Ajax_UnitTestCase extends WP_UnitTestCase {
'wp-privacy-erase-personal-data',
);
public static function setUpBeforeClass() {
parent::setUpBeforeClass();
public static function set_up_before_class() {
parent::set_up_before_class();
remove_action( 'admin_init', '_maybe_update_core' );
remove_action( 'admin_init', '_maybe_update_plugins' );
@@ -135,8 +135,8 @@ abstract class WP_Ajax_UnitTestCase extends WP_UnitTestCase {
*
* Overrides wp_die(), pretends to be Ajax, and suppresses E_WARNINGs.
*/
public function setUp() {
parent::setUp();
public function set_up() {
parent::set_up();
add_filter( 'wp_doing_ajax', '__return_true' );
add_filter( 'wp_die_ajax_handler', array( $this, 'getDieHandler' ), 1, 1 );
@@ -156,7 +156,7 @@ abstract class WP_Ajax_UnitTestCase extends WP_UnitTestCase {
*
* Resets $_POST, removes the wp_die() override, restores error reporting.
*/
public function tearDown() {
public function tear_down() {
$_POST = array();
$_GET = array();
unset( $GLOBALS['post'] );
@@ -165,7 +165,7 @@ abstract class WP_Ajax_UnitTestCase extends WP_UnitTestCase {
remove_action( 'clear_auth_cookie', array( $this, 'logout' ) );
error_reporting( $this->_error_level );
set_current_screen( 'front' );
parent::tearDown();
parent::tear_down();
}
/**

View File

@@ -23,8 +23,8 @@ class WP_Canonical_UnitTestCase extends WP_UnitTestCase {
self::delete_shared_fixtures();
}
public function setUp() {
parent::setUp();
public function set_up() {
parent::set_up();
update_option( 'page_comments', true );
update_option( 'comments_per_page', 5 );

View File

@@ -4,8 +4,8 @@ abstract class WP_Test_REST_Controller_Testcase extends WP_Test_REST_TestCase {
protected $server;
public function setUp() {
parent::setUp();
public function set_up() {
parent::set_up();
add_filter( 'rest_url', array( $this, 'filter_rest_url_for_leading_slash' ), 10, 2 );
/** @var WP_REST_Server $wp_rest_server */
global $wp_rest_server;
@@ -13,12 +13,12 @@ abstract class WP_Test_REST_Controller_Testcase extends WP_Test_REST_TestCase {
do_action( 'rest_api_init', $wp_rest_server );
}
public function tearDown() {
public function tear_down() {
remove_filter( 'rest_url', array( $this, 'test_rest_url_for_leading_slash' ), 10, 2 );
/** @var WP_REST_Server $wp_rest_server */
global $wp_rest_server;
$wp_rest_server = null;
parent::tearDown();
parent::tear_down();
}
abstract public function test_register_routes();

View File

@@ -6,20 +6,20 @@ require_once ABSPATH . WPINC . '/class-wp-xmlrpc-server.php';
class WP_XMLRPC_UnitTestCase extends WP_UnitTestCase {
protected $myxmlrpcserver;
function setUp() {
parent::setUp();
function set_up() {
parent::set_up();
add_filter( 'pre_option_enable_xmlrpc', '__return_true' );
$this->myxmlrpcserver = new wp_xmlrpc_server();
}
function tearDown() {
function tear_down() {
remove_filter( 'pre_option_enable_xmlrpc', '__return_true' );
$this->remove_added_uploads();
parent::tearDown();
parent::tear_down();
}
protected static function make_user_by_role( $role ) {