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/functions.php

    r51653 r52010  
    55 */
    66class Tests_Functions extends WP_UnitTestCase {
    7     function test_wp_parse_args_object() {
     7    public function test_wp_parse_args_object() {
    88        $x        = new MockClass;
    99        $x->_baba = 5;
     
    2222    }
    2323
    24     function test_wp_parse_args_array() {
     24    public function test_wp_parse_args_array() {
    2525        // Arrays.
    2626        $a = array();
     
    4141    }
    4242
    43     function test_wp_parse_args_defaults() {
     43    public function test_wp_parse_args_defaults() {
    4444        $x        = new MockClass;
    4545        $x->_baba = 5;
     
    6767    }
    6868
    69     function test_wp_parse_args_other() {
     69    public function test_wp_parse_args_other() {
    7070        $b = true;
    7171        wp_parse_str( $b, $s );
     
    7979     * @ticket 30753
    8080     */
    81     function test_wp_parse_args_boolean_strings() {
     81    public function test_wp_parse_args_boolean_strings() {
    8282        $args = wp_parse_args( 'foo=false&bar=true' );
    8383        $this->assertIsString( $args['foo'] );
     
    8888     * @ticket 35972
    8989     */
    90     function test_bool_from_yn() {
     90    public function test_bool_from_yn() {
    9191        $this->assertTrue( bool_from_yn( 'Y' ) );
    9292        $this->assertTrue( bool_from_yn( 'y' ) );
     
    9494    }
    9595
    96     function test_path_is_absolute() {
     96    public function test_path_is_absolute() {
    9797        $absolute_paths = array(
    9898            '/',
     
    112112    }
    113113
    114     function test_path_is_not_absolute() {
     114    public function test_path_is_not_absolute() {
    115115        $relative_paths = array(
    116116            '',
     
    136136     * @dataProvider data_wp_normalize_path
    137137     */
    138     function test_wp_normalize_path( $path, $expected ) {
     138    public function test_wp_normalize_path( $path, $expected ) {
    139139        $this->assertSame( $expected, wp_normalize_path( $path ) );
    140140    }
    141141
    142     function data_wp_normalize_path() {
     142    public function data_wp_normalize_path() {
    143143        return array(
    144144            // Windows paths.
     
    164164    }
    165165
    166     function test_wp_unique_filename() {
     166    public function test_wp_unique_filename() {
    167167
    168168        $testdir = DIR_TESTDATA . '/images/';
     
    208208     * @ticket 42437
    209209     */
    210     function test_unique_filename_with_dimension_like_filename() {
     210    public function test_unique_filename_with_dimension_like_filename() {
    211211        $testdir = DIR_TESTDATA . '/images/';
    212212
     
    225225
    226226    // Callback to patch "basedir" when used in `wp_unique_filename()`.
    227     function upload_dir_patch_basedir( $upload_dir ) {
     227    public function upload_dir_patch_basedir( $upload_dir ) {
    228228        $upload_dir['basedir'] = DIR_TESTDATA . '/images/';
    229229        return $upload_dir;
     
    233233     * @ticket 53668
    234234     */
    235     function test_wp_unique_filename_with_additional_image_extension() {
     235    public function test_wp_unique_filename_with_additional_image_extension() {
    236236        $testdir = DIR_TESTDATA . '/images/';
    237237
     
    315315     * @dataProvider data_is_not_serialized
    316316     */
    317     function test_maybe_serialize( $value ) {
     317    public function test_maybe_serialize( $value ) {
    318318        if ( is_array( $value ) || is_object( $value ) ) {
    319319            $expected = serialize( $value );
     
    328328     * @dataProvider data_is_serialized
    329329     */
    330     function test_maybe_serialize_with_double_serialization( $value ) {
     330    public function test_maybe_serialize_with_double_serialization( $value ) {
    331331        $expected = serialize( $value );
    332332
     
    338338     * @dataProvider data_is_not_serialized
    339339     */
    340     function test_maybe_unserialize( $value, $is_serialized ) {
     340    public function test_maybe_unserialize( $value, $is_serialized ) {
    341341        if ( $is_serialized ) {
    342342            $expected = unserialize( trim( $value ) );
     
    356356     * @dataProvider data_is_not_serialized
    357357     */
    358     function test_is_serialized( $value, $expected ) {
     358    public function test_is_serialized( $value, $expected ) {
    359359        $this->assertSame( $expected, is_serialized( $value ) );
    360360    }
     
    363363     * @dataProvider data_serialize_deserialize_objects
    364364     */
    365     function test_deserialize_request_utility_filtered_iterator_objects( $value ) {
     365    public function test_deserialize_request_utility_filtered_iterator_objects( $value ) {
    366366        $serialized = maybe_serialize( $value );
    367367        if ( get_class( $value ) === 'Requests_Utility_FilteredIterator' ) {
     
    376376    }
    377377
    378     function data_serialize_deserialize_objects() {
     378    public function data_serialize_deserialize_objects() {
    379379        return array(
    380380            array( new Requests_Utility_FilteredIterator( array( 1 ), 'md5' ) ),
     
    384384    }
    385385
    386     function data_is_serialized() {
     386    public function data_is_serialized() {
    387387        return array(
    388388            array( serialize( null ), true ),
     
    410410    }
    411411
    412     function data_is_not_serialized() {
     412    public function data_is_not_serialized() {
    413413        return array(
    414414            array( null, false ),
     
    440440     * @dataProvider data_is_serialized_should_return_true_for_large_floats
    441441     */
    442     function test_is_serialized_should_return_true_for_large_floats( $value ) {
     442    public function test_is_serialized_should_return_true_for_large_floats( $value ) {
    443443        $this->assertTrue( is_serialized( $value ) );
    444444    }
    445445
    446     function data_is_serialized_should_return_true_for_large_floats() {
     446    public function data_is_serialized_should_return_true_for_large_floats() {
    447447        return array(
    448448            array( serialize( 1.7976931348623157E+308 ) ),
     
    454454     * @ticket 17375
    455455     */
    456     function test_no_new_serializable_types() {
     456    public function test_no_new_serializable_types() {
    457457        $this->assertFalse( is_serialized( 'C:16:"Serialized_Class":6:{a:0:{}}' ) );
    458458    }
     
    461461     * @group add_query_arg
    462462     */
    463     function test_add_query_arg() {
     463    public function test_add_query_arg() {
    464464        $old_req_uri = $_SERVER['REQUEST_URI'];
    465465
     
    649649     * @ticket 31306
    650650     */
    651     function test_add_query_arg_numeric_keys() {
     651    public function test_add_query_arg_numeric_keys() {
    652652        $url = add_query_arg( array( 'foo' => 'bar' ), '1=1' );
    653653        $this->assertSame( '1=1&foo=bar', $url );
     
    669669     * @ticket 21594
    670670     */
    671     function test_get_allowed_mime_types() {
     671    public function test_get_allowed_mime_types() {
    672672        $mimes = get_allowed_mime_types();
    673673
     
    689689     * @ticket 21594
    690690     */
    691     function test_wp_get_mime_types() {
     691    public function test_wp_get_mime_types() {
    692692        $mimes = wp_get_mime_types();
    693693
     
    721721     * @ticket 23688
    722722     */
    723     function test_canonical_charset() {
     723    public function test_canonical_charset() {
    724724        $orig_blog_charset = get_option( 'blog_charset' );
    725725
     
    759759     * @dataProvider data_wp_parse_list
    760760     */
    761     function test_wp_parse_list( $expected, $actual ) {
     761    public function test_wp_parse_list( $expected, $actual ) {
    762762        $this->assertSame( $expected, array_values( wp_parse_list( $actual ) ) );
    763763    }
    764764
    765     function data_wp_parse_list() {
     765    public function data_wp_parse_list() {
    766766        return array(
    767767            array( array( '1', '2', '3', '4' ), '1,2,3,4' ),
     
    782782     * @dataProvider data_wp_parse_id_list
    783783     */
    784     function test_wp_parse_id_list( $expected, $actual ) {
     784    public function test_wp_parse_id_list( $expected, $actual ) {
    785785        $this->assertSame( $expected, array_values( wp_parse_id_list( $actual ) ) );
    786786    }
    787787
    788     function data_wp_parse_id_list() {
     788    public function data_wp_parse_id_list() {
    789789        return array(
    790790            array( array( 1, 2, 3, 4 ), '1,2,3,4' ),
     
    801801     * @dataProvider data_wp_parse_slug_list
    802802     */
    803     function test_wp_parse_slug_list( $expected, $actual ) {
     803    public function test_wp_parse_slug_list( $expected, $actual ) {
    804804        $this->assertSame( $expected, array_values( wp_parse_slug_list( $actual ) ) );
    805805    }
    806806
    807     function data_wp_parse_slug_list() {
     807    public function data_wp_parse_slug_list() {
    808808        return array(
    809809            array( array( 'apple', 'banana', 'carrot', 'dog' ), 'apple,banana,carrot,dog' ),
     
    817817     * @dataProvider data_device_can_upload
    818818     */
    819     function test_device_can_upload( $user_agent, $expected ) {
     819    public function test_device_can_upload( $user_agent, $expected ) {
    820820        $_SERVER['HTTP_USER_AGENT'] = $user_agent;
    821821        $actual                     = _device_can_upload();
     
    824824    }
    825825
    826     function data_device_can_upload() {
     826    public function data_device_can_upload() {
    827827        return array(
    828828            // iPhone iOS 5.0.1, Safari 5.1.
     
    877877     * @ticket 9064
    878878     */
    879     function test_wp_extract_urls() {
     879    public function test_wp_extract_urls() {
    880880        $original_urls = array(
    881881            'http://woo.com/1,2,3,4,5,6/-1-2-3-4-/woo.html',
     
    10441044     * @ticket 28786
    10451045     */
    1046     function test_wp_json_encode() {
     1046    public function test_wp_json_encode() {
    10471047        $this->assertSame( wp_json_encode( 'a' ), '"a"' );
    10481048    }
     
    10511051     * @ticket 28786
    10521052     */
    1053     function test_wp_json_encode_utf8() {
     1053    public function test_wp_json_encode_utf8() {
    10541054        $this->assertSame( wp_json_encode( '这' ), '"\u8fd9"' );
    10551055    }
     
    10591059     * @requires function mb_detect_order
    10601060     */
    1061     function test_wp_json_encode_non_utf8() {
     1061    public function test_wp_json_encode_non_utf8() {
    10621062        $charsets     = mb_detect_order();
    10631063        $old_charsets = $charsets;
     
    10811081     * @requires function mb_detect_order
    10821082     */
    1083     function test_wp_json_encode_non_utf8_in_array() {
     1083    public function test_wp_json_encode_non_utf8_in_array() {
    10841084        $charsets     = mb_detect_order();
    10851085        $old_charsets = $charsets;
     
    11021102     * @ticket 28786
    11031103     */
    1104     function test_wp_json_encode_array() {
     1104    public function test_wp_json_encode_array() {
    11051105        $this->assertSame( wp_json_encode( array( 'a' ) ), '["a"]' );
    11061106    }
     
    11091109     * @ticket 28786
    11101110     */
    1111     function test_wp_json_encode_object() {
     1111    public function test_wp_json_encode_object() {
    11121112        $object    = new stdClass;
    11131113        $object->a = 'b';
     
    11181118     * @ticket 28786
    11191119     */
    1120     function test_wp_json_encode_depth() {
     1120    public function test_wp_json_encode_depth() {
    11211121        $data = array( array( array( 1, 2, 3 ) ) );
    11221122        $json = wp_json_encode( $data, 0, 1 );
     
    11311131     * @ticket 53238
    11321132     */
    1133     function test_wp_json_file_decode() {
     1133    public function test_wp_json_file_decode() {
    11341134        $result = wp_json_file_decode(
    11351135            DIR_TESTDATA . '/blocks/notice/block.json'
     
    11431143     * @ticket 53238
    11441144     */
    1145     function test_wp_json_file_decode_associative_array() {
     1145    public function test_wp_json_file_decode_associative_array() {
    11461146        $result = wp_json_file_decode(
    11471147            DIR_TESTDATA . '/blocks/notice/block.json',
     
    11571157     * @dataProvider datetime_provider
    11581158     */
    1159     function test_mysql_to_rfc3339( $expected, $actual ) {
     1159    public function test_mysql_to_rfc3339( $expected, $actual ) {
    11601160        $date_return = mysql_to_rfc3339( $actual );
    11611161
     
    11661166    }
    11671167
    1168     function datetime_provider() {
     1168    public function datetime_provider() {
    11691169        return array(
    11701170            array( '2016-03-15T18:54:46', '15-03-2016 18:54:46' ),
     
    12191219     * @ticket 32075
    12201220     */
    1221     function test_wp_raise_memory_limit() {
     1221    public function test_wp_raise_memory_limit() {
    12221222        if ( -1 !== WP_MAX_MEMORY_LIMIT ) {
    12231223            $this->markTestSkipped( 'WP_MAX_MEMORY_LIMIT should be set to -1.' );
     
    12391239     * @ticket 38164
    12401240     */
    1241     function test_wp_generate_uuid4() {
     1241    public function test_wp_generate_uuid4() {
    12421242        $uuids = array();
    12431243        for ( $i = 0; $i < 20; $i += 1 ) {
     
    12571257     * @ticket 39778
    12581258     */
    1259     function test_wp_is_valid_uuid() {
     1259    public function test_wp_is_valid_uuid() {
    12601260        $uuids_v4 = array(
    12611261            '27fe2421-780c-44c5-b39b-fff753092b55',
     
    13071307     * @ticket 44883
    13081308     */
    1309     function test_wp_unique_id() {
     1309    public function test_wp_unique_id() {
    13101310
    13111311        // Test without prefix.
     
    13311331    /**
    13321332     * @ticket 40017
    1333      * @dataProvider _wp_get_image_mime
     1333     * @dataProvider wp_get_image_mime
    13341334     */
    13351335    public function test_wp_get_image_mime( $file, $expected ) {
     
    13661366    /**
    13671367     * @ticket 39550
    1368      * @dataProvider _wp_check_filetype_and_ext_data
     1368     * @dataProvider wp_check_filetype_and_ext_data
    13691369     * @requires extension fileinfo
    13701370     */
    1371     function test_wp_check_filetype_and_ext( $file, $filename, $expected ) {
     1371    public function test_wp_check_filetype_and_ext( $file, $filename, $expected ) {
    13721372        $this->assertSame( $expected, wp_check_filetype_and_ext( $file, $filename ) );
    13731373    }
     
    13781378     * @requires extension fileinfo
    13791379     */
    1380     function test_wp_check_filetype_and_ext_with_filtered_svg() {
     1380    public function test_wp_check_filetype_and_ext_with_filtered_svg() {
    13811381        $file     = DIR_TESTDATA . '/uploads/video-play.svg';
    13821382        $filename = 'video-play.svg';
     
    13881388        );
    13891389
    1390         add_filter( 'upload_mimes', array( $this, '_filter_mime_types_svg' ) );
     1390        add_filter( 'upload_mimes', array( $this, 'filter_mime_types_svg' ) );
    13911391        $this->assertSame( $expected, wp_check_filetype_and_ext( $file, $filename ) );
    13921392
    13931393        // Cleanup.
    1394         remove_filter( 'upload_mimes', array( $this, '_test_add_mime_types_svg' ) );
     1394        remove_filter( 'upload_mimes', array( $this, 'filter_mime_types_svg' ) );
    13951395    }
    13961396
     
    14001400     * @requires extension fileinfo
    14011401     */
    1402     function test_wp_check_filetype_and_ext_with_filtered_woff() {
     1402    public function test_wp_check_filetype_and_ext_with_filtered_woff() {
    14031403        $file     = DIR_TESTDATA . '/uploads/dashicons.woff';
    14041404        $filename = 'dashicons.woff';
     
    14101410        );
    14111411
    1412         add_filter( 'upload_mimes', array( $this, '_filter_mime_types_woff' ) );
     1412        add_filter( 'upload_mimes', array( $this, 'filter_mime_types_woff' ) );
    14131413        $this->assertSame( $expected, wp_check_filetype_and_ext( $file, $filename ) );
    14141414
    14151415        // Cleanup.
    1416         remove_filter( 'upload_mimes', array( $this, '_test_add_mime_types_woff' ) );
    1417     }
    1418 
    1419     public function _filter_mime_types_svg( $mimes ) {
     1416        remove_filter( 'upload_mimes', array( $this, 'filter_mime_types_woff' ) );
     1417    }
     1418
     1419    public function filter_mime_types_svg( $mimes ) {
    14201420        $mimes['svg'] = 'image/svg+xml';
    14211421        return $mimes;
    14221422    }
    14231423
    1424     public function _filter_mime_types_woff( $mimes ) {
     1424    public function filter_mime_types_woff( $mimes ) {
    14251425        $mimes['woff'] = 'application/font-woff';
    14261426        return $mimes;
     
    14301430     * Data provider for test_wp_get_image_mime().
    14311431     */
    1432     public function _wp_get_image_mime() {
     1432    public function wp_get_image_mime() {
    14331433        $data = array(
    14341434            // Standard JPEG.
     
    15851585    }
    15861586
    1587     public function _wp_check_filetype_and_ext_data() {
     1587    public function wp_check_filetype_and_ext_data() {
    15881588        $data = array(
    15891589            // Standard image.
Note: See TracChangeset for help on using the changeset viewer.