com.sageserpent.americium.java.TrialsFactoring.scala Maven / Gradle / Ivy

Go to download
package com.sageserpent.americium.java

trait TrialsFactoring[+Case] {
  // Scala and Java API ...

  /** Reproduce a specific case in a repeatable fashion, based on a recipe.
    *
    * @param recipe
    *   This encodes a specific case and will only be understood by the same
    *   *value* of trials instance that was used to obtain it.
    * @return
    *   The specific {@code Case} denoted by the recipe.
    * @throws RuntimeException
    *   if the recipe does not correspond to the receiver, either due to it
    *   being created by a different flavour of trials instance or subsequent
    *   code changes.
    */
  def reproduce(recipe: String): Case

  abstract class TrialException(cause: Throwable)
      extends RuntimeException(cause) {
    override def toString: String =
      s"Trial exception with underlying cause:\n$getCause\nProvoked by test case:\n$provokingCase\n\nReproduce via Java property:\ntrials.recipeHash=$recipeHash\n\n... or via Java property:\ntrials.recipe=\"$escapedRecipe\"\n\n... or via `withRecipe` using recipe:\n$recipe"

    /** @return
      *   The {@code Case} that provoked the exception.
      */
    def provokingCase: Case

    /** @return
      *   A recipe that can be used to reproduce the provoking {@code Case} when
      *   supplied to the corresponding trials instance.
      */
    def recipe: String

    def escapedRecipe: String

    def recipeHash: String
  }
}