Renaming unit test files with underscore in their names.

[stephdau]

The following list of Core phpunit tests have underscores in their name, which is against ​WP's file naming convention (which we enforce in our own repo, so I cannot import them).

trunk/tests/phpunit/tests/filesystem/find_folder.php
trunk/tests/phpunit/tests/hooks/add_filter.php
trunk/tests/phpunit/tests/hooks/apply_filters.php
trunk/tests/phpunit/tests/hooks/do_action.php
trunk/tests/phpunit/tests/hooks/do_all_hook.php
trunk/tests/phpunit/tests/hooks/has_filter.php
trunk/tests/phpunit/tests/hooks/has_filters.php
trunk/tests/phpunit/tests/hooks/preinit_hooks.php
trunk/tests/phpunit/tests/hooks/remove_all_filters.php
trunk/tests/phpunit/tests/hooks/remove_filter.php
trunk/tests/phpunit/tests/image/editor_gd.php
trunk/tests/phpunit/tests/image/editor_imagick.php
trunk/tests/phpunit/tests/image/intermediate_size.php
trunk/tests/phpunit/tests/image/resize_gd.php
trunk/tests/phpunit/tests/image/resize_imagick.php
trunk/tests/phpunit/tests/image/site_icon.php

Would it be possible to have them renamed with hyphens instead of underscores?

[Mte90]

I think that they are an exception because they are all name of functions of WordPress.

[stephdau]

Replying to Mte90:

I think that they are an exception because they are all name of functions of WordPress.

Don't think that's a valid enough reason. :)
Especially when we explicitly say the following for classes:

Class file names should be based on the class name with class- prepended and the underscores in the class name replaced with hyphens, for example WP_Error becomes: class-wp-error.php

[Mte90]

They are functions not classes but probably is missing that part in the docs :-)

[pento]

Yeah, we can do this. We have plenty of other files with a similar purpose (ie, the entire content of the functions folder) that manage to convey their purpose without using underscores.

There doesn't appear to be any particular standard for naming test files, but it looks like camelCase is the most common, so I'm cool with using that.

[welcher]

Any objections to making this a good-first-bug?

[GaryJ]

Rename test files to avoid using underscores

[GaryJ]

Patch created from a git repo, but I'm not convinced that it's going to be SVN-friendly.

[GaryJ]

Use "svn mv" to remove underscores from test file names.

[SergeyBiryukov]

Replying to welcher:

Any objections to making this a good-first-bug?

SVN doesn't properly reflect file copying/renaming in patches, so this can only be done on commit.

[netweb]

Replying to pento:

There doesn't appear to be any particular standard for naming test files, but it looks like camelCase is the most common, so I'm cool with using that.

There is now: ​https://make.wordpress.org/core/handbook/testing/automated-testing/phpunit/#naming

These new docs changes are based on "PHP Unit testing" #coe chats from ~18 months ago

• ​https://make.wordpress.org/core/2016/02/12/php-unit-test-discussion-feb-12-recap/
• ​https://wordpress.slack.com/archives/C02RQBWTW/p1456515743002360

• Writing Tests - Naming
• Tests should be organized in such a way that they’re easy to find and easy to run in isolation.
• Generally the test file path has taken the form /tests/phpunit/tests/{component}/{functionInCamelCase}.php
• Generally a file’s test class has taken the form Tests_{Component}_{FunctionInCamelCase}
• Test method names should take the format test_{{description_of_what_is_expected}}. For example, test_termmeta_cache_should_be_primed_by_default.
• Sometimes it’s handy to have things like /tests/phpunit/tests/query/orderby.php, which is not about a function name but instead about a part of the query infrastructure

[stephdau]

Replying to netweb:

There is now: ​https://make.wordpress.org/core/handbook/testing/automated-testing/phpunit/#naming

😍 Awesome!

[stephdau]

Replying to SergeyBiryukov:

Replying to welcher:

Any objections to making this a good-first-bug?

SVN doesn't properly reflect file copying/renaming in patches, so this can only be done on commit.

Indeed. That's why I couldn't provide one when I opened the ticket.

[pento]

In 41261:

Tests: Rename tests with underscore in the name

There were a handful of files with an underscore in the name, which violated our naming scheme, and caused problems for anyone how enforced the scheme on their own systems.

This commit renames all of the files to the correct camelCase scheme.

Fixes #41658.

[pento]

Side note: I could've done it manually, but writing a command to do it for me was much more interesting, even if it took twice as long.

for i in `find . -name *_*`; do svn mv $i `echo $i | sed -e 's/_\([a-z]\)/\U\1/g'`; done

[pento]

PPS: *_* is an emoticon that expresses how I feel about writing sed expressions.

[ocean90]

phpunit.xml.dist needs to be updated as well.

[pento]

In 41262:

Tests: Rename ignored tests in phpunit.xml.dist.

Some of the files renamed in [41261] are listed in phpunit.xml.dist, as they need to be ignore in PHP 5.2.

This followup commit changes phpunit.xml.dist to match their new names.

See #41658.

[pento]

In 41263:

Tests: Rename ignored tests in multisite.xml.

For bonus :yolo: :friday:, this repeats [41262] for multisite.xml, which duplicates the ignored file list from phpunit.xml.dist.

See #41658.