reporter

Type Members

1. trait AllExporting extends Reporter with Exporters

   

   This trait can be mixed in a reporter to allow the exporting of an executed specification to many different formats: html, junit xml, markdown, custom,...

2. trait ConsoleNotifier extends Notifier

   

3. trait ConsoleReporter extends DefaultReporter with TextExporting

   

   The console reporter executes a Specification and exports the results to the Console Output:

   The console reporter executes a Specification and exports the results to the Console Output:

   - DefaultSelection filters and sorts the Fragments - DefaultExecutionStrategy executes the Examples concurrently by default - TextExporting prints the results in a Tree manner (using a TextOutput)

4. trait DefaultExecutionStrategy extends ExecutionStrategy with FragmentExecution

   

   This trait uses Scalaz promises to execute Fragments concurrently

   This trait uses Scalaz promises to execute Fragments concurrently

   It uses a Fixed thread pool with a number of threads to execute the fragments. The default number is the number of available threads by default but this can be overridden by providing different Arguments

5. trait DefaultReporter extends Reporter with Executor with DefaultSelection with DefaultSequence with DefaultExecutionStrategy with DefaultStoring

   

6. trait DefaultSelection extends ExamplesIsolation with TagSelection with StatusSelection with ExamplesSelection with Selection

   

   The DefaultSelection trait filters the fragments to execute by filtering Examples:

   The DefaultSelection trait filters the fragments to execute by filtering Examples:

   - by tags - according to their names - according to their previous execution

   If the isolated argument is passed, then each example is executed in its own copy of the specification

7. trait DefaultSequence extends AnyRef

   

   The DefaultSequence trait sorts the Fragments by making sure Steps will be executed before Examples

8. trait DefaultStatisticsRepository extends StatisticsRepository with OutputDir

   

   This repository store the results in one file per specification, in a special directory

   This repository store the results in one file per specification, in a special directory

   This solution is preferred over having a single file for all specifications because of the possible concurrent execution of specifications

9. trait DefaultStoring extends Storing with Statistics with WithDefaultStatisticsRepository

   

10. case class DescriptionAndExamples[T](description: Description, descriptions: Map[T, Description]) extends Product with Serializable

    

    Utility class grouping the total description + map of each fragment to its description

11. case class EndOfArguments[T](value: T, name: SpecName) extends ApplicableArguments[T] with Product with Serializable

    

12. trait Events extends AnyRef

    

13. trait ExamplesIsolation extends AnyRef

    

    This trait "isolates" examples by replacing their body with another one, created from a clone of the specification.

14. trait ExamplesSelection extends AnyRef

    

    This trait filters examples based on their description

15. case class ExecutableSpecification(name: SpecName, arguments: Arguments, fs: Seq[FragmentSeq]) extends Product with Serializable

    

    this case class transports the fragments to execute, grouped in sequences of examples which can be executed concurrently

16. trait Executor extends DefaultSelection with DefaultSequence with DefaultExecutionStrategy with DefaultStoring

    

17. trait Exporter extends Exporting

    

    public trait to create a custom exporter

18. case class FinalResultsExporter(taskDef: TaskDef, handler: EventHandler, loggers: Array[Logger]) extends SbtExporter with Product with Serializable

    

    This reporter will just notify the test interface about test results for the end statistics

    This reporter will just notify the test interface about test results for the end statistics

    It is only used if we are not using the Console exporter

19. case class FragmentSeq(fragments: Seq[Fragment], arguments: Arguments) extends Product with Serializable

    

20. trait HandlerEvents extends AnyRef

    

    Specific events which can be notified to sbt

21. trait HtmlExporting extends Exporting with HtmlPrinter with HtmlFileWriter

    

    Trait for exporting the specification as Html files

22. case class HtmlFile(url: String, xml: NodeSeq) extends Product with Serializable

    

23. trait HtmlFileWriter extends OutputDir

    

24. trait HtmlPrinter extends AnyRef

    

    The Html printer is used to create an Html report of an executed specification.

    The Html printer is used to create an Html report of an executed specification.

    To do this, it uses a reducer to prepare print blocks with:

    - the text to print - the indentation level - the statistics - the current arguments to use

25. trait HtmlReportOutput extends AnyRef

    

    This trait defines how the specification elements should be translated as xhtml An implementation of that trait must accumulate the results and return the created xhmtl with the xml method

26. trait HtmlReporter extends DefaultReporter with HtmlExporting with ConsoleOutput

    

    Reports a Specification as an Html page

27. class JUnitDescriptionsFragments extends JUnitDescriptions[Fragment]

    

    Descriptions for a seq of Fragments to execute

28. trait JUnitReporter extends ExecutionOrigin with DefaultReporter with Exporters

    

    The JUnitReporter reports a specification by using a JUnit RunNotifier

    The JUnitReporter reports a specification by using a JUnit RunNotifier

    To do so, it uses most of the execution pipeline of a normal reporter but overrides the fragments execution so as to notify JUnit of the appropriate events

29. trait JUnitXmlExporting extends Exporting with JUnitXmlPrinter

    

    Trait for exporting the specification as JUnit xml files

30. trait JUnitXmlPrinter extends AnyRef

    

    The JUnitXml printer is used to create a JUnit xml report of an executed specification.

    The JUnitXml printer is used to create a JUnit xml report of an executed specification.

    To do this, it uses a reducer to prepare print blocks with:

    - the text to print - the statistics - the current arguments to use

31. trait JUnitXmlReporter extends DefaultReporter with JUnitXmlExporting with ConsoleOutput

    

    This trait execute specifications and exports them as JUnit xml files in the target/test-reports directory (by default).

32. case class Levels[T](levelsSeq: Vector[Level[T]] = Vector[Level[T]]()) extends Product with Serializable

    

    This class computes the 'level' of a given fragment.

    This class computes the 'level' of a given fragment. It is used to indent Fragments in a ConsoleReporter and to create a tree or Descriptions in the JUnit runner

    It does so by considering that some fragments have an effect on the indentation of the next fragment

    - a Text fragment is an Indent(1) so it indents the next fragment once - a Tab(n) fragment is an Indent(n) so it indents the next fragment n times - a Backtab(n) fragment is an Unindent(n) so it un-indents the next fragment n times - an Example fragment is a Terminal(), it doesn't do anything. This means that 2 consecutive examples will stay at the same level - an End fragment is a Reset, it set the level of the next fragment to 0 level

33. trait LineLogger extends AnyRef

    

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

34. trait LineLoggerOutput extends ResultOutput with LineLogger

    

    This outputs the textual results of an executed specification to a LineLogger

35. trait MarkdownExporting extends HtmlExporting

    

    Trait for exporting the specification as Markup files.

    Trait for exporting the specification as Markup files. It reuses most of the classes for writing html files but skips the markup conversion for text

36. trait MarkdownReporter extends DefaultReporter with MarkdownExporting with ConsoleOutput

    

    Reports a Specification as a markdown page

37. trait MessagesNotifier extends Notifier with StringOutput

    

38. trait NoExporting extends Exporter

    

    Null implementation for the Exporting trait

39. class NoResultOutput extends ResultOutput

    

    This output can be used for testing

40. case class NoStartOfArguments[T](value: T) extends ApplicableArguments[T] with Product with Serializable

    

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

42. trait NoStdOutAroundExample extends AroundExample

    

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

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

44. trait NotifierExporting extends Exporting with Exporters

    

45. trait NotifierReporter extends DefaultReporter with NotifierExporting

    

    Report a Specification by notifying execution events to a Notifier

46. trait Reporter extends Selection with Sequence with ExecutionStrategy with Storing with Exporting

    

    A Reporter will report the execution of a Specification following 3 steps:

    A Reporter will report the execution of a Specification following 3 steps:

    1. an extraction of the Fragments to report (like creating Descriptions for JUnit)

    • filtering out some elements if necessary

    2. an ordering of the Fragments to execute:

    • action steps must be executed in order
    • dependency between Fragments can be specified
    • other Fragments can be executed concurrently (unless specified otherwise)

    3. a reporting to:

    • the console (ConsoleRunner or sbt)
    • a listener object (junit or sbt)
    • a file (html, xml, junit-report)

47. trait ResultOutput extends AnyRef

    

    This traits provides specialised print methods for message representing different types of results.

    This traits provides specialised print methods for message representing different types of results. They can be overridden to define a more specific behaviour.

48. class SbtConsoleReporter extends ConsoleReporter with AllExporting

    

    Reporter for the test interface defined for sbt

    Reporter for the test interface defined for sbt

    It prints out the result to the output defined by the sbt loggers and publishes events to sbt event handlers

49. class SbtExporter extends TextExporting with Events

    

50. trait SbtLoggers extends AnyRef

    

51. class SbtResultOutput extends LineLoggerOutput with SbtLoggers

    

52. trait Selection extends AnyRef

    

    The Selection trait implements the logic for filtering the fragments to execute

53. trait Sequence extends AnyRef

    

    The Sequence trait implements the logic for the fragments to execute according to their dependencies

54. class SpecFailureAssertionFailedError extends AssertionFailedError

    

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

55. case class StartOfArguments[T](value: T, name: SpecName, args: Arguments) extends ApplicableArguments[T] with Product with Serializable

    

56. trait StatisticsRepository extends AnyRef

    

57. trait StatusSelection extends WithDefaultStatisticsRepository

    

    This trait selects examples based on their previous execution

58. trait Storing extends AnyRef

    

    This trait stores the results of an executed specification It also updates the statistics of:

    This trait stores the results of an executed specification It also updates the statistics of:

    • SpecStart fragments from SpecEnd fragments

59. trait TagSelection extends TagsAssociation

    

    This trait selects fragments based on their tags

60. class TestInterfaceReporter extends ConsoleReporter with HandlerEvents

    

    Reporter for the test interface defined for sbt

    Reporter for the test interface defined for sbt

    It prints out the result to the output defined by the sbt loggers and publishes events to sbt event handlers

61. class TestInterfaceResultOutput extends LineLoggerOutput with TestLoggers

    

62. trait TestLoggers extends AnyRef

    

63. trait TextExporting extends TextPrinter with Exporting

    

    This trait prints the executed fragments results and statistics at the end of the specification

64. trait TextPrinter extends AnyRef

    

    This trait reduces a list of ExecutedFragments to a list of PrintLines.

    This trait reduces a list of ExecutedFragments to a list of PrintLines.

    Each line contains: - A description (text or example description) - A level, to work out the indenting - Some statistics, to print on SpecEnd - The current arguments, to control the conditional printing of text, statistics,...

65. class TextReporter extends DefaultReporter with TextExporting

    

    This reporter can be used to get the result of a specification execution as a String

66. class TextResultOutput extends LineLoggerOutput with ConsoleOutput

    

    Implementation of the ResultOutput trait as Text

67. case class TreeToc(rootCode: SpecId, toc: NodeSeq = NodeSeq.Empty) extends Product with Serializable

    

    Table of contents, represented as a NodeSeq