Changeset 48300 for trunk/tests/phpunit/tests/rest-api/rest-schema-sanitization.php

Timestamp:

07/04/2020 07:51:10 PM (4 years ago)

Author:

TimothyBlynJacobs

Message:

REST API: Only validate the format keyword if the type is a string.

This allows for using multi-type support with a string that has a format. For backwards compatibility support, the format validation will still apply if the type is not specified, or it is invalid.

Two new doing it wrong notices are issued when omitting a type, or using an invalid type.

Props ryotsun.
Fixes #50189.

File:

• trunk/tests/phpunit/tests/rest-api/rest-schema-sanitization.php (modified) (3 diffs)

trunk/tests/phpunit/tests/rest-api/rest-schema-sanitization.php

@@ -313 +313 @@
 
     public function test_type_unknown() {
+        $this->setExpectedIncorrectUsage( 'rest_sanitize_value_from_schema' );
+
         $schema = array(
             'type' => 'lalala',
@@ -322 +324 @@
 
     public function test_no_type() {
+        $this->setExpectedIncorrectUsage( 'rest_sanitize_value_from_schema' );
+
         $schema = array(
             'type' => null,
@@ -339 +343 @@
         $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 ) );
+    }
+
+    /**
+     * @ticket 50189
+     */
+    public function test_format_validation_is_skipped_if_non_string_type() {
+        $schema = array(
+            'type'   => 'array',
+            'format' => 'hex-color',
+        );
+        $this->assertEquals( array( '#fff' ), rest_sanitize_value_from_schema( '#fff', $schema ) );
+        $this->assertEquals( array( '#qrst' ), rest_sanitize_value_from_schema( '#qrst', $schema ) );
+    }
+
+    /**
+     * @ticket 50189
+     */
+    public function test_format_validation_is_applied_if_missing_type() {
+        $this->expectException( 'PHPUnit_Framework_Error_Notice' ); // For the undefined index.
+        $this->setExpectedIncorrectUsage( 'rest_sanitize_value_from_schema' );
+
+        $schema = array( 'format' => 'hex-color' );
+        $this->assertEquals( '#abc', rest_sanitize_value_from_schema( '#abc', $schema ) );
+        $this->assertEquals( '', rest_sanitize_value_from_schema( '#jkl', $schema ) );
+    }
+
+    /**
+     * @ticket 50189
+     */
+    public function test_format_validation_is_applied_if_unknown_type() {
+        $this->setExpectedIncorrectUsage( 'rest_sanitize_value_from_schema' );
+
+        $schema = array(
+            'format' => 'hex-color',
+            'type'   => 'str',
+        );
+        $this->assertEquals( '#abc', rest_sanitize_value_from_schema( '#abc', $schema ) );
+        $this->assertEquals( '', rest_sanitize_value_from_schema( '#jkl', $schema ) );
     }