Changeset 40037 for trunk

Timestamp:

02/01/2017 08:30:17 PM (8 years ago)

Author:

jnylen0

Message:

REST API: Improve posts orderby tests

This commit adds tests for orderby=relevance combined with a search term in the REST API.

It also improves tests for the orderby parameter in WP_REST_Posts_Controller by looking at the generated SQL query instead of creating a bunch of carefully arranged test objects. This should be much more robust, and we can use this approach in other places (such as #39055).

Fixes #39079.

File:

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

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

@@ -21 +21 @@
 
     protected $forbidden_cat;
+    protected $posts_orderby;
 
     public static function wpSetUpBeforeClass( $factory ) {
@@ -67 +68 @@
         parent::setUp();
         register_post_type( 'youseeme', array( 'supports' => array(), 'show_in_rest' => true ) );
+        add_filter( 'rest_pre_dispatch', array( $this, 'wpSetUpBeforeRequest' ), 10, 3 );
+        add_filter( 'posts_orderby', array( $this, 'save_posts_orderby' ), 10, 2 );
+    }
+
+    public function wpSetUpBeforeRequest( $result, $server, $request ) {
+        $this->posts_orderby = array();
+        return $result;
+    }
+
+    public function save_posts_orderby( $orderby, $query ) {
+        array_push( $this->posts_orderby, $orderby );
+        return $orderby;
+    }
+
+    public function assertPostsOrderedBy( $pattern ) {
+        global $wpdb;
+        $orderby = str_replace( '{posts}', $wpdb->posts, $pattern );
+        $this->assertEquals( array( $orderby ), $this->posts_orderby );
     }
 
@@ -225 +244 @@
         $this->assertEquals( 2, count( $data ) );
         $this->assertEquals( $id3, $data[0]['id'] );
+        $this->assertPostsOrderedBy( '{posts}.post_date DESC' );
         // Orderby=>include
         $request->set_param( 'orderby', 'include' );
@@ -231 +251 @@
         $this->assertEquals( 2, count( $data ) );
         $this->assertEquals( $id1, $data[0]['id'] );
+        $this->assertPostsOrderedBy( "FIELD( {posts}.ID, $id1,$id3 )" );
         // Invalid include should error
         $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
@@ -439 +460 @@
         $data = $response->get_data();
         $this->assertEquals( 'Apple Sauce', $data[0]['title']['rendered'] );
+        $this->assertPostsOrderedBy( '{posts}.post_title DESC' );
         // order=>asc
         $request->set_param( 'order', 'asc' );
@@ -444 +466 @@
         $data = $response->get_data();
         $this->assertEquals( 'Apple Cobbler', $data[0]['title']['rendered'] );
+        $this->assertPostsOrderedBy( '{posts}.post_title ASC' );
         // order=>asc,id should fail
         $request->set_param( 'order', 'asc,id' );
@@ -481 +504 @@
         $this->assertEquals( $id2, $data[1]['id'] );
         $this->assertEquals( $id1, $data[2]['id'] );
+        $this->assertPostsOrderedBy( '{posts}.ID DESC' );
     }
 
@@ -497 +521 @@
         $this->assertEquals( 'xyz', $data[0]['slug'] );
         $this->assertEquals( 'abc', $data[1]['slug'] );
+        $this->assertPostsOrderedBy( '{posts}.post_name DESC' );
     }
 
     public function test_get_items_with_orderby_relevance() {
-        $this->factory->post->create( array( 'post_title' => 'Title is more relevant', 'post_content' => 'Content is', 'post_status' => 'publish' ) );
-        $this->factory->post->create( array( 'post_title' => 'Title is', 'post_content' => 'Content is less relevant', 'post_status' => 'publish' ) );
-
+        $id1 = $this->factory->post->create( array( 'post_title' => 'Title is more relevant', 'post_content' => 'Content is', 'post_status' => 'publish' ) );
+        $id2 = $this->factory->post->create( array( 'post_title' => 'Title is', 'post_content' => 'Content is less relevant', 'post_status' => 'publish' ) );
+        $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+        $request->set_param( 'orderby', 'relevance' );
+        $request->set_param( 'search', 'relevant' );
+        $response = $this->server->dispatch( $request );
+        $this->assertEquals( 200, $response->get_status() );
+        $data = $response->get_data();
+        $this->assertCount( 2, $data );
+        $this->assertEquals( $id1, $data[0]['id'] );
+        $this->assertEquals( $id2, $data[1]['id'] );
+        $this->assertPostsOrderedBy( '{posts}.post_title LIKE \'%relevant%\' DESC, {posts}.post_date DESC' );
+    }
+
+    public function test_get_items_with_orderby_relevance_two_terms() {
+        $id1 = $this->factory->post->create( array( 'post_title' => 'Title is more relevant', 'post_content' => 'Content is', 'post_status' => 'publish' ) );
+        $id2 = $this->factory->post->create( array( 'post_title' => 'Title is', 'post_content' => 'Content is less relevant', 'post_status' => 'publish' ) );
+        $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
+        $request->set_param( 'orderby', 'relevance' );
+        $request->set_param( 'search', 'relevant content' );
+        $response = $this->server->dispatch( $request );
+        $this->assertEquals( 200, $response->get_status() );
+        $data = $response->get_data();
+        $this->assertCount( 2, $data );
+        $this->assertEquals( $id1, $data[0]['id'] );
+        $this->assertEquals( $id2, $data[1]['id'] );
+        $this->assertPostsOrderedBy( '(CASE WHEN {posts}.post_title LIKE \'%relevant content%\' THEN 1 WHEN {posts}.post_title LIKE \'%relevant%\' AND {posts}.post_title LIKE \'%content%\' THEN 2 WHEN {posts}.post_title LIKE \'%relevant%\' OR {posts}.post_title LIKE \'%content%\' THEN 3 WHEN {posts}.post_excerpt LIKE \'%relevant content%\' THEN 4 WHEN {posts}.post_content LIKE \'%relevant content%\' THEN 5 ELSE 6 END), {posts}.post_date DESC' );
+    }
+
+    public function test_get_items_with_orderby_relevance_missing_search() {
         $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
         $request->set_param( 'orderby', 'relevance' );
@@ -2720 +2772 @@
             $this->remove_added_uploads();
         }
+        remove_filter( 'rest_pre_dispatch', array( $this, 'wpSetUpBeforeRequest' ), 10, 3 );
+        remove_filter( 'posts_orderby', array( $this, 'save_posts_orderby' ), 10, 2 );
         parent::tearDown();
     }