Changeset 48300 for trunk/tests/phpunit/tests/rest-api/rest-schema-validation.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-validation.php (modified) (2 diffs)

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

@@ -138 +138 @@
     }
 
+    /**
+     * @ticket 50189
+     */
+    public function test_format_validation_is_skipped_if_non_string_type() {
+        $schema = array(
+            'type'   => 'array',
+            'items'  => array(
+                'type' => 'string',
+            ),
+            'format' => 'email',
+        );
+        $this->assertTrue( rest_validate_value_from_schema( 'email@example.com', $schema ) );
+        $this->assertTrue( rest_validate_value_from_schema( 'email', $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_validate_value_from_schema' );
+
+        $schema = array( 'format' => 'email' );
+        $this->assertTrue( rest_validate_value_from_schema( 'email@example.com', $schema ) );
+        $this->assertWPError( rest_validate_value_from_schema( 'email', $schema ) );
+    }
+
+    /**
+     * @ticket 50189
+     */
+    public function test_format_validation_is_applied_if_unknown_type() {
+        $this->setExpectedIncorrectUsage( 'rest_validate_value_from_schema' );
+
+        $schema = array(
+            'format' => 'email',
+            'type'   => 'str',
+        );
+        $this->assertTrue( rest_validate_value_from_schema( 'email@example.com', $schema ) );
+        $this->assertWPError( rest_validate_value_from_schema( 'email', $schema ) );
+    }
+
     public function test_type_array() {
         $schema = array(
@@ -323 +364 @@
 
     public function test_type_unknown() {
+        $this->setExpectedIncorrectUsage( 'rest_validate_value_from_schema' );
+
         $schema = array(
             'type' => 'lalala',