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

Timestamp:

12/21/2021 04:12:06 AM (3 years ago)

Author:

hellofromTonya

Message:

REST API: Support . in theme directory names in WP_REST_Global_Styles_Controller, WP_REST_Templates_Controller, and WP_REST_Themes_Controller.

Regex changes from [52376] are reverted to restore the original regex patterns. Why? [52376] used an include characters pattern, which was too limiting. It did not account for localized characters, such as é, or other valid directory name characters.

The original theme directory regex pattern, i.e. [^.\/]+(?:\/[^.\/]+)? excluded the period . character. Removing the . character resolves the reported issue by allowing matching for themes/theme-dirname-1.0/ or themes/<subdirname>/theme-dirname-1.0/.

As the pattern used an exclude approach, all characters are valid for matching except for /. However, not all characters are cross-platform valid for directory names. For example, the characters /:<>*?"| are not valid on Windows OS. The pattern now excludes those characters.

The theme's directory (or subdirectory) name pattern matching is now used in WP_REST_Global_Styles_Controller, WP_REST_Templates_Controller, and WP_REST_Themes_Controller.

Follow-up to [51003], [52051], [52275], [52376].

Props costdev, hellofromTonya, spacedmonkey, TimothyBlynJacobs, bijayyadav, kafleg.
Fixes #54596.

File:

• trunk/tests/phpunit/tests/rest-api/rest-themes-controller.php (modified) (1 diff)

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

@@ -1286 +1286 @@
 
     /**
+     * @dataProvider data_get_item_non_subdir_theme
+     * @ticket 54596
+     * @covers WP_REST_Themes_Controller::get_item
+     *
+     * @param string $theme_dir     Theme directory to test.
+     * @param string $expected_name Expected theme name.
+     */
+    public function test_get_item_non_subdir_theme( $theme_dir, $expected_name ) {
+        wp_set_current_user( self::$admin_id );
+        $request  = new WP_REST_Request( 'GET', self::$themes_route . $theme_dir );
+        $response = rest_do_request( $request );
+
+        $this->assertSame( 200, $response->get_status() );
+        $this->assertSame( $expected_name, $response->get_data()['name']['raw'] );
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array
+     */
+    public function data_get_item_non_subdir_theme() {
+        return array(
+            'parent theme'                => array(
+                'theme_dir'     => '/block-theme',
+                'expected_name' => 'Block Theme',
+            ),
+            'child theme'                 => array(
+                'theme_dir'     => '/block-theme-child',
+                'expected_name' => 'Block Theme Child Theme',
+            ),
+            'theme with _-[]. characters' => array(
+                'theme_dir'     => '/block_theme-[0.4.0]',
+                'expected_name' => 'Block Theme [0.4.0]',
+            ),
+        );
+    }
+
+    /**
+     * @dataProvider data_get_item_subdirectory_theme
      * @ticket 54349
-     */
-    public function test_get_item_subdirectory_theme() {
+     * @ticket 54596
+     * @covers WP_REST_Themes_Controller::get_item
+     *
+     * @param string $theme_dir     Theme directory to test.
+     * @param string $expected_name Expected theme name.
+     */
+    public function test_get_item_subdirectory_theme( $theme_dir, $expected_name ) {
         wp_set_current_user( self::$admin_id );
-        $request  = new WP_REST_Request( 'GET', self::$themes_route . '/subdir/theme2' );
+        $request  = new WP_REST_Request( 'GET', self::$themes_route . $theme_dir );
         $response = rest_do_request( $request );
 
-        $this->assertSame( 200, $response->get_status() );
-        $this->assertSame( 'My Subdir Theme', $response->get_data()['name']['raw'] );
+        $this->assertSame(
+            200,
+            $response->get_status(),
+            'A 200 OK status was not returned.'
+        );
+        $this->assertSame(
+            $expected_name,
+            $response->get_data()['name']['raw'],
+            'The actual theme name was not the expected theme name.'
+        );
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array
+     */
+    public function data_get_item_subdirectory_theme() {
+        return array(
+            'theme2'                      => array(
+                'theme_dir'     => '/subdir/theme2',
+                'expected_name' => 'My Subdir Theme',
+            ),
+            'theme with _-[]. characters' => array(
+                'theme_dir'     => '/subdir/block_theme-[1.0.0]',
+                'expected_name' => 'Block Theme [1.0.0] in subdirectory',
+            ),
+        );
     }