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)

class ConsoleNotifier extends Notifier

Notifier that prints out to the console

Notifier that prints out to the console

case class CustomInstances(arguments: Arguments, loader: ClassLoader, logger: Logger)
Companion
object
Companion
class
case class DefaultReporter(statistics: Statistics, statisticsRepository: StatisticsRepository, selector: Selector, executor: Executor, printers: List[Printer], env: Env) extends Reporter

Default implementation of a Reporter using specs2 Printers

Default implementation of a Reporter using specs2 Printers

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
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
case class MarkdownPrinter(env: Env) 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

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.

case class NotifierPrinter(commandLineArguments: Arguments)

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 AsyncStream[Fragment]
  • uses an AsyncSink 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
case class PrinterFactory(arguments: Arguments, customInstances: CustomInstances, logger: Logger)

Create printers based on their class names and the arguments passed by the user Note that this operation might fail if the corresponding printer classes are not on the class path

Create printers based on their class names and the arguments passed by the user Note that this operation might fail if the corresponding printer classes are not on the class path

Companion
object
Companion
class

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
Companion
class
trait Reporter

A reporter executes a list of specification and return statistics representing the execution results.

A reporter executes a list of specification and return statistics representing the execution results.

A full list of specification is passed instead of just one specification because it gives the possibility to the reporter to prepare and finalize the reporting according to the needs of each Printer (see the Printer doc)

Companion
object
object 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 SbtPrinter(env: Env, loggers: Array[Logger], events: SbtEvents) 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
case class SbtPrinterLogger(loggers: Array[Logger]) extends BufferedPrinterLogger

Line logger using sbt's loggers

Line logger using sbt's loggers

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

case class TextPrinter(env: Env) 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
Companion
class
object noOut extends PrintStream
object stdOut extends PrintStream