org.specs2.reporter

Type members

Classlikes

This line logger tries to respect line breaks in the original text.

This line logger tries to respect line breaks in the original text.

So if the original text is: Hello world\nHow are you? and we call infoLog("Hello world\n"); infoLog("How are you?")

Then there will be only 2 lines displayed and not 3 (2 for the first infoLog, 1 for the second one)

Notifier that prints out to the console

Notifier that prints out to the console

case object EmptyLine extends LogLine
case class ErrorLine(s: String) extends LogLine
case class FailureLine(s: String) extends LogLine
case class InfoLine(s: String) extends LogLine

Logger with info, failure, error where each new message is displayed on a new line

Logger with info, failure, error where each new message is displayed on a new line

Companion:
object
object LineLogger
Companion:
class
sealed trait LogLine

ADT for logging strings as info, warning or errors

ADT for logging strings as info, warning or errors

Companion:
object
object LogLine
Companion:
class
case class MarkdownOptions(outDir: DirectoryPath, extension: String)
Companion:
object
Companion:
class
trait MarkdownPrinter extends Printer

This trait is not a full fledged markdown printer yet

This trait is not a full fledged markdown printer yet

Companion:
object
Companion:
class
trait NoStdOut extends Around

This trait allows to remove any console display during the execution of an example

This trait allows to remove any console display during the execution of an example

Of course it needs to be understood that the output might be completely messed up when executing specifications and examples concurrently

Companion:
object
object NoStdOut extends NoStdOut
Companion:
class

This trait allows to remove any console display during the execution of the examples of a Specification

This trait allows to remove any console display during the execution of the examples of a Specification

trait Notifier

This trait can be used for any event concerning the execution of examples seen as a Tree of Fragments.

This trait can be used for any event concerning the execution of examples seen as a Tree of Fragments.

A pair of contextStart/contextEnd calls delimits a sequence of children in that tree.

A Printer can be created from a Notifier implementation

A Printer can be created from a Notifier implementation

object NullOutputStream extends OutputStream
trait Printer

A Printer is essentially defined by a FoldM sink that:

A Printer is essentially defined by a FoldM sink that:

  • can run a Process[Task, Fragment]
  • uses a scalaz-stream Sink for side-effects and
  • accumulates state for final reporting

See TextPrinter for an example of such a Printer

Companion:
object
object Printer

specs2 built-in printers and creation methods based on the command line arguments

specs2 built-in printers and creation methods based on the command line arguments

Companion:
class
trait Reporter

A reporter is responsible for

A reporter is responsible for

  • selecting printers based on the command-line arguments
  • executing the specification
  • passing it to each printer for printing

It is also responsible for saving the specification state at the end of the run

Companion:
object
object Reporter extends Reporter
Companion:
class
trait SbtEvents

Sbt events for a given TaskDef and event handler

Sbt events for a given TaskDef and event handler

case class SbtLineLogger(loggers: Array[Logger]) extends BufferedLineLogger

Line logger using sbt's loggers

Line logger using sbt's loggers

trait SbtPrinter extends Printer

Text printer for Sbt

Text printer for Sbt

It delegates the console printing to a normal text printer but using the Sbt loggers It also publishes events (success, error, skipped, pending) to Sbt

Companion:
object
object SbtPrinter
Companion:
class
trait SilentNotifier extends Notifier

Notifier which does not notify at all

Notifier which does not notify at all

It can be subclassed so that just one method is overridden

trait TextPrinter extends Printer

Prints the result of a specification execution to the console (using the line logger provided by the environment)

Prints the result of a specification execution to the console (using the line logger provided by the environment)

At the end of the run the specification statistics are displayed as well.

Companion:
object
object TextPrinter extends TextPrinter
Companion:
class
object noOut extends PrintStream
object stdOut extends PrintStream