specs2-core/org.specs2.specification.create/SpecificationCreation

SpecificationCreation

trait SpecificationCreation extends AcceptanceDsl with AutoExamples with ArgumentsArgs with ArgumentsShortcuts with S2StringContext with FormattingFragments
trait ArgumentsShortcuts
trait ArgumentsArgs
trait ArgProperties
trait ArgumentsCreation
trait TitleDsl
trait ActionDsl
trait TagDsl
class Object
trait Matchable
class Any

Type members

Inherited classlikes

trait ToFragments[T]
Inherited from:
FragmentsDsl
trait ToSpecStructure[T1, T2]
Inherited from:
SpecStructureDsl
implicit class appendFragments[T1, T2](t1: T1)(using evidence$1: ToFragments[T1], evidence$2: ToFragments[T2])
Inherited from:
FragmentsDsl
implicit class appendSpecStructure[T1, T2](t1: T1)(using tss: ToSpecStructure[T1, T2])
Inherited from:
SpecStructureDsl
object given_Conversion_Fragment_SpecStructure extends Conversion[Fragment, SpecStructure]
Inherited from:
SpecStructureDsl
object given_Conversion_Fragments_Interpolated extends Conversion[Fragments, Interpolated]
Inherited from:
S2StringContext
object given_Conversion_SpecHeader_SpecStructure extends Conversion[SpecHeader, SpecStructure]
Inherited from:
SpecStructureDsl
object given_Conversion_SpecStructure_Fragments extends Conversion[SpecStructure, Fragments]
Inherited from:
SpecStructureDsl
object given_Conversion_SpecStructure_Interpolated extends Conversion[SpecStructure, Interpolated]
Inherited from:
S2StringContext
object given_Conversion_SpecificationRef_Interpolated extends Conversion[SpecificationRef, Interpolated]
Inherited from:
S2StringContext
object given_Conversion_SpecificationStructure_Interpolated extends Conversion[SpecificationStructure, Interpolated]
Inherited from:
S2StringContext
object given_Conversion_String_SpecStructure extends Conversion[String, SpecStructure]
Inherited from:
SpecStructureDsl
object given_ToFragments_Fragment extends ToFragments[Fragment]
Inherited from:
FragmentsDsl
object given_ToFragments_Fragments extends ToFragments[Fragments]
Inherited from:
FragmentsDsl
object given_ToFragments_Seq extends ToFragments[Seq[Fragment]]
Inherited from:
FragmentsDsl
object given_ToFragments_String extends ToFragments[String]
Inherited from:
FragmentsDsl
object given_ToSpecStructure_Arguments_Arguments extends ToSpecStructure[Arguments, Arguments]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Arguments_Fragment extends ToSpecStructure[Arguments, Fragment]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Arguments_Fragments extends ToSpecStructure[Arguments, Fragments]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Arguments_SpecHeader extends ToSpecStructure[Arguments, SpecHeader]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Arguments_SpecStructure extends ToSpecStructure[Arguments, SpecStructure]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Arguments_String extends ToSpecStructure[Arguments, String]

APPENDING TO ARGUMENTS

APPENDING TO ARGUMENTS

Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Fragment_Arguments extends ToSpecStructure[Fragment, Arguments]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Fragment_Fragment extends ToSpecStructure[Fragment, Fragment]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Fragment_Fragments extends ToSpecStructure[Fragment, Fragments]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Fragment_SpecStructure extends ToSpecStructure[Fragment, SpecStructure]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Fragment_String extends ToSpecStructure[Fragment, String]

APPENDING TO A FRAGMENT

APPENDING TO A FRAGMENT

Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Fragments_Fragment extends ToSpecStructure[Fragments, Fragment]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Fragments_Fragments extends ToSpecStructure[Fragments, Fragments]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_Fragments_String extends ToSpecStructure[Fragments, String]

APPENDING TO FRAGMENTS

APPENDING TO FRAGMENTS

Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecHeader_Arguments extends ToSpecStructure[SpecHeader, Arguments]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecHeader_Fragment extends ToSpecStructure[SpecHeader, Fragment]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecHeader_Fragments extends ToSpecStructure[SpecHeader, Fragments]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecHeader_Seq extends ToSpecStructure[SpecHeader, Seq[Fragment]]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecHeader_SpecStructure extends ToSpecStructure[SpecHeader, SpecStructure]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecHeader_String extends ToSpecStructure[SpecHeader, String]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecStructure_Arguments extends ToSpecStructure[SpecStructure, Arguments]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecStructure_Fragment extends ToSpecStructure[SpecStructure, Fragment]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecStructure_Fragments extends ToSpecStructure[SpecStructure, Fragments]

APPENDING TO A SPEC STRUCTURE

APPENDING TO A SPEC STRUCTURE

Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecStructure_Seq extends ToSpecStructure[SpecStructure, Seq[Fragment]]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecStructure_SpecStructure extends ToSpecStructure[SpecStructure, SpecStructure]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_SpecStructure_String extends ToSpecStructure[SpecStructure, String]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_String_Fragment extends ToSpecStructure[String, Fragment]

APPENDING TO A STRING

APPENDING TO A STRING

Inherited from:
SpecStructureDsl
object given_ToSpecStructure_String_Fragments extends ToSpecStructure[String, Fragments]
Inherited from:
SpecStructureDsl
object given_ToSpecStructure_String_SpecStructure extends ToSpecStructure[String, SpecStructure]
Inherited from:
SpecStructureDsl

Value members

Inherited methods

def action[T](a: => T)(using evidence$3: AsExecution[T]): Fragment
Inherited from:
ActionDsl
def addExample(d: String, execution: => Execution): Fragment
Inherited from:
ExampleDsl
def args(ex: ArgProperty[String], include: ArgProperty[String], exclude: ArgProperty[String], was: ArgProperty[String], plan: ArgProperty[Boolean], skipAll: ArgProperty[Boolean], stopOnFail: ArgProperty[Boolean], stopOnError: ArgProperty[Boolean], stopOnIssue: ArgProperty[Boolean], stopOnSkip: ArgProperty[Boolean], sequential: ArgProperty[Boolean], sequentialRandom: ArgProperty[Boolean], batchSize: ArgProperty[Int], timeFactor: ArgProperty[Int], timeout: ArgProperty[FiniteDuration], asap: ArgProperty[Boolean], xonly: ArgProperty[Boolean], showOnly: ArgProperty[String], color: ArgProperty[Boolean]): Arguments

shorthand method to create an Arguments object

shorthand method to create an Arguments object

Inherited from:
ArgumentsCreation
def batchSize(n: Int): Arguments
Returns:

arguments for a specification where examples must in a given batch size

Inherited from:
ArgumentsShortcuts
def br: Fragment
Inherited from:
FormattingFragments
def bt(n: Int): Fragment
Inherited from:
FormattingFragments
def bt: Fragment
Inherited from:
FormattingFragments
def colors(c: Colors): Arguments

shortcut to set new Colors

shortcut to set new Colors

Inherited from:
ArgumentsShortcuts
def diffs(show: Boolean, separators: String, triggerSize: Int, diffRatio: Int, shortenSize: Int, full: Boolean, seqTriggerSize: Int, seqMaxSize: Int): Arguments

shortcut to display the differences with some specific parameters

shortcut to display the differences with some specific parameters

Inherited from:
ArgumentsShortcuts
inline def eg[T](inline code: => T)(using asResult: AsResult[T]): Fragments
Inherited from:
AutoExamples
def exclude(tags: String): Arguments

shortcut to exclude some tagged fragments

shortcut to exclude some tagged fragments

Inherited from:
ArgumentsShortcuts
def excludeAlsoTrace(patterns: String*): IncludeExcludeStackTraceFilter

shortcut to add exclude trace patterns

shortcut to add exclude trace patterns

Inherited from:
ArgumentsShortcuts
def excludeTrace(patterns: String*): IncludeExcludeStackTraceFilter

shortcut to create a stackTrace filter to exclude only some elements

shortcut to create a stackTrace filter to exclude only some elements

Inherited from:
ArgumentsShortcuts
protected def fragmentFactory: FragmentFactory
Inherited from:
FragmentsFactory
def fragmentsBlock(fragments: Seq[Fragment], offset: Int): Fragments

create a block of new fragments where each of them is separated by a newline and there is a specific offset from the left margin

create a block of new fragments where each of them is separated by a newline and there is a specific offset from the left margin

Inherited from:
FragmentsDsl
def fullStackTrace: Arguments

shortcut to filter nothing

shortcut to filter nothing

Inherited from:
ArgumentsShortcuts
def include(tags: String): Arguments

shortcut to include only some tagged fragments

shortcut to include only some tagged fragments

Inherited from:
ArgumentsShortcuts
def includeAlsoTrace(patterns: String*): IncludeExcludeStackTraceFilter

shortcut to add include trace patterns

shortcut to add include trace patterns

Inherited from:
ArgumentsShortcuts
def includeTrace(patterns: String*): IncludeExcludeStackTraceFilter

shortcut to create a stackTrace filter to include only some elements

shortcut to create a stackTrace filter to include only some elements

Inherited from:
ArgumentsShortcuts
def nocolor: Arguments

shortcut to avoid colored output

shortcut to avoid colored output

Inherited from:
ArgumentsShortcuts
def only(examples: String): Arguments

shortcut to execute and print only some examples

shortcut to execute and print only some examples

Inherited from:
ArgumentsShortcuts
def p: Fragments
Inherited from:
FormattingFragments
def plan: Arguments

shortcut to show only the text without any execution

shortcut to show only the text without any execution

Inherited from:
ArgumentsShortcuts
def postProcessAutoExample(fs: Fragments): Fragments

this function is introduced just to allow the mutable specification to register the newly created fragments

this function is introduced just to allow the mutable specification to register the newly created fragments

Inherited from:
AutoExamples
def postProcessS2Fragments(fs: Fragments): Fragments

this function is exposed so that it can be overridden with side-effects when using s2 strings in mutable specs

this function is exposed so that it can be overridden with side-effects when using s2 strings in mutable specs

Inherited from:
S2StringContextCreation
def section(tag: NamedTag): Fragment
Inherited from:
TagDsl
def section(names: String*): Fragment
Inherited from:
TagDsl
def sequential: Arguments
Returns:

arguments for a specification where examples must be executed sequentially

Inherited from:
ArgumentsShortcuts
def sequentialRandom: Arguments
Returns:

arguments for a specification where examples must be executed sequentially but in a random order

Inherited from:
ArgumentsShortcuts
def showOnly(s: String): Arguments

shortcut to print only some statuses

shortcut to print only some statuses

Inherited from:
ArgumentsShortcuts
def skipAll: Arguments

shortcut to skip all examples

shortcut to skip all examples

Inherited from:
ArgumentsShortcuts
def skipAllIf(condition: => Boolean): Arguments

shortcut to skip all examples when a condition is true. if the condition throws an exception, its stacktrace is not printed and all the examples are skipped

shortcut to skip all examples when a condition is true. if the condition throws an exception, its stacktrace is not printed and all the examples are skipped

Inherited from:
ArgumentsShortcuts
def skipAllUnless(condition: => Boolean): Arguments

shortcut to skip all examples when a condition is false.

shortcut to skip all examples when a condition is false.

Inherited from:
ArgumentsShortcuts
def step[T](a: => T, global: Boolean)(using evidence$2: AsExecution[T]): Fragment
Inherited from:
ActionDsl
def step[T](a: => T)(using evidence$1: AsExecution[T]): Fragment
Inherited from:
ActionDsl
def stopOnFail: Arguments

shortcut to stop after the first failure or error

shortcut to stop after the first failure or error

Inherited from:
ArgumentsShortcuts
def stopOnSkip: Arguments

shortcut to stop after the first skipped result

shortcut to stop after the first skipped result

Inherited from:
ArgumentsShortcuts
def t(n: Int): Fragment
Inherited from:
FormattingFragments
def t: Fragment
Inherited from:
FormattingFragments
def tag(tag: NamedTag): Fragment
Inherited from:
TagDsl
def tag(names: String*): Fragment
Inherited from:
TagDsl
def title(s: String)(using nothing: Int): SpecHeader
Inherited from:
TitleDsl
def unbatched: Arguments
Returns:

arguments for a specification where examples must be executed inside just one big batch

Inherited from:
ArgumentsShortcuts
def was(s: String): Arguments

shortcut to include only examples with some previous statuses

shortcut to include only examples with some previous statuses

Inherited from:
ArgumentsShortcuts
def xonly: Arguments

shortcut to print only failures and errors

shortcut to print only failures and errors

Inherited from:
ArgumentsShortcuts

Inherited fields

lazy val args: ArgumentsNamespace
Inherited from:
ArgumentsCreation

Givens

Inherited givens

given given_FragmentFactory: FragmentFactory

The FragmentFactory has to be passed as an implicit in order to be inlined in macros

The FragmentFactory has to be passed as an implicit in order to be inlined in macros

Inherited from:
S2StringContextCreation
given given_ToSpecStructure_Arguments_String: given_ToSpecStructure_Arguments_String.type

APPENDING TO ARGUMENTS

APPENDING TO ARGUMENTS

Inherited from:
SpecStructureDsl
given given_ToSpecStructure_Arguments_T[T <: SpecificationStructure]: given_ToSpecStructure_Arguments_T[T]
Inherited from:
SpecStructureDsl
given given_ToSpecStructure_Fragment_String: given_ToSpecStructure_Fragment_String.type

APPENDING TO A FRAGMENT

APPENDING TO A FRAGMENT

Inherited from:
SpecStructureDsl
given given_ToSpecStructure_Fragment_T[T <: SpecificationStructure]: given_ToSpecStructure_Fragment_T[T]
Inherited from:
SpecStructureDsl
given given_ToSpecStructure_Fragments_String: given_ToSpecStructure_Fragments_String.type

APPENDING TO FRAGMENTS

APPENDING TO FRAGMENTS

Inherited from:
SpecStructureDsl
given given_ToSpecStructure_SpecHeader_T[T <: SpecificationStructure]: given_ToSpecStructure_SpecHeader_T[T]

APPENDING TO A SPEC HEADER

APPENDING TO A SPEC HEADER

Inherited from:
SpecStructureDsl
given given_ToSpecStructure_SpecStructure_Fragments: given_ToSpecStructure_SpecStructure_Fragments.type

APPENDING TO A SPEC STRUCTURE

APPENDING TO A SPEC STRUCTURE

Inherited from:
SpecStructureDsl
given given_ToSpecStructure_SpecStructure_T[T <: SpecificationStructure]: given_ToSpecStructure_SpecStructure_T[T]
Inherited from:
SpecStructureDsl
given given_ToSpecStructure_String_Fragment: given_ToSpecStructure_String_Fragment.type

APPENDING TO A STRING

APPENDING TO A STRING

Inherited from:
SpecStructureDsl
given given_ToSpecStructure_String_T[T <: SpecificationStructure]: given_ToSpecStructure_String_T[T]
Inherited from:
SpecStructureDsl

Extensions

Inherited extensions

extension (alias: String)
infix def ~(s: => SpecificationStructure, tooltip: String): Fragment
Inherited from:
ReferenceDsl
infix def ~(s: => SpecificationStructure): Fragment
Inherited from:
ReferenceDsl
infix def ~(s: SpecStructure, tooltip: String): Fragment
Inherited from:
ReferenceDsl
infix def ~(s: SpecStructure): Fragment
Inherited from:
ReferenceDsl
extension (alias: String)
infix def ~/(s: => SpecificationStructure, tooltip: String): Fragment
Inherited from:
ReferenceDsl
infix def ~/(s: => SpecificationStructure): Fragment
Inherited from:
ReferenceDsl
infix def ~/(s: SpecStructure, tooltip: String): Fragment
Inherited from:
ReferenceDsl
infix def ~/(s: SpecStructure): Fragment
Inherited from:
ReferenceDsl
extension [R](d: String)
def !(using not: NotGiven[NoBangExamples])(r: Env => R)(using evidence$3: AsResult[R]): Fragment
Inherited from:
ExampleDsl
extension [R](d: String)
def !(using not: NotGiven[NoBangExamples])(r: String => R)(using evidence$2: AsResult[R]): Fragment
Inherited from:
ExampleDsl
def !(using not: NotGiven[NoBangExamples])(r: => R)(using evidence$1: AsResult[R]): Fragment
Inherited from:
ExampleDsl
extension (d: String)
def !(using not: NotGiven[NoBangExamples])(execution: => Execution): Fragment
Inherited from:
ExampleDsl
extension (fragment: Fragment)
def hide: Fragment
Inherited from:
FragmentsDsl
extension (fragment: Fragment)
def mute: Fragment
Inherited from:
FragmentsDsl
extension (s: String)
def title(using not: NotGiven[NoTitleDsl]): SpecHeader
Inherited from:
TitleDsl
extension (sc: StringContext)
inline def s2(using factory: FragmentFactory)(inline variables: Interpolated*): Fragments

String interpolation for specs2 fragments

String interpolation for specs2 fragments

Inherited from:
S2StringContextCreation
extension [T1, T2](t1: T1)
def ^(t2: => T2)(using tss: ToSpecStructure[T1, T2]): SpecStructure
Inherited from:
SpecStructureDsl

Implicits

Inherited implicits

final implicit def appendFragments[T1, T2](t1: T1)(using evidence$1: ToFragments[T1], evidence$2: ToFragments[T2]): appendFragments[T1, T2]
Inherited from:
FragmentsDsl
final implicit def appendSpecStructure[T1, T2](t1: T1)(using tss: ToSpecStructure[T1, T2]): appendSpecStructure[T1, T2]
Inherited from:
SpecStructureDsl
implicit inline def asExecutionIsInterpolated[R](inline r: => R)(using evidence$1: AsExecution[R], inline factory: FragmentFactory): Interpolated

create an example based on an execution

create an example based on an execution

Inherited from:
S2StringContext
implicit inline def asResultIsInterpolated[R](inline r: => R)(using evidence$3: AsResult[R]): Interpolated
Inherited from:
S2StringContext1 (hidden)
implicit inline def fragmentIsInterpolated(inline f: => Fragment): Interpolated
Inherited from:
S2StringContext1 (hidden)
implicit def resultAsSpecStructure[R](r: => R)(using evidence$1: AsResult[R]): SpecStructure
Inherited from:
SpecStructureDsl
implicit inline def stepParserIsInterpolatedFragment[R](f: StepParser[R])(using evidence$4: AsResult[R]): Interpolated
Inherited from:
S2StringContext1 (hidden)
implicit def stringIsInterpolated(s: => String): Interpolated
Inherited from:
S2StringContext
implicit inline def stringResultIsInterpolated[R](inline f: String => R)(using evidence$2: AsResult[R]): Interpolated
Inherited from:
S2StringContext1 (hidden)
implicit def toArgProperty[T](t: => T)(using NotGiven[NoArgProperties], CanEqual[T, T]): ArgProperty[T]
Inherited from:
ArgProperties