feat: Support ignore in action result testkit API (#1354)

Author: johanandren

sdk/java-sdk-testkit/src/main/java/kalix/javasdk/testkit/ActionResult.java

@@ -57,6 +57,9 @@ public interface ActionResult<T> {
    */
   CompletionStage<ActionResult<T>> getAsyncResult();
 
+  /** @return true if the returned effect was ignore, false if not */
+  boolean isIgnore();
+
   /** @return true if the call was an error, false if not */
   boolean isError();
 

sdk/java-sdk-testkit/src/main/scala/kalix/javasdk/testkit/impl/ActionResultImpl.scala

@@ -50,22 +50,22 @@ final class ActionResultImpl[T](effect: ActionEffectImpl.PrimaryEffect[T]) exten
 
   def this(effect: Action.Effect[T]) = this(effect.asInstanceOf[ActionEffectImpl.PrimaryEffect[T]])
 
-  implicit val ec = ExecutionContext.Implicits.global
+  private implicit val ec = ExecutionContext.Implicits.global
 
   /** @return true if the call had an effect with a reply, false if not */
-  def isReply(): Boolean = effect.isInstanceOf[ActionEffectImpl.ReplyEffect[T]]
+  override def isReply(): Boolean = effect.isInstanceOf[ActionEffectImpl.ReplyEffect[T]]
 
-  def getReply(): T = {
+  override def getReply(): T = {
     val reply = getEffectOfType(classOf[ActionEffectImpl.ReplyEffect[T]])
     reply.msg
   }
 
   //TODO add metadata??
 
   /** @return true if the call was forwarded, false if not */
-  def isForward(): Boolean = effect.isInstanceOf[ActionEffectImpl.ForwardEffect[T]]
+  override def isForward(): Boolean = effect.isInstanceOf[ActionEffectImpl.ForwardEffect[T]]
 
-  def getForward(): DeferredCallDetails[Any, T] =
+  override def getForward(): DeferredCallDetails[Any, T] =
     effect match {
       case ActionEffectImpl.ForwardEffect(serviceCall: GrpcDeferredCall[Any @unchecked, T @unchecked], _) =>
         TestKitDeferredCall(serviceCall)
@@ -76,22 +76,24 @@ final class ActionResultImpl[T](effect: ActionEffectImpl.PrimaryEffect[T]) exten
 
   // TODO rewrite
   /** @return true if the call was async, false if not */
-  def isAsync(): Boolean = effect.isInstanceOf[ActionEffectImpl.AsyncEffect[T]]
+  override def isAsync(): Boolean = effect.isInstanceOf[ActionEffectImpl.AsyncEffect[T]]
 
-  def getAsyncResult(): CompletionStage[ActionResult[T]] = {
+  override def getAsyncResult(): CompletionStage[ActionResult[T]] = {
     val async = getEffectOfType(classOf[ActionEffectImpl.AsyncEffect[T]])
     async.effect.map(new ActionResultImpl(_).asInstanceOf[ActionResult[T]]).toJava
   }
 
   /** @return true if the call was an error, false if not */
-  def isError(): Boolean = effect.isInstanceOf[ActionEffectImpl.ErrorEffect[T]]
+  override def isError(): Boolean = effect.isInstanceOf[ActionEffectImpl.ErrorEffect[T]]
 
-  def getError(): String = {
+  override def getError(): String = {
     val error = getEffectOfType(classOf[ActionEffectImpl.ErrorEffect[T]])
     error.description
   }
 
-  def getErrorStatusCode(): Status.Code = {
+  override def isIgnore(): Boolean = effect == ActionEffectImpl.IgnoreEffect()
+
+  override def getErrorStatusCode(): Status.Code = {
     val error = getEffectOfType(classOf[ActionEffectImpl.ErrorEffect[T]])
     error.statusCode.getOrElse(Status.Code.UNKNOWN)
   }
@@ -109,7 +111,7 @@ final class ActionResultImpl[T](effect: ActionEffectImpl.PrimaryEffect[T]) exten
         "expected effect type [" + expectedClass.getName + "] but found [" + effect.getClass.getName + "]")
   }
 
-  def getSideEffects(): JList[DeferredCallDetails[_, _]] =
+  override def getSideEffects(): JList[DeferredCallDetails[_, _]] =
     toDeferredCallDetails(effect.internalSideEffects())
 
 }

sdk/scala-sdk-testkit/src/main/scala/kalix/scalasdk/testkit/ActionResult.scala

@@ -57,6 +57,9 @@ trait ActionResult[T] {
    */
   def asyncResult: Future[ActionResult[T]]
 
+  /** @return true if the returned effect was ignore, false if not */
+  def isIgnore: Boolean
+
   /** @return true if the call was an error, false if not */
   def isError: Boolean
 

sdk/scala-sdk-testkit/src/main/scala/kalix/scalasdk/testkit/impl/ActionResultImpl.scala

@@ -72,6 +72,8 @@ final class ActionResultImpl[T](val effect: ActionEffectImpl.PrimaryEffect[T]) e
 
   override def isError: Boolean = effect.isInstanceOf[ActionEffectImpl.ErrorEffect[_]]
 
+  override def isIgnore: Boolean = effect == ActionEffectImpl.IgnoreEffect()
+
   override def errorDescription: String = effect match {
     case e: ActionEffectImpl.ErrorEffect[_] => e.description
     case _ => throw new IllegalStateException(s"The effect was not an error but [$effectName]")