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

Timestamp:

11/03/2016 08:04:59 PM (8 years ago)

Author:

rachelbaker

Message:

REST API: Modify the structure of our DELETE responses to be more explicit.

Add the deleted property to the root of the Response object to communicate if the delete action was successful. Move the state of the resource prior to the delete request under a new previous property. As a result DELETE responses are now structured like so:

{ deleted: true, previous: { ... } }

Also includes helpful information to DELETE requests for resources that are not trashable.

Props timmydcrawford, rmccue, jnylen0.
Fixes #38494.

File:

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

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

@@ -1155 +1155 @@
         $this->assertEquals( 200, $response->get_status() );
         $data = $response->get_data();
-        $this->assertEquals( 'Deleted User', $data['name'] );
+        $this->assertTrue( $data['deleted'] );
+        $this->assertEquals( 'Deleted User', $data['previous']['name'] );
+    }
+
+    public function test_delete_item_no_trash() {
+        $user_id = $this->factory->user->create( array( 'display_name' => 'Deleted User' ) );
+
+        $this->allow_user_to_manage_multisite();
+        wp_set_current_user( self::$user );
+
+        $userdata = get_userdata( $user_id ); // cache for later
+
+        $request = new WP_REST_Request( 'DELETE', sprintf( '/wp/v2/users/%d', $user_id ) );
+        $response = $this->server->dispatch( $request );
+        $this->assertErrorResponse( 'rest_trash_not_supported', $response, 501 );
+
+        $request->set_param( 'force', 'false' );
+        $response = $this->server->dispatch( $request );
+        $this->assertErrorResponse( 'rest_trash_not_supported', $response, 501 );
+
+        // Ensure the user still exists
+        $user = get_user_by( 'id', $user_id );
+        $this->assertNotEmpty( $user );
     }
 
@@ -1171 +1193 @@
         $this->assertEquals( 200, $response->get_status() );
         $data = $response->get_data();
-        $this->assertEquals( 'Deleted User', $data['name'] );
-    }
-
-    public function test_delete_item_no_trash() {
-        $user_id = $this->factory->user->create( array( 'display_name' => 'Deleted User' ) );
-
-        $this->allow_user_to_manage_multisite();
-        wp_set_current_user( self::$user );
-
-        $userdata = get_userdata( $user_id ); // cache for later
-        $request = new WP_REST_Request( 'DELETE', sprintf( '/wp/v2/users/%d', $user_id ) );
-        $response = $this->server->dispatch( $request );
-        $this->assertErrorResponse( 'rest_trash_not_supported', $response, 501 );
-
-        // Ensure the user still exists
-        $user = get_user_by( 'id', $user_id );
-        $this->assertNotEmpty( $user );
+        $this->assertTrue( $data['deleted'] );
+        $this->assertEquals( 'Deleted User', $data['previous']['name'] );
     }
 
     public function test_delete_current_item_no_trash() {
-        $user_id = $this->factory->user->create( array( 'role' => 'administrator' ) );
+        $user_id = $this->factory->user->create( array( 'role' => 'administrator', 'display_name' => 'Deleted User' ) );
 
         wp_set_current_user( $user_id );
@@ -1197 +1204 @@
         update_site_option( 'site_admins', array( $user->user_login ) );
 
-        $userdata = get_userdata( $user_id ); // cache for later
         $request = new WP_REST_Request( 'DELETE', '/wp/v2/users/me' );
+        $response = $this->server->dispatch( $request );
+        $this->assertErrorResponse( 'rest_trash_not_supported', $response, 501 );
+
+        $request->set_param( 'force', 'false' );
         $response = $this->server->dispatch( $request );
         $this->assertErrorResponse( 'rest_trash_not_supported', $response, 501 );