feat(sbt-plugin): add generateUnmanagedTest

Author: patriknw

codegen/scala-gen/src/main/scala/com/akkaserverless/codegen/scalasdk/AkkaserverlessUnmanagedTestGenerator.scala

@@ -0,0 +1,57 @@
+/*
+ * Copyright 2021 Lightbend Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.akkaserverless.codegen.scalasdk
+
+import com.akkaserverless.Annotations
+import com.akkaserverless.codegen.scalasdk.impl.SourceGenerator
+import com.google.protobuf.ExtensionRegistry
+import com.google.protobuf.compiler.PluginProtos.CodeGeneratorResponse
+import com.lightbend.akkasls.codegen.ModelBuilder
+import protocbridge.Artifact
+import protocgen.CodeGenApp
+import protocgen.CodeGenRequest
+import protocgen.CodeGenResponse
+
+object AkkaserverlessUnmanagedTestGenerator extends CodeGenApp {
+  override def registerExtensions(registry: ExtensionRegistry): Unit = {
+    Annotations.registerAllExtensions(registry)
+  }
+
+  override def process(request: CodeGenRequest): CodeGenResponse = {
+    val debugEnabled = request.parameter.contains(AkkaserverlessGenerator.enableDebug)
+    val model = ModelBuilder.introspectProtobufClasses(request.filesToGenerate)(
+      DebugPrintlnLog(debugEnabled),
+      FullyQualifiedNameExtractor(request))
+    try {
+      CodeGenResponse.succeed(
+        SourceGenerator
+          .generateUnmanagedTest(model)
+          .map(file =>
+            CodeGeneratorResponse.File
+              .newBuilder()
+              .setName(file.name)
+              .setContent(file.content)
+              .build()))
+    } catch {
+      case t: Throwable =>
+        t.printStackTrace()
+        CodeGenResponse.fail(t.getMessage)
+    }
+  }
+
+  override def suggestedDependencies: Seq[Artifact] = Nil
+}

codegen/scala-gen/src/main/scala/com/akkaserverless/codegen/scalasdk/genUnmanagedTest.scala

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2021 Lightbend Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.akkaserverless.codegen.scalasdk
+
+import protocbridge.SandboxedJvmGenerator
+
+object genUnmanagedTest {
+  def apply(options: Seq[String] = Seq.empty): (SandboxedJvmGenerator, Seq[String]) =
+    gen(options, "com.akkaserverless.codegen.scalasdk.AkkaserverlessUnmanagedTestGenerator$")
+}

samples/scala-value-entity-customer-registry/build.sbt

@@ -29,8 +29,8 @@ Test / logBuffered := false
 run / fork := false
 Global / cancelable := false // ctrl-c
 
-// FIXME include these dependencies via the AkkaserverlessPlugin
 val AkkaServerlessSdkVersion = System.getProperty("akkaserverless-sdk.version", "0.7.2")
 libraryDependencies ++= Seq(
   "org.scalatest" %% "scalatest" % "3.2.7" % Test,
+  // FIXME include testkit dependency via the AkkaserverlessPlugin
   "com.akkaserverless" %% "akkaserverless-scala-sdk-testkit" % AkkaServerlessSdkVersion % Test)

sbt-plugin/src/main/scala/com/akkaserverless/sbt/AkkaserverlessPlugin.scala

@@ -23,7 +23,7 @@ import akka.grpc.sbt.AkkaGrpcPlugin.autoImport.AkkaGrpc
 import java.nio.file.Path
 import java.nio.file.Paths
 import java.nio.file.Files
-import com.akkaserverless.codegen.scalasdk.{ gen, genTests, genUnmanaged, AkkaserverlessGenerator }
+import com.akkaserverless.codegen.scalasdk.{ gen, genTests, genUnmanaged, genUnmanagedTest, AkkaserverlessGenerator }
 import sbt.{ Compile, _ }
 import sbt.Keys._
 import sbtprotoc.ProtocPlugin
@@ -40,6 +40,7 @@ object AkkaserverlessPlugin extends AutoPlugin {
       "These are the source files that are placed in the source tree, and after initial generation should typically be maintained by the user.\n" +
       "Files that already exist they are not re-generated.")
     val temporaryUnmanagedDirectory = settingKey[File]("Directory to generate 'unmanaged' sources into")
+    val temporaryUnmanagedTestDirectory = settingKey[File]("Directory to generate 'unmanaged' test sources into")
   }
   object autoImport extends Keys
   import autoImport._
@@ -52,12 +53,15 @@ object AkkaserverlessPlugin extends AutoPlugin {
       gen(
         akkaGrpcCodeGeneratorSettings.value :+ AkkaserverlessGenerator.enableDebug) -> (Compile / sourceManaged).value / "akkaserverless",
     Compile / temporaryUnmanagedDirectory := (Compile / baseDirectory).value / "target" / "akkaserverless-unmanaged",
+    Test / temporaryUnmanagedTestDirectory := (Test / baseDirectory).value / "target" / "akkaserverless-unmanaged-test",
     // FIXME there is a name clash between the Akka gRPC server-side service 'handler'
     // and the Akka Serverless 'handler'. For now working around it by only generating
     // the client, but we should probably resolve this before the first public release.
     Compile / akkaGrpcGeneratedSources := Seq(AkkaGrpc.Client),
     Compile / PB.targets ++= Seq(genUnmanaged(
       akkaGrpcCodeGeneratorSettings.value :+ AkkaserverlessGenerator.enableDebug) -> (Compile / temporaryUnmanagedDirectory).value),
+    Test / PB.targets ++= Seq(genUnmanagedTest(
+      akkaGrpcCodeGeneratorSettings.value :+ AkkaserverlessGenerator.enableDebug) -> (Test / temporaryUnmanagedTestDirectory).value),
     Test / PB.protoSources ++= (Compile / PB.protoSources).value,
     Test / PB.targets +=
       genTests(
@@ -71,10 +75,23 @@ object AkkaserverlessPlugin extends AutoPlugin {
         Paths.get((Compile / temporaryUnmanagedDirectory).value.toURI),
         Paths.get((Compile / sourceDirectory).value.toURI).resolve("scala"))
     },
+    Test / generateUnmanaged := {
+      Files.createDirectories(Paths.get((Test / temporaryUnmanagedTestDirectory).value.toURI))
+      // Make sure generation has happened
+      val _ = (Test / PB.generate).value
+      // Then copy over any new generated unmanaged sources
+      copyIfNotExist(
+        Paths.get((Test / temporaryUnmanagedTestDirectory).value.toURI),
+        Paths.get((Test / sourceDirectory).value.toURI).resolve("scala"))
+    },
     Compile / managedSources :=
       (Compile / managedSources).value.filter(s => !isIn(s, (Compile / temporaryUnmanagedDirectory).value)),
     Compile / unmanagedSources :=
-      (Compile / generateUnmanaged).value ++ (Compile / unmanagedSources).value)
+      (Compile / generateUnmanaged).value ++ (Compile / unmanagedSources).value,
+    Test / managedSources :=
+      (Test / managedSources).value.filter(s => !isIn(s, (Test / temporaryUnmanagedTestDirectory).value)),
+    Test / unmanagedSources :=
+      (Test / generateUnmanaged).value ++ (Test / unmanagedSources).value)
 
   def isIn(file: File, dir: File): Boolean =
     Paths.get(file.toURI).startsWith(Paths.get(dir.toURI))

sbt-plugin/src/sbt-test/sbt-akkaserverless/basic/build.sbt

@@ -1,3 +1,9 @@
 scalaVersion := "2.13.6"
 
 enablePlugins(AkkaserverlessPlugin)
+
+val AkkaServerlessSdkVersion = System.getProperty("plugin.version", "0.7.2")
+libraryDependencies ++= Seq(
+  "org.scalatest" %% "scalatest" % "3.2.7" % Test,
+  // FIXME include testkit dependency via the AkkaserverlessPlugin
+  "com.akkaserverless" %% "akkaserverless-scala-sdk-testkit" % AkkaServerlessSdkVersion % Test)

sbt-plugin/src/sbt-test/sbt-akkaserverless/basic/test

@@ -66,3 +66,8 @@ $ exists src/main/scala/com/example/valueentity/domain/User.scala
 $ exists target/scala-2.13/src_managed/main/akkaserverless/com/example/valueentity/domain/AbstractUser.scala
 
 > Test/compile
+
+# com/example/valueentity/some_value_entity_api.proto
+# com/example/valueentity/domain/some_value_entity_domain.proto
+$ exists src/test/scala/com/example/valueentity/domain/SomeValueEntitySpec.scala
+$ exists target/scala-2.13/src_managed/test/akkaserverless/com/example/valueentity/domain/SomeValueEntityTestKit.scala