Tests and README adjustments

domdorn · domdorn · commit 9ac1445b9bbc · 2024-05-09T16:03:06.000+02:00
diff --git a/README.md b/README.md
@@ -449,7 +449,6 @@ def mkRoutes(router: Router) =
 
 ### `Future[T]` and `Promise[T]` support in Rest-Endpoints
 
-If you're using Scala 3, you might be using `Future` for async operations.
 This extension allows you to return `Future[T]` and `Promise[T]` from your rest-endpoints.
 
 ```scala
@@ -475,6 +474,25 @@ end GreetingResource
 
 If the `Future[T]` or `Promise[T]` fails, the normal exception handling is invoked.
 
+Make sure to have the following dependencies in your `pom.xml` to make it work:
+
+```xml
+    <dependency>
+      <groupId>io.quarkus</groupId>
+      <artifactId>quarkus-rest</artifactId>
+    </dependency>
+    <dependency>
+      <groupId>io.quarkiverse.scala</groupId>
+      <artifactId>quarkus-scala3</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>io.quarkiverse.scala</groupId>
+      <artifactId>quarkus-scala3-deployment</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+```
+
 
 ## Contributors ✨
 
diff --git a/deployment/src/main/java/io/quarkiverse/scala/scala3/deployment/FutureReturnTypeMethodScanner.java b/deployment/src/main/java/io/quarkiverse/scala/scala3/deployment/FutureReturnTypeMethodScanner.java
@@ -25,6 +25,9 @@ private void ensureNotBlocking(MethodInfo method) {
         }
     }
 
+    public FutureReturnTypeMethodScanner() {
+    }
+
     @Override
     public List<HandlerChainCustomizer> scan(MethodInfo method, ClassInfo actualEndpointClass,
             Map<String, Object> methodContext) {
diff --git a/deployment/src/main/java/io/quarkiverse/scala/scala3/deployment/Scala3Processor.java b/deployment/src/main/java/io/quarkiverse/scala/scala3/deployment/Scala3Processor.java
@@ -32,6 +32,7 @@ void registerScalaJacksonModule(BuildProducer<ClassPathJacksonModuleBuildItem> c
 
     @BuildStep
     MethodScannerBuildItem enableAsyncMethodsInRestEndpoints() {
+        System.out.println("Enabling async methods in rest endpoints");
         return new MethodScannerBuildItem(new FutureReturnTypeMethodScanner());
     }
 }
diff --git a/integration-tests/pom.xml b/integration-tests/pom.xml
@@ -8,28 +8,58 @@
   </parent>
   <artifactId>quarkus-scala3-integration-tests</artifactId>
   <name>Quarkus - Scala3 - Integration Tests</name>
+  <properties>
+    <scala-maven-plugin.version>4.9.0</scala-maven-plugin.version>
+    <scala.version>3.4.1</scala.version>
+  </properties>
   <dependencies>
     <dependency>
       <groupId>io.quarkus</groupId>
-      <artifactId>quarkus-resteasy</artifactId>
+      <artifactId>quarkus-rest</artifactId>
+      <scope>test</scope>
     </dependency>
     <dependency>
       <groupId>io.quarkiverse.scala</groupId>
       <artifactId>quarkus-scala3</artifactId>
       <version>${project.version}</version>
     </dependency>
+    <dependency>
+      <groupId>io.quarkiverse.scala</groupId>
+      <artifactId>quarkus-scala3-deployment</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+    <dependency>
+      <groupId>org.scala-lang</groupId>
+      <artifactId>scala3-compiler_3</artifactId>
+      <version>${scala.version}</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.scala-lang</groupId>
+      <artifactId>scala3-library_3</artifactId>
+      <version>${scala.version}</version>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>io.quarkus</groupId>
       <artifactId>quarkus-junit5</artifactId>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>io.quarkus</groupId>
+      <artifactId>quarkus-junit5-internal</artifactId>
+      <scope>test</scope>
+    </dependency>
     <dependency>
       <groupId>io.rest-assured</groupId>
       <artifactId>rest-assured</artifactId>
       <scope>test</scope>
     </dependency>
+
   </dependencies>
   <build>
+    <sourceDirectory>src/main/scala</sourceDirectory>
+    <testSourceDirectory>src/test/scala</testSourceDirectory>
     <plugins>
       <plugin>
         <groupId>io.quarkus</groupId>
@@ -42,6 +72,51 @@
           </execution>
         </executions>
       </plugin>
+      <plugin>
+        <artifactId>maven-compiler-plugin</artifactId>
+        <configuration>
+          <annotationProcessorPaths>
+            <path>
+              <groupId>io.quarkus</groupId>
+              <artifactId>quarkus-extension-processor</artifactId>
+              <version>${quarkus.version}</version>
+            </path>
+          </annotationProcessorPaths>
+        </configuration>
+      </plugin>
+      <plugin>
+        <groupId>net.alchim31.maven</groupId>
+        <artifactId>scala-maven-plugin</artifactId>
+        <version>${scala-maven-plugin.version}</version>
+        <executions>
+          <execution>
+            <?m2e ignore?>
+            <id>scala-compile-first</id>
+            <phase>process-resources</phase>
+            <goals>
+              <goal>add-source</goal>
+              <goal>compile</goal>
+            </goals>
+          </execution>
+          <execution>
+            <?m2e ignore?>
+            <id>scala-test-compile</id>
+            <phase>process-test-resources</phase>
+            <goals>
+              <goal>add-source</goal>
+              <goal>testCompile</goal>
+            </goals>
+          </execution>
+        </executions>
+        <configuration>
+          <args>
+            <arg>-Wunused:all</arg>
+            <arg>-feature</arg>
+            <arg>-deprecation</arg>
+            <arg>-Ysemanticdb</arg>
+          </args>
+        </configuration>
+      </plugin>
     </plugins>
   </build>
   <profiles>
@@ -54,6 +129,7 @@
       </activation>
       <build>
         <plugins>
+
           <plugin>
             <artifactId>maven-surefire-plugin</artifactId>
             <configuration>
diff --git a/integration-tests/src/main/java/io/quarkiverse/scala/scala3/it/Scala3Resource.java b/integration-tests/src/main/java/io/quarkiverse/scala/scala3/it/Scala3Resource.java
diff --git a/integration-tests/src/main/scala/io/quarkiverse/scala/scala3/it/Scala3Resource.scala b/integration-tests/src/main/scala/io/quarkiverse/scala/scala3/it/Scala3Resource.scala
@@ -0,0 +1,38 @@
+package io.quarkiverse.scala.scala3.it
+
+import jakarta.ws.rs.GET
+import jakarta.ws.rs.Path
+import jakarta.ws.rs.Produces
+import jakarta.ws.rs.core.MediaType.TEXT_PLAIN
+
+import scala.concurrent.Future
+import scala.concurrent.Promise
+import scala.concurrent.ExecutionContext.Implicits.global
+
+@Path("")
+class Scala3Resource {
+
+  @GET
+  @Path("/hello")
+  def hello(): String = "Hello from Scala 3.4.1"
+
+  @GET
+  @Path("/simple-future")
+  @Produces(Array(TEXT_PLAIN))
+  def simpleFuture: Future[String] = for {
+    _ <- Future { Thread.sleep(2000L) }
+    s <- Future.successful("Hello from a Future in Scala 3.4.1")
+  } yield s
+
+  @GET
+  @Path("simple-promise")
+  @Produces(Array(TEXT_PLAIN))
+  def simplePromise: Promise[String] = Promise.successful("Promise returned")
+  
+  
+  @GET
+  @Path("future-failure")
+  @Produces(Array(TEXT_PLAIN))
+  def futureFailure: Future[String] = Future.failed(new RuntimeException("Future failed"))
+
+}
diff --git a/integration-tests/src/test/java/io/quarkiverse/scala/scala3/it/NativeScala3ResourceIT.java b/integration-tests/src/test/java/io/quarkiverse/scala/scala3/it/NativeScala3ResourceIT.java
diff --git a/integration-tests/src/test/java/io/quarkiverse/scala/scala3/it/Scala3ResourceTest.java b/integration-tests/src/test/java/io/quarkiverse/scala/scala3/it/Scala3ResourceTest.java
diff --git a/integration-tests/src/test/scala/io/quarkiverse/scala/scala3/it/Given.scala b/integration-tests/src/test/scala/io/quarkiverse/scala/scala3/it/Given.scala
@@ -0,0 +1,26 @@
+package io.quarkiverse.scala.scala3.it
+
+import io.restassured.RestAssured.*
+import io.restassured.internal.{ResponseSpecificationImpl, ValidatableResponseImpl}
+import io.restassured.response.{ExtractableResponse, Response, ValidatableResponse}
+import io.restassured.specification.{RequestSender, RequestSpecification, ResponseSpecification}
+
+class GivenConstructor(givenBlock: RequestSpecification => RequestSpecification):
+  def When(whenBlock: RequestSpecification => Response): ExpectationConstructor =
+    ExpectationConstructor(givenBlock, whenBlock)
+
+  class ExpectationConstructor(
+                                givenBlock: RequestSpecification => RequestSpecification,
+                                whenBlock: RequestSpecification => Response
+                              ):
+    def Then(validatable: ValidatableResponse => Unit) =
+      val appliedGiven: RequestSpecification = givenBlock.apply(`given`())
+      val appliedWhen: Response              = whenBlock.apply(appliedGiven)
+      validatable.apply(appliedWhen.`then`())
+
+object Given:
+  def apply(givenBlock: RequestSpecification => RequestSpecification): GivenConstructor = GivenConstructor(givenBlock)
+
+def When(whenBlock: RequestSpecification => Response) =
+  def blankGiven(givenBlock: RequestSpecification): RequestSpecification = `given`()
+  Given(blankGiven).When(whenBlock)
diff --git a/integration-tests/src/test/scala/io/quarkiverse/scala/scala3/it/NativeScala3ResourceIT.scala b/integration-tests/src/test/scala/io/quarkiverse/scala/scala3/it/NativeScala3ResourceIT.scala
@@ -0,0 +1,8 @@
+package io.quarkiverse.scala.scala3.it
+
+import io.quarkus.test.junit.QuarkusIntegrationTest
+
+@QuarkusIntegrationTest
+class NativeScala3ResourceIT extends Scala3ResourceTest {
+
+}
diff --git a/integration-tests/src/test/scala/io/quarkiverse/scala/scala3/it/Scala3ResourceTest.scala b/integration-tests/src/test/scala/io/quarkiverse/scala/scala3/it/Scala3ResourceTest.scala
@@ -0,0 +1,58 @@
+package io.quarkiverse.scala.scala3.it
+
+import org.hamcrest.Matchers.is
+import org.junit.jupiter.api.Test
+import io.quarkus.test.junit.QuarkusTest
+import org.hamcrest.Matchers
+
+@QuarkusTest
+class Scala3ResourceTest {
+
+
+
+  @Test
+  def `test Hello Endpoint`(): Unit = {
+    Given {
+      _.params("something", "value")
+    }.When {
+      _.get("/hello").prettyPeek()
+    }.Then {
+      _.statusCode(200).body(is("Hello from Scala 3.4.1"))
+    }
+  }
+
+  @Test
+  def `test future Endpoint`(): Unit = {
+    Given {
+      _.params("something", "value")
+    }.When {
+      _.get("/simple-future").prettyPeek()
+    }.Then {
+      _.statusCode(200).body(is("Hello from a Future in Scala 3.4.1"))
+    }
+  }
+
+  @Test
+  def `test promise Endpoint`(): Unit = {
+    Given {
+      _.params("something", "value")
+    }.When {
+      _.get("/simple-promise").prettyPeek()
+    }.Then {
+      _.statusCode(200).body(is("Promise returned"))
+    }
+  }
+
+  @Test
+  def `future should fail`(): Unit = {
+    Given {
+      _.params("something", "value")
+    }.When {
+      _.get("/future-failure").prettyPeek()
+    }.Then {
+      _.statusCode(500).body(Matchers.containsString("Future failed"))
+    }
+  }
+
+
+}

Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,9 @@ private void ensureNotBlocking(MethodInfo method) {`
`25`	`25`	`}`
`26`	`26`	`}`
`27`	`27`
	`28`	`+ public FutureReturnTypeMethodScanner() {`
	`29`	`+ }`
	`30`	`+`
`28`	`31`	`@Override`
`29`	`32`	`public List<HandlerChainCustomizer> scan(MethodInfo method, ClassInfo actualEndpointClass,`
`30`	`33`	`Map<String, Object> methodContext) {`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ void registerScalaJacksonModule(BuildProducer<ClassPathJacksonModuleBuildItem> c`
`32`	`32`
`33`	`33`	`@BuildStep`
`34`	`34`	`MethodScannerBuildItem enableAsyncMethodsInRestEndpoints() {`
	`35`	`+ System.out.println("Enabling async methods in rest endpoints");`
`35`	`36`	`return new MethodScannerBuildItem(new FutureReturnTypeMethodScanner());`
`36`	`37`	`}`
`37`	`38`	`}`