Coding Standards: Add visibility to methods in tests/phpunit/tests/.

Adds a `public` visibility to test fixtures, tests, data providers, and callbacks methods.

Adds a `private` visibility to helper methods within test classes.

Renames callbacks and helpers that previously started with a `_` prefix. Why? For consistency and to leverage using the method visibility. Further naming standardizations is beyond the scope of this commit.

Props costdev, jrf, hellofromTonya.
Fixes #54177.

git-svn-id: https://develop.svn.wordpress.org/trunk@52010 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Tonya Mork
2021-11-04 15:22:47 +00:00
parent 80380cd374
commit 40ac5de838
327 changed files with 3656 additions and 3969 deletions

View File

@@ -19,7 +19,7 @@ class Tests_Theme_CustomHeader extends WP_UnitTestCase {
self::$header_video_id = $factory->attachment->create_upload_object( $file );
}
function set_up() {
public function set_up() {
parent::set_up();
require_once ABSPATH . WPINC . '/class-wp-customize-manager.php';
@@ -29,7 +29,7 @@ class Tests_Theme_CustomHeader extends WP_UnitTestCase {
wp_dequeue_script( 'wp-custom-header' );
}
function tear_down() {
public function tear_down() {
$this->customize_manager = null;
unset( $GLOBALS['wp_customize'] );
@@ -42,33 +42,33 @@ class Tests_Theme_CustomHeader extends WP_UnitTestCase {
parent::tear_down();
}
function test_add_and_remove_theme_support() {
$this->_add_theme_support();
public function test_add_and_remove_theme_support() {
$this->add_theme_support();
$this->assertTrue( current_theme_supports( 'custom-header' ) );
remove_theme_support( 'custom-header' );
$this->assertFalse( current_theme_supports( 'custom-header' ) );
}
function test_get_header_image_without_registered_default() {
$this->_add_theme_support();
public function test_get_header_image_without_registered_default() {
$this->add_theme_support();
$image = get_header_image();
$this->assertFalse( has_header_image() );
$this->assertEmpty( $image );
}
function test_get_header_image_with_registered_default() {
public function test_get_header_image_with_registered_default() {
$default = 'http://localhost/default-header.jpg';
$this->_add_theme_support( array( 'default-image' => $default ) );
$this->add_theme_support( array( 'default-image' => $default ) );
$image = get_header_image();
$this->assertTrue( has_header_image() );
$this->assertSame( $default, $image );
}
function test_get_header_image_from_theme_mod() {
public function test_get_header_image_from_theme_mod() {
$default = 'http://localhost/default-header.jpg';
$custom = 'http://localhost/custom-header.jpg';
$this->_add_theme_support( array( 'default-image' => $default ) );
$this->add_theme_support( array( 'default-image' => $default ) );
set_theme_mod( 'header_image', $custom );
$image = get_header_image();
@@ -81,15 +81,15 @@ class Tests_Theme_CustomHeader extends WP_UnitTestCase {
$this->assertFalse( $image );
}
function test_get_header_image_tag_without_registered_default_image() {
$this->_add_theme_support();
public function test_get_header_image_tag_without_registered_default_image() {
$this->add_theme_support();
$html = get_header_image_tag();
$this->assertEmpty( $html );
}
function test_get_header_image_tag_with_registered_default_image() {
public function test_get_header_image_tag_with_registered_default_image() {
$default = 'http://localhost/default-header.jpg';
$this->_add_theme_support( array( 'default-image' => $default ) );
$this->add_theme_support( array( 'default-image' => $default ) );
$html = get_header_image_tag();
$this->assertStringStartsWith( '<img ', $html );
@@ -99,19 +99,19 @@ class Tests_Theme_CustomHeader extends WP_UnitTestCase {
/**
* @ticket 38633
*/
function test_get_header_image_tag_with_registered_default_image_and_remove_header_theme_mod() {
public function test_get_header_image_tag_with_registered_default_image_and_remove_header_theme_mod() {
$default = 'http://localhost/default-header.jpg';
$this->_add_theme_support( array( 'default-image' => $default ) );
$this->add_theme_support( array( 'default-image' => $default ) );
set_theme_mod( 'header_image', 'remove-header' );
$html = get_header_image_tag();
$this->assertEmpty( $html );
}
function test_get_header_image_tag_with_registered_default_image_and_custom_theme_mod() {
public function test_get_header_image_tag_with_registered_default_image_and_custom_theme_mod() {
$default = 'http://localhost/default-header.jpg';
$custom = 'http://localhost/custom-header.jpg';
$this->_add_theme_support( array( 'default-image' => $default ) );
$this->add_theme_support( array( 'default-image' => $default ) );
set_theme_mod( 'header_image', $custom );
$html = get_header_image_tag();
@@ -119,30 +119,30 @@ class Tests_Theme_CustomHeader extends WP_UnitTestCase {
$this->assertStringContainsString( sprintf( 'src="%s"', $custom ), $html );
}
function test_get_custom_header_markup_without_registered_default_image() {
$this->_add_theme_support();
public function test_get_custom_header_markup_without_registered_default_image() {
$this->add_theme_support();
$html = get_custom_header_markup();
$this->assertFalse( has_custom_header() );
$this->assertEmpty( $html );
// The container should always be returned in the Customizer preview.
$this->_set_customize_previewing( true );
$this->set_customize_previewing( true );
$html = get_custom_header_markup();
$this->assertSame( '<div id="wp-custom-header" class="wp-custom-header"></div>', $html );
}
function test_get_custom_header_markup_with_registered_default_image() {
public function test_get_custom_header_markup_with_registered_default_image() {
$default = 'http://localhost/default-header.jpg';
$this->_add_theme_support( array( 'default-image' => $default ) );
$this->add_theme_support( array( 'default-image' => $default ) );
$html = get_custom_header_markup();
$this->assertTrue( has_custom_header() );
$this->assertStringStartsWith( '<div id="wp-custom-header" class="wp-custom-header">', $html );
$this->assertStringContainsString( sprintf( 'src="%s"', $default ), $html );
}
function test_get_header_video_url() {
$this->_add_theme_support( array( 'video' => true ) );
public function test_get_header_video_url() {
$this->add_theme_support( array( 'video' => true ) );
$this->assertFalse( has_header_video() );
set_theme_mod( 'header_video', self::$header_video_id );
@@ -150,9 +150,9 @@ class Tests_Theme_CustomHeader extends WP_UnitTestCase {
$this->assertSame( wp_get_attachment_url( self::$header_video_id ), get_header_video_url() );
}
function test_get_external_header_video_url() {
public function test_get_external_header_video_url() {
$external = 'http://example.com/custom-video.mp4';
$this->_add_theme_support( array( 'video' => true ) );
$this->add_theme_support( array( 'video' => true ) );
$this->assertFalse( has_header_video() );
set_theme_mod( 'external_header_video', $external );
@@ -160,18 +160,18 @@ class Tests_Theme_CustomHeader extends WP_UnitTestCase {
$this->assertSame( $external, get_header_video_url() );
}
function test_get_header_video_url_prefers_local_video() {
public function test_get_header_video_url_prefers_local_video() {
$external = 'http://example.com/custom-video.mp4';
$this->_add_theme_support( array( 'video' => true ) );
$this->add_theme_support( array( 'video' => true ) );
set_theme_mod( 'header_video', self::$header_video_id );
set_theme_mod( 'external_header_video', $external );
$this->assertSame( wp_get_attachment_url( self::$header_video_id ), get_header_video_url() );
}
function test_get_custom_header_markup_with_video_and_without_an_image() {
public function test_get_custom_header_markup_with_video_and_without_an_image() {
$custom = 'http://localhost/custom-video.mp4';
$this->_add_theme_support(
$this->add_theme_support(
array(
'video' => true,
'video-active-callback' => '__return_true',
@@ -185,8 +185,8 @@ class Tests_Theme_CustomHeader extends WP_UnitTestCase {
$this->assertSame( '<div id="wp-custom-header" class="wp-custom-header"></div>', $html );
}
function test_header_script_is_not_enqueued_by_the_custom_header_markup_without_video() {
$this->_add_theme_support(
public function test_header_script_is_not_enqueued_by_the_custom_header_markup_without_video() {
$this->add_theme_support(
array(
'video' => true,
'video-active-callback' => '__return_true',
@@ -206,8 +206,8 @@ class Tests_Theme_CustomHeader extends WP_UnitTestCase {
$this->assertFalse( wp_script_is( 'wp-custom-header', 'enqueued' ) );
}
function test_header_script_is_not_enqueued_by_the_custom_header_markup_when_active_callback_is_false() {
$this->_add_theme_support(
public function test_header_script_is_not_enqueued_by_the_custom_header_markup_when_active_callback_is_false() {
$this->add_theme_support(
array(
'video' => true,
'video-active-callback' => '__return_false',
@@ -221,14 +221,14 @@ class Tests_Theme_CustomHeader extends WP_UnitTestCase {
$this->assertFalse( wp_script_is( 'wp-custom-header', 'enqueued' ) );
}
function test_header_script_is_enqueued_by_the_custom_header_markup_without_video_when_previewing_in_customizer() {
$this->_add_theme_support(
public function test_header_script_is_enqueued_by_the_custom_header_markup_without_video_when_previewing_in_customizer() {
$this->add_theme_support(
array(
'video' => true,
'video-active-callback' => '__return_true',
)
);
$this->_set_customize_previewing( true );
$this->set_customize_previewing( true );
ob_start();
the_custom_header_markup();
@@ -236,8 +236,8 @@ class Tests_Theme_CustomHeader extends WP_UnitTestCase {
$this->assertTrue( wp_script_is( 'wp-custom-header', 'enqueued' ) );
}
function test_header_script_is_enqueued_by_the_custom_header_markup_with_video() {
$this->_add_theme_support(
public function test_header_script_is_enqueued_by_the_custom_header_markup_with_video() {
$this->add_theme_support(
array(
'video' => true,
'video-active-callback' => '__return_true',
@@ -254,8 +254,8 @@ class Tests_Theme_CustomHeader extends WP_UnitTestCase {
/**
* @ticket 38738
*/
function test_video_header_callback_front_page_from_front_page() {
$this->_add_theme_support(
public function test_video_header_callback_front_page_from_front_page() {
$this->add_theme_support(
array(
'video' => true,
)
@@ -271,8 +271,8 @@ class Tests_Theme_CustomHeader extends WP_UnitTestCase {
/**
* @ticket 38738
*/
function test_video_header_callback_front_page_from_elsewhere() {
$this->_add_theme_support(
public function test_video_header_callback_front_page_from_elsewhere() {
$this->add_theme_support(
array(
'video' => true,
)
@@ -288,8 +288,8 @@ class Tests_Theme_CustomHeader extends WP_UnitTestCase {
/**
* @ticket 38738
*/
function test_video_header_callback_globally_from_front_page() {
$this->_add_theme_support(
public function test_video_header_callback_globally_from_front_page() {
$this->add_theme_support(
array(
'video' => true,
'video-active-callback' => '__return_true',
@@ -306,8 +306,8 @@ class Tests_Theme_CustomHeader extends WP_UnitTestCase {
/**
* @ticket 38738
*/
function test_video_header_callback_globally_from_elsewhere() {
$this->_add_theme_support(
public function test_video_header_callback_globally_from_elsewhere() {
$this->add_theme_support(
array(
'video' => true,
'video-active-callback' => '__return_true',
@@ -324,8 +324,8 @@ class Tests_Theme_CustomHeader extends WP_UnitTestCase {
/**
* @ticket 38738
*/
function test_video_header_callback_globally_with_negative_filter() {
$this->_add_theme_support(
public function test_video_header_callback_globally_with_negative_filter() {
$this->add_theme_support(
array(
'video' => true,
'video-active-callback' => '__return_true',
@@ -346,7 +346,7 @@ class Tests_Theme_CustomHeader extends WP_UnitTestCase {
* add_theme_support( 'custom-header' ) will poison subsequent tests since
* it defines constants.
*/
function _add_theme_support( $args = array() ) {
private function add_theme_support( $args = array() ) {
global $_wp_theme_features;
$_wp_theme_features['custom-header'][0] = wp_parse_args(
@@ -370,7 +370,7 @@ class Tests_Theme_CustomHeader extends WP_UnitTestCase {
);
}
function _set_customize_previewing( $value ) {
private function set_customize_previewing( $value ) {
$class = new ReflectionClass( 'WP_Customize_Manager' );
$property = $class->getProperty( 'previewing' );
$property->setAccessible( true );