-
Notifications
You must be signed in to change notification settings - Fork 3.1k
Tests: Improves the documentation and structure of test cases #10481
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: trunk
Are you sure you want to change the base?
Conversation
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Test using WordPress PlaygroundThe changes in this pull request can previewed and tested using a WordPress Playground instance. WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser. Some things to be aware of
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
Co-authored-by: Weston Ruter <[email protected]>
| * @ticket 26798 | ||
| * Data provider for test_wp_insert_post_handle_malformed_post_date(). | ||
| * | ||
| * @return array<array{ date: string, expected: bool }> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ideally this would be:
| * @return array<array{ date: string, expected: bool }> | |
| * @return array<string, array{ date: string, expected: bool }> |
Where the array keys in the data provider below are strings in an associative array. What are currently comments like "24-hour time format" should rather be part of the array key. This would make it much easier to locate the data set for a failing test.
| * @ticket 26798 | ||
| * Data provider for test_wp_resolve_post_date_regex(). | ||
| * | ||
| * @return array<array{ date: string, expected: string|false }> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ditto above:
| * @return array<array{ date: string, expected: string|false }> | |
| * @return array<string, array{ date: string, expected: string|false }> |
But this would require coming up with names for all of the tests to use in the keys.
Trac ticket: https://core.trac.wordpress.org/ticket/26798
This PR improves the documentation and structure of test cases related to post date handling in
tests/phpunit/tests/post.php. The main focus is on updating docblocks for clarity and converting data provider methods to static methods, which is a best practice in PHPUnit.test_wp_insert_post_handle_malformed_post_date()andtest_wp_resolve_post_date_regex()to clearly describe the parameters and expected behavior of each test, making the intent and usage of the tests more understandable.data_wp_insert_post_handle_malformed_post_date()anddata_wp_resolve_post_date_regex()to static methods and enhanced their docblocks to specify the structure of the returned data, aligning with PHPUnit best practices.This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.