<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[40037] trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php: REST API: Improve posts orderby tests</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/40037">40037</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/40037","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jnylen0</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-02-01 20:30:17 +0000 (Wed, 01 Feb 2017)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/39055">#39055</a>).
Fixes <a href="https://core.trac.wordpress.org/ticket/39079">#39079</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsrestapirestpostscontrollerphp">trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunktestsphpunittestsrestapirestpostscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php 2017-02-01 01:39:39 UTC (rev 40036)
+++ trunk/tests/phpunit/tests/rest-api/rest-posts-controller.php 2017-02-01 20:30:17 UTC (rev 40037)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -20,6 +20,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> protected static $supported_formats;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> protected $forbidden_cat;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ protected $posts_orderby;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> public static function wpSetUpBeforeClass( $factory ) {
</span><span class="cx" style="display: block; padding: 0 10px"> self::$post_id = $factory->post->create();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -66,8 +67,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function setUp() {
</span><span class="cx" style="display: block; padding: 0 10px"> parent::setUp();
</span><span class="cx" style="display: block; padding: 0 10px"> register_post_type( 'youseeme', array( 'supports' => array(), 'show_in_rest' => true ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_filter( 'rest_pre_dispatch', array( $this, 'wpSetUpBeforeRequest' ), 10, 3 );
+ add_filter( 'posts_orderby', array( $this, 'save_posts_orderby' ), 10, 2 );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 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 );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_register_routes() {
</span><span class="cx" style="display: block; padding: 0 10px"> $routes = $this->server->get_routes();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -224,12 +243,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $response->get_data();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 2, count( $data ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $id3, $data[0]['id'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertPostsOrderedBy( '{posts}.post_date DESC' );
</ins><span class="cx" style="display: block; padding: 0 10px"> // Orderby=>include
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_param( 'orderby', 'include' );
</span><span class="cx" style="display: block; padding: 0 10px"> $response = $this->server->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $response->get_data();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 2, count( $data ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $id1, $data[0]['id'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertPostsOrderedBy( "FIELD( {posts}.ID, $id1,$id3 )" );
</ins><span class="cx" style="display: block; padding: 0 10px"> // Invalid include should error
</span><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_param( 'include', 'invalid' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -438,11 +459,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $response = $this->server->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $response->get_data();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'Apple Sauce', $data[0]['title']['rendered'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertPostsOrderedBy( '{posts}.post_title DESC' );
</ins><span class="cx" style="display: block; padding: 0 10px"> // order=>asc
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_param( 'order', 'asc' );
</span><span class="cx" style="display: block; padding: 0 10px"> $response = $this->server->dispatch( $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $data = $response->get_data();
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'Apple Cobbler', $data[0]['title']['rendered'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertPostsOrderedBy( '{posts}.post_title ASC' );
</ins><span class="cx" style="display: block; padding: 0 10px"> // order=>asc,id should fail
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_param( 'order', 'asc,id' );
</span><span class="cx" style="display: block; padding: 0 10px"> $response = $this->server->dispatch( $request );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -480,6 +503,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $id3, $data[0]['id'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $id2, $data[1]['id'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $id1, $data[2]['id'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertPostsOrderedBy( '{posts}.ID DESC' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_items_with_orderby_slug() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -496,15 +520,43 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Default ORDER is DESC.
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'xyz', $data[0]['slug'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( 'abc', $data[1]['slug'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertPostsOrderedBy( '{posts}.post_name DESC' );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_items_with_orderby_relevance() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $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' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $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' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 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' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $request = new WP_REST_Request( 'GET', '/wp/v2/posts' );
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_param( 'orderby', 'relevance' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $request->set_param( 'search', 'relevant content' );
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = $this->server->dispatch( $request );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $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' );
+ $response = $this->server->dispatch( $request );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertErrorResponse( 'rest_no_search_term_defined', $response, 400 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2719,6 +2771,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $this->attachment_id ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->remove_added_uploads();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ remove_filter( 'rest_pre_dispatch', array( $this, 'wpSetUpBeforeRequest' ), 10, 3 );
+ remove_filter( 'posts_orderby', array( $this, 'save_posts_orderby' ), 10, 2 );
</ins><span class="cx" style="display: block; padding: 0 10px"> parent::tearDown();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>