mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2025-10-16 12:05:38 +00:00
b0f085ece3
Per the[https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#6-file-headers documentation standards], whenever possible, all WordPress files should contain a header DocBlock, regardless of the file’s contents – this includes files containing classes. However, this recommendation makes less sense for unit test classes if not applied consistently, and the duplicate tags cause some confusion. This commit aims to reduce confusion and avoid repeating information by combining the DocBlocks. Follow-up to [55337]. Props sakibmd, fuadragib, robinwpdeveloper, naeemhaque, seakashdiu, jakariaistauk, hasanmisbah, SergeyBiryukov. Fixes #57723. git-svn-id: https://develop.svn.wordpress.org/trunk@55457 602fd350-edb4-49c9-b593-d223f7449a82
663 lines
17 KiB
PHP
663 lines
17 KiB
PHP
<?php
|
|
/**
|
|
* Unit tests covering WP_REST_Block_Renderer_Controller functionality.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage REST_API
|
|
* @since 5.0.0
|
|
*
|
|
* @covers WP_REST_Block_Renderer_Controller
|
|
*
|
|
* @group restapi-blocks
|
|
* @group restapi
|
|
*/
|
|
class REST_Block_Renderer_Controller_Test extends WP_Test_REST_Controller_Testcase {
|
|
|
|
/**
|
|
* The REST API route for the block renderer.
|
|
*
|
|
* @since 5.0.0
|
|
*
|
|
* @var string
|
|
*/
|
|
protected static $rest_api_route = '/wp/v2/block-renderer/';
|
|
|
|
/**
|
|
* Test block's name.
|
|
*
|
|
* @since 5.0.0
|
|
*
|
|
* @var string
|
|
*/
|
|
protected static $block_name = 'core/test-block';
|
|
|
|
/**
|
|
* Test post context block's name.
|
|
*
|
|
* @since 5.0.0
|
|
*
|
|
* @var string
|
|
*/
|
|
protected static $context_block_name = 'core/context-test-block';
|
|
|
|
/**
|
|
* Non-dynamic block name.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @var string
|
|
*/
|
|
protected static $non_dynamic_block_name = 'core/non-dynamic';
|
|
|
|
/**
|
|
* Dynamic block with boolean attributes block name.
|
|
*
|
|
* @since 5.5.0
|
|
*
|
|
* @var string
|
|
*/
|
|
protected static $dynamic_block_with_boolean_attributes_block_name = 'core/dynamic-block-with-boolean-attributes';
|
|
|
|
/**
|
|
* Test API user's ID.
|
|
*
|
|
* @since 5.0.0
|
|
*
|
|
* @var int
|
|
*/
|
|
protected static $user_id;
|
|
|
|
/**
|
|
* Test post ID.
|
|
*
|
|
* @since 5.0.0
|
|
*
|
|
* @var int
|
|
*/
|
|
protected static $post_id;
|
|
|
|
/**
|
|
* Author test user ID.
|
|
*
|
|
* @since 5.0.0
|
|
*
|
|
* @var int
|
|
*/
|
|
protected static $author_id;
|
|
|
|
/**
|
|
* Create test data before the tests run.
|
|
*
|
|
* @since 5.0.0
|
|
*
|
|
* @param WP_UnitTest_Factory $factory Helper that lets us create fake data.
|
|
*/
|
|
public static function wpSetUpBeforeClass( WP_UnitTest_Factory $factory ) {
|
|
self::$user_id = $factory->user->create(
|
|
array(
|
|
'role' => 'editor',
|
|
)
|
|
);
|
|
|
|
self::$author_id = $factory->user->create(
|
|
array(
|
|
'role' => 'author',
|
|
)
|
|
);
|
|
|
|
self::$post_id = $factory->post->create(
|
|
array(
|
|
'post_title' => 'Test Post',
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Delete test data after our tests run.
|
|
*
|
|
* @since 5.0.0
|
|
*/
|
|
public static function wpTearDownAfterClass() {
|
|
self::delete_user( self::$user_id );
|
|
}
|
|
|
|
/**
|
|
* Set up each test method.
|
|
*
|
|
* @since 5.0.0
|
|
*/
|
|
public function set_up() {
|
|
parent::set_up();
|
|
|
|
$this->register_test_block();
|
|
$this->register_post_context_test_block();
|
|
$this->register_non_dynamic_block();
|
|
$this->register_dynamic_block_with_boolean_attributes();
|
|
}
|
|
|
|
/**
|
|
* Tear down each test method.
|
|
*
|
|
* @since 5.0.0
|
|
*/
|
|
public function tear_down() {
|
|
WP_Block_Type_Registry::get_instance()->unregister( self::$block_name );
|
|
WP_Block_Type_Registry::get_instance()->unregister( self::$context_block_name );
|
|
WP_Block_Type_Registry::get_instance()->unregister( self::$non_dynamic_block_name );
|
|
WP_Block_Type_Registry::get_instance()->unregister( self::$dynamic_block_with_boolean_attributes_block_name );
|
|
parent::tear_down();
|
|
}
|
|
|
|
/**
|
|
* Register test block.
|
|
*
|
|
* @since 5.0.0
|
|
*/
|
|
public function register_test_block() {
|
|
register_block_type(
|
|
self::$block_name,
|
|
array(
|
|
'attributes' => array(
|
|
'some_string' => array(
|
|
'type' => 'string',
|
|
'default' => 'some_default',
|
|
),
|
|
'some_int' => array(
|
|
'type' => 'integer',
|
|
),
|
|
'some_array' => array(
|
|
'type' => 'array',
|
|
'items' => array(
|
|
'type' => 'integer',
|
|
),
|
|
),
|
|
),
|
|
'render_callback' => array( $this, 'render_test_block' ),
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Register test block with post_id as attribute for post context test.
|
|
*
|
|
* @since 5.0.0
|
|
*/
|
|
public function register_post_context_test_block() {
|
|
register_block_type(
|
|
self::$context_block_name,
|
|
array(
|
|
'attributes' => array(),
|
|
'render_callback' => array( $this, 'render_post_context_test_block' ),
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Registers the non-dynamic block name.
|
|
*
|
|
* @since 5.5.0
|
|
*/
|
|
protected function register_non_dynamic_block() {
|
|
register_block_type( self::$non_dynamic_block_name );
|
|
}
|
|
|
|
/**
|
|
* Registers the dynamic with boolean attributes block name.
|
|
*
|
|
* @since 5.5.0
|
|
*/
|
|
protected function register_dynamic_block_with_boolean_attributes() {
|
|
register_block_type(
|
|
self::$dynamic_block_with_boolean_attributes_block_name,
|
|
array(
|
|
'attributes' => array(
|
|
'boolean_true_attribute' => array(
|
|
'type' => 'boolean',
|
|
'default' => true,
|
|
),
|
|
'boolean_false_attribute' => array(
|
|
'type' => 'boolean',
|
|
'default' => false,
|
|
),
|
|
),
|
|
'render_callback' => array( $this, 'render_test_block' ),
|
|
)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Test render callback.
|
|
*
|
|
* @since 5.0.0
|
|
*
|
|
* @param array $attributes Props.
|
|
* @return string Rendered attributes, which is here just JSON.
|
|
*/
|
|
public function render_test_block( $attributes ) {
|
|
return wp_json_encode( $attributes );
|
|
}
|
|
|
|
/**
|
|
* Test render callback for testing post context.
|
|
*
|
|
* @since 5.0.0
|
|
*
|
|
* @return string
|
|
*/
|
|
public function render_post_context_test_block() {
|
|
return get_the_title();
|
|
}
|
|
|
|
/**
|
|
* Check that the route was registered properly.
|
|
*
|
|
* @ticket 45098
|
|
*
|
|
* @covers WP_REST_Block_Renderer_Controller::register_routes
|
|
*/
|
|
public function test_register_routes() {
|
|
$dynamic_block_names = get_dynamic_block_names();
|
|
$this->assertContains( self::$block_name, $dynamic_block_names );
|
|
|
|
$routes = rest_get_server()->get_routes();
|
|
$this->assertArrayHasKey( self::$rest_api_route . '(?P<name>[a-z0-9-]+/[a-z0-9-]+)', $routes );
|
|
}
|
|
|
|
/**
|
|
* Test getting item without permissions.
|
|
*
|
|
* @ticket 45098
|
|
*
|
|
* @covers WP_REST_Block_Renderer_Controller::get_item
|
|
*/
|
|
public function test_get_item_without_permissions() {
|
|
wp_set_current_user( 0 );
|
|
|
|
$request = new WP_REST_Request( 'GET', self::$rest_api_route . self::$block_name );
|
|
$request->set_param( 'context', 'edit' );
|
|
|
|
$response = rest_get_server()->dispatch( $request );
|
|
|
|
$this->assertErrorResponse( 'block_cannot_read', $response, rest_authorization_required_code() );
|
|
}
|
|
|
|
/**
|
|
* Test getting item without 'edit' context.
|
|
*
|
|
* @ticket 45098
|
|
*/
|
|
public function test_get_item_with_invalid_context() {
|
|
wp_set_current_user( self::$user_id );
|
|
|
|
$request = new WP_REST_Request( 'GET', self::$rest_api_route . self::$block_name );
|
|
$response = rest_get_server()->dispatch( $request );
|
|
|
|
$this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
|
|
}
|
|
|
|
/**
|
|
* Test getting item with invalid block name.
|
|
*
|
|
* @ticket 45098
|
|
*
|
|
* @covers WP_REST_Block_Renderer_Controller::get_item
|
|
*/
|
|
public function test_get_item_invalid_block_name() {
|
|
wp_set_current_user( self::$user_id );
|
|
$request = new WP_REST_Request( 'GET', self::$rest_api_route . 'core/123' );
|
|
|
|
$request->set_param( 'context', 'edit' );
|
|
$response = rest_get_server()->dispatch( $request );
|
|
|
|
$this->assertErrorResponse( 'block_invalid', $response, 404 );
|
|
}
|
|
|
|
/**
|
|
* Check getting item with an invalid param provided.
|
|
*
|
|
* @ticket 45098
|
|
*
|
|
* @covers WP_REST_Block_Renderer_Controller::get_item
|
|
*/
|
|
public function test_get_item_invalid_attribute() {
|
|
wp_set_current_user( self::$user_id );
|
|
$request = new WP_REST_Request( 'GET', self::$rest_api_route . self::$block_name );
|
|
$request->set_param( 'context', 'edit' );
|
|
$request->set_param(
|
|
'attributes',
|
|
array(
|
|
'some_string' => array( 'no!' ),
|
|
)
|
|
);
|
|
$response = rest_get_server()->dispatch( $request );
|
|
$this->assertSame( 400, $response->get_status() );
|
|
}
|
|
|
|
/**
|
|
* Check getting item with an invalid param provided.
|
|
*
|
|
* @ticket 45098
|
|
*
|
|
* @covers WP_REST_Block_Renderer_Controller::get_item
|
|
*/
|
|
public function test_get_item_unrecognized_attribute() {
|
|
wp_set_current_user( self::$user_id );
|
|
$request = new WP_REST_Request( 'GET', self::$rest_api_route . self::$block_name );
|
|
$request->set_param( 'context', 'edit' );
|
|
$request->set_param(
|
|
'attributes',
|
|
array(
|
|
'unrecognized' => 'yes',
|
|
)
|
|
);
|
|
$response = rest_get_server()->dispatch( $request );
|
|
$this->assertSame( 400, $response->get_status() );
|
|
}
|
|
|
|
/**
|
|
* Check getting item with default attributes provided.
|
|
*
|
|
* @ticket 45098
|
|
*
|
|
* @covers WP_REST_Block_Renderer_Controller::get_item
|
|
*/
|
|
public function test_get_item_default_attributes() {
|
|
wp_set_current_user( self::$user_id );
|
|
|
|
$block_type = WP_Block_Type_Registry::get_instance()->get_registered( self::$block_name );
|
|
$defaults = array();
|
|
foreach ( $block_type->attributes as $key => $attribute ) {
|
|
if ( isset( $attribute['default'] ) ) {
|
|
$defaults[ $key ] = $attribute['default'];
|
|
}
|
|
}
|
|
|
|
$request = new WP_REST_Request( 'GET', self::$rest_api_route . self::$block_name );
|
|
$request->set_param( 'context', 'edit' );
|
|
$request->set_param( 'attributes', array() );
|
|
$response = rest_get_server()->dispatch( $request );
|
|
$this->assertSame( 200, $response->get_status() );
|
|
$data = $response->get_data();
|
|
|
|
$this->assertSame( $defaults, json_decode( $data['rendered'], true ) );
|
|
$this->assertEquals(
|
|
json_decode( $block_type->render( $defaults ) ),
|
|
json_decode( $data['rendered'] )
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Check getting item with attributes provided.
|
|
*
|
|
* @ticket 45098
|
|
*
|
|
* @covers WP_REST_Block_Renderer_Controller::get_item
|
|
*/
|
|
public function test_get_item() {
|
|
wp_set_current_user( self::$user_id );
|
|
|
|
$block_type = WP_Block_Type_Registry::get_instance()->get_registered( self::$block_name );
|
|
$attributes = array(
|
|
'some_int' => '123',
|
|
'some_string' => 'foo',
|
|
'some_array' => array( 1, '2', 3 ),
|
|
);
|
|
|
|
$expected_attributes = $attributes;
|
|
$expected_attributes['some_int'] = (int) $expected_attributes['some_int'];
|
|
$expected_attributes['some_array'] = array_map( 'intval', $expected_attributes['some_array'] );
|
|
|
|
$request = new WP_REST_Request( 'GET', self::$rest_api_route . self::$block_name );
|
|
$request->set_param( 'context', 'edit' );
|
|
$request->set_param( 'attributes', $attributes );
|
|
$response = rest_get_server()->dispatch( $request );
|
|
$this->assertSame( 200, $response->get_status() );
|
|
$data = $response->get_data();
|
|
|
|
$this->assertSame( $expected_attributes, json_decode( $data['rendered'], true ) );
|
|
$this->assertEqualSetsWithIndex(
|
|
json_decode( $block_type->render( $attributes ), true ),
|
|
json_decode( $data['rendered'], true )
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Check filtering block output using the pre_render_block filter.
|
|
*
|
|
* @ticket 49387
|
|
*/
|
|
public function test_get_item_with_pre_render_block_filter() {
|
|
wp_set_current_user( self::$user_id );
|
|
|
|
$pre_render_filter = static function( $output, $block ) {
|
|
if ( $block['blockName'] === self::$block_name ) {
|
|
return '<p>Alternate content.</p>';
|
|
}
|
|
};
|
|
add_filter( 'pre_render_block', $pre_render_filter, 10, 2 );
|
|
|
|
$attributes = array(
|
|
'some_int' => '123',
|
|
'some_string' => 'foo',
|
|
'some_array' => array( 1, '2', 3 ),
|
|
);
|
|
|
|
$request = new WP_REST_Request( 'GET', self::$rest_api_route . self::$block_name );
|
|
$request->set_param( 'context', 'edit' );
|
|
$request->set_param( 'attributes', $attributes );
|
|
$response = rest_get_server()->dispatch( $request );
|
|
$this->assertSame( 200, $response->get_status() );
|
|
|
|
$data = $response->get_data();
|
|
$this->assertSame( '<p>Alternate content.</p>', $data['rendered'] );
|
|
|
|
remove_filter( 'pre_render_block', $pre_render_filter );
|
|
}
|
|
|
|
/**
|
|
* Test getting item with post context.
|
|
*
|
|
* @ticket 45098
|
|
*/
|
|
public function test_get_item_with_post_context() {
|
|
wp_set_current_user( self::$user_id );
|
|
|
|
$expected_title = 'Test Post';
|
|
$request = new WP_REST_Request( 'GET', self::$rest_api_route . self::$context_block_name );
|
|
$request->set_param( 'context', 'edit' );
|
|
|
|
// Test without post ID.
|
|
$response = rest_get_server()->dispatch( $request );
|
|
|
|
$this->assertSame( 200, $response->get_status() );
|
|
$data = $response->get_data();
|
|
|
|
$this->assertEmpty( $data['rendered'] );
|
|
|
|
// Now test with post ID.
|
|
$request->set_param( 'post_id', self::$post_id );
|
|
$response = rest_get_server()->dispatch( $request );
|
|
|
|
$this->assertSame( 200, $response->get_status() );
|
|
$data = $response->get_data();
|
|
|
|
$this->assertSame( $expected_title, $data['rendered'] );
|
|
}
|
|
|
|
/**
|
|
* Test a POST request, with the attributes in the body.
|
|
*
|
|
* @ticket 49680
|
|
*/
|
|
public function test_get_item_post_request() {
|
|
wp_set_current_user( self::$user_id );
|
|
$string_attribute = 'Lorem ipsum dolor';
|
|
$attributes = array( 'some_string' => $string_attribute );
|
|
$request = new WP_REST_Request( 'POST', self::$rest_api_route . self::$block_name );
|
|
$request->set_param( 'context', 'edit' );
|
|
$request->set_header( 'Content-Type', 'application/json' );
|
|
$request->set_body( wp_json_encode( compact( 'attributes' ) ) );
|
|
$response = rest_get_server()->dispatch( $request );
|
|
|
|
$this->assertSame( 200, $response->get_status() );
|
|
$this->assertStringContainsString( $string_attribute, $response->get_data()['rendered'] );
|
|
}
|
|
|
|
/**
|
|
* Test getting item with invalid post ID.
|
|
*
|
|
* @ticket 45098
|
|
*/
|
|
public function test_get_item_without_permissions_invalid_post() {
|
|
wp_set_current_user( self::$user_id );
|
|
|
|
$request = new WP_REST_Request( 'GET', self::$rest_api_route . self::$context_block_name );
|
|
$request->set_param( 'context', 'edit' );
|
|
|
|
// Test with invalid post ID.
|
|
$request->set_param( 'post_id', PHP_INT_MAX );
|
|
$response = rest_get_server()->dispatch( $request );
|
|
|
|
$this->assertErrorResponse( 'block_cannot_read', $response, 403 );
|
|
}
|
|
|
|
/**
|
|
* Test getting item without permissions to edit context post.
|
|
*
|
|
* @ticket 45098
|
|
*/
|
|
public function test_get_item_without_permissions_cannot_edit_post() {
|
|
wp_set_current_user( self::$author_id );
|
|
|
|
$request = new WP_REST_Request( 'GET', self::$rest_api_route . self::$context_block_name );
|
|
$request->set_param( 'context', 'edit' );
|
|
|
|
// Test with private post ID.
|
|
$request->set_param( 'post_id', self::$post_id );
|
|
$response = rest_get_server()->dispatch( $request );
|
|
|
|
$this->assertErrorResponse( 'block_cannot_read', $response, 403 );
|
|
}
|
|
|
|
/**
|
|
* @ticket 48079
|
|
*/
|
|
public function test_get_item_non_dynamic_block() {
|
|
wp_set_current_user( self::$user_id );
|
|
$request = new WP_REST_Request( 'GET', self::$rest_api_route . self::$non_dynamic_block_name );
|
|
|
|
$request->set_param( 'context', 'edit' );
|
|
$response = rest_get_server()->dispatch( $request );
|
|
|
|
$this->assertErrorResponse( 'block_invalid', $response, 404 );
|
|
}
|
|
|
|
/**
|
|
* @ticket 50620
|
|
*/
|
|
public function test_get_sanitized_attributes_for_dynamic_block_with_boolean_attributes() {
|
|
wp_set_current_user( self::$user_id );
|
|
|
|
$request = new WP_REST_Request( 'GET', self::$rest_api_route . self::$dynamic_block_with_boolean_attributes_block_name );
|
|
|
|
$attributes = array(
|
|
'boolean_true_attribute' => 'true',
|
|
'boolean_false_attribute' => 'false',
|
|
);
|
|
|
|
$expected = array(
|
|
'boolean_true_attribute' => true,
|
|
'boolean_false_attribute' => false,
|
|
);
|
|
|
|
$request->set_param( 'context', 'edit' );
|
|
$request->set_param( 'attributes', $attributes );
|
|
$response = rest_get_server()->dispatch( $request );
|
|
$this->assertSame( 200, $response->get_status() );
|
|
$data = $response->get_data();
|
|
|
|
$this->assertSame( $expected, json_decode( $data['rendered'], true ) );
|
|
}
|
|
|
|
/**
|
|
* Get item schema.
|
|
*
|
|
* @ticket 45098
|
|
*
|
|
* @covers WP_REST_Block_Renderer_Controller::get_item_schema
|
|
*/
|
|
public function test_get_item_schema() {
|
|
$request = new WP_REST_Request( 'OPTIONS', self::$rest_api_route . self::$block_name );
|
|
$response = rest_get_server()->dispatch( $request );
|
|
$data = $response->get_data();
|
|
|
|
$this->assertSameSets( array( 'GET', 'POST' ), $data['endpoints'][0]['methods'] );
|
|
$this->assertSameSets(
|
|
array( 'name', 'context', 'attributes', 'post_id' ),
|
|
array_keys( $data['endpoints'][0]['args'] )
|
|
);
|
|
$this->assertSame( 'object', $data['endpoints'][0]['args']['attributes']['type'] );
|
|
|
|
$this->assertArrayHasKey( 'schema', $data );
|
|
$this->assertSame( 'rendered-block', $data['schema']['title'] );
|
|
$this->assertSame( 'object', $data['schema']['type'] );
|
|
$this->arrayHasKey( 'rendered', $data['schema']['properties'] );
|
|
$this->arrayHasKey( 'string', $data['schema']['properties']['rendered']['type'] );
|
|
$this->assertSame( array( 'edit' ), $data['schema']['properties']['rendered']['context'] );
|
|
}
|
|
|
|
/**
|
|
* The update_item() method does not exist for block rendering.
|
|
*
|
|
* @doesNotPerformAssertions
|
|
*/
|
|
public function test_update_item() {
|
|
// Controller does not implement update_item().
|
|
}
|
|
|
|
/**
|
|
* The create_item() method does not exist for block rendering.
|
|
*
|
|
* @doesNotPerformAssertions
|
|
*/
|
|
public function test_create_item() {
|
|
// Controller does not implement create_item().
|
|
}
|
|
|
|
/**
|
|
* The delete_item() method does not exist for block rendering.
|
|
*
|
|
* @doesNotPerformAssertions
|
|
*/
|
|
public function test_delete_item() {
|
|
// Controller does not implement delete_item().
|
|
}
|
|
|
|
/**
|
|
* The get_items() method does not exist for block rendering.
|
|
*
|
|
* @doesNotPerformAssertions
|
|
*/
|
|
public function test_get_items() {
|
|
// Controller does not implement get_items().
|
|
}
|
|
|
|
/**
|
|
* The get_context_param() method is not used for block rendering.
|
|
*
|
|
* @doesNotPerformAssertions
|
|
*/
|
|
public function test_context_param() {
|
|
// Controller does not use get_context_param().
|
|
}
|
|
|
|
/**
|
|
* The prepare_item() method does not exist for block rendering.
|
|
*
|
|
* @doesNotPerformAssertions
|
|
*/
|
|
public function test_prepare_item() {
|
|
// Controller does not implement prepare_item().
|
|
}
|
|
}
|