[pekko-testkit-typed] Support for Junit5

actor-testkit-typed/src/main/scala/org/apache/pekko/actor/testkit/typed/javadsl/Junit5TestKit.java

@@ -0,0 +1,21 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * license agreements; and to You under the Apache License, version 2.0:
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * This file is part of the Apache Pekko project, which was derived from Akka.
+ */
+
+package org.apache.pekko.actor.testkit.typed.javadsl;
+
+
+import java.lang.annotation.*;
+
+@Documented
+@Target(ElementType.FIELD)
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Junit5TestKit {
+}
+
+

actor-testkit-typed/src/main/scala/org/apache/pekko/actor/testkit/typed/javadsl/Junit5TestKitBuilder.scala

@@ -0,0 +1,47 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * license agreements; and to You under the Apache License, version 2.0:
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * This file is part of the Apache Pekko project, which was derived from Akka.
+ */
+
+package org.apache.pekko.actor.testkit.typed.javadsl
+
+import com.typesafe.config.Config
+import org.apache.pekko.actor.testkit.typed.internal.TestKitUtils
+import org.apache.pekko.actor.testkit.typed.scaladsl.ActorTestKit.ApplicationTestConfig
+import org.apache.pekko.actor.typed.ActorSystem
+
+case class Junit5TestKitBuilder() {
+
+ var system: Option[ActorSystem[_]] = None
+
+ var customConfig: Config = ApplicationTestConfig
+
+ var name: String = TestKitUtils.testNameFromCallStack(classOf[Junit5TestKitBuilder])
+
+ def withSystem(system: ActorSystem[_]): Junit5TestKitBuilder = {
+ this.system = Some(system)
+ this
+ }
+
+ def withCustomConfig(customConfig: Config): Junit5TestKitBuilder = {
+ this.customConfig = customConfig
+ this
+ }
+
+ def withName(name: String): Junit5TestKitBuilder = {
+ this.name = name
+ this
+ }
+
+ def build(): ActorTestKit = {
+ if (system.isDefined) {
+ return ActorTestKit.create(system.get)
+ }
+ ActorTestKit.create(name, customConfig)
+ }
+
+}

actor-testkit-typed/src/main/scala/org/apache/pekko/actor/testkit/typed/javadsl/LogCapturingExtension.scala

@@ -0,0 +1,53 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * license agreements; and to You under the Apache License, version 2.0:
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * This file is part of the Apache Pekko project, which was derived from Akka.
+ */
+
+package org.apache.pekko.actor.testkit.typed.javadsl
+
+import org.junit.jupiter.api.extension.InvocationInterceptor.Invocation
+import org.junit.jupiter.api.extension.{ ExtensionContext, InvocationInterceptor, ReflectiveInvocationContext }
+import org.slf4j.LoggerFactory
+import org.apache.pekko.actor.testkit.typed.internal.CapturingAppender
+
+import java.lang.reflect.Method
+import scala.util.control.NonFatal
+
+final class LogCapturingExtension extends InvocationInterceptor {
+
+ private val capturingAppender = CapturingAppender.get("")
+
+ private val myLogger = LoggerFactory.getLogger(classOf[LogCapturing])
+
+ @throws[Throwable]
+ override def interceptTestMethod(invocation: Invocation[Void], invocationContext: ReflectiveInvocationContext[Method],
+ extensionContext: ExtensionContext): Unit = {
+
+ val testClassName = invocationContext.getTargetClass.getSimpleName
+ val testMethodName = invocationContext.getExecutable.getName
+
+ try {
+ myLogger.info(s"Logging started for test [${testClassName}: ${testMethodName}]")
+ invocation.proceed
+ myLogger.info(
+ s"Logging finished for test [${testClassName}: ${testMethodName}] that was successful")
+ } catch {
+ case NonFatal(e) =>
+ println(
+ s"--> [${Console.BLUE}${testClassName}: ${testMethodName}${Console.RESET}] " +
+ s"Start of log messages of test that failed with ${e.getMessage}")
+ capturingAppender.flush()
+ println(
+ s"<-- [${Console.BLUE}${testClassName}: ${testMethodName}${Console.RESET}] " +
+ s"End of log messages of test that failed with ${e.getMessage}")
+ throw e
+ } finally {
+
+ capturingAppender.clear()
+ }
+ }
+}

actor-testkit-typed/src/main/scala/org/apache/pekko/actor/testkit/typed/javadsl/TestKitJunit5Extension.scala

@@ -0,0 +1,44 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * license agreements; and to You under the Apache License, version 2.0:
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * This file is part of the Apache Pekko project, which was derived from Akka.
+ */
+
+package org.apache.pekko.actor.testkit.typed.javadsl
+
+import org.junit.jupiter.api.extension.{ AfterAllCallback, BeforeTestExecutionCallback, ExtensionContext }
+import org.junit.platform.commons.support.AnnotationSupport
+import org.apache.pekko
+import pekko.util.ccompat.JavaConverters.CollectionHasAsScala
+
+final class TestKitJunit5Extension() extends AfterAllCallback with BeforeTestExecutionCallback {
+
+ var testKit: Option[ActorTestKit] = None
+
+ /**
+ * Get a reference to the field annotated with @Junit5Testkit [[pekko.actor.testkit.typed.javadsl.Junit5TestKit]]
+ */
+ override def beforeTestExecution(context: ExtensionContext): Unit = {
+
+ context.getTestInstance.ifPresent((instance: AnyRef) => {
+ val annotations = AnnotationSupport.findAnnotatedFieldValues(instance, classOf[Junit5TestKit])
+ if (annotations.isEmpty) {
+ throw new IllegalArgumentException("Could not find field annotated with @Junit5TestKit")
+ } else {
+ val fieldValue = annotations.asScala.toList.head
+ testKit = Some(fieldValue.asInstanceOf[ActorTestKit])
+ }
+ })
+ }
+
+ /**
+ * Shutdown testKit
+ */
+ override def afterAll(context: ExtensionContext): Unit = {
+ testKit.get.shutdownTestKit()
+ }
+
+}

actor-testkit-typed/src/test/java/jdocs/org/apache/pekko/actor/testkit/typed/javadsl/GreeterMain.scala

@@ -0,0 +1,61 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * license agreements; and to You under the Apache License, version 2.0:
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * This file is part of the Apache Pekko project, which was derived from Akka.
+ */
+
+package jdocs.org.apache.pekko.actor.testkit.typed.javadsl
+
+import org.apache.pekko.actor.typed.{ ActorRef, Behavior }
+import org.apache.pekko.actor.typed.scaladsl.Behaviors
+
+object Greeter {
+ final case class Greet(whom: String, replyTo: ActorRef[Greeted])
+ final case class Greeted(whom: String, from: ActorRef[Greet])
+
+ def apply(): Behavior[Greet] = Behaviors.receive { (context, message) =>
+ context.log.info("Hello {}!", message.whom)
+ // #greeter-send-messages
+ message.replyTo ! Greeted(message.whom, context.self)
+ // #greeter-send-messages
+ Behaviors.same
+ }
+}
+
+object GreeterBot {
+
+ def apply(max: Int): Behavior[Greeter.Greeted] = {
+ bot(0, max)
+ }
+
+ private def bot(greetingCounter: Int, max: Int): Behavior[Greeter.Greeted] =
+ Behaviors.receive { (context, message) =>
+ val n = greetingCounter + 1
+ context.log.info("Greeting {} for {}", n, message.whom)
+ if (n == max) {
+ Behaviors.stopped
+ } else {
+ message.from ! Greeter.Greet(message.whom, context.self)
+ bot(n, max)
+ }
+ }
+}
+
+object GreeterMain {
+
+ final case class SayHello(name: String)
+
+ def apply(): Behavior[SayHello] =
+ Behaviors.setup { context =>
+ val greeter = context.spawn(Greeter(), "greeter")
+
+ Behaviors.receiveMessage { message =>
+ val replyTo = context.spawn(GreeterBot(max = 3), message.name)
+ greeter ! Greeter.Greet(message.name, replyTo)
+ Behaviors.same
+ }
+ }
+}

actor-testkit-typed/src/test/java/jdocs/org/apache/pekko/actor/testkit/typed/javadsl/Junit5IntegrationExampleTest.java

@@ -0,0 +1,61 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * license agreements; and to You under the Apache License, version 2.0:
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * This file is part of the Apache Pekko project, which was derived from Akka.
+ */
+
+// test code copied from JunitIntegrationTest.java
+
+package jdocs.org.apache.pekko.actor.testkit.typed.javadsl;
+
+import org.apache.pekko.actor.Address;
+import org.apache.pekko.actor.testkit.typed.javadsl.*;
+import org.apache.pekko.actor.testkit.typed.javadsl.Junit5TestKitBuilder;
+import org.apache.pekko.actor.typed.ActorRef;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertNotNull;
+
+// #junit5-integration
+@DisplayName("Junit5")
+@ExtendWith(TestKitJunit5Extension.class)
+class Junit5IntegrationExampleTest {
+
+ @Junit5TestKit public ActorTestKit testKit = new Junit5TestKitBuilder().build();
+
+ @Test
+ void junit5Test() {
+ Address address = testKit.system().address();
+ assertNotNull(address);
+ }
+
+ @Test
+ void testSomething() {
+
+ ActorRef<AsyncTestingExampleTest.Echo.Ping> pinger =
+ testKit.spawn(AsyncTestingExampleTest.Echo.create(), "ping");
+ TestProbe<AsyncTestingExampleTest.Echo.Pong> probe = testKit.createTestProbe();
+ pinger.tell(new AsyncTestingExampleTest.Echo.Ping("hello", probe.ref()));
+ AsyncTestingExampleTest.Echo.Pong pong =
+ probe.expectMessage(new AsyncTestingExampleTest.Echo.Pong("hello"));
+ assertEquals("hello", pong.message);
+ }
+
+ @Test
+ void testSomething2() {
+ ActorRef<AsyncTestingExampleTest.Echo.Ping> pinger2 =
+ testKit.spawn(AsyncTestingExampleTest.Echo.create(), "ping2");
+ TestProbe<AsyncTestingExampleTest.Echo.Pong> probe2 = testKit.createTestProbe();
+ pinger2.tell(new AsyncTestingExampleTest.Echo.Ping("hello", probe2.ref()));
+ AsyncTestingExampleTest.Echo.Pong pong =
+ probe2.expectMessage(new AsyncTestingExampleTest.Echo.Pong("hello"));
+ assertEquals("hello", pong.message);
+ }
+}
+// #junit5-integration

actor-testkit-typed/src/test/java/jdocs/org/apache/pekko/actor/testkit/typed/javadsl/LogCapturingExtensionExampleTest.java

@@ -0,0 +1,48 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * license agreements; and to You under the Apache License, version 2.0:
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * This file is part of the Apache Pekko project, which was derived from Akka.
+ */
+
+package jdocs.org.apache.pekko.actor.testkit.typed.javadsl;
+
+// #log-capturing-junit5
+
+import org.apache.pekko.actor.testkit.typed.javadsl.*;
+import org.apache.pekko.actor.testkit.typed.javadsl.Junit5TestKitBuilder;
+import org.apache.pekko.actor.typed.ActorRef;
+import org.junit.jupiter.api.DisplayName;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+
+import static jdocs.org.apache.pekko.actor.testkit.typed.javadsl.AsyncTestingExampleTest.Echo;
+
+// test code copied from LogCapturingExampleTest.java
+
+@DisplayName("Junit5 log capturing")
+@ExtendWith(TestKitJunit5Extension.class)
+@ExtendWith(LogCapturingExtension.class)
+class LogCapturingExtensionExampleTest {
+
+ @Junit5TestKit public ActorTestKit testKit = new Junit5TestKitBuilder().build();
+
+ @Test
+ void testSomething() {
+ ActorRef<Echo.Ping> pinger = testKit.spawn(Echo.create(), "ping");
+ TestProbe<Echo.Pong> probe = testKit.createTestProbe();
+ pinger.tell(new Echo.Ping("hello", probe.ref()));
+ probe.expectMessage(new Echo.Pong("hello"));
+ }
+
+ @Test
+ void testSomething2() {
+ ActorRef<Echo.Ping> pinger = testKit.spawn(Echo.create(), "ping");
+ TestProbe<Echo.Pong> probe = testKit.createTestProbe();
+ pinger.tell(new Echo.Ping("hello", probe.ref()));
+ probe.expectMessage(new Echo.Pong("hello"));
+ }
+}
+// #log-capturing-junit5