org.specs2.specification.core

The next fragment must be un-indented

Break (== new line)

Description of a Fragment

Creation methods for Descriptions

End of a block

Whole creation / execution / reporting environment for a specification

Part of it is driven by the command-line, part of it is specs2 implementation Yet it can be used to drive the creation or execution of examples

Note: creating an Env instance is a delicate activity because the Env hold a thread pool that needs to be shutdown at the end of the execution

Execution of a Fragment

• there can be none (for a piece of text)
• the execution depends on the current Env. by default executions are created synchronously but can also be fork-off with Execution.withEnvAsync
• it can have its own timeout (default is infinite)
• once executed the result is kept
• if mustJoin is true this means that all previous executions must be finished before this one can start
• it has a condition deciding if the next execution can proceed or not depending on the current result
• if isolable is true this means that it should be executed in its own specification instance
• the result of a similar execution can be stored to decide if this one needs to be executed or not
• it can store a continuation that will create more fragments, possibly containing more executions, based on the current result

Fragment of a specification

It has a description (generally text but sometimes not, for a step for example) It has an execution which might do or don't do anything (for examples it runs some code)

Fragments of a specification

It is implemented as a Process of Fragment in order to produce fragments dynamically if necessary

Function creating more fragments (to be added to the specification) based on the current result

Structure of an immutable specification.

It may depend on the current environment.

If the examples need to be executed in their own instance of the specification they will be "isolated"

Location of a Fragment

This is currently implemented using stacktraces which is very brittle

Description of a Tag fragment

NoText description, used when creating steps and actions which are not described

This trait copies the inherited env: Env for a Specification and makes sure it is shutdown when the specification finishes

The specification using this trait must require an Env:

class MySpec(env: Env) extends Specification with OwnEnv

This trait provides an isolated Execution Env for a Specification and makes sure it is shutdown when the specification finishes.

The specification using this trait must require an Env:

class MySpec(env: Env) extends Specification with OwnExecutionEnv

Header of a Specification

It can hold a user-defined title for better presentation

Structure of a Specification:

• a header
• some arguments
• specification fragments

Note that the fragments have to be lazy in order to avoid cycles when 2 specifications are referencing each other with links

Create SpecStructures from header, arguments, fragments

Reference to another specification

Start of a block. This is used to delimit the blocks in mutable specifications and know exactly how to create levels when transforming a specification to a tree of examples (for JUnit for example)

The next fragment must be indented

Text description