Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jupiter-tools/mvc-requester
Wrapper over the MockMvc to write tests of REST API in Spring.
https://github.com/jupiter-tools/mvc-requester
Last synced: 15 days ago
JSON representation
Wrapper over the MockMvc to write tests of REST API in Spring.
- Host: GitHub
- URL: https://github.com/jupiter-tools/mvc-requester
- Owner: jupiter-tools
- Created: 2019-01-29T05:37:19.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-06-14T22:29:22.000Z (over 1 year ago)
- Last Synced: 2024-11-05T19:18:17.426Z (2 months ago)
- Language: Java
- Homepage: http://jupiter-tools.com
- Size: 85 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.adoc
Awesome Lists containing this project
README
:toc: preamble
# MvcRequester
image:https://travis-ci.com/jupiter-tools/mvc-requester.svg?branch=master["Build Status", link="https://travis-ci.com/jupiter-tools/mvc-requester"]
image:https://codecov.io/gh/jupiter-tools/mvc-requester/branch/master/graph/badge.svg[link ="https://codecov.io/gh/jupiter-tools/mvc-requester"]
Tools which wrap the MockMvc in a simple matcher of HTTP responses,
to write your REST-API tests in a more easy way.
## Getting started
You need to add a next dependency:
[source, xml]
----
com.jupiter-tools
mvc-requester
0.4
----
And now you can write MVC tests in a more simple way.
Let's consider the next controller:
[source, java]
----
@RestController
@RequestMapping("/test")
public class TestController {
@GetMapping("/object")
public SimpleObject getObject() {
return new SimpleObject("test-name", 1987);
}
@GetMapping("/custom-object")
public SimpleObject getWithParams(@RequestParam("name") String name,
@RequestParam("value") int value) {
return new SimpleObject(name, value);
}
@GetMapping("/{id}/object")
public SimpleObject getWithPathVariable(@PathVariable("id") int id) {
return new SimpleObject(String.valueOf(id), id);
}
}
----
## Simple GET request:
[source, java]
----
@Test
void testReturnAs() throws Exception {
// Act
SimpleObject result = MvcRequester.on(mockMvc)
.to("/test/object")
.get()
.returnAs(SimpleObject.class); <1>
// Asserts
assertThat(result).isNotNull() <2>
.extracting(SimpleObject::getName, SimpleObject::getValue)
.containsOnly("test-name", 1987);
}
----
<1> return received response as a type safety object
<2> asserting of the received object with a type safety
## Make a GET request with parameters:
[source, java]
----
@Test
void getWithParams() throws Exception {
// Act
SimpleObject result = MvcRequester.on(mockMvc)
.to("/test/custom-object")
.withParam("name", "custom")
.withParam("value", 10101)
.get()
.returnAs(SimpleObject.class);
// Asserts
assertThat(result).isNotNull()
.extracting(SimpleObject::getName, SimpleObject::getValue)
.containsOnly("custom", 10101);
}
----
## Using path variables
[source, java]
----
MvcRequester.on(mockMvc)
.to("/users/{name}/acls", "admin") <1>
.get()
.returnAs(AclDto.class);
----
<1> String `admin` will be put instead of `{name}` variable in the url, before send request.
## Checking returned status
[source, java]
----
@Test
void testCreateObject() throws Exception {
MvcRequester.on(mockMvc)
.to("/objects/create")
.post()
.expectStatus(HttpStatus.CREATED); <1>
}
----
<1> Check the HTTP status of the response
## Send POST request with the body
Let's consider the next controller:
[source, java]
----
@RestController
@RequestMapping("/test")
public class TestController {
@PostMapping("/object-body")
public SimpleObject postWithBody(@RequestBody SimpleObject body) {
return new SimpleObject(body.getName() + "-test",
body.getValue() + 1000);
}
}
----
[source, java]
----
SimpleObject postBody = new SimpleObject("body", 987); <1>
SimpleObject result = MvcRequester.on(mockMvc)
.to("/test/object-body")
.post(postBody) <2>
.returnAs(SimpleObject.class);
----
<1> create an object which will send in the body
<2> send a POST request with converting the body to JSON
## Expected Parametrized Type
For example, we consider an API which return the list of entities:
[source, java]
----
@RestController
@RequestMapping("/objects")
public class TestController {
@GetMapping("/list")
public List getObject() {
SimpleObject a = new SimpleObject("AAA", 1);
SimpleObject b = new SimpleObject("BBB", 1);
SimpleObject c = new SimpleObject("CCC", 1);
return Arrays.asList(a, b, c);
}
}
----
and we can test it like that:
[source, java]
----
@Test
void parametrizedType() throws Exception {
// Act
List objectList = MvcRequester.on(mockMvc)
.to("/objects/list")
.get()
.doReturn(new TypeReference>() {});
// Asserts
assertThat(objectList).isNotNull()
.hasSize(3)
.extracting(SimpleObject::getName)
.containsOnly("AAA", "BBB", "CCC");
}
----
## Use custom headers in request
[source,java]
----
MvcRequester.on(mockMvc)
.to("test/headers/check")
.withHeader("custom-header", "12345")
.get();
----
## Upload the MultipartFile
[source, java]
----
byte[] data = "file content".getBytes();
MvcRequester.on(mockMvc)
.to("/test/create")
.withFile("data",
"filename.txt",
MimeType.valueOf("text/plain"),
data)
.upload();
----
## Authorization
### OAuth
[source, java]
----
MvcRequester.on(mockMvc)
.to("/test/oauth")
.withOAuth(TOKEN)
.get();
----
will send a request with the next header:
`Authorization: Bearer {TOKEN}`
### Basic Authorization
[source, java]
----
String result = MvcRequester.on(mockMvc)
.to("/test/basic")
.withBasicAuth("root", "12345")
.post()
----
will send a request with the next header:
`Authorization: Basic {base64}`
## Response charset
To get a response in the specific charset you can use `MvcRequestResult.charset` method,
for example when we expect a response in `cp1251`:
[source, java]
----
String response = MvcRequester.on(mockMvc)
.to("/api/endpoint")
.get()
.charset(Charset.forName("cp1251"))
.returnAsPrimitive(String.class);
----
By default MvcRequester uses the `UTF-8` charset.