Canonical: Improve the method names and inline docs for canonical redirect tests.

git-svn-id: https://develop.svn.wordpress.org/trunk@36714 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn 2016-02-25 21:55:57 +00:00
parent a9a61a2764
commit fd03f6ec19

View File

@ -23,9 +23,9 @@ class Tests_Canonical extends WP_Canonical_UnitTestCase {
} }
/** /**
* @dataProvider data * @dataProvider data_canonical
*/ */
function test( $test_url, $expected, $ticket = 0, $expected_doing_it_wrong = array() ) { function test_canonical( $test_url, $expected, $ticket = 0, $expected_doing_it_wrong = array() ) {
if ( false !== strpos( $test_url, '%d' ) ) { if ( false !== strpos( $test_url, '%d' ) ) {
if ( false !== strpos( $test_url, '/?author=%d' ) ) if ( false !== strpos( $test_url, '/?author=%d' ) )
@ -37,14 +37,15 @@ class Tests_Canonical extends WP_Canonical_UnitTestCase {
$this->assertCanonical( $test_url, $expected, $ticket, $expected_doing_it_wrong ); $this->assertCanonical( $test_url, $expected, $ticket, $expected_doing_it_wrong );
} }
function data() { function data_canonical() {
/* Data format: /* Data format:
* [0]: $test_url, * [0]: Test URL.
* [1]: expected results: Any of the following can be used * [1]: expected results: Any of the following can be used
* array( 'url': expected redirection location, 'qv': expected query vars to be set via the rewrite AND $_GET ); * array( 'url': expected redirection location, 'qv': expected query vars to be set via the rewrite AND $_GET );
* array( expected query vars to be set, same as 'qv' above ) * array( expected query vars to be set, same as 'qv' above )
* (string) expected redirect location * (string) expected redirect location
* [2]: (optional) The ticket the test refers to, Can be skipped if unknown. * [2]: (optional) The ticket the test refers to, Can be skipped if unknown.
* [3]: (optional) Array of class/function names expected to throw `_doing_it_wrong()` notices.
*/ */
// Please Note: A few test cases are commented out below, Look at the test case following it, in most cases it's simply showing 2 options for the "proper" redirect. // Please Note: A few test cases are commented out below, Look at the test case following it, in most cases it's simply showing 2 options for the "proper" redirect.