mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2025-10-16 12:05:38 +00:00
85ae9dd89b
WordPress core test suite uses PHPUnit's `beStrictAboutTestsThatDoNotTestAnything` option set to `true`, which marks a test as risky when no assertions are performed. REST API test classes have some empty tests for non-implemented methods because these test classes extend the abstract `WP_Test_REST_Controller_Testcase` class, which requires several methods to be implemented that don't necessarily make sense for all REST API routes. Some of these empty tests were already marked as skipped, but not in a consistent manner. Since skipping these tests is intentional for the time being, this commit aims to bring some consistency and adjust them all to be more accurately reported as skipped instead of risky. The skipping can be reconsidered in the future when the tests are either removed as unnecessary or updated to actually perform assertions related to their behavior. Follow-up to [40534], [41176], [41228]. Props Mte90, tomepajk, johnbillion, zieladam, SergeyBiryukov. See #40538, #41463, #55652. git-svn-id: https://develop.svn.wordpress.org/trunk@53921 602fd350-edb4-49c9-b593-d223f7449a82
563 lines
16 KiB
PHP
563 lines
16 KiB
PHP
<?php
|
|
/**
|
|
* Unit tests covering WP_REST_Pattern_Directory_Controller functionality.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage REST API
|
|
*/
|
|
|
|
/**
|
|
* @group restapi
|
|
* @group pattern-directory
|
|
*/
|
|
class WP_REST_Pattern_Directory_Controller_Test extends WP_Test_REST_Controller_Testcase {
|
|
|
|
/**
|
|
* Contributor user id.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @var int
|
|
*/
|
|
protected static $contributor_id;
|
|
|
|
/**
|
|
* An instance of WP_REST_Pattern_Directory_Controller class.
|
|
*
|
|
* @since 6.0.0
|
|
*
|
|
* @var WP_REST_Pattern_Directory_Controller
|
|
*/
|
|
private static $controller;
|
|
|
|
/**
|
|
* Set up class test fixtures.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param WP_UnitTest_Factory $factory WordPress unit test factory.
|
|
*/
|
|
public static function wpSetUpBeforeClass( $factory ) {
|
|
self::$contributor_id = $factory->user->create(
|
|
array(
|
|
'role' => 'contributor',
|
|
)
|
|
);
|
|
|
|
static::$controller = new WP_REST_Pattern_Directory_Controller();
|
|
}
|
|
|
|
/**
|
|
* Asserts that the pattern matches the expected response schema.
|
|
*
|
|
* @param WP_REST_Response[] $pattern An individual pattern from the REST API response.
|
|
*/
|
|
public function assertPatternMatchesSchema( $pattern ) {
|
|
$schema = static::$controller->get_item_schema();
|
|
$pattern_id = isset( $pattern->id ) ? $pattern->id : '{pattern ID is missing}';
|
|
|
|
$this->assertTrue(
|
|
rest_validate_value_from_schema( $pattern, $schema ),
|
|
"Pattern ID `$pattern_id` doesn't match the response schema."
|
|
);
|
|
|
|
$this->assertSame(
|
|
array_keys( $schema['properties'] ),
|
|
array_keys( $pattern ),
|
|
"Pattern ID `$pattern_id` doesn't contain all of the fields expected from the schema."
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @covers WP_REST_Pattern_Directory_Controller::register_routes
|
|
*
|
|
* @since 5.8.0
|
|
*/
|
|
public function test_register_routes() {
|
|
$routes = rest_get_server()->get_routes();
|
|
|
|
$this->assertArrayHasKey( '/wp/v2/pattern-directory/patterns', $routes );
|
|
}
|
|
|
|
/**
|
|
* @covers WP_REST_Pattern_Directory_Controller::get_context_param
|
|
*
|
|
* @since 5.8.0
|
|
*/
|
|
public function test_context_param() {
|
|
$request = new WP_REST_Request( 'OPTIONS', '/wp/v2/pattern-directory/patterns' );
|
|
$response = rest_get_server()->dispatch( $request );
|
|
$patterns = $response->get_data();
|
|
|
|
$this->assertSame( 'view', $patterns['endpoints'][0]['args']['context']['default'] );
|
|
$this->assertSame( array( 'view', 'embed', 'edit' ), $patterns['endpoints'][0]['args']['context']['enum'] );
|
|
}
|
|
|
|
/**
|
|
* @covers WP_REST_Pattern_Directory_Controller::get_items
|
|
*
|
|
* @since 5.8.0
|
|
*/
|
|
public function test_get_items() {
|
|
wp_set_current_user( self::$contributor_id );
|
|
self::mock_successful_response( 'browse-all', true );
|
|
|
|
$request = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
|
|
$response = rest_do_request( $request );
|
|
$patterns = $response->get_data();
|
|
|
|
$this->assertNotWPError( $response->as_error() );
|
|
$this->assertSame( 200, $response->status );
|
|
$this->assertGreaterThan( 0, count( $patterns ) );
|
|
|
|
array_walk( $patterns, array( $this, 'assertPatternMatchesSchema' ) );
|
|
$this->assertSame( array( 'blog post' ), $patterns[0]['keywords'] );
|
|
$this->assertSame( array( 'header', 'hero' ), $patterns[1]['keywords'] );
|
|
$this->assertSame( array( 'call to action', 'hero section' ), $patterns[2]['keywords'] );
|
|
}
|
|
|
|
/**
|
|
* @covers WP_REST_Pattern_Directory_Controller::get_items
|
|
*
|
|
* @since 5.8.0
|
|
*/
|
|
public function test_get_items_by_category() {
|
|
wp_set_current_user( self::$contributor_id );
|
|
self::mock_successful_response( 'browse-category', true );
|
|
|
|
$request = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
|
|
$request->set_query_params( array( 'category' => 2 ) );
|
|
$response = rest_do_request( $request );
|
|
$patterns = $response->get_data();
|
|
|
|
$this->assertNotWPError( $response->as_error() );
|
|
$this->assertSame( 200, $response->status );
|
|
$this->assertGreaterThan( 0, count( $patterns ) );
|
|
|
|
array_walk( $patterns, array( $this, 'assertPatternMatchesSchema' ) );
|
|
|
|
foreach ( $patterns as $pattern ) {
|
|
$this->assertContains( 'buttons', $pattern['categories'] );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @covers WP_REST_Pattern_Directory_Controller::get_items
|
|
*
|
|
* @since 5.8.0
|
|
*/
|
|
public function test_get_items_by_keyword() {
|
|
wp_set_current_user( self::$contributor_id );
|
|
self::mock_successful_response( 'browse-keyword', true );
|
|
|
|
$request = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
|
|
$request->set_query_params( array( 'keyword' => 11 ) );
|
|
$response = rest_do_request( $request );
|
|
$patterns = $response->get_data();
|
|
|
|
$this->assertNotWPError( $response->as_error() );
|
|
$this->assertSame( 200, $response->status );
|
|
$this->assertGreaterThan( 0, count( $patterns ) );
|
|
|
|
array_walk( $patterns, array( $this, 'assertPatternMatchesSchema' ) );
|
|
}
|
|
|
|
/**
|
|
* @covers WP_REST_Pattern_Directory_Controller::get_items
|
|
*
|
|
* @since 5.8.0
|
|
*/
|
|
public function test_get_items_search() {
|
|
wp_set_current_user( self::$contributor_id );
|
|
self::mock_successful_response( 'search', true );
|
|
|
|
$search_term = 'button';
|
|
$request = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
|
|
$request->set_query_params( array( 'search' => $search_term ) );
|
|
$response = rest_do_request( $request );
|
|
$patterns = $response->get_data();
|
|
|
|
$this->assertNotWPError( $response->as_error() );
|
|
$this->assertSame( 200, $response->status );
|
|
$this->assertGreaterThan( 0, count( $patterns ) );
|
|
|
|
array_walk( $patterns, array( $this, 'assertPatternMatchesSchema' ) );
|
|
|
|
foreach ( $patterns as $pattern ) {
|
|
$search_field_values = $pattern['title'] . ' ' . $pattern['description'];
|
|
|
|
$this->assertStringContainsStringIgnoringCase( $search_term, $search_field_values );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @covers WP_REST_Pattern_Directory_Controller::get_items
|
|
*
|
|
* @since 5.8.0
|
|
*/
|
|
public function test_get_items_wdotorg_unavailable() {
|
|
wp_set_current_user( self::$contributor_id );
|
|
self::prevent_requests_to_host( 'api.wordpress.org' );
|
|
|
|
$request = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
|
|
$response = rest_do_request( $request );
|
|
|
|
$this->assertErrorResponse( 'patterns_api_failed', $response, 500 );
|
|
}
|
|
|
|
/**
|
|
* @covers WP_REST_Pattern_Directory_Controller::get_items
|
|
*
|
|
* @since 5.8.0
|
|
*/
|
|
public function test_get_items_logged_out() {
|
|
$request = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
|
|
$request->set_query_params( array( 'search' => 'button' ) );
|
|
$response = rest_do_request( $request );
|
|
|
|
$this->assertErrorResponse( 'rest_pattern_directory_cannot_view', $response );
|
|
}
|
|
|
|
/**
|
|
* @covers WP_REST_Pattern_Directory_Controller::get_items
|
|
*
|
|
* @since 5.8.0
|
|
*/
|
|
public function test_get_items_no_results() {
|
|
wp_set_current_user( self::$contributor_id );
|
|
self::mock_successful_response( 'browse-all', false );
|
|
|
|
$request = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
|
|
$request->set_query_params( array( 'category' => PHP_INT_MAX ) );
|
|
$response = rest_do_request( $request );
|
|
$patterns = $response->get_data();
|
|
|
|
$this->assertSame( 200, $response->status );
|
|
$this->assertSame( array(), $patterns );
|
|
}
|
|
|
|
/**
|
|
* @covers WP_REST_Pattern_Directory_Controller::get_items
|
|
*
|
|
* @since 5.8.0
|
|
*/
|
|
public function test_get_items_search_no_results() {
|
|
wp_set_current_user( self::$contributor_id );
|
|
self::mock_successful_response( 'search', false );
|
|
|
|
$request = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
|
|
$request->set_query_params( array( 'search' => '0c4549ee68f24eaaed46a49dc983ecde' ) );
|
|
$response = rest_do_request( $request );
|
|
$patterns = $response->get_data();
|
|
|
|
$this->assertSame( 200, $response->status );
|
|
$this->assertSame( array(), $patterns );
|
|
}
|
|
|
|
/**
|
|
* @covers WP_REST_Pattern_Directory_Controller::get_items
|
|
*
|
|
* @since 5.8.0
|
|
*/
|
|
public function test_get_items_invalid_response_data() {
|
|
wp_set_current_user( self::$contributor_id );
|
|
self::mock_successful_response( 'invalid-data', true );
|
|
|
|
$request = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
|
|
$response = rest_do_request( $request );
|
|
|
|
$this->assertSame( 500, $response->status );
|
|
$this->assertWPError( $response->as_error() );
|
|
}
|
|
|
|
/**
|
|
* @covers WP_REST_Pattern_Directory_Controller::get_items
|
|
*
|
|
* @since 5.8.0
|
|
*/
|
|
public function test_get_items_prepare_filter() {
|
|
wp_set_current_user( self::$contributor_id );
|
|
self::mock_successful_response( 'browse-all', true );
|
|
|
|
// Test that filter changes uncached values.
|
|
add_filter(
|
|
'rest_prepare_block_pattern',
|
|
static function( $response ) {
|
|
return 'initial value';
|
|
}
|
|
);
|
|
|
|
$request = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
|
|
$response = rest_do_request( $request );
|
|
$patterns = $response->get_data();
|
|
|
|
$this->assertSame( 'initial value', $patterns[0] );
|
|
|
|
// Test that filter changes cached values (the previous request primed the cache).
|
|
add_filter(
|
|
'rest_prepare_block_pattern',
|
|
static function( $response ) {
|
|
return 'modified the cache';
|
|
},
|
|
11
|
|
);
|
|
|
|
// Test that the filter works against cached values.
|
|
$request = new WP_REST_Request( 'GET', '/wp/v2/pattern-directory/patterns' );
|
|
$response = rest_do_request( $request );
|
|
$patterns = $response->get_data();
|
|
|
|
$this->assertSame( 'modified the cache', $patterns[0] );
|
|
}
|
|
|
|
public function test_get_item() {
|
|
$this->markTestSkipped( 'Controller does not implement get_item().' );
|
|
}
|
|
|
|
public function test_create_item() {
|
|
$this->markTestSkipped( 'Controller does not implement create_item().' );
|
|
}
|
|
|
|
public function test_update_item() {
|
|
$this->markTestSkipped( 'Controller does not implement update_item().' );
|
|
}
|
|
|
|
public function test_delete_item() {
|
|
$this->markTestSkipped( 'Controller does not implement delete_item().' );
|
|
}
|
|
|
|
/**
|
|
* @covers WP_REST_Pattern_Directory_Controller::prepare_item_for_response
|
|
*
|
|
* @since 5.8.0
|
|
*/
|
|
public function test_prepare_item() {
|
|
$raw_patterns = json_decode( self::get_raw_response( 'browse-all' ) );
|
|
$raw_patterns[0]->extra_field = 'this should be removed';
|
|
|
|
$prepared_pattern = static::$controller->prepare_response_for_collection(
|
|
static::$controller->prepare_item_for_response( $raw_patterns[0], new WP_REST_Request() )
|
|
);
|
|
|
|
$this->assertPatternMatchesSchema( $prepared_pattern );
|
|
$this->assertArrayNotHasKey( 'extra_field', $prepared_pattern );
|
|
}
|
|
|
|
/**
|
|
* @covers WP_REST_Pattern_Directory_Controller::prepare_item_for_response
|
|
*
|
|
* @since 5.8.0
|
|
*/
|
|
public function test_prepare_item_search() {
|
|
$raw_patterns = json_decode( self::get_raw_response( 'search' ) );
|
|
$raw_patterns[0]->extra_field = 'this should be removed';
|
|
|
|
$prepared_pattern = static::$controller->prepare_response_for_collection(
|
|
static::$controller->prepare_item_for_response( $raw_patterns[0], new WP_REST_Request() )
|
|
);
|
|
|
|
$this->assertPatternMatchesSchema( $prepared_pattern );
|
|
$this->assertArrayNotHasKey( 'extra_field', $prepared_pattern );
|
|
}
|
|
|
|
/**
|
|
* Get a mocked raw response from api.wordpress.org.
|
|
*
|
|
* @return string
|
|
*/
|
|
private static function get_raw_response( $action ) {
|
|
$fixtures_dir = DIR_TESTDATA . '/blocks/pattern-directory';
|
|
|
|
switch ( $action ) {
|
|
default:
|
|
case 'browse-all':
|
|
// Response from https://api.wordpress.org/patterns/1.0/.
|
|
$response = file_get_contents( $fixtures_dir . '/browse-all.json' );
|
|
break;
|
|
|
|
case 'browse-category':
|
|
// Response from https://api.wordpress.org/patterns/1.0/?pattern-categories=2.
|
|
$response = file_get_contents( $fixtures_dir . '/browse-category-2.json' );
|
|
break;
|
|
|
|
case 'browse-keyword':
|
|
// Response from https://api.wordpress.org/patterns/1.0/?pattern-keywords=11.
|
|
$response = file_get_contents( $fixtures_dir . '/browse-keyword-11.json' );
|
|
break;
|
|
|
|
case 'search':
|
|
// Response from https://api.wordpress.org/patterns/1.0/?search=button.
|
|
$response = file_get_contents( $fixtures_dir . '/search-button.json' );
|
|
break;
|
|
|
|
case 'invalid-data':
|
|
$response = ''; // Any HTTP 200 response from w.org should be in JSON, even if it contains an error message.
|
|
break;
|
|
}
|
|
|
|
return $response;
|
|
}
|
|
|
|
/**
|
|
* @covers WP_REST_Pattern_Directory_Controller::get_item_schema
|
|
*
|
|
* @since 5.8.0
|
|
*/
|
|
public function test_get_item_schema() {
|
|
$this->markTestSkipped( "The controller's schema is hardcoded, so tests would not be meaningful." );
|
|
}
|
|
|
|
/**
|
|
* Tests if the transient key gets generated correctly.
|
|
*
|
|
* @dataProvider data_get_query_parameters
|
|
*
|
|
* @covers WP_REST_Pattern_Directory_Controller::get_transient_key
|
|
*
|
|
* @since 6.0.0
|
|
*
|
|
* @ticket 55617
|
|
*
|
|
* @param array $parameters_1 Expected query arguments.
|
|
* @param array $parameters_2 Actual query arguments.
|
|
* @param string $message An error message to display.
|
|
* @param bool $assert_same Assertion type (assertSame vs assertNotSame).
|
|
*/
|
|
public function test_transient_keys_get_generated_correctly( $parameters_1, $parameters_2, $message, $assert_same = true ) {
|
|
$reflection_method = new ReflectionMethod( static::$controller, 'get_transient_key' );
|
|
$reflection_method->setAccessible( true );
|
|
|
|
$result_1 = $reflection_method->invoke( self::$controller, $parameters_1 );
|
|
$result_2 = $reflection_method->invoke( self::$controller, $parameters_2 );
|
|
|
|
$this->assertIsString( $result_1, 'Transient key #1 must be a string.' );
|
|
$this->assertNotEmpty( $result_1, 'Transient key #1 must not be empty.' );
|
|
|
|
$this->assertIsString( $result_2, 'Transient key #2 must be a string.' );
|
|
$this->assertNotEmpty( $result_2, 'Transient key #2 must not be empty.' );
|
|
|
|
if ( $assert_same ) {
|
|
$this->assertSame( $result_1, $result_2, $message );
|
|
} else {
|
|
$this->assertNotSame( $result_1, $result_2, $message );
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* @since 6.0.0
|
|
*
|
|
* @ticket 55617
|
|
*/
|
|
public function data_get_query_parameters() {
|
|
return array(
|
|
'same key and empty slugs' => array(
|
|
'parameters_1' => array(
|
|
'parameter_1' => 1,
|
|
'slug' => array(),
|
|
),
|
|
'parameters_2' => array(
|
|
'parameter_1' => 1,
|
|
),
|
|
'message' => 'Empty slugs should not affect the transient key.',
|
|
),
|
|
'same key and slugs in different order' => array(
|
|
'parameters_1' => array(
|
|
'parameter_1' => 1,
|
|
'slug' => array( 0, 2 ),
|
|
),
|
|
'parameters_2' => array(
|
|
'parameter_1' => 1,
|
|
'slug' => array( 2, 0 ),
|
|
),
|
|
'message' => 'The order of slugs should not affect the transient key.',
|
|
),
|
|
'same key and different slugs' => array(
|
|
'parameters_1' => array(
|
|
'parameter_1' => 1,
|
|
'slug' => array( 'some_slug' ),
|
|
),
|
|
'parameters_2' => array(
|
|
'parameter_1' => 1,
|
|
'slug' => array( 'some_other_slug' ),
|
|
),
|
|
'message' => 'Transient keys must not match.',
|
|
false,
|
|
),
|
|
'different keys' => array(
|
|
'parameters_1' => array(
|
|
'parameter_1' => 1,
|
|
),
|
|
'parameters_2' => array(
|
|
'parameter_2' => 1,
|
|
),
|
|
'message' => 'Transient keys must depend on array keys.',
|
|
false,
|
|
),
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Simulate a successful outbound HTTP requests, to keep tests pure and performant.
|
|
*
|
|
* @param string $action Pass a case from `get_raw_response()` to determine returned data.
|
|
* @param bool $expects_results Pass `true` to get results, or `false` to get 0 results.
|
|
*
|
|
* @since 5.8.0
|
|
*/
|
|
private static function mock_successful_response( $action, $expects_results ) {
|
|
add_filter(
|
|
'pre_http_request',
|
|
static function ( $preempt, $args, $url ) use ( $action, $expects_results ) {
|
|
|
|
if ( 'api.wordpress.org' !== wp_parse_url( $url, PHP_URL_HOST ) ) {
|
|
return $preempt;
|
|
}
|
|
|
|
$response = array(
|
|
'headers' => array(),
|
|
'response' => array(
|
|
'code' => 200,
|
|
'message' => 'OK',
|
|
),
|
|
'body' => $expects_results ? self::get_raw_response( $action ) : '[]',
|
|
'cookies' => array(),
|
|
'filename' => null,
|
|
);
|
|
|
|
return $response;
|
|
},
|
|
10,
|
|
3
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Simulate a network failure on outbound http requests to a given hostname.
|
|
*
|
|
* @since 5.8.0
|
|
*
|
|
* @param string $blocked_host The host to block connections to.
|
|
*/
|
|
private static function prevent_requests_to_host( $blocked_host = 'api.wordpress.org' ) {
|
|
add_filter(
|
|
'pre_http_request',
|
|
static function ( $return, $args, $url ) use ( $blocked_host ) {
|
|
|
|
if ( wp_parse_url( $url, PHP_URL_HOST ) === $blocked_host ) {
|
|
return new WP_Error(
|
|
'patterns_api_failed',
|
|
"An expected error occurred connecting to $blocked_host because of a unit test.",
|
|
"cURL error 7: Failed to connect to $blocked_host port 80: Connection refused"
|
|
);
|
|
|
|
}
|
|
|
|
return $return;
|
|
},
|
|
10,
|
|
3
|
|
);
|
|
}
|
|
}
|