Make WordPress Core


Ignore:
Timestamp:
11/04/2021 03:22:47 PM (3 years ago)
Author:
hellofromTonya
Message:

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.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/tests/phpunit/tests/user.php

    r51738 r52010  
    6161    }
    6262
    63     function set_up() {
     63    public function set_up() {
    6464        parent::set_up();
    6565
     
    6767    }
    6868
    69     function test_get_users_of_blog() {
     69    public function test_get_users_of_blog() {
    7070        // Add one of each user role.
    7171        $nusers = array(
     
    9393
    9494    // Simple get/set tests for user_option functions.
    95     function test_user_option() {
     95    public function test_user_option() {
    9696        $key = rand_str();
    9797        $val = rand_str();
     
    113113     * Simple tests for usermeta functions.
    114114     */
    115     function test_usermeta() {
     115    public function test_usermeta() {
    116116        $key = 'key';
    117117        $val = 'value1';
     
    147147     * Test usermeta functions in array mode.
    148148     */
    149     function test_usermeta_array() {
     149    public function test_usermeta_array() {
    150150        // Some values to set.
    151151        $vals = array(
     
    189189     * Test property magic functions for property get/set/isset.
    190190     */
    191     function test_user_properties() {
     191    public function test_user_properties() {
    192192        $user = new WP_User( self::$author_id );
    193193
     
    248248     * @ticket 20043
    249249     */
    250     function test_user_unset_lowercase_id( $user ) {
     250    public function test_user_unset_lowercase_id( $user ) {
    251251        $id = $user->id;
    252252        unset( $user->id );
     
    261261     * @ticket 20043
    262262     */
    263     function test_user_unset_uppercase_id( $user ) {
     263    public function test_user_unset_uppercase_id( $user ) {
    264264        $this->assertNotEmpty( $user->ID );
    265265        unset( $user->ID );
     
    270270     * Test meta property magic functions for property get/set/isset.
    271271     */
    272     function test_user_meta_properties() {
     272    public function test_user_meta_properties() {
    273273        $user = new WP_User( self::$author_id );
    274274
     
    283283     * @expectedDeprecated WP_User->id
    284284     */
    285     function test_id_property_back_compat() {
     285    public function test_id_property_back_compat() {
    286286        $user = new WP_User( self::$author_id );
    287287
     
    295295     * @ticket 19265
    296296     */
    297     function test_user_level_property_back_compat() {
     297    public function test_user_level_property_back_compat() {
    298298        $roles = array(
    299299            self::$admin_id   => 10,
     
    312312    }
    313313
    314     function test_construction() {
     314    public function test_construction() {
    315315        $user = new WP_User( self::$author_id );
    316316        $this->assertInstanceOf( 'WP_User', $user );
     
    351351    }
    352352
    353     function test_get() {
     353    public function test_get() {
    354354        $user = new WP_User( self::$author_id );
    355355        $this->assertSame( 'author_login', $user->get( 'user_login' ) );
     
    362362    }
    363363
    364     function test_has_prop() {
     364    public function test_has_prop() {
    365365        $user = new WP_User( self::$author_id );
    366366        $this->assertTrue( $user->has_prop( 'user_email' ) );
     
    372372    }
    373373
    374     function test_update_user() {
     374    public function test_update_user() {
    375375        $user = new WP_User( self::$author_id );
    376376
     
    430430     * @ticket 19595
    431431     */
    432     function test_global_userdata() {
     432    public function test_global_userdata() {
    433433        global $userdata, $wpdb;
    434434
     
    446446     * @ticket 19769
    447447     */
    448     function test_global_userdata_is_null_when_logged_out() {
     448    public function test_global_userdata_is_null_when_logged_out() {
    449449        global $userdata;
    450450        wp_set_current_user( 0 );
     
    452452    }
    453453
    454     function test_exists() {
     454    public function test_exists() {
    455455        $user = new WP_User( self::$author_id );
    456456
     
    466466    }
    467467
    468     function test_global_authordata() {
     468    public function test_global_authordata() {
    469469        global $authordata, $id;
    470470
     
    499499     * @ticket 13317
    500500     */
    501     function test_get_userdata() {
     501    public function test_get_userdata() {
    502502        $this->assertFalse( get_userdata( 0 ) );
    503503        $this->assertFalse( get_userdata( '0' ) );
     
    509509     * @ticket 23480
    510510     */
    511     function test_user_get_data_by_id() {
     511    public function test_user_get_data_by_id() {
    512512        $user = WP_User::get_data_by( 'id', self::$author_id );
    513513        $this->assertInstanceOf( 'stdClass', $user );
     
    548548     * @ticket 21431
    549549     */
    550     function test_count_many_users_posts() {
     550    public function test_count_many_users_posts() {
    551551        $user_id_b = self::factory()->user->create( array( 'role' => 'author' ) );
    552552        $post_id_a = self::factory()->post->create( array( 'post_author' => self::$author_id ) );
     
    581581     * @ticket 22858
    582582     */
    583     function test_wp_update_user_on_nonexistent_users() {
     583    public function test_wp_update_user_on_nonexistent_users() {
    584584        $user_id = 1;
    585585        // Find me a non-existent user ID.
     
    595595     * @ticket 28435
    596596     */
    597     function test_wp_update_user_should_not_change_password_when_passed_WP_User_instance() {
     597    public function test_wp_update_user_should_not_change_password_when_passed_WP_User_instance() {
    598598        $testuserid = 1;
    599599        $user       = get_userdata( $testuserid );
     
    610610     * @group ms-excluded
    611611     */
    612     function test_wp_update_user_should_not_mark_user_as_spam_on_single_site() {
     612    public function test_wp_update_user_should_not_mark_user_as_spam_on_single_site() {
    613613        $u = wp_update_user(
    614614            array(
     
    634634     * @ticket 28315
    635635     */
    636     function test_user_meta_error() {
     636    public function test_user_meta_error() {
    637637        $id1 = wp_insert_user(
    638638            array(
     
    665665     * @ticket 30647
    666666     */
    667     function test_user_update_email_error() {
     667    public function test_user_update_email_error() {
    668668        $id1 = wp_insert_user(
    669669            array(
     
    708708    /**
    709709     * @ticket 27317
    710      * @dataProvider _illegal_user_logins_data
    711      */
    712     function test_illegal_user_logins_single( $user_login ) {
     710     * @dataProvider data_illegal_user_logins
     711     */
     712    public function test_illegal_user_logins_single( $user_login ) {
    713713        $user_data = array(
    714714            'user_login' => $user_login,
     
    717717        );
    718718
    719         add_filter( 'illegal_user_logins', array( $this, '_illegal_user_logins' ) );
     719        add_filter( 'illegal_user_logins', array( $this, 'illegal_user_logins' ) );
    720720
    721721        $response = wp_insert_user( $user_data );
     
    723723        $this->assertSame( 'invalid_username', $response->get_error_code() );
    724724
    725         remove_filter( 'illegal_user_logins', array( $this, '_illegal_user_logins' ) );
     725        remove_filter( 'illegal_user_logins', array( $this, 'illegal_user_logins' ) );
    726726
    727727        $user_id = wp_insert_user( $user_data );
     
    732732    /**
    733733     * @ticket 27317
    734      * @dataProvider _illegal_user_logins_data
    735      */
    736     function test_illegal_user_logins_single_wp_create_user( $user_login ) {
     734     * @dataProvider data_illegal_user_logins
     735     */
     736    public function test_illegal_user_logins_single_wp_create_user( $user_login ) {
    737737        $user_email = 'testuser-' . $user_login . '@example.com';
    738738
    739         add_filter( 'illegal_user_logins', array( $this, '_illegal_user_logins' ) );
     739        add_filter( 'illegal_user_logins', array( $this, 'illegal_user_logins' ) );
    740740
    741741        $response = register_new_user( $user_login, $user_email );
     
    743743        $this->assertSame( 'invalid_username', $response->get_error_code() );
    744744
    745         remove_filter( 'illegal_user_logins', array( $this, '_illegal_user_logins' ) );
     745        remove_filter( 'illegal_user_logins', array( $this, 'illegal_user_logins' ) );
    746746
    747747        $response = register_new_user( $user_login, $user_email );
     
    754754     * @group ms-required
    755755     */
    756     function test_illegal_user_logins_multisite() {
     756    public function test_illegal_user_logins_multisite() {
    757757        $user_data = array(
    758758            'user_login' => 'testuser',
     
    760760        );
    761761
    762         add_filter( 'illegal_user_logins', array( $this, '_illegal_user_logins' ) );
     762        add_filter( 'illegal_user_logins', array( $this, 'illegal_user_logins' ) );
    763763
    764764        $response = wpmu_validate_user_signup( $user_data['user_login'], $user_data['user_email'] );
     
    766766        $this->assertSame( 'user_name', $response['errors']->get_error_code() );
    767767
    768         remove_filter( 'illegal_user_logins', array( $this, '_illegal_user_logins' ) );
     768        remove_filter( 'illegal_user_logins', array( $this, 'illegal_user_logins' ) );
    769769
    770770        $response = wpmu_validate_user_signup( $user_data['user_login'], $user_data['user_email'] );
     
    773773    }
    774774
    775     function _illegal_user_logins_data() {
     775    public function data_illegal_user_logins() {
    776776        $data = array(
    777777            array( 'testuser' ),
     
    785785    }
    786786
    787     function _illegal_user_logins() {
     787    public function illegal_user_logins() {
    788788        return array( 'testuser' );
    789789    }
     
    11641164     * @ticket 32158
    11651165     */
    1166     function test_email_case() {
     1166    public function test_email_case() {
    11671167        // Alter the case of the email address (which stays the same).
    11681168        $userdata = array(
     
    11781178     * @ticket 32158
    11791179     */
    1180     function test_email_change() {
     1180    public function test_email_change() {
    11811181        // Change the email address.
    11821182        $userdata = array(
     
    12011201     * @ticket 36009
    12021202     */
    1203     function test_wp_new_user_notification( $notify, $admin_email_sent_expected, $user_email_sent_expected ) {
     1203    public function test_wp_new_user_notification( $notify, $admin_email_sent_expected, $user_email_sent_expected ) {
    12041204        reset_phpmailer_instance();
    12051205
     
    12441244     * }
    12451245     */
    1246     function data_wp_new_user_notifications() {
     1246    public function data_wp_new_user_notifications() {
    12471247        return array(
    12481248            array(
     
    12811281     * @expectedDeprecated wp_new_user_notification
    12821282     */
    1283     function test_wp_new_user_notification_old_signature_throws_deprecated_warning_but_sends() {
     1283    public function test_wp_new_user_notification_old_signature_throws_deprecated_warning_but_sends() {
    12841284        reset_phpmailer_instance();
    12851285
     
    13061306     * @ticket 34377
    13071307     */
    1308     function test_wp_new_user_notification_old_signature_no_password() {
     1308    public function test_wp_new_user_notification_old_signature_no_password() {
    13091309        reset_phpmailer_instance();
    13101310
     
    13311331     * @ticket 40015
    13321332     */
    1333     function test_new_admin_email_notification_html_entities_decoded() {
     1333    public function test_new_admin_email_notification_html_entities_decoded() {
    13341334        reset_phpmailer_instance();
    13351335
     
    13641364     * @dataProvider data_user_admin_email_confirmation_emails
    13651365     */
    1366     function test_new_admin_email_confirmation_not_sent_when_email_invalid( $email, $message ) {
     1366    public function test_new_admin_email_confirmation_not_sent_when_email_invalid( $email, $message ) {
    13671367        reset_phpmailer_instance();
    13681368
     
    13841384     * }
    13851385     */
    1386     function data_user_admin_email_confirmation_emails() {
     1386    public function data_user_admin_email_confirmation_emails() {
    13871387        return array(
    13881388            array(
     
    14051405     * @dataProvider data_user_change_email_confirmation_emails
    14061406     */
    1407     function test_profile_email_confirmation_not_sent_invalid_email( $email, $message ) {
     1407    public function test_profile_email_confirmation_not_sent_invalid_email( $email, $message ) {
    14081408
    14091409        $old_current = get_current_user_id();
     
    14481448     * }
    14491449     */
    1450     function data_user_change_email_confirmation_emails() {
     1450    public function data_user_change_email_confirmation_emails() {
    14511451        return array(
    14521452            array(
     
    14711471     * @ticket 42766
    14721472     */
    1473     function test_edit_user_blank_password() {
     1473    public function test_edit_user_blank_password() {
    14741474        $_POST                 = array();
    14751475        $_GET                  = array();
     
    15451545     * Check passwords action for test_edit_user_blank_password().
    15461546     */
    1547     function action_check_passwords_blank_password( $user_login, &$pass1 ) {
     1547    public function action_check_passwords_blank_password( $user_login, &$pass1 ) {
    15481548        $pass1 = '';
    15491549    }
     
    15521552     * @ticket 16470
    15531553     */
    1554     function test_send_confirmation_on_profile_email() {
     1554    public function test_send_confirmation_on_profile_email() {
    15551555        reset_phpmailer_instance();
    15561556        $was_confirmation_email_sent = false;
     
    15871587     * @ticket 16470
    15881588     */
    1589     function test_remove_send_confirmation_on_profile_email() {
     1589    public function test_remove_send_confirmation_on_profile_email() {
    15901590        remove_action( 'personal_options_update', 'send_confirmation_on_profile_email' );
    15911591
     
    16271627     * @ticket 40015
    16281628     */
    1629     function test_send_confirmation_on_profile_email_html_entities_decoded() {
     1629    public function test_send_confirmation_on_profile_email_html_entities_decoded() {
    16301630        $user_id = self::factory()->user->create(
    16311631            array(
     
    16631663     * @ticket 42564
    16641664     */
    1665     function test_edit_user_role_update() {
     1665    public function test_edit_user_role_update() {
    16661666        $_POST    = array();
    16671667        $_GET     = array();
     
    17061706     * @ticket 43547
    17071707     */
    1708     function test_wp_user_personal_data_exporter_no_user() {
     1708    public function test_wp_user_personal_data_exporter_no_user() {
    17091709        $actual = wp_user_personal_data_exporter( 'not-a-user-email@test.com' );
    17101710
     
    17231723     * @ticket 43547
    17241724     */
    1725     function test_wp_user_personal_data_exporter() {
     1725    public function test_wp_user_personal_data_exporter() {
    17261726        $test_user = new WP_User( self::$contrib_id );
    17271727
     
    17431743     * @ticket 43921
    17441744     */
    1745     function test_wp_community_events_location_ip_personal_data_exporter() {
     1745    public function test_wp_community_events_location_ip_personal_data_exporter() {
    17461746        $test_user = new WP_User( self::$contrib_id );
    17471747
     
    17671767     * @ticket 43921
    17681768     */
    1769     function test_wp_community_events_location_city_personal_data_exporter() {
     1769    public function test_wp_community_events_location_city_personal_data_exporter() {
    17701770        $test_user = new WP_User( self::$contrib_id );
    17711771
     
    18091809     * @ticket 45889
    18101810     */
    1811     function test_wp_session_tokens_personal_data_exporter() {
     1811    public function test_wp_session_tokens_personal_data_exporter() {
    18121812        $test_user = new WP_User( self::$contrib_id );
    18131813
     
    19251925     * @ticket 47509
    19261926     */
    1927     function test_filter_wp_privacy_additional_user_profile_data() {
     1927    public function test_filter_wp_privacy_additional_user_profile_data() {
    19281928        $test_user = new WP_User( self::$contrib_id );
    19291929
Note: See TracChangeset for help on using the changeset viewer.