mirror of
https://github.com/gosticks/wordpress-develop.git
synced 2026-03-03 05:02:52 +00:00
4e0062e5be
Permit passing an empty object as the string "?obj=". The type of the passed empty argument is inferred from the registered schema. Props TimothyBlynJacobs, steffanhalv, schlessera, dd32. Fixes #42961. git-svn-id: https://develop.svn.wordpress.org/trunk@47362 602fd350-edb4-49c9-b593-d223f7449a82
358 lines
11 KiB
PHP
358 lines
11 KiB
PHP
<?php
|
|
/**
|
|
* Unit tests covering schema validation and sanitization functionality.
|
|
*
|
|
* @package WordPress
|
|
* @subpackage REST API
|
|
*/
|
|
|
|
/**
|
|
* @group restapi
|
|
*/
|
|
class WP_Test_REST_Schema_Sanitization extends WP_UnitTestCase {
|
|
|
|
public function test_type_number() {
|
|
$schema = array(
|
|
'type' => 'number',
|
|
);
|
|
$this->assertEquals( 1, rest_sanitize_value_from_schema( 1, $schema ) );
|
|
$this->assertEquals( 1.10, rest_sanitize_value_from_schema( '1.10', $schema ) );
|
|
$this->assertEquals( 1, rest_sanitize_value_from_schema( '1abc', $schema ) );
|
|
$this->assertEquals( 0, rest_sanitize_value_from_schema( 'abc', $schema ) );
|
|
$this->assertEquals( 0, rest_sanitize_value_from_schema( array(), $schema ) );
|
|
}
|
|
|
|
public function test_type_integer() {
|
|
$schema = array(
|
|
'type' => 'integer',
|
|
);
|
|
$this->assertEquals( 1, rest_sanitize_value_from_schema( 1, $schema ) );
|
|
$this->assertEquals( 1, rest_sanitize_value_from_schema( '1.10', $schema ) );
|
|
$this->assertEquals( 1, rest_sanitize_value_from_schema( '1abc', $schema ) );
|
|
$this->assertEquals( 0, rest_sanitize_value_from_schema( 'abc', $schema ) );
|
|
$this->assertEquals( 0, rest_sanitize_value_from_schema( array(), $schema ) );
|
|
}
|
|
|
|
public function test_type_string() {
|
|
$schema = array(
|
|
'type' => 'string',
|
|
);
|
|
$this->assertEquals( 'Hello', rest_sanitize_value_from_schema( 'Hello', $schema ) );
|
|
$this->assertEquals( '1.10', rest_sanitize_value_from_schema( '1.10', $schema ) );
|
|
$this->assertEquals( '1.1', rest_sanitize_value_from_schema( 1.1, $schema ) );
|
|
$this->assertEquals( '1', rest_sanitize_value_from_schema( 1, $schema ) );
|
|
}
|
|
|
|
public function test_type_boolean() {
|
|
$schema = array(
|
|
'type' => 'boolean',
|
|
);
|
|
$this->assertEquals( true, rest_sanitize_value_from_schema( '1', $schema ) );
|
|
$this->assertEquals( true, rest_sanitize_value_from_schema( 'true', $schema ) );
|
|
$this->assertEquals( true, rest_sanitize_value_from_schema( '100', $schema ) );
|
|
$this->assertEquals( true, rest_sanitize_value_from_schema( 1, $schema ) );
|
|
$this->assertEquals( false, rest_sanitize_value_from_schema( '0', $schema ) );
|
|
$this->assertEquals( false, rest_sanitize_value_from_schema( 'false', $schema ) );
|
|
$this->assertEquals( false, rest_sanitize_value_from_schema( 0, $schema ) );
|
|
}
|
|
|
|
public function test_format_email() {
|
|
$schema = array(
|
|
'type' => 'string',
|
|
'format' => 'email',
|
|
);
|
|
$this->assertEquals( 'email@example.com', rest_sanitize_value_from_schema( 'email@example.com', $schema ) );
|
|
$this->assertEquals( 'a@b.c', rest_sanitize_value_from_schema( 'a@b.c', $schema ) );
|
|
$this->assertEquals( 'invalid', rest_sanitize_value_from_schema( 'invalid', $schema ) );
|
|
}
|
|
|
|
public function test_format_ip() {
|
|
$schema = array(
|
|
'type' => 'string',
|
|
'format' => 'ip',
|
|
);
|
|
|
|
$this->assertEquals( '127.0.0.1', rest_sanitize_value_from_schema( '127.0.0.1', $schema ) );
|
|
$this->assertEquals( 'hello', rest_sanitize_value_from_schema( 'hello', $schema ) );
|
|
$this->assertEquals( '2001:DB8:0:0:8:800:200C:417A', rest_sanitize_value_from_schema( '2001:DB8:0:0:8:800:200C:417A', $schema ) );
|
|
}
|
|
|
|
public function test_type_array() {
|
|
$schema = array(
|
|
'type' => 'array',
|
|
'items' => array(
|
|
'type' => 'number',
|
|
),
|
|
);
|
|
$this->assertEquals( array( 1 ), rest_sanitize_value_from_schema( array( 1 ), $schema ) );
|
|
$this->assertEquals( array( 1 ), rest_sanitize_value_from_schema( array( '1' ), $schema ) );
|
|
}
|
|
|
|
public function test_type_array_nested() {
|
|
$schema = array(
|
|
'type' => 'array',
|
|
'items' => array(
|
|
'type' => 'array',
|
|
'items' => array(
|
|
'type' => 'number',
|
|
),
|
|
),
|
|
);
|
|
$this->assertEquals( array( array( 1 ), array( 2 ) ), rest_sanitize_value_from_schema( array( array( 1 ), array( 2 ) ), $schema ) );
|
|
$this->assertEquals( array( array( 1 ), array( 2 ) ), rest_sanitize_value_from_schema( array( array( '1' ), array( '2' ) ), $schema ) );
|
|
}
|
|
|
|
public function test_type_array_as_csv() {
|
|
$schema = array(
|
|
'type' => 'array',
|
|
'items' => array(
|
|
'type' => 'number',
|
|
),
|
|
);
|
|
$this->assertEquals( array( 1, 2 ), rest_sanitize_value_from_schema( '1,2', $schema ) );
|
|
$this->assertEquals( array( 1, 2, 0 ), rest_sanitize_value_from_schema( '1,2,a', $schema ) );
|
|
$this->assertEquals( array( 1, 2 ), rest_sanitize_value_from_schema( '1,2,', $schema ) );
|
|
}
|
|
|
|
public function test_type_array_with_enum() {
|
|
$schema = array(
|
|
'type' => 'array',
|
|
'items' => array(
|
|
'enum' => array( 'chicken', 'ribs', 'brisket' ),
|
|
'type' => 'string',
|
|
),
|
|
);
|
|
$this->assertEquals( array( 'ribs', 'brisket' ), rest_sanitize_value_from_schema( array( 'ribs', 'brisket' ), $schema ) );
|
|
$this->assertEquals( array( 'coleslaw' ), rest_sanitize_value_from_schema( array( 'coleslaw' ), $schema ) );
|
|
}
|
|
|
|
public function test_type_array_with_enum_as_csv() {
|
|
$schema = array(
|
|
'type' => 'array',
|
|
'items' => array(
|
|
'enum' => array( 'chicken', 'ribs', 'brisket' ),
|
|
'type' => 'string',
|
|
),
|
|
);
|
|
$this->assertEquals( array( 'ribs', 'chicken' ), rest_sanitize_value_from_schema( 'ribs,chicken', $schema ) );
|
|
$this->assertEquals( array( 'chicken', 'coleslaw' ), rest_sanitize_value_from_schema( 'chicken,coleslaw', $schema ) );
|
|
$this->assertEquals( array( 'chicken', 'coleslaw' ), rest_sanitize_value_from_schema( 'chicken,coleslaw,', $schema ) );
|
|
}
|
|
|
|
public function test_type_array_is_associative() {
|
|
$schema = array(
|
|
'type' => 'array',
|
|
'items' => array(
|
|
'type' => 'string',
|
|
),
|
|
);
|
|
$this->assertEquals(
|
|
array( '1', '2' ),
|
|
rest_sanitize_value_from_schema(
|
|
array(
|
|
'first' => '1',
|
|
'second' => '2',
|
|
),
|
|
$schema
|
|
)
|
|
);
|
|
}
|
|
|
|
public function test_type_object() {
|
|
$schema = array(
|
|
'type' => 'object',
|
|
'properties' => array(
|
|
'a' => array(
|
|
'type' => 'number',
|
|
),
|
|
),
|
|
);
|
|
$this->assertEquals( array( 'a' => 1 ), rest_sanitize_value_from_schema( array( 'a' => 1 ), $schema ) );
|
|
$this->assertEquals( array( 'a' => 1 ), rest_sanitize_value_from_schema( array( 'a' => '1' ), $schema ) );
|
|
$this->assertEquals(
|
|
array(
|
|
'a' => 1,
|
|
'b' => 1,
|
|
),
|
|
rest_sanitize_value_from_schema(
|
|
array(
|
|
'a' => '1',
|
|
'b' => 1,
|
|
),
|
|
$schema
|
|
)
|
|
);
|
|
}
|
|
|
|
public function test_type_object_strips_additional_properties() {
|
|
$schema = array(
|
|
'type' => 'object',
|
|
'properties' => array(
|
|
'a' => array(
|
|
'type' => 'number',
|
|
),
|
|
),
|
|
'additionalProperties' => false,
|
|
);
|
|
$this->assertEquals( array( 'a' => 1 ), rest_sanitize_value_from_schema( array( 'a' => 1 ), $schema ) );
|
|
$this->assertEquals( array( 'a' => 1 ), rest_sanitize_value_from_schema( array( 'a' => '1' ), $schema ) );
|
|
$this->assertEquals(
|
|
array( 'a' => 1 ),
|
|
rest_sanitize_value_from_schema(
|
|
array(
|
|
'a' => '1',
|
|
'b' => 1,
|
|
),
|
|
$schema
|
|
)
|
|
);
|
|
}
|
|
|
|
public function test_type_object_nested() {
|
|
$schema = array(
|
|
'type' => 'object',
|
|
'properties' => array(
|
|
'a' => array(
|
|
'type' => 'object',
|
|
'properties' => array(
|
|
'b' => array( 'type' => 'number' ),
|
|
'c' => array( 'type' => 'number' ),
|
|
),
|
|
),
|
|
),
|
|
);
|
|
|
|
$this->assertEquals(
|
|
array(
|
|
'a' => array(
|
|
'b' => 1,
|
|
'c' => 3,
|
|
),
|
|
),
|
|
rest_sanitize_value_from_schema(
|
|
array(
|
|
'a' => array(
|
|
'b' => '1',
|
|
'c' => '3',
|
|
),
|
|
),
|
|
$schema
|
|
)
|
|
);
|
|
$this->assertEquals(
|
|
array(
|
|
'a' => array(
|
|
'b' => 1,
|
|
'c' => 3,
|
|
'd' => '1',
|
|
),
|
|
'b' => 1,
|
|
),
|
|
rest_sanitize_value_from_schema(
|
|
array(
|
|
'a' => array(
|
|
'b' => '1',
|
|
'c' => '3',
|
|
'd' => '1',
|
|
),
|
|
'b' => 1,
|
|
),
|
|
$schema
|
|
)
|
|
);
|
|
$this->assertEquals( array( 'a' => array() ), rest_sanitize_value_from_schema( array( 'a' => null ), $schema ) );
|
|
}
|
|
|
|
public function test_type_object_stdclass() {
|
|
$schema = array(
|
|
'type' => 'object',
|
|
'properties' => array(
|
|
'a' => array(
|
|
'type' => 'number',
|
|
),
|
|
),
|
|
);
|
|
$this->assertEquals( array( 'a' => 1 ), rest_sanitize_value_from_schema( (object) array( 'a' => '1' ), $schema ) );
|
|
}
|
|
|
|
/**
|
|
* @ticket 42961
|
|
*/
|
|
public function test_type_object_accepts_empty_string() {
|
|
$this->assertEquals( array(), rest_sanitize_value_from_schema( '', array( 'type' => 'object' ) ) );
|
|
}
|
|
|
|
public function test_type_unknown() {
|
|
$schema = array(
|
|
'type' => 'lalala',
|
|
);
|
|
$this->assertEquals( 'Best lyrics', rest_sanitize_value_from_schema( 'Best lyrics', $schema ) );
|
|
$this->assertEquals( 1.10, rest_sanitize_value_from_schema( 1.10, $schema ) );
|
|
$this->assertEquals( 1, rest_sanitize_value_from_schema( 1, $schema ) );
|
|
}
|
|
|
|
public function test_no_type() {
|
|
$schema = array(
|
|
'type' => null,
|
|
);
|
|
$this->assertEquals( 'Nothing', rest_sanitize_value_from_schema( 'Nothing', $schema ) );
|
|
$this->assertEquals( 1.10, rest_sanitize_value_from_schema( 1.10, $schema ) );
|
|
$this->assertEquals( 1, rest_sanitize_value_from_schema( 1, $schema ) );
|
|
}
|
|
|
|
public function test_nullable_date() {
|
|
$schema = array(
|
|
'type' => array( 'string', 'null' ),
|
|
'format' => 'date-time',
|
|
);
|
|
|
|
$this->assertNull( rest_sanitize_value_from_schema( null, $schema ) );
|
|
$this->assertEquals( '2019-09-19T18:00:00', rest_sanitize_value_from_schema( '2019-09-19T18:00:00', $schema ) );
|
|
$this->assertNull( rest_sanitize_value_from_schema( 'lalala', $schema ) );
|
|
}
|
|
|
|
public function test_object_or_string() {
|
|
$schema = array(
|
|
'type' => array( 'object', 'string' ),
|
|
'properties' => array(
|
|
'raw' => array(
|
|
'type' => 'string',
|
|
),
|
|
),
|
|
);
|
|
|
|
$this->assertEquals( 'My Value', rest_sanitize_value_from_schema( 'My Value', $schema ) );
|
|
$this->assertEquals( array( 'raw' => 'My Value' ), rest_sanitize_value_from_schema( array( 'raw' => 'My Value' ), $schema ) );
|
|
$this->assertNull( rest_sanitize_value_from_schema( array( 'raw' => 1 ), $schema ) );
|
|
}
|
|
|
|
public function test_object_or_bool() {
|
|
$schema = array(
|
|
'type' => array( 'object', 'boolean' ),
|
|
'properties' => array(
|
|
'raw' => array(
|
|
'type' => 'boolean',
|
|
),
|
|
),
|
|
);
|
|
|
|
$this->assertTrue( rest_sanitize_value_from_schema( true, $schema ) );
|
|
$this->assertTrue( rest_sanitize_value_from_schema( '1', $schema ) );
|
|
$this->assertTrue( rest_sanitize_value_from_schema( 1, $schema ) );
|
|
|
|
$this->assertFalse( rest_sanitize_value_from_schema( false, $schema ) );
|
|
$this->assertFalse( rest_sanitize_value_from_schema( '0', $schema ) );
|
|
$this->assertFalse( rest_sanitize_value_from_schema( 0, $schema ) );
|
|
|
|
$this->assertEquals( array( 'raw' => true ), rest_sanitize_value_from_schema( array( 'raw' => true ), $schema ) );
|
|
$this->assertEquals( array( 'raw' => true ), rest_sanitize_value_from_schema( array( 'raw' => '1' ), $schema ) );
|
|
$this->assertEquals( array( 'raw' => true ), rest_sanitize_value_from_schema( array( 'raw' => 1 ), $schema ) );
|
|
|
|
$this->assertEquals( array( 'raw' => false ), rest_sanitize_value_from_schema( array( 'raw' => false ), $schema ) );
|
|
$this->assertEquals( array( 'raw' => false ), rest_sanitize_value_from_schema( array( 'raw' => '0' ), $schema ) );
|
|
$this->assertEquals( array( 'raw' => false ), rest_sanitize_value_from_schema( array( 'raw' => 0 ), $schema ) );
|
|
|
|
$this->assertNull( rest_sanitize_value_from_schema( array( 'raw' => 'something non boolean' ), $schema ) );
|
|
}
|
|
}
|