https://github.com/vertx-howtos/test-web-application-howto
Test your Web application with Vert.x & JUnit 5
https://github.com/vertx-howtos/test-web-application-howto
Last synced: 3 months ago
JSON representation
Test your Web application with Vert.x & JUnit 5
- Host: GitHub
- URL: https://github.com/vertx-howtos/test-web-application-howto
- Owner: vertx-howtos
- License: apache-2.0
- Created: 2019-12-12T09:25:14.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-04T10:20:10.000Z (5 months ago)
- Last Synced: 2024-12-04T11:25:53.294Z (5 months ago)
- Language: Java
- Size: 68.4 KB
- Stars: 0
- Watchers: 5
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.adoc
- License: LICENSE
Awesome Lists containing this project
README
= Test your Web application with Vert.x & JUnit 5
:page-permalink: /
:page-github: vertx-howtos/test-web-application-howto
WARNING: This repository has been archived because the `reactiverse-junit5-web-client` is no longer relevant in Vert.x 5.
Consider using `Future.expecting` with HTTP expectations.
This document will show you how to test your web application with Vert.x & JUnit 5.
== What you will build
You will build a Web application using Vert.x Web and test it with JUnit 5 doing HTTP requests.
== What you need
* A text editor or IDE
* Java 8 or higher
* Maven
== Create a project
Here is the content of the `pom.xml` file you should be using:
[source,xml,role="collapsed"]
.Maven `pom.xml`
----
include::pom.xml[]
----
The pom contains JUnit 5 dependencies, https://vertx.io/docs/vertx-junit5/java/[vertx-junit5] and https://github.com/reactiverse/reactiverse-junit5-extensions[reactiverse-junit5-web-client] modules
== Create the Web application Verticle
The web application will have two endpoints:
* `GET /pet/:id`
* `POST /pet`
`GET /pet/:id` serves a Pet with a specific id:
[source,java,indent=0]
----
include::src/main/java/io/vertx/howtos/web/test/WebApplicationVerticle.java[tags=getPet]
----
`POST /pet` adds a new Pet to the collection:
[source,java,indent=0]
----
include::src/main/java/io/vertx/howtos/web/test/WebApplicationVerticle.java[tags=addPet]
----
To start the HTTP server:
[source,java,indent=0]
----
include::src/main/java/io/vertx/howtos/web/test/WebApplicationVerticle.java[tags=startHttpServer]
----
You can find the complete source code of the web application at https://github.com/vertx-howtos/test-web-application-howto/blob/master/src/main/java/io/vertx/howtos/web/test/WebApplicationVerticle.java[`WebApplicationVerticle`] on this how-to repo.
== Create the Web application test
Create a new test class called `WebApplicationTest` and add the following annotation to the class:
[source,java,indent=0]
----
include::src/test/java/io/vertx/howtos/web/test/WebApplicationTest.java[tags=testExtensions]
----
This ensures that JUnit 5 runs the test inside Vert.x and injects the https://vertx.io/docs/vertx-web-client/java/[`WebClient`], which is used for doing HTTP requests to the web application.
== Setup and Tear down the test
To setup and tear down the test, deploy and undeploy the `WebApplicationVerticle`:
[source,java,indent=0]
----
include::src/test/java/io/vertx/howtos/web/test/WebApplicationTest.java[tags=setUp]
----
[source,java,indent=0]
----
include::src/test/java/io/vertx/howtos/web/test/WebApplicationTest.java[tags=tearDown]
----
== Configure the Web Client
Since the test server will be available during the tests at `localhost:9000`, you can configure the injected `WebClient` using `@WebClientOptionsInject`:
[source,java,indent=0]
----
include::src/test/java/io/vertx/howtos/web/test/WebApplicationTest.java[tags=webClientOptions]
----
This ensures that all `WebClient` instances injected are properly configured to send requests to the application under test.
== Test get pet
To test the get pet endpoint:
[source,java,indent=0]
----
include::src/test/java/io/vertx/howtos/web/test/WebApplicationTest.java[tags=testGetPetOk]
----
The `testRequest` method creates a `TestRequest` instance, where you can add asserts about HTTP response.
In this case, asserts about the status code, the `x-pet-id` header and body are added.
After the response is received, if the assertions are correct the test completes, otherwise it fails.
== Test get pet error codes
To test the _Bad Request_ and _Page not found_ responses:
[source,java,indent=0]
----
include::src/test/java/io/vertx/howtos/web/test/WebApplicationTest.java[tags=testGetPetErrors]
----
== Post a pet and assert that is correctly added
To test if adding a pet works, first add the pet and then get it with another request:
[source,java,indent=0]
----
include::src/test/java/io/vertx/howtos/web/test/WebApplicationTest.java[tags=testPostAndGetPet]
----
When you pass a `Checkpoint` to `send*` methods of `TestRequest`, They don't complete the `VertxTestContext` but just flag the `Checkpoint`.
For more details on `VertxTestContext` and `Checkpoint`, look at https://vertx.io/docs/vertx-junit5/java/#_checkpoint_when_there_are_multiple_success_conditions[Vertx JUnit 5 documentation].
`TestRequest.send*` methods return a `Future` that is completed after all assertions pass, so you can execute another request after the first one.
== Complete code
You can find the complete source code of the test class at https://github.com/vertx-howtos/test-web-application-howto/blob/master/src/test/java/io/vertx/howtos/web/test/WebApplicationTest.java[`WebApplicationTest`] on this how-to repo.
== Summary
This how-to explained to you:
. How to inject `WebClient` into your unit tests
. How to setup and tear down your HTTP web application in your unit tests
. How to do test requests
. How to assert HTTP responses
. How to to multiple test requests in the same unit test
== See also
* https://vertx.io/docs/vertx-web/java/[Vert.x Web Documentation]
* https://vertx.io/docs/vertx-junit5/java/[Vert.x JUnit 5]
* https://vertx.io/docs/vertx-web-client/java/[Vert.x Web Client]
* https://vertx.io/docs/vertx-junit5-web-client/java/[Vert.x JUnit 5 Web Client]