Informer

Trait to which custom information about a running suite of tests can be reported.

An Informer is essentially used to wrap a Reporter and provide easy ways to send custom information to that Reporter via an InfoProvided event. Informer contains an apply method that takes a string and an optional payload object of type Any. The Informer will forward the passed message string to the Reporter as the message parameter, and the optional payload object as the payload parameter, of an InfoProvided event.

Here's an example in which the Informer is used both directly via info method of trait FlatSpec and indirectly via the methods of trait GivenWhenThen:

package org.scalatest.examples.flatspec.info

import collection.mutable
import org.scalatest._

class SetSpec extends FlatSpec with GivenWhenThen {

 "A mutable Set" should "allow an element to be added" in {
   given("an empty mutable Set")
   val set = mutable.Set.empty[String]

   when("an element is added")
   set += "clarity"

   then("the Set should have size 1")
   assert(set.size === 1)

   and("the Set should contain the added element")
   assert(set.contains("clarity"))

   info("That's all folks!")
 }
}

If you run this SetSpec from the interpreter, you will see the following output:

scala> org.scalatest.run(new SetSpec)
A mutable Set
- should allow an element to be added
 + Given an empty mutable Set
 + When an element is added
 + Then the Set should have size 1
 + And the Set should contain the added element
 + That's all folks!