From 962f6e6ac12315db55db9b059786813399915e83 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicolas=20Mass=C3=A9?= Date: Fri, 21 Oct 2022 15:45:24 +0200 Subject: [PATCH] remove unit tests, add doc --- README.md | 68 +++++++++++++++++++ src/test/java/org/sebi/HelloResourceIT.java | 9 --- src/test/java/org/sebi/HelloResourceTest.java | 21 ------ 3 files changed, 68 insertions(+), 30 deletions(-) create mode 100644 README.md delete mode 100644 src/test/java/org/sebi/HelloResourceIT.java delete mode 100644 src/test/java/org/sebi/HelloResourceTest.java diff --git a/README.md b/README.md new file mode 100644 index 0000000..4506099 --- /dev/null +++ b/README.md @@ -0,0 +1,68 @@ +# antennas-incident Project + +This project uses Quarkus, the Supersonic Subatomic Java Framework. + +If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ . + +## Running the application in dev mode + +You can run your application in dev mode that enables live coding using: +```shell script +./mvnw compile quarkus:dev +``` + +> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/. + +## Packaging and running the application + +The application can be packaged using: +```shell script +./mvnw package +``` +It produces the `quarkus-run.jar` file in the `target/quarkus-app/` directory. +Be aware that it’s not an _über-jar_ as the dependencies are copied into the `target/quarkus-app/lib/` directory. + +The application is now runnable using `java -jar target/quarkus-app/quarkus-run.jar`. + +If you want to build an _über-jar_, execute the following command: +```shell script +./mvnw package -Dquarkus.package.type=uber-jar +``` + +The application, packaged as an _über-jar_, is now runnable using `java -jar target/*-runner.jar`. + +## Creating a native executable + +You can create a native executable using: +```shell script +./mvnw package -Pnative +``` + +Or, if you don't have GraalVM installed, you can run the native executable build in a container using: +```shell script +./mvnw package -Pnative -Dquarkus.native.container-build=true +``` + +You can then execute your native executable with: `./target/antennas-front-1.0.0-SNAPSHOT-runner` + +If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling. + +## Building the container image + +```sh +./mvnw clean package +buildah build -f src/main/docker/Dockerfile.jvm -t quay.io/redhat_sa_france/antennas-incident:latest +podman push quay.io/redhat_sa_france/antennas-incident:latest +``` + +## Related Guides + +- RESTEasy Classic ([guide](https://quarkus.io/guides/resteasy)): REST endpoint framework implementing JAX-RS and more + +## Provided Code + +### RESTEasy JAX-RS + +Easily start your RESTful Web Services + +[Related guide section...](https://quarkus.io/guides/getting-started#the-jax-rs-resources) diff --git a/src/test/java/org/sebi/HelloResourceIT.java b/src/test/java/org/sebi/HelloResourceIT.java deleted file mode 100644 index 37bcba8..0000000 --- a/src/test/java/org/sebi/HelloResourceIT.java +++ /dev/null @@ -1,9 +0,0 @@ -package org.sebi; - -import io.quarkus.test.junit.QuarkusIntegrationTest; - -@QuarkusIntegrationTest -public class HelloResourceIT extends HelloResourceTest { - - // Execute the same tests but in native mode. -} diff --git a/src/test/java/org/sebi/HelloResourceTest.java b/src/test/java/org/sebi/HelloResourceTest.java deleted file mode 100644 index 49bc731..0000000 --- a/src/test/java/org/sebi/HelloResourceTest.java +++ /dev/null @@ -1,21 +0,0 @@ -package org.sebi; - -import io.quarkus.test.junit.QuarkusTest; -import org.junit.jupiter.api.Test; - -import static io.restassured.RestAssured.given; -import static org.hamcrest.CoreMatchers.is; - -@QuarkusTest -public class HelloResourceTest { - - @Test - public void testHelloEndpoint() { - given() - .when().get("/hello") - .then() - .statusCode(200) - .body(is("Hello RESTEasy")); - } - -} \ No newline at end of file