[ledger-api-test-tool] - Future assertions improvements [KVL-1218] (#…

…12294)

ledger/ledger-api-test-tool/BUILD.bazel

@@ -94,6 +94,7 @@ da_scala_binary(
                 "//ledger/error",
                 "//ledger/ledger-api-common",
                 "//libs-scala/build-info",
+                "//libs-scala/contextualized-logging",
                 "//libs-scala/grpc-utils",
                 "//libs-scala/resources",
                 "//libs-scala/resources-akka",

ledger/ledger-api-test-tool/src/main/scala/com/daml/ledger/api/testtool/LedgerApiTestTool.scala

@@ -3,6 +3,10 @@
 
 package com.daml.ledger.api.testtool
 
+import java.io.File
+import java.nio.file.{Files, Paths, StandardCopyOption}
+import java.util.concurrent.Executors
+
 import com.daml.ledger.api.testtool.infrastructure.Reporter.ColorizedPrintStreamReporter
 import com.daml.ledger.api.testtool.infrastructure.Result.Excluded
 import com.daml.ledger.api.testtool.infrastructure._
@@ -13,9 +17,6 @@ import io.grpc.netty.{NegotiationType, NettyChannelBuilder}
 import org.slf4j.LoggerFactory
 
 import scala.collection.compat._
-import java.io.File
-import java.nio.file.{Files, Paths, StandardCopyOption}
-import java.util.concurrent.Executors
 import scala.concurrent.duration.DurationInt
 import scala.concurrent.{ExecutionContext, Future}
 import scala.util.{Failure, Success}
@@ -179,7 +180,7 @@ object LedgerApiTestTool {
           testsToRun,
         )
 
-    runner.flatMap(_.runTests).onComplete {
+    runner.flatMap(_.runTests(ExecutionContext.global)).onComplete {
       case Success(summaries) =>
         val excludedTestSummaries =
           excludedTests.map { ledgerTestCase =>

ledger/ledger-api-test-tool/src/main/scala/com/daml/ledger/api/testtool/infrastructure/Assertions.scala

@@ -3,6 +3,7 @@
 
 package com.daml.ledger.api.testtool.infrastructure
 
+import java.util
 import java.util.regex.Pattern
 
 import com.daml.error.ErrorCode
@@ -144,9 +145,7 @@ object Assertions {
         errorInfo.getMetadataMap
       }
       .getOrElse {
-        fail(
-          s"The error did not contain a definite answer. Details were: ${details.mkString("[", ", ", "]")}"
-        )
+        new util.HashMap()
       }
   }
 

ledger/ledger-api-test-tool/src/main/scala/com/daml/ledger/api/testtool/infrastructure/FutureAssertions.scala

@@ -3,9 +3,15 @@
 
 package com.daml.ledger.api.testtool.infrastructure
 
+import java.time.Instant
+
 import com.daml.ledger.api.testtool.infrastructure.FutureAssertions.ExpectedFailureException
+import com.daml.logging.{ContextualizedLogger, LoggingContext}
+import com.daml.timer.Delayed
 
+import scala.concurrent.duration._
 import scala.concurrent.{ExecutionContext, Future}
+import scala.util.control.NonFatal
 import scala.util.{Failure, Success}
 
 final class FutureAssertions[T](future: Future[T]) {
@@ -34,13 +40,121 @@ final class FutureAssertions[T](future: Future[T]) {
       case Success(value) => Failure(new ExpectedFailureException(context, value))
       case Failure(other) => Failure(other)
     }
+
 }
 
 object FutureAssertions {
 
+  private val logger = ContextualizedLogger.get(getClass)
+
+  /** Runs the test case after the specified delay
+    */
+  def assertAfter[V](
+      delay: FiniteDuration
+  )(test: => Future[V]): Future[V] =
+    Delayed.Future.by(delay)(test)
+
+  /** Run the test every [[retryDelay]] up to [[maxRetryDuration]].
+    * The test case will run up to [[ceil(maxRetryDuration / retryDelay)]] times.
+    * The assertion will succeed as soon as any of the test case runs are successful.
+    * The assertion will fail if no test case runs are successful and the [[maxRetryDuration]] is exceeded.
+    */
+  def succeedsEventually[V](
+      retryDelay: FiniteDuration = 100.millis,
+      maxRetryDuration: FiniteDuration,
+      description: String,
+  )(
+      test: => Future[V]
+  )(implicit ec: ExecutionContext, loggingContext: LoggingContext): Future[V] = {
+    def internalSucceedsEventually(remainingDuration: FiniteDuration): Future[V] = {
+      val nextRetryRemainingDuration = remainingDuration - retryDelay
+      if (nextRetryRemainingDuration < Duration.Zero) test.andThen { case Failure(exception) =>
+        logger.error(
+          s"Assertion never succeeded after $maxRetryDuration with a delay of $retryDelay. Description: $description",
+          exception,
+        )
+      }
+      else
+        assertAfter(retryDelay)(test).recoverWith { case NonFatal(ex) =>
+          logger.debug(
+            s"Failed assertion: $description. Running again with new max duration $nextRetryRemainingDuration",
+            ex,
+          )
+          internalSucceedsEventually(nextRetryRemainingDuration)
+        }
+    }
+
+    internalSucceedsEventually(maxRetryDuration)
+  }
+
+  /** Run the test every [[rerunDelay]] for a duration of [[succeedDuration]] or until the current time exceeds [[succeedDeadline]].
+    * The assertion will succeed if all of the test case runs are successful and [[succeedDuration]] is exceeded or [[succeedDeadline]] is exceeded.
+    * The assertion will fail if any test case runs fail.
+    */
+  def succeedsUntil[V](
+      rerunDelay: FiniteDuration = 100.millis,
+      succeedDuration: FiniteDuration,
+      succeedDeadline: Option[Instant] = None,
+  )(
+      test: => Future[V]
+  )(implicit ec: ExecutionContext, loggingContext: LoggingContext): Future[V] = {
+    def internalSucceedsUntil(remainingDuration: FiniteDuration): Future[V] = {
+      val nextRerunRemainingDuration = remainingDuration - rerunDelay
+      if (
+        succeedDeadline.exists(
+          _.isBefore(Instant.now().plusSeconds(rerunDelay.toSeconds))
+        ) || nextRerunRemainingDuration < Duration.Zero
+      ) test
+      else
+        assertAfter(rerunDelay)(test)
+          .flatMap { _ =>
+            internalSucceedsUntil(nextRerunRemainingDuration)
+          }
+    }
+
+    internalSucceedsUntil(succeedDuration)
+      .andThen { case Failure(exception) =>
+        logger.error(
+          s"Repeated assertion failed with a succeed duration of $succeedDuration.",
+          exception,
+        )
+      }
+  }
+
+  def forAllParallel[T](
+      data: Seq[T]
+  )(testCase: T => Future[Unit])(implicit ec: ExecutionContext): Future[Seq[Unit]] = Future
+    .traverse(data)(input =>
+      testCase(input).map(Right(_)).recover { case NonFatal(ex) =>
+        Left(input -> ex)
+      }
+    )
+    .map { results =>
+      val (failures, successes) = results.partitionMap(identity)
+      if (failures.nonEmpty)
+        throw ParallelTestFailureException(
+          s"Failed parallel test case. Failures: ${failures.length}. Success: ${successes.length}\nFailed inputs: ${failures
+            .map(_._1)
+            .mkString("[", ",", "]")}",
+          failures.last._2,
+        )
+      else successes
+    }
+
+  def optionalAssertion(runs: Boolean, description: String)(
+      assertions: => Future[_]
+  )(implicit loggingContext: LoggingContext): Future[_] = if (runs) assertions
+  else {
+    logger.warn(s"Not running optional assertions: $description")
+    Future.unit
+  }
+
   final class ExpectedFailureException[T](context: String, value: T)
       extends NoSuchElementException(
         s"Expected a failure when $context, but got a successful result of: $value"
       )
 
 }
+
+final case class ParallelTestFailureException(message: String, failure: Throwable)
+    extends RuntimeException(message, failure)

ledger/ledger-api-test-tool/src/main/scala/com/daml/ledger/api/testtool/infrastructure/LedgerTestCasesRunner.scala

@@ -231,12 +231,12 @@ final class LedgerTestCasesRunner(
               ledgerSession,
               concurrentTestCases,
               concurrentTestRuns,
-            )(materializer, materializer.executionContext)
+            )(materializer, executionContext)
             sequentialTestResults <- runTestCases(
               ledgerSession,
               sequentialTestCases,
               concurrency = 1,
-            )(materializer, materializer.executionContext)
+            )(materializer, executionContext)
           } yield concurrentTestResults ++ sequentialTestResults ++ excludedTestResults
 
         testResults.recover {
@@ -259,7 +259,7 @@ final class LedgerTestCasesRunner(
     val results =
       for {
         materializer <- materializerResources.asFuture
-        results <- run(participants)(materializer, materializer.executionContext)
+        results <- run(participants)(materializer, executionContext)
       } yield results
 
     results.onComplete(_ => materializerResources.release())