Changeset 44546 for trunk/tests/phpunit/tests/rest-api/rest-controller.php

Timestamp:

01/10/2019 09:05:50 PM (6 years ago)

Author:

flixos90

Message:

General: Fix problematic string to array parsing.

WordPress has historically often used code like preg_split( '/[\s,]+/', $var ) to parse a string of comma-separated values into an array. However, this approach was causing an empty string to not be parsed into an empty array as expected, but rather into an array with the empty string as its sole element.

This was among other areas causing problems in the REST API where passing an empty request parameter could cause that request to fail because, instead of it being ignored, that parameter would be compared against the valid values for it, which typically do not include an empty string.

Props david.binda, sstoqnov.
Fixes #43977.

File:

• trunk/tests/phpunit/tests/rest-api/rest-controller.php (modified) (2 diffs)

trunk/tests/phpunit/tests/rest-api/rest-controller.php

@@ -204 +204 @@
     }
 
-    public function test_get_fields_for_response() {
+    /**
+     * @dataProvider data_get_fields_for_response,
+     */
+    public function test_get_fields_for_response( $param, $expected ) {
         $controller = new WP_REST_Test_Controller();
         $request    = new WP_REST_Request( 'GET', '/wp/v2/testroute' );
@@ -222 +225 @@
             $fields
         );
-        $request->set_param( '_fields', 'somestring,someinteger' );
+        $request->set_param( '_fields', $param );
         $fields = $controller->get_fields_for_response( $request );
-        $this->assertEquals(
-            array(
-                'somestring',
-                'someinteger',
+        $this->assertEquals( $expected, $fields );
+    }
+
+    public function data_get_fields_for_response() {
+        return array(
+            array(
+                'somestring,someinteger',
+                array(
+                    'somestring',
+                    'someinteger',
+                ),
             ),
-            $fields
+            array(
+                ',,',
+                array(
+                    'somestring',
+                    'someinteger',
+                    'someboolean',
+                    'someurl',
+                    'somedate',
+                    'someemail',
+                    'someenum',
+                    'someargoptions',
+                    'somedefault',
+                ),
+            ),
         );
     }