americium/com.sageserpent.americium/Trials

Trials

trait Trials[+Case] extends TrialsScaffolding[Case]
Companion:
object
trait TrialsScaffolding[Case]
trait TrialsFactoring[Case]
class Object
trait Matchable
class Any

Type members

Inherited classlikes

abstract class TrialException(cause: Throwable) extends RuntimeException
Inherited from:
TrialsFactoring

Types

override type SupplySyntaxType <: SupplyToSyntax[Case]

Value members

Abstract methods

def and[Case2](secondTrials: Trials[Case2]): Tuple2Trials[Case, Case2]

Fluent syntax to allow trials to be combined prior to calling TrialsScaffolding.withLimit etc. This grants the user the choice of either supplying the combined trials in the usual way, in which case the Function will take a Tuple2 parameterised by types Case and Case2, or a Function2 can be used taking separate arguments of types [[Case]] and [[Case2]].

Fluent syntax to allow trials to be combined prior to calling TrialsScaffolding.withLimit etc. This grants the user the choice of either supplying the combined trials in the usual way, in which case the Function will take a Tuple2 parameterised by types Case and Case2, or a Function2 can be used taking separate arguments of types [[Case]] and [[Case2]].

This can be repeated up to a limit by calling and on the results to add more trials - this enables supply to consumers of higher argument arity.

Returns:

Syntax object that permits the test code to consume either a pair or two separate arguments.

def filter(predicate: Case => Boolean): Trials[Case]
def flatMap[TransformedCase](step: Case => Trials[TransformedCase]): Trials[TransformedCase]
def javaTrials[CovarianceFudge >: Case]: Trials[CovarianceFudge]

This is mostly just for implementation purposes, as the Java incarnation com.sageserpent.americium.java.Trials is effectively a wrapper around the Scala incarnation Trials. However, if you want to pull cases via an iterator, this is handy as currently the iterator access is via the Java incarnation.

This is mostly just for implementation purposes, as the Java incarnation com.sageserpent.americium.java.Trials is effectively a wrapper around the Scala incarnation Trials. However, if you want to pull cases via an iterator, this is handy as currently the iterator access is via the Java incarnation.

Returns:

The Java incarnation com.sageserpent.americium.java.Trials of this instance

def lists: Trials[List[Case]]
def listsOfSize(size: Int): Trials[List[Case]]
def lotsOfSize[Collection](size: Int)(implicit factory: Factory[Case, Collection]): Trials[Collection]

Transform this to a trials of collection, where Collection is some kind of collection that can be built from elements of type Case by a Factory. The collection instances yielded by the result are all built from the specified number of elements.

Transform this to a trials of collection, where Collection is some kind of collection that can be built from elements of type Case by a Factory. The collection instances yielded by the result are all built from the specified number of elements.

Type parameters:
Collection

Any kind of collection that can take an arbitrary number of elements of type Case.

Value parameters:
factory

A Factory that can build a Collection.

size

The number of elements of type Case to build the collection instance from. Be aware that sets, maps and bounded size collections don't have to accept that many elements.

Returns:

A [[Trials]] instance that yields Collection instances.

def map[TransformedCase](transform: Case => TransformedCase): Trials[TransformedCase]
def mapFilter[TransformedCase](filteringTransform: Case => Option[TransformedCase]): Trials[TransformedCase]
def maps[CovarianceFudge >: Case, Value](values: Trials[Value]): Trials[Map[CovarianceFudge, Value]]
def options: Trials[Option[Case]]
Returns:

A lifted trials that wraps the underlying cases from this in an Option; the resulting trials also supplies a special case of Option.empty.

def or[Case2](alternativeTrials: Trials[Case2]): Trials[Either[Case, Case2]]

Fluent syntax to allow trials of dissimilar types to be supplied as alternatives to the same test. In contrast to the TrialsApi.alternate, the alternatives do not have to conform to the same type; instead here we can switch in the test between unrelated types using an Either instance to hold cases supplied from either this trials instance or from alternativeTrials.

Fluent syntax to allow trials of dissimilar types to be supplied as alternatives to the same test. In contrast to the TrialsApi.alternate, the alternatives do not have to conform to the same type; instead here we can switch in the test between unrelated types using an Either instance to hold cases supplied from either this trials instance or from alternativeTrials.

Returns:

[[Either]] that is populated with either a Case or with a Case2.

def sets[CovarianceFudge >: Case]: Trials[Set[CovarianceFudge]]
def several[Collection](implicit factory: Factory[Case, Collection]): Trials[Collection]

Transform this to a trials of collection, where Collection is some kind of collection that can be built from elements of type Case by a Factory.

Transform this to a trials of collection, where Collection is some kind of collection that can be built from elements of type Case by a Factory.

Type parameters:
Collection

Any kind of collection that can take an arbitrary number of elements of type Case.

Value parameters:
factory

A Factory that can build a Collection.

Returns:

A Trials instance that yields Collection instances.

def sortedMaps[CovarianceFudge >: Case, Value](values: Trials[Value])(implicit ordering: Ordering[CovarianceFudge]): Trials[SortedMap[CovarianceFudge, Value]]
def sortedSets[CovarianceFudge >: Case](implicit ordering: Ordering[CovarianceFudge]): Trials[SortedSet[CovarianceFudge]]

Concrete methods

def strings: Trials[String]
Implicitly added by CharacterTrialsSyntax
def stringsOfSize(size: Int): Trials[String]
Implicitly added by CharacterTrialsSyntax
def withFilter(predicate: Case => Boolean): Trials[Case]

Inherited methods

def reproduce(recipe: String): Case

Reproduce a specific case in a repeatable fashion, based on a recipe.

Reproduce a specific case in a repeatable fashion, based on a recipe.

Value parameters:
recipe

This encodes a specific case and will only be understood by the same value of trials instance that was used to obtain it.

Returns:

The specific 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.

Inherited from:
TrialsFactoring
def trials: Trials[Case]

Use this to lose any specialised supply syntax and go back to the regular Trials API. The motivation for this is when the and combinator is used to glue together several trials instances, but we want to treat the result as a plain trials of tuples, rather than calling Trials.withLimits etc there and then.

Use this to lose any specialised supply syntax and go back to the regular Trials API. The motivation for this is when the and combinator is used to glue together several trials instances, but we want to treat the result as a plain trials of tuples, rather than calling Trials.withLimits etc there and then.

Returns:

The equivalent Trials instance.

Inherited from:
TrialsScaffolding
def withLimit(limit: Int): SupplySyntaxType

Fluent syntax for configuring a limit to the number of cases supplied to a consumer.

Fluent syntax for configuring a limit to the number of cases supplied to a consumer.

Value parameters:
limit

The maximum number of cases that can be supplied - note that this is no guarantee that so many cases will be supplied, it is simply a limit.

Returns:

An instance of SupplyToSyntax with the limit configured.

Inherited from:
TrialsScaffolding
def withStrategy(casesLimitStrategyFactory: CaseSupplyCycle => CasesLimitStrategy, complexityLimit: Int, shrinkageAttemptsLimit: Int, shrinkageStop: () => Case): SupplySyntaxType

Fluent syntax for configuring a limit strategy for the number of cases supplied to a consumer.

Fluent syntax for configuring a limit strategy for the number of cases supplied to a consumer.

Value parameters:
casesLimitStrategyFactory

A factory method that should produce a fresh instance of a CasesLimitStrategy on each call.

Returns:

An instance of SupplyToSyntax with the strategy configured.

Note:

The factory casesLimitStrategyFactory takes an argument of CaseSupplyCycle; this can be used to dynamically configure the strategy depending on which cycle the strategy is intended for, or simply disregarded if a one-size-fits-all approach is desired.

Inherited from:
TrialsScaffolding

Deprecated and Inherited methods

@deprecated("Use `withLimit` followed by calls to `withComplexityLimit`, `withShrinkageAttemptsLimit` and `withShrinkageStop`.")
def withLimits(casesLimit: Int, complexityLimit: Int, shrinkageAttemptsLimit: Int, shrinkageStop: () => Case): SupplySyntaxType
Deprecated
Inherited from:
TrialsScaffolding
@deprecated("Use the JVM system property JavaPropertyNames.recipeHashJavaProperty() - `trials.recipeHash` instead to force existing tests written using `withLimit` or `withStrategy` to pick up the recipe. This has the advantage of being a temporary measure for debugging that doesn\'t require test code changes.")
def withRecipe(recipe: String): SupplySyntaxType
Deprecated
Inherited from:
TrialsScaffolding

Concrete fields

val characterTrials: Trials[Char]
Implicitly added by CharacterTrialsSyntax

Inherited fields

val generation: Free[GenerationOperation, _ <: Case]
Inherited from:
GenerationSupport