org.openhubframework.openhub.test.rest

Class TestRestUtils

java.lang.Object

org.openhubframework.openhub.test.rest.TestRestUtils

public final class TestRestUtils
extends Object

TestRestUtils is a collection of REST-based utility methods for use in unit and integration testing scenarios.

Since:

2.0

Author:

Petr Juza

Field Summary

Fields

Modifier and Type	Field and Description
static String	UTF8

Method Summary

Modifier and Type	Method and Description
static List<org.apache.http.NameValuePair>	createDateQuery(String paramName, LocalDate date) Creates the GET query for local date based upon configuration.
static org.apache.http.client.utils.URIBuilder	createGetUrl(String path) Construct an instance from the REST path which must be a valid URI.
static javax.json.JsonObjectBuilder	createJson() Creates JsonObjectBuilder to easy creation JSON objects and serialization into string.
static org.springframework.data.domain.Pageable	createPage(int page, int size) Creates Pageable object based upon configuration.
static List<org.apache.http.NameValuePair>	createPagePair(int page, int size) Creates the GET pageable query based upon configuration.
static String	createPageQuery(int page, int size) Formats the GET query based upon configuration.
static List<org.apache.http.NameValuePair>	createSortPair(org.springframework.data.domain.Sort sort) Creates the GET sortable query based upon configuration.
static <T> T	jsonObject(org.springframework.test.web.servlet.MvcResult mockResult, Class<T> valueType) Method to deserialize JSON content from given JSON content String.
static <T> T	jsonObject(String content, Class<T> valueType) Method to deserialize JSON content from given JSON content String.
static String	toUrl(org.apache.http.client.utils.URIBuilder builder) Creates URL string based upon URIBuilder which is URL decoded in UTF8 character encoding.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UTF8

public static final String UTF8

See Also:

Constant Field Values

Method Detail

createPageQuery

public static String createPageQuery(int page,
                                     int size)

Formats the GET query based upon configuration.

  createPageQuery(1,20) → p=1&s=20
 

Parameters:

page - the page number

size - the size of page

Returns:

the query

createPagePair

public static List<org.apache.http.NameValuePair> createPagePair(int page,
                                                                 int size)

Creates the GET pageable query based upon configuration.

  createPagePair(1,20) → p=1&s=20
 

Parameters:

page - the page number

size - the size of page

Returns:

the list of NameValuePair

createSortPair

public static List<org.apache.http.NameValuePair> createSortPair(org.springframework.data.domain.Sort sort)

Creates the GET sortable query based upon configuration. With this method it is necessary to use URLDecoder#decode(String, String) to decode URL or use toUrl(URIBuilder).

  createSortPair(new Sort(new Sort.Order(Sort.Direction.DESC, "dateFrom"))) → sort=name&name,dir=desc
 

Parameters:

sort - the sort instrument

Returns:

the list of NameValuePair

See Also:

URLDecoder.decode(String, String), toUrl(URIBuilder)

createDateQuery

public static List<org.apache.http.NameValuePair> createDateQuery(String paramName,
                                                                  LocalDate date)

Creates the GET query for local date based upon configuration.

  createDateQuery("dateFrom", LocalDate.now()) → dateFrom=2015-03-09
 

Parameters:

paramName - the name of attribute/parameter

date - the local date value

Returns:

the list of NameValuePair that represents query parameter for date represented by paramName attribute

createPage

public static org.springframework.data.domain.Pageable createPage(int page,
                                                                  int size)

Creates Pageable object based upon configuration.

Parameters:

page - the number of page

size - the size of page

Returns:

the Pageable

createJson

public static javax.json.JsonObjectBuilder createJson()

Creates JsonObjectBuilder to easy creation JSON objects and serialization into string.

 final String content = createJson()
                          .add("p", 1)
                          .add("size", 20)
                          .add("fulltext", "value")
                              .build().toString();
 

Returns:

the JsonObjectBuilder

createGetUrl

public static org.apache.http.client.utils.URIBuilder createGetUrl(String path)

Construct an instance from the REST path which must be a valid URI.

 final String context = createGetUrl("/rpc/orders")
      .addParameters(createPagePair(1, 20))
      .addParameter("fulltext", "value")
          .build().toString();

Result: /rpc/orders?p=1&s=20&fulltext=value&createdFrom=2015-06-20

Parameters:

path - a valid REST URI path in string form

toUrl

public static String toUrl(org.apache.http.client.utils.URIBuilder builder)
                    throws Exception

Creates URL string based upon URIBuilder which is URL decoded in UTF8 character encoding.

Parameters:

builder - the URI builder

Returns:

the URL decoded URI as plain string

Throws:

Exception - occurs if URI is wrong

See Also:

URLDecoder.decode(String, String), UTF8

jsonObject

public static <T> T jsonObject(org.springframework.test.web.servlet.MvcResult mockResult,
                               Class<T> valueType)

Method to deserialize JSON content from given JSON content String.

Type Parameters:

T - JSON object type

Parameters:

mockResult - as result of mock that contains response as JSON string

valueType - as type of object that represents JSON string

Returns:

the object that represents JSON content

See Also:

jsonObject(String, Class)

jsonObject

public static <T> T jsonObject(String content,
                               Class<T> valueType)

Method to deserialize JSON content from given JSON content String.

Type Parameters:

T - JSON object type

Parameters:

content - as JSON string

valueType - as type of object that represents JSON string

Returns:

the object that represents JSON content

See Also:

jsonObject(MvcResult, Class)