From 5826f39dbe15791a171fa8ea15d675e98803297a Mon Sep 17 00:00:00 2001
From: Harry Stern <boustrophedon@users.noreply.github.com>
Date: Sat, 18 May 2019 22:36:28 -0400
Subject: [PATCH] Add `set_json` method to TestRequest (#851)

- Takes a type which implements serde::Serialize, serializes it to JSON,
and sets it as the payload. The content-type is also set to JSON.
---
 CHANGES.md  |  2 ++
 src/test.rs | 35 ++++++++++++++++++++++++++++++++++-
 2 files changed, 36 insertions(+), 1 deletion(-)

diff --git a/CHANGES.md b/CHANGES.md
index 85e635365..cc18e068e 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -6,6 +6,8 @@
 
 * Add `Query<T>::from_query()` to extract parameters from a query string. #846
 * `QueryConfig`, similar to `JsonConfig` for customizing error handling of query extractors.
+* Add `test::TestRequest::set_json` convenience method to automatically
+  serialize data and set header in test requests.
 
 ### Changes
 
diff --git a/src/test.rs b/src/test.rs
index 3b3aac67d..979a8bc4a 100644
--- a/src/test.rs
+++ b/src/test.rs
@@ -2,7 +2,7 @@
 use std::cell::RefCell;
 use std::rc::Rc;
 
-use actix_http::http::header::{Header, HeaderName, IntoHeaderValue};
+use actix_http::http::header::{ContentType, Header, HeaderName, IntoHeaderValue};
 use actix_http::http::{HttpTryFrom, Method, StatusCode, Uri, Version};
 use actix_http::test::TestRequest as HttpTestRequest;
 use actix_http::{cookie::Cookie, Extensions, Request};
@@ -13,6 +13,7 @@ use actix_service::{IntoNewService, IntoService, NewService, Service};
 use bytes::{Bytes, BytesMut};
 use futures::future::{lazy, ok, Future, IntoFuture};
 use futures::Stream;
+use serde::Serialize;
 use serde::de::DeserializeOwned;
 use serde_json;
 
@@ -477,6 +478,15 @@ impl TestRequest {
         self
     }
 
+    /// Serialize `data` to JSON and set it as the request payload. The `Content-Type` header is
+    /// set to `application/json`.
+    pub fn set_json<T: Serialize>(mut self, data: &T) -> Self {
+        let bytes = serde_json::to_string(data).expect("Failed to serialize test data to json");
+        self.req.set_payload(bytes);
+        self.req.set(ContentType::json());
+        self
+    }
+
     /// Set application data. This is equivalent of `App::data()` method
     /// for testing purpose.
     pub fn data<T: 'static>(mut self, data: T) -> Self {
@@ -553,6 +563,7 @@ impl TestRequest {
 
 #[cfg(test)]
 mod tests {
+    use actix_http::httpmessage::HttpMessage;
     use serde::{Deserialize, Serialize};
     use std::time::SystemTime;
 
@@ -657,6 +668,28 @@ mod tests {
         assert_eq!(&result.id, "12345");
     }
 
+    #[test]
+    fn test_request_response_json() {
+        let mut app = init_service(App::new().service(web::resource("/people").route(
+            web::post().to(|person: web::Json<Person>| {
+                HttpResponse::Ok().json(person.into_inner())
+            }),
+        )));
+
+        let payload = Person {id: "12345".to_string(), name: "User name".to_string() };
+
+        let req = TestRequest::post()
+            .uri("/people")
+            .set_json(&payload)
+            .to_request();
+
+        assert_eq!(req.content_type(), "application/json");
+
+        let result: Person = read_response_json(&mut app, req);
+        assert_eq!(&result.id, "12345");
+        assert_eq!(&result.name, "User name");
+    }
+
     #[test]
     fn test_async_with_block() {
         fn async_with_block() -> impl Future<Item = HttpResponse, Error = Error> {