Testing a Quarkus Application
Learn how to test the Quarkus application.
We'll cover the following...
To ensure a bug-free and robust application, we need to thoroughly test it. This can be done by manual testing or by automating the task with scripts and code. We’ll explore how this can be done with Quarkus.
Example app
Let’s start by creating a new application with the below command:
Press + to interact
mvn io.quarkus.platform:quarkus-maven-plugin:2.15.3.Final:create -DprojectGroupId=io.educative -DprojectArtifactId=educative-quarkus
The code generated is available via the playground below:
#### # This Dockerfile is used in order to build a container that runs the Quarkus application in JVM mode # # Before building the container image run: # # ./mvnw package # # Then, build the image with: # # docker build -f src/main/docker/Dockerfile.jvm -t quarkus/educative-quarkus-jvm . # # Then run the container using: # # docker run -i --rm -p 8080:8080 quarkus/educative-quarkus-jvm # # If you want to include the debug port into your docker image # you will have to expose the debug port (default 5005) like this : EXPOSE 8080 5005 # # Then run the container using : # # docker run -i --rm -p 8080:8080 quarkus/educative-quarkus-jvm # # This image uses the `run-java.sh` script to run the application. # This scripts computes the command line to execute your Java application, and # includes memory/GC tuning. # You can configure the behavior using the following environment properties: # - JAVA_OPTS: JVM options passed to the `java` command (example: "-verbose:class") # - JAVA_OPTS_APPEND: User specified Java options to be appended to generated options # in JAVA_OPTS (example: "-Dsome.property=foo") # - JAVA_MAX_MEM_RATIO: Is used when no `-Xmx` option is given in JAVA_OPTS. This is # used to calculate a default maximal heap memory based on a containers restriction. # If used in a container without any memory constraints for the container then this # option has no effect. If there is a memory constraint then `-Xmx` is set to a ratio # of the container available memory as set here. The default is `50` which means 50% # of the available memory is used as an upper boundary. You can skip this mechanism by # setting this value to `0` in which case no `-Xmx` option is added. # - JAVA_INITIAL_MEM_RATIO: Is used when no `-Xms` option is given in JAVA_OPTS. This # is used to calculate a default initial heap memory based on the maximum heap memory. # If used in a container without any memory constraints for the container then this # option has no effect. If there is a memory constraint then `-Xms` is set to a ratio # of the `-Xmx` memory as set here. The default is `25` which means 25% of the `-Xmx` # is used as the initial heap size. You can skip this mechanism by setting this value # to `0` in which case no `-Xms` option is added (example: "25") # - JAVA_MAX_INITIAL_MEM: Is used when no `-Xms` option is given in JAVA_OPTS. # This is used to calculate the maximum value of the initial heap memory. If used in # a container without any memory constraints for the container then this option has # no effect. If there is a memory constraint then `-Xms` is limited to the value set # here. The default is 4096MB which means the calculated value of `-Xms` never will # be greater than 4096MB. The value of this variable is expressed in MB (example: "4096") # - JAVA_DIAGNOSTICS: Set this to get some diagnostics information to standard output # when things are happening. This option, if set to true, will set # `-XX:+UnlockDiagnosticVMOptions`. Disabled by default (example: "true"). # - JAVA_DEBUG: If set remote debugging will be switched on. Disabled by default (example: # true"). # - JAVA_DEBUG_PORT: Port used for remote debugging. Defaults to 5005 (example: "8787"). # - CONTAINER_CORE_LIMIT: A calculated core limit as described in # https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt. (example: "2") # - CONTAINER_MAX_MEMORY: Memory limit given to the container (example: "1024"). # - GC_MIN_HEAP_FREE_RATIO: Minimum percentage of heap free after GC to avoid expansion. # (example: "20") # - GC_MAX_HEAP_FREE_RATIO: Maximum percentage of heap free after GC to avoid shrinking. # (example: "40") # - GC_TIME_RATIO: Specifies the ratio of the time spent outside the garbage collection. # (example: "4") # - GC_ADAPTIVE_SIZE_POLICY_WEIGHT: The weighting given to the current GC time versus # previous GC times. (example: "90") # - GC_METASPACE_SIZE: The initial metaspace size. (example: "20") # - GC_MAX_METASPACE_SIZE: The maximum metaspace size. (example: "100") # - GC_CONTAINER_OPTIONS: Specify Java GC to use. The value of this variable should # contain the necessary JRE command-line options to specify the required GC, which # will override the default of `-XX:+UseParallelGC` (example: -XX:+UseG1GC). # - HTTPS_PROXY: The location of the https proxy. (example: "myuser@127.0.0.1:8080") # - HTTP_PROXY: The location of the http proxy. (example: "myuser@127.0.0.1:8080") # - NO_PROXY: A comma separated lists of hosts, IP addresses or domains that can be # accessed directly. (example: "foo.example.com,bar.example.com") # ### FROM registry.access.redhat.com/ubi8/openjdk-17:1.14 ENV LANGUAGE='en_US:en' # We make four distinct layers so if there are application changes the library layers can be re-used COPY --chown=185 target/quarkus-app/lib/ /deployments/lib/ COPY --chown=185 target/quarkus-app/*.jar /deployments/ COPY --chown=185 target/quarkus-app/app/ /deployments/app/ COPY --chown=185 target/quarkus-app/quarkus/ /deployments/quarkus/ EXPOSE 8080 USER 185 ENV JAVA_OPTS="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager" ENV JAVA_APP_JAR="/deployments/quarkus-run.jar"
Generated Quarkus application
HTTP testing
To start testing our endpoints, we’ll use the ...