specs2-core/org.specs2.specification.dsl.mutable/SpecificationCreation

SpecificationCreation

trait SpecificationCreation extends SpecificationCreation with FormattingFragments with AutoExamples with MutableDsl with ArgumentsShortcuts with ArgumentsDsl

Trait for creating a mutable specification

trait TagDsl
trait TitleDsl
trait ActionDsl
trait TextDsl
trait BlockDsl
trait BlockCreation
trait S2StringContext1
trait ArgumentsShortcuts
trait ArgumentsArgs
trait ArgProperties
trait ArgumentsCreation
trait TitleDsl
trait AcceptanceDsl1
trait ActionDsl
trait TagDsl
class Object
trait Matchable
class Any

Type members

Inherited classlikes

trait ToBlock[S, R]
Inherited from
BlockCreation
trait ToFragments[T]
Inherited from
FragmentsDsl
trait ToSpecStructure[T1, T2]
Inherited from
SpecStructureDsl
class WarningForgottenOperator(s: String)
Inherited from
ExtendedBlockDsl
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

Value members

Concrete methods

override
def postProcessS2Fragments(fs: Fragments): Fragments

add fragments created with the s2 interpolated string

add fragments created with the s2 interpolated string

Definition Classes

Inherited methods

override
def action[T](a: => T)(using evidence$1: AsExecution[T]): Fragment
Definition Classes
Inherited from
ActionDsl
def addBacktab(n: Int): Fragment
Inherited from
TextCreation
def addBacktab: Fragment
Inherited from
TextCreation
def addBreak(n: Int): Fragment
Inherited from
TextCreation
def addBreak: Fragment
Inherited from
TextCreation
override
def addExample(d: String, execution: => Execution): Fragment
Definition Classes
Inherited from
ExampleDsl
def addFragment(fragment: Fragment): Fragment
def addParagraph(s: String, n: Int): Fragment
Inherited from
TextCreation
def addSections(): Unit
def addTab(n: Int): Fragment
Inherited from
TextCreation
def addTab: Fragment
Inherited from
TextCreation
def addText(s: String): Fragment
Inherited from
TextCreation
override
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

Definition Classes
ArgumentsCreation -> ArgumentsCreation
Inherited from
ArgumentsCreation
def batchSize(n: Int): Arguments
Returns

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

Inherited from
ArgumentsShortcuts
override
def br: Fragment
override
def bt(n: Int): Fragment
override
def bt: Fragment
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
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 hasSectionsForBlocks: Boolean
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
override
def p: Fragments
def plan: Arguments

shortcut to show only the text without any execution

shortcut to show only the text without any execution

Inherited from
ArgumentsShortcuts
override
def postProcessAutoExample(fs: Fragments): Fragments
Definition Classes
Inherited from
AutoExamples
override
def section(tag: NamedTag): Fragment
Definition Classes
Inherited from
TagDsl
override
def section(names: String*): Fragment
Definition Classes
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 setArguments(a: Arguments): Arguments
def setTitle(t: String): SpecHeader
Inherited from
MutableHeaderBuilder
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
override
def step[T](a: => T)(using evidence$2: AsExecution[T]): Fragment
Definition Classes
Inherited from
ActionDsl
def step[T](a: => T, global: Boolean)(using evidence$2: 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 stopWhen(f: Result => Boolean): Fragment
Inherited from
ActionDsl
def stopWhen(r: Result): Fragment
Inherited from
ActionDsl
def stopWhenFail(when: => Boolean): Fragment
Inherited from
ActionDsl
def stopWhenFail: Fragment
Inherited from
ActionDsl
def stopWhenSkipped(when: => Boolean): Fragment
Inherited from
ActionDsl
override
def t(n: Int): Fragment
override
def t: Fragment
override
def tag(tag: NamedTag): Fragment
Definition Classes
Inherited from
TagDsl
override
def tag(names: String*): Fragment
Definition Classes
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 updateArguments(a: Arguments): Arguments
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

final lazy
val 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
lazy override
val args: ArgumentsNamespaceMutable
Inherited from
ArgumentsCreation

Givens

Inherited givens

given ToBlock_Function_Fragment[R]: ToBlock[String => R, Fragment]
Inherited from
BlockDsl
given ToBlock_R_Fragment[R]: ToBlock[R, Fragment]
Inherited from
BlockDsl
given ToBlock_StepParser_Fragment[R]: ToBlock[StepParser[R], Fragment]
Inherited from
BlockDsl
given ToSpecStructure_Arguments_T[T <: SpecificationStructure]: ToSpecStructure[Arguments, T]
Inherited from
SpecStructureDsl
given ToSpecStructure_Fragment_T[T <: SpecificationStructure]: ToSpecStructure[Fragment, T]
Inherited from
SpecStructureDsl
given ToSpecStructure_SpecHeader_T[T <: SpecificationStructure]: ToSpecStructure[SpecHeader, T]

APPENDING TO A SPEC HEADER

APPENDING TO A SPEC HEADER

Inherited from
SpecStructureDsl
given ToSpecStructure_SpecStructure_T[T <: SpecificationStructure]: ToSpecStructure[SpecStructure, T]
Inherited from
SpecStructureDsl
given ToSpecStructure_String_T[T <: SpecificationStructure]: ToSpecStructure[String, T]
Inherited from
SpecStructureDsl
given given_Conversion_Fragment_SpecStructure: Conversion[Fragment, SpecStructure]
Inherited from
SpecStructureDsl
given given_Conversion_Fragments_Interpolated: Conversion[Fragments, Interpolated]
Inherited from
S2StringContext
given given_Conversion_SpecHeader_SpecStructure: Conversion[SpecHeader, SpecStructure]
Inherited from
SpecStructureDsl
given given_Conversion_SpecStructure_Fragments: Conversion[SpecStructure, Fragments]
Inherited from
SpecStructureDsl
given given_Conversion_SpecStructure_Interpolated: Conversion[SpecStructure, Interpolated]
Inherited from
S2StringContext
given given_Conversion_SpecificationRef_Interpolated: Conversion[SpecificationRef, Interpolated]
Inherited from
S2StringContext
given given_Conversion_SpecificationStructure_Interpolated: Conversion[SpecificationStructure, Interpolated]
Inherited from
S2StringContext
given given_Conversion_String_SpecStructure: Conversion[String, SpecStructure]
Inherited from
SpecStructureDsl
given given_ToBlock_Fragment_Fragment: ToBlock[Fragment, Fragment]
Inherited from
BlockDsl
given given_ToBlock_Fragments_Fragments: ToBlock[Fragments, Fragments]
Inherited from
BlockDsl
given given_ToFragments_Fragment: ToFragments[Fragment]
Inherited from
FragmentsDsl
given given_ToFragments_Fragments: ToFragments[Fragments]
Inherited from
FragmentsDsl
given given_ToFragments_Seq: ToFragments[Seq[Fragment]]
Inherited from
FragmentsDsl
given given_ToFragments_String: ToFragments[String]
Inherited from
FragmentsDsl
given given_ToSpecStructure_Arguments_Arguments: ToSpecStructure[Arguments, Arguments]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_Arguments_Fragment: ToSpecStructure[Arguments, Fragment]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_Arguments_Fragments: ToSpecStructure[Arguments, Fragments]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_Arguments_SpecHeader: ToSpecStructure[Arguments, SpecHeader]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_Arguments_SpecStructure: ToSpecStructure[Arguments, SpecStructure]
Inherited from
SpecStructureDsl
given given_ToSpecStructure_Arguments_String: ToSpecStructure[Arguments, String]

APPENDING TO ARGUMENTS

APPENDING TO ARGUMENTS

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

APPENDING TO A FRAGMENT

APPENDING TO A FRAGMENT

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

APPENDING TO FRAGMENTS

APPENDING TO FRAGMENTS

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

APPENDING TO A SPEC STRUCTURE

APPENDING TO A SPEC STRUCTURE

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

APPENDING TO A STRING

APPENDING TO A STRING

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

Extensions

Inherited extensions

extension (alias: String)
infix override
def ~/(s: => SpecificationStructure, tooltip: String): Fragment
Definition Classes
Inherited from
ReferenceDsl
infix override
def ~/(s: => SpecificationStructure): Fragment
Definition Classes
Inherited from
ReferenceDsl
infix override
def ~/(s: SpecStructure, tooltip: String): Fragment
Definition Classes
Inherited from
ReferenceDsl
infix override
def ~/(s: SpecStructure): Fragment
Definition Classes
Inherited from
ReferenceDsl
extension (alias: String)
infix override
def ~(s: => SpecificationStructure, tooltip: String): Fragment
Definition Classes
Inherited from
ReferenceDsl
infix override
def ~(s: => SpecificationStructure): Fragment
Definition Classes
Inherited from
ReferenceDsl
infix override
def ~(s: SpecStructure, tooltip: String): Fragment
Definition Classes
Inherited from
ReferenceDsl
infix override
def ~(s: SpecStructure): Fragment
Definition Classes
Inherited from
ReferenceDsl
extension [S, R](d: String)
infix
def >>(s: => S)(using t: ToBlock[S, R]): R
Inherited from
BlockDsl
extension (d: String)
def !(using not: NotGiven[NoBangExamples])(execution: => Execution): Fragment
Inherited from
ExampleDsl
extension [R](d: String)
@targetName("bangWithEnv")
def !(using not: NotGiven[NoBangExamples])(r: Env => R)(using evidence$3: AsResult[R]): Fragment
Inherited from
ExampleDsl
extension [S, R](d: String)
infix
def can(using not: NotGiven[NoExtendedBlockDsl])(s: => S)(using t: ToBlock[S, R]): R
Inherited from
ExtendedBlockDsl
infix
def in(using not: NotGiven[NoExtendedBlockDsl])(s: => S)(using t: ToBlock[S, R]): R
Inherited from
ExtendedBlockDsl
infix
def should(using not: NotGiven[NoExtendedBlockDsl])(s: => S)(using t: ToBlock[S, R]): R
Inherited from
ExtendedBlockDsl
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 (f: => Fragment)
def backtab(n: Int): Fragment
Inherited from
TextDsl
def backtab: Fragment
Inherited from
TextDsl
def br(n: Int): Fragment
Inherited from
TextDsl
def br: Fragment
Inherited from
TextDsl
def p(n: Int): Fragment
Inherited from
TextDsl
def p: Fragment
Inherited from
TextDsl
def tab(n: Int): Fragment
Inherited from
TextDsl
def tab: Fragment
Inherited from
TextDsl
extension (f: => Fragment)
infix
def section(tag: NamedTag): Fragment

This implicit allows to add tags and sections after the examples

This implicit allows to add tags and sections after the examples

Inherited from
TagDsl
infix
def section(tag: String): Fragment

This implicit allows to add tags and sections after the examples

This implicit allows to add tags and sections after the examples

Inherited from
TagDsl
infix
def tag(tag: NamedTag): Fragment

This implicit allows to add tags and sections after the examples

This implicit allows to add tags and sections after the examples

Inherited from
TagDsl
infix
def tag(tag: String): Fragment

This implicit allows to add tags and sections after the examples

This implicit allows to add tags and sections after the examples

Inherited from
TagDsl
extension (fragment: Fragment)
def mute: Fragment
Inherited from
FragmentsDsl
extension (fragment: Fragment)
def hide: Fragment
Inherited from
FragmentsDsl
extension (fs: => Fragments)
infix
def section(tag: NamedTag): Fragments

This implicit allows to add tags and sections after the examples

This implicit allows to add tags and sections after the examples

Inherited from
TagDsl
infix
def tag(tag: NamedTag): Fragments

This implicit allows to add tags and sections after the examples

This implicit allows to add tags and sections after the examples

Inherited from
TagDsl
extension (fs: => Fragments)
def backtab(n: Int): Fragments
Inherited from
TextDsl
def backtab: Fragments
Inherited from
TextDsl
def br(n: Int): Fragments
Inherited from
TextDsl
def br: Fragments
Inherited from
TextDsl
def p(n: Int): Fragments
Inherited from
TextDsl
def p: Fragments
Inherited from
TextDsl
def tab(n: Int): Fragments
Inherited from
TextDsl
def tab: Fragments
Inherited from
TextDsl
extension (s: String)
def br(n: Int): Fragment
Inherited from
TextDsl
def br: Fragment
Inherited from
TextDsl
def p(n: Int): Fragment
Inherited from
TextDsl
def p: Fragment
Inherited from
TextDsl
def txt: Fragment
Inherited from
TextDsl
extension (s: String)
override
def title(using not: NotGiven[NoTitleDsl]): SpecHeader
Definition Classes
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

> result ***-fffff55e" data-f-keywords="implicit" data-f-inherited="ExtendedBlockDsl">> result ***-fffff55e" class="documentableAnchor">
implicit
def > result ***-fffff55e" class="documentableName ">`***If you see this message this means that you've forgotten an operator after the description string: you should write "example" >> result ***`(s: String): WarningForgottenOperator

adding a conflicting implicit to warn the user when a >> was forgotten

adding a conflicting implicit to warn the user when a >> was forgotten

Inherited from
> result ***-fffff55e">ExtendedBlockDsl
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
implicit inline
def fragmentIsInterpolated(inline f: => Fragment): Interpolated
Inherited from
S2StringContext1
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
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
implicit
def toArgProperty[T](t: => T)(using NotGiven[NoArgProperties], CanEqual[T, T]): ArgProperty[T]
Inherited from
ArgProperties