reporter

Type Members

1. trait BufferedLineLogger extends LineLogger

   

   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)

2. class ConsoleNotifier extends Notifier

   

   Notifier that prints out to the console

3. case class ErrorLine(s: String) extends LogLine with Product with Serializable

   

4. case class FailureLine(s: String) extends LogLine with Product with Serializable

   

5. trait HtmlBodyPrinter extends AnyRef

   

   Create the body of an html file reporting a specification execution

6. case class HtmlOptions(outDir: DirectoryPath, baseDir: DirectoryPath, template: FilePath, variables: Map[String, String], noStats: Boolean, search: Boolean, warnMissingSeeRefs: Boolean, tocEntryMaxSize: Int, toc: Boolean) extends Product with Serializable

   

   Options for the Html generation

7. trait HtmlPrinter extends Printer

   

   Printer for html files

8. trait HtmlUrls extends AnyRef

   

9. case class InfoLine(s: String) extends LogLine with Product with Serializable

   

10. trait JUnitDescriptions extends ExecutionOrigin

    

    Create Description objects from the specification fragments and arrange them as a tree

11. trait JUnitPrinter extends Printer

    

    The JUnitPrinter sends notifications to JUnit's RunNotifier

12. trait JUnitXmlPrinter extends Printer

    

    The JUnitXmlPrinter creates an xml file with the specification execution results

13. trait LineLogger extends AnyRef

    

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

14. sealed trait LogLine extends AnyRef

    

    ADT for logging strings as info, warning or errors

15. case class MarkdownOptions(outDir: DirectoryPath, extension: String) extends Product with Serializable

    

16. trait MarkdownPrinter extends Printer

    

    This trait is not a full fledged markdown printer yet

17. 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

18. trait NoStdOutAroundEach extends AroundEach

    

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

19. trait Notifier extends AnyRef

    

    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.

20. case class Pandoc(verbose: Boolean, executable: FilePath, inputFormat: String, outputFormat: String) extends Product with Serializable

    

    Representation of the Pandoc executable

21. trait Printer extends AnyRef

    

    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

22. trait Reporter extends AnyRef

    

    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

23. trait SbtEvents extends AnyRef

    

    Sbt events for a given TaskDef and event handler

24. case class SbtLineLogger(loggers: Array[Logger]) extends BufferedLineLogger with Product with Serializable

    

    Line logger using sbt's loggers

25. 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

26. trait SearchPage extends AnyRef

    

    Functions used to create an index and a search page for the generated html pages

27. trait ShowDescription extends AnyRef

    

    Implementation of the Show trait to allow the drawing of Tree[Description] with scalaz

28. 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

29. class SpecFailureAssertionFailedError extends AssertionFailedError

    

    This class refines the AssertionFailedError from junit and provides the stackTrace of an exception which occurred during the specification execution

30. 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.