All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • org.scalatest.FlatSpec.scala Maven / Gradle / Ivy

    Go to download

    ScalaTest is a free, open-source testing toolkit for Scala and Java programmers.

    The newest version!
    /*
 * Copyright 2001-2009 Artima, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.scalatest

import verb.{ResultOfTaggedAsInvocation, ResultOfStringPassedToVerb, BehaveWord, ShouldVerb, MustVerb, CanVerb}
import NodeFamily._
import scala.collection.immutable.ListSet
import org.scalatest.StackDepthExceptionHelper.getStackDepth
import java.util.concurrent.atomic.AtomicReference
import java.util.ConcurrentModificationException
import org.scalatest.events._
import Suite.anErrorThatShouldCauseAnAbort

/**
 * Trait that facilitates a “behavior-driven” style of development (BDD), in which tests
 * are combined with text that specifies the behavior the tests verify.
 * (In BDD, the word example is usually used instead of test. The word test will not appear
 * in your code if you use FlatSpec, so if you prefer the word example you can use it. However, in this documentation
 * the word test will be used, for clarity and to be consistent with the rest of ScalaTest.)
 * Trait FlatSpec is so named because
 * your specification text and tests line up flat against the left-side indentation level, with no nesting needed.
 * 
    
 *
 * 
    
 * FlatSpec's no-nesting approach contrasts with traits Spec and WordSpec, which use nesting
 * to reduce duplication of specification text. Although nesting does have the advantage of reducing text duplication,
 * figuring out the full specification text for one test can require back-tracking out of several levels of nesting, mentally prepending
 * each fragment of text encountered. Thus the tradeoff with the nesting approach of Spec and WordSpec is that
 * they have less duplicated text at the cost of being a bit challenging to read. Trait FlatSpec offers the opposite
 * tradeoff. In a FlatSpec text is duplicated more, but figuring out the full specification text for a particular test is
 * easier. Here's an example FlatSpec:
 * 
    
 *
 * 
     * import org.scalatest.FlatSpec
 * import scala.collection.mutable.Stack
 *
 * class StackSpec extends FlatSpec {
 *
 *   behavior of "A Stack"
 *
 *   it should "pop values in last-in-first-out order" in {
 *     val stack = new Stack[Int]
 *     stack.push(1)
 *     stack.push(2)
 *     assert(stack.pop() === 2)
 *     assert(stack.pop() === 1)
 *   }
 *
 *   it should "throw NoSuchElementException if an empty stack is popped" in {
 *     val emptyStack = new Stack[String]
 *     intercept[NoSuchElementException] {
 *       emptyStack.pop()
 *     }
 *   }
 * }
 * 
    
 *
 * 
    
 * Note: you can you must or can as well as should in a FlatSpec. For example, instead of
 * it should "pop..., you could write it must "pop... or it can "pop....
 * 
    
 *
 * 
    
 * Instead of using a behavior of clause, you can alternatively use a shorthand syntax in which you replace
 * the first it with the subject string, like this:
 * 
    
 *
 * 
     * import org.scalatest.FlatSpec
 * import scala.collection.mutable.Stack
 *
 * class StackSpec extends FlatSpec {
 *
 *   "A Stack" should "pop values in last-in-first-out order" in {
 *     val stack = new Stack[Int]
 *     stack.push(1)
 *     stack.push(2)
 *     assert(stack.pop() === 2)
 *     assert(stack.pop() === 1)
 *   }
 *
 *   it should "throw NoSuchElementException if an empty stack is popped" in {
 *     val emptyStack = new Stack[String]
 *     intercept[NoSuchElementException] {
 *       emptyStack.pop()
 *     }
 *   }
 * }
 * 
    
 *
 * 
    
 * Running either of the two previous three versions of StackSpec in the Scala interpreter would yield:
 * 
    
 * 
 * 
     * A Stack
 * - should pop values in last-in-first-out order
 * - should throw NoSuchElementException if an empty stack is popped
 * 
    
 *
 * 
    
 * In a FlatSpec you write a one (or more) sentence specification for each bit of behavior you wish to
 * specify and test. Each specification sentence has a
 * "subject," which is sometimes called the system under test (or SUT). The 
 * subject is the entity being specified and tested and also serves as the subject of the sentences you write for each test.
 * Often you will want to write multiple tests for the same subject. In a FlatSpec, you name the subject once,
 * with a behavior of clause or its shorthand, then write tests for that subject with it should/mustcan "do something" phrases.
 * Each it refers to the most recently declared subject. For example, the four tests shown in this snippet are all testing
 * a stack that contains one item:
 * 
    
 * 
 * 
     * behavior of "A Stack (with one item)"
 *
 * it should "be non-empty" in {}
 *
 * it should "return the top item on peek" in {}
 *
 * it should "not remove the top item on peek" in {}
 *
 * it should "remove the top item on pop" in {}
 * 
    
 * 
 * 
    
 * The same is true if the tests are written using the shorthand notation:
 * 
    
 *
 * 
     * "A Stack (with one item)" should "be non-empty" in {}
 *
 * it should "return the top item on peek" in {}
 *
 * it should "not remove the top item on peek" in {}
 *
 * it should "remove the top item on pop" in {}
 * 
    
 * 
 * 
    
 * In a FlatSpec, therefore, to figure out what "it" means, you just scan vertically until you find the most
 * recent use of behavior of or the shorthand notation.
 * 
    
 *
 * 
    
 * A FlatSpec's lifecycle has two phases: the registration phase and the
 * ready phase. It starts in registration phase and enters ready phase the first time
 * run is called on it. It then remains in ready phase for the remainder of its lifetime.
 * 
    
 *
 * 
    
 * Tests can only be registered while the FlatSpec is
 * in its registration phase. Any attempt to register a test after the FlatSpec has
 * entered its ready phase, i.e., after run has been invoked on the FlatSpec,
 * will be met with a thrown TestRegistrationClosedException. The recommended style
 * of using FlatSpec is to register tests during object construction as is done in all
 * the examples shown here. If you keep to the recommended style, you should never see a
 * TestRegistrationClosedException.
 * 
    
 *
 * 
    Shared fixtures
    
 *
 * 
    
 * A test fixture is objects or other artifacts (such as files, sockets, database
 * connections, etc.) used by tests to do their work. You can use fixtures in
 * FlatSpecs with the same approaches suggested for Suite in
 * its documentation. The same text that appears in the test fixture
 * section of Suite's documentation is repeated here, with examples changed from
 * Suite to FlatSpec.
 * 
    
 *
 * 
    
 * If a fixture is used by only one test, then the definitions of the fixture objects can
 * be local to the test function, such as the objects assigned to stack and emptyStack in the
 * previous StackSpec examples. If multiple tests need to share an immutable fixture, one approach
 * is to assign them to instance variables. Here's a (very contrived) example, in which the object assigned
 * to shared is used by multiple test functions:
 * 
    
 *
 * 
     * import org.scalatest.FlatSpec
 *
 * class ArithmeticSpec extends FlatSpec {
 *
 *   // Sharing immutable fixture objects via instance variables
 *   val shared = 5
 *
 *  "The Scala language" must "add correctly" in {
 *     val sum = 2 + 3
 *     assert(sum === shared)
 *   }
 *
 *   it must "subtract correctly" in {
 *     val diff = 7 - 2
 *     assert(diff === shared)
 *   }
 * }
 * 
    
 *
 * 
    
 * In some cases, however, shared mutable fixture objects may be changed by tests such that
 * they need to be recreated or reinitialized before each test. Shared resources such
 * as files or database connections may also need to be created and initialized before, and
 * cleaned up after, each test. JUnit offers methods setUp and
 * tearDown for this purpose. In ScalaTest, you can use the BeforeAndAfterEach trait,
 * which will be described later, to implement an approach similar to JUnit's setUp
 * and tearDown, however, this approach often involves reassigning vars
 * between tests. Before going that route, you should consider some approaches that
 * avoid vars. One approach is to write one or more create-fixture methods
 * that return a new instance of a needed object (or a tuple or case class holding new instances of
 * multiple objects) each time it is called. You can then call a create-fixture method at the beginning of each
 * test that needs the fixture, storing the fixture object or objects in local variables. Here's an example:
 * 
    
 *
 * 
     * import org.scalatest.FlatSpec
 * import scala.collection.mutable.ListBuffer
 *
 * class MySuite extends FlatSpec {
 *
 *   // create objects needed by tests and return as a tuple
 *   def createFixture = (
 *     new StringBuilder("ScalaTest is "),
 *     new ListBuffer[String]
 *   )
 *
 *  "ScalaTest" can "be easy " in {
 *     val (builder, lbuf) = createFixture
 *     builder.append("easy!")
 *     assert(builder.toString === "ScalaTest is easy!")
 *     assert(lbuf.isEmpty)
 *     lbuf += "sweet"
 *   }
 *
 *   it can "be fun" in {
 *     val (builder, lbuf) = createFixture
 *     builder.append("fun!")
 *     assert(builder.toString === "ScalaTest is fun!")
 *     assert(lbuf.isEmpty)
 *   }
 * }
 * 
    
 *
 * 
    
 * If different tests in the same FlatSpec require different fixtures, you can create multiple create-fixture methods and
 * call the method (or methods) needed by each test at the begining of the test. If every test requires the same set of
 * mutable fixture objects, one other approach you can take is make them simply vals and mix in trait
 * OneInstancePerTest.  If you mix in OneInstancePerTest, each test
 * will be run in its own instance of the FlatSpec, similar to the way JUnit tests are executed.
 * 
    
 *
 * 
    
 * Although the create-fixture and OneInstancePerTest approaches take care of setting up a fixture before each
 * test, they don't address the problem of cleaning up a fixture after the test completes. In this situation,
 * one option is to mix in the BeforeAndAfterEach trait.
 * BeforeAndAfterEach's beforeEach method will be run before, and its afterEach
 * method after, each test (like JUnit's setUp  and tearDown
 * methods, respectively). 
 * For example, you could create a temporary file before each test, and delete it afterwords, like this:
 * 
    
 *
 * 
     * import org.scalatest.FlatSpec
 * import org.scalatest.BeforeAndAfterEach
 * import java.io.FileReader
 * import java.io.FileWriter
 * import java.io.File
 *
 * class MySuite extends FlatSpec with BeforeAndAfterEach {
 *
 *   private val FileName = "TempFile.txt"
 *   private var reader: FileReader = _
 *
 *   // Set up the temp file needed by the test
 *   override def beforeEach() {
 *     val writer = new FileWriter(FileName)
 *     try {
 *       writer.write("Hello, test!")
 *     }
 *     finally {
 *       writer.close()
 *     }
 *
 *     // Create the reader needed by the test
 *     reader = new FileReader(FileName)
 *   }
 *
 *   // Close and delete the temp file
 *   override def afterEach() {
 *     reader.close()
 *     val file = new File(FileName)
 *     file.delete()
 *   }
 *
 *  "A FileReader" should "read in the contents of a file correctly" in {
 *     var builder = new StringBuilder
 *     var c = reader.read()
 *     while (c != -1) {
 *       builder.append(c.toChar)
 *       c = reader.read()
 *     }
 *     assert(builder.toString === "Hello, test!")
 *   }
 * 
 *   it should "read in the first character of a file correctly" in {
 *     assert(reader.read() === 'H')
 *   }
 * 
 *   it should "work without a fixture" in {
 *     assert(1 + 1 === 2)
 *   }
 * }
 * 
    
 *
 * 
    
 * In this example, the instance variable reader is a var, so
 * it can be reinitialized between tests by the beforeEach method.
 * 
    
 * 
 * 
    
 * Although the BeforeAndAfterEach approach should be familiar to the users of most
 * test other frameworks, ScalaTest provides another alternative that also allows you to perform cleanup
 * after each test: overriding withFixture(NoArgTest).
 * To execute each test, Suite's implementation of the runTest method wraps an invocation
 * of the appropriate test method in a no-arg function. runTest passes that test function to the withFixture(NoArgTest)
 * method, which is responsible for actually running the test by invoking the function. Suite's
 * implementation of withFixture(NoArgTest) simply invokes the function, like this:
 * 
    
 *
 * 
     * // Default implementation
 * protected def withFixture(test: NoArgTest) {
 *   test()
 * }
 * 
    
 *
 * 
    
 * The withFixture(NoArgTest) method exists so that you can override it and set a fixture up before, and clean it up after, each test.
 * Thus, the previous temp file example could also be implemented without mixing in BeforeAndAfterEach, like this:
 * 
    
 *
 * 
     * import org.scalatest.FlatSpec
 * import org.scalatest.BeforeAndAfterEach
 * import java.io.FileReader
 * import java.io.FileWriter
 * import java.io.File
 *
 * class MySuite extends FlatSpec {
 *
 *   private var reader: FileReader = _
 *
 *   override def withFixture(test: NoArgTest) {
 *
 *     val FileName = "TempFile.txt"
 *
 *     // Set up the temp file needed by the test
 *     val writer = new FileWriter(FileName)
 *     try {
 *       writer.write("Hello, test!")
 *     }
 *     finally {
 *       writer.close()
 *     }
 *
 *     // Create the reader needed by the test
 *     reader = new FileReader(FileName)
 *
 *     try {
 *       test() // Invoke the test function
 *     }
 *     finally {
 *       // Close and delete the temp file
 *       reader.close()
 *       val file = new File(FileName)
 *       file.delete()
 *     }
 *   }
 *
 *  "A FileReader" should "read in the contents of a file correctly" in {
 *     var builder = new StringBuilder
 *     var c = reader.read()
 *     while (c != -1) {
 *       builder.append(c.toChar)
 *       c = reader.read()
 *     }
 *     assert(builder.toString === "Hello, test!")
 *   }
 * 
 *   it should "read in the first character of a file correctly" in {
 *     assert(reader.read() === 'H')
 *   }
 * 
 *   it should "work without a fixture" in {
 *     assert(1 + 1 === 2)
 *   }
 * }
 * 
    
 *
 * 
    
 * If you prefer to keep your test classes immutable, one final variation is to use the
 * FixtureFlatSpec trait from the
 * org.scalatest.fixture package.  Tests in an org.scalatest.fixture.FixtureFlatSpec can have a fixture
 * object passed in as a parameter. You must indicate the type of the fixture object
 * by defining the Fixture type member and define a withFixture method that takes a one-arg test function.
 * (A FixtureFlatSpec has two overloaded withFixture methods, therefore, one that takes a OneArgTest
 * and the other, inherited from Suite, that takes a NoArgTest.)
 * Inside the withFixture(OneArgTest) method, you create the fixture, pass it into the test function, then perform any
 * necessary cleanup after the test function returns. Instead of invoking each test directly, a FixtureFlatSpec will
 * pass a function that invokes the code of a test to withFixture(OneArgTest). Your withFixture(OneArgTest) method, therefore,
 * is responsible for actually running the code of the test by invoking the test function.
 * For example, you could pass the temp file reader fixture to each test that needs it
 * by overriding the withFixture(OneArgTest) method of a FixtureFlatSpec, like this:
 * 
    
 *
 * 
     * import org.scalatest.fixture.FixtureFlatSpec
 * import java.io.FileReader
 * import java.io.FileWriter
 * import java.io.File
 * 
 * class MySuite extends FixtureFlatSpec {
 *
 *   type FixtureParam = FileReader
 *
 *   def withFixture(test: OneArgTest) {
 *
 *     val FileName = "TempFile.txt"
 *
 *     // Set up the temp file needed by the test
 *     val writer = new FileWriter(FileName)
 *     try {
 *       writer.write("Hello, test!")
 *     }
 *     finally {
 *       writer.close()
 *     }
 *
 *     // Create the reader needed by the test
 *     val reader = new FileReader(FileName)
 *  
 *     try {
 *       // Run the test using the temp file
 *       test(reader)
 *     }
 *     finally {
 *       // Close and delete the temp file
 *       reader.close()
 *       val file = new File(FileName)
 *       file.delete()
 *     }
 *   }
 * 
 *  "A FileReader" should "read in the contents of a file correctly" in { reader =>
 *     var builder = new StringBuilder
 *     var c = reader.read()
 *     while (c != -1) {
 *       builder.append(c.toChar)
 *       c = reader.read()
 *     }
 *     assert(builder.toString === "Hello, test!")
 *   }
 * 
 *   it should "read in the first character of a file correctly" in { reader =>
 *     assert(reader.read() === 'H')
 *   }
 * 
 *   it should "work without a fixture" in { () =>
 *     assert(1 + 1 === 2)
 *   }
 * }
 * 
    
 *
 * 
    
 * It is worth noting that the only difference in the test code between the mutable
 * BeforeAndAfterEach approach shown here and the immutable FixtureFlatSpec
 * approach shown previously is that two of the FixtureFlatSpec's test functions take a FileReader as
 * a parameter via the "reader =>" at the beginning of the function. Otherwise the test code is identical.
 * One benefit of the explicit parameter is that, as demonstrated
 * by the "it should work without a fixture" test, a FixtureFlatSpec
 * test need not take the fixture. So you can have some tests that take a fixture, and others that don't.
 * In this case, the FixtureFlatSpec provides documentation indicating which
 * tests use the fixture and which don't, whereas the BeforeAndAfterEach approach does not.
 * (If you have want to combine tests that take different fixture types in the same FlatSpec, you can
 * use MultipleFixtureFlatSpec.)
 * 
    
 *
 * 
    
 * If you want to execute code before and after all tests (and nested suites) in a suite, such
 * as you could do with @BeforeClass and @AfterClass
 * annotations in JUnit 4, you can use the beforeAll and afterAll
 * methods of BeforeAndAfterAll. See the documentation for BeforeAndAfterAll for
 * an example.
 * 
    
 *
 * 
    Shared tests
    
 *
 * 
    
 * Sometimes you may want to run the same test code on different fixture objects. In other words, you may want to write tests that are "shared"
 * by different fixture objects.  To accomplish this in a FlatSpec, you first place shared tests in behavior functions.
 * These behavior functions will be invoked during the construction phase of any FlatSpec that uses them, so that the tests they
 * contain will be registered as tests in that FlatSpec.  For example, given this stack class:
 * 
    
 *
 * 
     * import scala.collection.mutable.ListBuffer
 * 
 * class Stack[T] {
 *
 *   val MAX = 10
 *   private var buf = new ListBuffer[T]
 *
 *   def push(o: T) {
 *     if (!full)
 *       o +: buf
 *     else
 *       throw new IllegalStateException("can't push onto a full stack")
 *   }
 *
 *   def pop(): T = {
 *     if (!empty)
 *       buf.remove(0)
 *     else
 *       throw new IllegalStateException("can't pop an empty stack")
 *   }
 *
 *   def peek: T = {
 *     if (!empty)
 *       buf(0)
 *     else
 *       throw new IllegalStateException("can't pop an empty stack")
 *   }
 *
 *   def full: Boolean = buf.size == MAX
 *   def empty: Boolean = buf.size == 0
 *   def size = buf.size
 *
 *   override def toString = buf.mkString("Stack(", ", ", ")")
 * }
 * 
    
 *
 * 
    
 * You may want to test the Stack class in different states: empty, full, with one item, with one item less than capacity,
 * etc. You may find you have several tests that make sense any time the stack is non-empty. Thus you'd ideally want to run
 * those same tests for three stack fixture objects: a full stack, a stack with a one item, and a stack with one item less than
 * capacity. With shared tests, you can factor these tests out into a behavior function, into which you pass the
 * stack fixture to use when running the tests. So in your FlatSpec for stack, you'd invoke the
 * behavior function three times, passing in each of the three stack fixtures so that the shared tests are run for all three fixtures. You
 * can define a behavior function that encapsulates these shared tests inside the FlatSpec that uses them. If they are shared
 * between different FlatSpecs, however, you could also define them in a separate trait that is mixed into each FlatSpec
 * that uses them.
 * 
    
 *
 * 
    
 * For example, here the nonEmptyStack behavior function (in this case, a behavior method) is
 * defined in a trait along with another method containing shared tests for non-full stacks:
 * 
    
 * 
 * 
     * trait StackBehaviors { this: FlatSpec =>
 * 
 *   def nonEmptyStack(stack: Stack[Int], lastItemAdded: Int) {
 * 
 *     it should "be non-empty" in {
 *       assert(!stack.empty)
 *     }  
 * 
 *     it should "return the top item on peek" in {
 *       assert(stack.peek === lastItemAdded)
 *     }
 *   
 *     it should "not remove the top item on peek" in {
 *       val size = stack.size
 *       assert(stack.peek === lastItemAdded)
 *       assert(stack.size === size)
 *     }
 *   
 *     it should "remove the top item on pop" in {
 *       val size = stack.size
 *       assert(stack.pop === lastItemAdded)
 *       assert(stack.size === size - 1)
 *     }
 *   }
 *   
 *   def nonFullStack(stack: Stack[Int]) {
 *       
 *     it should "not be full" in {
 *       assert(!stack.full)
 *     }
 *       
 *     it should "add to the top on push" in {
 *       val size = stack.size
 *       stack.push(7)
 *       assert(stack.size === size + 1)
 *       assert(stack.peek === 7)
 *     }
 *   }
 * }
 * 
    
 *
 *
 * 
    
 * Given these behavior functions, you could invoke them directly, but FlatSpec offers a DSL for the purpose,
 * which looks like this:
 * 
    
 *
 * 
     * it should behave like nonEmptyStack(stackWithOneItem, lastValuePushed)
 * it should behave like nonFullStack(stackWithOneItem)
 * 
    
 *
 * 
    
 * If you prefer to use an imperative style to change fixtures, for example by mixing in BeforeAndAfterEach and
 * reassigning a stack var in beforeEach, you could write your behavior functions
 * in the context of that var, which means you wouldn't need to pass in the stack fixture because it would be
 * in scope already inside the behavior function. In that case, your code would look like this:
 * 
    
 *
 * 
     * it should behave like nonEmptyStack // assuming lastValuePushed is also in scope inside nonEmptyStack
 * it should behave like nonFullStack
 * 
    
 *
 * 
    
 * The recommended style, however, is the functional, pass-all-the-needed-values-in style. Here's an example:
 * 
    
 *
 * 
     * class SharedTestExampleSpec extends FlatSpec with StackBehaviors {
 * 
 *   // Stack fixture creation methods
 *   def emptyStack = new Stack[Int]
 * 
 *   def fullStack = {
 *     val stack = new Stack[Int]
 *     for (i <- 0 until stack.MAX)
 *       stack.push(i)
 *     stack
 *   }
 * 
 *   def stackWithOneItem = {
 *     val stack = new Stack[Int]
 *     stack.push(9)
 *     stack
 *   }
 * 
 *   def stackWithOneItemLessThanCapacity = {
 *     val stack = new Stack[Int]
 *     for (i <- 1 to 9)
 *       stack.push(i)
 *     stack
 *   }
 * 
 *   val lastValuePushed = 9
 * 
 *   "A Stack (when empty)" should "be empty" in {
 *     assert(emptyStack.empty)
 *   }
 * 
 *   it should "complain on peek" in {
 *     intercept[IllegalStateException] {
 *       emptyStack.peek
 *     }
 *   }
 *
 *   it should "complain on pop" in {
 *     intercept[IllegalStateException] {
 *       emptyStack.pop
 *     }
 *   }
 * 
 *   "A Stack (with one item)" should behave like nonEmptyStack(stackWithOneItem, lastValuePushed)
 *
 *   it should behave like nonFullStack(stackWithOneItem)
 *     
 *   "A Stack (with one item less than capacity)" should behave like nonEmptyStack(stackWithOneItemLessThanCapacity, lastValuePushed)
 *
 *   it should behave like nonFullStack(stackWithOneItemLessThanCapacity)
 * 
 *   "A Stack (full)" should "be full" in {
 *     assert(fullStack.full)
 *   }
 * 
 *   it should behave like nonEmptyStack(fullStack, lastValuePushed)
 * 
 *   it should "complain on a push" in {
 *     intercept[IllegalStateException] {
 *       fullStack.push(10)
 *     }
 *   }
 * }
 * 
    
 *
 * 
    
 * If you load these classes into the Scala interpreter (with scalatest's JAR file on the class path), and execute it,
 * you'll see:
 * 
    
 *
 * 
     * scala> (new SharedTestExampleSpec).execute()
 * A Stack (when empty) 
 * - should be empty
 * - should complain on peek
 * - should complain on pop
 * A Stack (with one item) 
 * - should be non-empty
 * - should return the top item on peek
 * - should not remove the top item on peek
 * - should remove the top item on pop
 * - should not be full
 * - should add to the top on push
 * A Stack (with one item less than capacity) 
 * - should be non-empty
 * - should return the top item on peek
 * - should not remove the top item on peek
 * - should remove the top item on pop
 * - should not be full
 * - should add to the top on push
 * A Stack (full) 
 * - should be full
 * - should be non-empty
 * - should return the top item on peek
 * - should not remove the top item on peek
 * - should remove the top item on pop
 * - should complain on a push
 * 
    
 * 
 * 
    
 * One thing to keep in mind when using shared tests is that in ScalaTest, each test in a suite must have a unique name.
 * If you register the same tests repeatedly in the same suite, one problem you may encounter is an exception at runtime
 * complaining that multiple tests are being registered with the same test name. A good way to solve this problem in a WordSpec is to make sure
 * each invocation of a behavior function is in the context of a different set of when, verb (should,
 * must, or can), and that clauses,
 * which will prepend a string to each test name.
 * For example, the following code in a WordSpec would register a test with the name "A Stack (when empty) should be empty":
 * 
    
 *
 * 
     *   behavior of "A Stack (when empty)"
 *       
 *   it should "be empty" in {
 *     assert(emptyStack.empty)
 *   }
 *   // ...
 * 
    
 *
 * 
    
 * Or, using the shorthand notation:
 * 
    
 *
 * 
     *   "A Stack" when {
 *     "empty" should {
 *       "be empty" in {
 *         assert(emptyStack.empty)
 *       }
 *     }
 *   }
 *   // ...
 * 
    
 *
 * 
    
 * If the "should be empty" test was factored out into a behavior function, it could be called repeatedly so long
 * as each invocation of the behavior function is in the context of a different combination
 * of when, verb, and that clauses.
 * 
    
 *
 * 
    Tagging tests
    
 *
 * A FlatSpec's tests may be classified into groups by tagging them with string names.
 * As with any suite, when executing a FlatSpec, groups of tests can
 * optionally be included and/or excluded. To tag a FlatSpec's tests,
 * you pass objects that extend abstract class org.scalatest.Tag to taggedAs method
 * invoked on the string that describes the test you want to tag. Class Tag takes one parameter,
 * a string name.  If you have
 * created Java annotation interfaces for use as group names in direct subclasses of org.scalatest.Suite,
 * then you will probably want to use group names on your FlatSpecs that match. To do so, simply 
 * pass the fully qualified names of the Java interfaces to the Tag constructor. For example, if you've
 * defined Java annotation interfaces with fully qualified names, com.mycompany.groups.SlowTest and com.mycompany.groups.DbTest, then you could
 * create matching groups for Specs like this:
 * 
    
 *
 * 
     * import org.scalatest.Tag
 *
 * object SlowTest extends Tag("com.mycompany.groups.SlowTest")
 * object DbTest extends Tag("com.mycompany.groups.DbTest")
 * 
    
 *
 * 
    
 * Given these definitions, you could place FlatSpec tests into groups like this:
 * 
    
 *
 * 
     * import org.scalatest.FlatSpec
 *
 * class MySuite extends FlatSpec {
 *
 *   "The Scala language" must "add correctly" taggedAs(SlowTest) in {
 *       val sum = 1 + 1
 *       assert(sum === 2)
 *       assert(sum + 2 === 4)
 *     }
 *
 *   it must "subtract correctly" taggedAs(SlowTest, DbTest) in {
 *     val diff = 4 - 1
 *     assert(diff === 3)
 *     assert(diff - 2 === 1)
 *   }
 * }
 * 
    
 *
 * 
    
 * This code marks both tests with the com.mycompany.groups.SlowTest tag, 
 * and test "The Scala language should subtract correctly" with the com.mycompany.groups.DbTest tag.
 * 
    
 *
 * 
    
 * The primary run method takes a Filter, whose constructor takes an optional
 * Set[String]s called tagsToInclude and a Set[String] called
 * tagsToExclude. If tagsToInclude is None, all tests will be run
 * except those those belonging to tags listed in the
 * tagsToExclude Set. If tagsToInclude is defined, only tests
 * belonging to tags mentioned in the tagsToInclude set, and not mentioned in tagsToExclude,
 * will be run.
 * 
    
 *
 * 
    Ignored tests
    
 *
 * To support the common use case of “temporarily” disabling a test, with the
 * good intention of resurrecting the test at a later time, FlatSpec provides a method
 * ignore that can be used instead of it to register a test. For example, to temporarily
 * disable the test with the name "A Stack should throw NoSuchElementException if an empty stack is popped", just
 * change “it” into “ignore,” like this:
 * 
    
 *
 * 
     * import org.scalatest.FlatSpec
 * import scala.collection.mutable.Stack
 *
 * class StackSpec extends FlatSpec {
 *
 *   "A Stack" should "pop values in last-in-first-out order" in {
 *       val stack = new Stack[Int]
 *       stack.push(1)
 *       stack.push(2)
 *       assert(stack.pop() === 2)
 *       assert(stack.pop() === 1)
 *     }
 *
 *   ignore should "throw NoSuchElementException if an empty stack is popped" in {
 *     val emptyStack = new Stack[String]
 *     intercept[NoSuchElementException] {
 *       emptyStack.pop()
 *     }
 *   }
 * }
 * 
    
 *
 * 
    
 * If you run this version of StackSpec with:
 * 
    
 *
 * 
     * scala> (new StackSpec).execute()
 * 
    
 *
 * 
    
 * It will run only the first test and report that the second test was ignored:
 * 
    
 *
 * 
     * A Stack
 * - should pop values in last-in-first-out order
 * - should throw NoSuchElementException if an empty stack is popped !!! IGNORED !!!
 * 
    
 *
 * 
    
 * When using shorthand notation, you won't have an it to change into ignore for
 * the first test of each new subject. To ignore such tests, you must instead change in to ignore.
 * For example, to temporarily disable the test with the name "A Stack should pop values in last-in-first-out order",
 * change “in” into “ignore” like this:
 * 
    
 *
 * 
     * import org.scalatest.FlatSpec
 * import scala.collection.mutable.Stack
 *
 * class StackSpec extends FlatSpec {
 *
 *   "A Stack" should "pop values in last-in-first-out order" ignore {
 *       val stack = new Stack[Int]
 *       stack.push(1)
 *       stack.push(2)
 *       assert(stack.pop() === 2)
 *       assert(stack.pop() === 1)
 *     }
 *
 *   it should "throw NoSuchElementException if an empty stack is popped" in {
 *     val emptyStack = new Stack[String]
 *     intercept[NoSuchElementException] {
 *       emptyStack.pop()
 *     }
 *   }
 * }
 * 
    
 *
 * 
    
 * If you run this version of StackSpec with:
 * 
    
 *
 * 
     * scala> (new StackSpec).execute()
 * 
    
 *
 * 
    
 * It will run only the second test and report that the first test was ignored:
 * 
    
 *
 * 
     * A Stack
 * - should pop values in last-in-first-out order !!! IGNORED !!!
 * - should throw NoSuchElementException if an empty stack is popped
 * 
    
 *
 * 
    Informers
    
 *
 * 
    
 * One of the parameters to the primary run method is a Reporter, which
 * will collect and report information about the running suite of tests.
 * Information about suites and tests that were run, whether tests succeeded or failed, 
 * and tests that were ignored will be passed to the Reporter as the suite runs.
 * Most often the reporting done by default by FlatSpec's methods will be sufficient, but
 * occasionally you may wish to provide custom information to the Reporter from a test.
 * For this purpose, an Informer that will forward information to the current Reporter
 * is provided via the info parameterless method.
 * You can pass the extra information to the Informer via its apply method.
 * The Informer will then pass the information to the Reporter via an InfoProvided event.
 * Here's an example:
 * 
    
 *
 * 
     * import org.scalatest.FlatSpec
 *
 * class ArithmeticSpec extends FlatSpec {
 *
 *  "The Scala language" must "add correctly" in {
 *     val sum = 2 + 3
 *     assert(sum === 5)
 *     info("addition seems to work")
 *   }
 *
 *   it must "subtract correctly" in {
 *     val diff = 7 - 2
 *     assert(diff === 5)
 *   }
 * }
 * 
    
 *
 * 
    
 * If you run this FlatSpec from the interpreter, you will see the following message
 * included in the printed report:
 * 
    
 *
 * 
     * scala> (new ArithmeticSpec).execute()
 * The Scala language 
 * - must add correctly
 *   + addition seems to work 
 * - must subtract correctly
 * 
    
 *
 * 
    
 * One use case for the Informer is to pass more information about a specification to the reporter. For example,
 * the GivenWhenThen trait provides methods that use the implicit info provided by FlatSpec
 * to pass such information to the reporter. Here's an example:
 * 
    
 *
 * 
     * import org.scalatest.FlatSpec
 * import org.scalatest.GivenWhenThen
 * 
 * class ArithmeticSpec extends FlatSpec with GivenWhenThen {
 * 
 *  "The Scala language" must "add correctly" in { 
 * 
 *     given("two integers")
 *     val x = 2
 *     val y = 3
 * 
 *     when("they are added")
 *     val sum = x + y
 * 
 *     then("the result is the sum of the two numbers")
 *     assert(sum === 5)
 *   }
 * 
 *   it must "subtract correctly" in {
 * 
 *     given("two integers")
 *     val x = 7
 *     val y = 2
 * 
 *     when("one is subtracted from the other")
 *     val diff = x - y
 * 
 *     then("the result is the difference of the two numbers")
 *     assert(diff === 5)
 *   }
 * }
 * 
    
 *
 * 
     * scala> (new ArithmeticSpec).execute()
 * The Scala language 
 * - must add correctly
 *   + Given two integers 
 *   + When they are added 
 *   + Then the result is the sum of the two numbers 
 * - must subtract correctly
 *   + Given two integers 
 *   + When one is subtracted from the other 
 *   + Then the result is the difference of the two numbers 
 * 
    
 *
 * 
    Pending tests
    
 *
 * 
    
 * A pending test is one that has been given a name but is not yet implemented. The purpose of
 * pending tests is to facilitate a style of testing in which documentation of behavior is sketched
 * out before tests are written to verify that behavior (and often, the before the behavior of
 * the system being tested is itself implemented). Such sketches form a kind of specification of
 * what tests and functionality to implement later.
 * 
    
 *
 * 
    
 * To support this style of testing, a test can be given a name that specifies one
 * bit of behavior required by the system being tested. The test can also include some code that
 * sends more information about the behavior to the reporter when the tests run. At the end of the test,
 * it can call method pending, which will cause it to complete abruptly with TestPendingException.
 * Because tests in ScalaTest can be designated as pending with TestPendingException, both the test name and any information
 * sent to the reporter when running the test can appear in the report of a test run. (In other words,
 * the code of a pending test is executed just like any other test.) However, because the test completes abruptly
 * with TestPendingException, the test will be reported as pending, to indicate
 * the actual test, and possibly the functionality it is intended to test, has not yet been implemented.
 * You can mark tests as pending in FlatSpec like this:
 * 
    
 *
 * 
     * import org.scalatest.FlatSpec
 *
 * class ArithmeticSpec extends FlatSpec {
 *
 *   // Sharing fixture objects via instance variables
 *   val shared = 5
 *
 *  "The Scala language" must "add correctly" in {
 *     val sum = 2 + 3
 *     assert(sum === shared)
 *   }
 *
 *   it must "subtract correctly" is (pending)
 * }
 * 
    
 *
 * 
    
 * If you run this version of ArithmeticSpec with:
 * 
    
 *
 * 
     * scala> (new ArithmeticSpec).execute()
 * 
    
 *
 * 
    
 * It will run both tests but report that The Scala language must subtract correctly is pending. You'll see:
 * 
    
 *
 * 
     * The Scala language
 * - must add correctly
 * - must subtract correctly (pending)
 * 
    
 * 
 * 
    
 * One difference between an ignored test and a pending one is that an ignored test is intended to be used during a
 * significant refactorings of the code under test, when tests break and you don't want to spend the time to fix
 * all of them immediately. You can mark some of those broken tests as ignored temporarily, so that you can focus the red
 * bar on just failing tests you actually want to fix immediately. Later you can go back and fix the ignored tests.
 * In other words, by ignoring some failing tests temporarily, you can more easily notice failed tests that you actually
 * want to fix. By contrast, a pending test is intended to be used before a test and/or the code under test is written.
 * Pending indicates you've decided to write a test for a bit of behavior, but either you haven't written the test yet, or
 * have only written part of it, or perhaps you've written the test but don't want to implement the behavior it tests
 * until after you've implemented a different bit of behavior you realized you need first. Thus ignored tests are designed
 * to facilitate refactoring of existing code whereas pending tests are designed to facilitate the creation of new code.
 * 
    
 *
 * 
    
 * One other difference between ignored and pending tests is that ignored tests are implemented as a test tag that is
 * excluded by default. Thus an ignored test is never executed. By contrast, a pending test is implemented as a
 * test that throws TestPendingException (which is what calling the pending method does). Thus
 * the body of pending tests are executed up until they throw TestPendingException. The reason for this difference
 * is that it enables your unfinished test to send InfoProvided messages to the reporter before it completes
 * abruptly with TestPendingException, as shown in the previous example on Informers
 * that used the GivenWhenThen trait. For example, the following snippet in a FlatSpec:
 * 
    
 *
 * 
     *  "The Scala language" must "add correctly" in { 
 *     given("two integers")
 *     when("they are added")
 *     then("the result is the sum of the two numbers")
 *     pending
 *   }
 *   // ...
 * 
    
 *
 * 
    
 * Would yield the following output when run in the interpreter:
 * 
    
 *
 * 
     * The Scala language
 * - must add correctly (pending)
 *   + Given two integers 
 *   + When they are added 
 *   + Then the result is the sum of the two numbers 
 * 
    
 *
 * @author Bill Venners
 */
trait FlatSpec extends Suite with ShouldVerb with MustVerb with CanVerb { thisSuite =>

  private val IgnoreTagName = "org.scalatest.Ignore"

  private class Bundle private(
    val trunk: Trunk,
    val currentBranch: Branch,
    val tagsMap: Map[String, Set[String]],

    // All tests, in reverse order of registration
    val testsList: List[TestLeaf],

    // Used to detect at runtime that they've stuck a describe or an it inside an it,
    // which should result in a TestRegistrationClosedException
    val registrationClosed: Boolean
  ) {
    def unpack = (trunk, currentBranch, tagsMap, testsList, registrationClosed)
  }

  private object Bundle {
    def apply(
      trunk: Trunk,
      currentBranch: Branch,
      tagsMap: Map[String, Set[String]],
      testsList: List[TestLeaf],
      registrationClosed: Boolean
    ): Bundle =
      new Bundle(trunk, currentBranch, tagsMap, testsList, registrationClosed)

    def initialize(
      trunk: Trunk,
      tagsMap: Map[String, Set[String]],
      testsList: List[TestLeaf],
      registrationClosed: Boolean
    ): Bundle =
      new Bundle(trunk, trunk, tagsMap, testsList, registrationClosed)
  }

  private val atomic =
    new AtomicReference[Bundle](
      Bundle.initialize(new Trunk, Map(), List[TestLeaf](), false)
    )

  private def updateAtomic(oldBundle: Bundle, newBundle: Bundle) {
    val shouldBeOldBundle = atomic.getAndSet(newBundle)
    if (!(shouldBeOldBundle eq oldBundle))
      throw new ConcurrentModificationException(Resources("concurrentFlatSpecBundleMod"))
  }

  private def registerTest(specText: String, f: () => Unit) = {

    val oldBundle = atomic.get
    var (trunk, currentBranch, tagsMap, testsList, registrationClosed) = oldBundle.unpack

    val testName = getTestName(specText, currentBranch)
    if (testsList.exists(_.testName == testName)) {
      throw new DuplicateTestNameException(testName, getStackDepth("FlatSpec.scala", "it"))
    }
    val testShortName = specText
    val test = TestLeaf(currentBranch, testName, specText, f)
    currentBranch.subNodes ::= test
    testsList ::= test

    updateAtomic(oldBundle, Bundle(trunk, currentBranch, tagsMap, testsList, registrationClosed))

    testName
  }

  private class RegistrationInformer extends Informer {
    def apply(message: String) {
      if (message == null)
        throw new NullPointerException

      val oldBundle = atomic.get
      var (trunk, currentBranch, tagsMap, testsList, registrationClosed) = oldBundle.unpack

      currentBranch.subNodes ::= InfoLeaf(currentBranch, message)

      updateAtomic(oldBundle, Bundle(trunk, currentBranch, tagsMap, testsList, registrationClosed))
    }
  }

  // The informer will be a registration informer until run is called for the first time. (This
  // is the registration phase of a FlatSpec's lifecycle.)
  private final val atomicInformer = new AtomicReference[Informer](new RegistrationInformer)

  /**
   * Returns an Informer that during test execution will forward strings (and other objects) passed to its
   * apply method to the current reporter. If invoked in a constructor, it
   * will register the passed string for forwarding later during test execution. If invoked while this
   * FlatSpec is being executed, such as from inside a test function, it will forward the information to
   * the current reporter immediately. If invoked at any other time, it will
   * throw an exception. This method can be called safely by any thread.
   */
  implicit protected def info: Informer = atomicInformer.get

  private val zombieInformer =
    new Informer {
      private val complaint = Resources("cantCallInfoNow", "FlatSpec")
      def apply(message: String) {
        if (message == null)
          throw new NullPointerException
        throw new IllegalStateException(complaint)
      }
    }

  /**
   * Register a test with the given spec text, optional tags, and test function value that takes no arguments.
   * An invocation of this method is called an “example.”
   *
   * This method will register the test for later execution via an invocation of one of the execute
   * methods. The name of the test will be a concatenation of the text of all surrounding describers,
   * from outside in, and the passed spec text, with one space placed between each item. (See the documenation
   * for testNames for an example.) The resulting test name must not have been registered previously on
   * this Spec instance.
   *
   * @param specText the specification text, which will be combined with the descText of any surrounding describers
   * to form the test name
   * @param testTags the optional list of tags for this test
   * @param testFun the test function
   * @throws DuplicateTestNameException if a test with the same name has been registered previously
   * @throws TestRegistrationClosedException if invoked after run has been invoked on this suite
   * @throws NullPointerException if specText or any passed test tag is null
   */
  private def registerTestToRun(specText: String, testTags: List[Tag], testFun: () => Unit) {

    if (atomic.get.registrationClosed)
      throw new TestRegistrationClosedException(Resources("itCannotAppearInsideAnotherIt"), getStackDepth("FlatSpec.scala", "it"))
    if (specText == null)
      throw new NullPointerException("specText was null")
    if (testTags.exists(_ == null))
      throw new NullPointerException("a test tag was null")

    val testName = registerTest(specText, testFun)

    val oldBundle = atomic.get
    var (trunk, currentBranch, tagsMap, testsList, registrationClosed2) = oldBundle.unpack
    val tagNames = Set[String]() ++ testTags.map(_.name)
    if (!tagNames.isEmpty)
      tagsMap += (testName -> tagNames)

    updateAtomic(oldBundle, Bundle(trunk, currentBranch, tagsMap, testsList, registrationClosed2))
  }

  /**
   * Class that supports the registration of a “subject” being specified and tested via the
   * instance referenced from FlatSpec's behavior field.
   *
   * 
    
   * This field enables syntax such as the following subject registration:
   * 
    
   *
   * 
       * behavior of "A Stack"
   * ^
   * 
    
   *
   * 
    
   * For more information and examples of the use of the behavior field, see the main documentation
   * for trait FlatSpec.
   * 
    
   */
  protected final class BehaviorWord {

    /**
     * Supports the registration of a “subject” being specified and tested via the
     * instance referenced from FlatSpec's behavior field.
     *
     * 
    
     * This method enables syntax such as the following subject registration:
     * 
    
     *
     * 
         * behavior of "A Stack"
     *          ^
     * 
    
     *
     * 
    
     * For more information and examples of the use of this method, see the main documentation
     * for trait FlatSpec.
     * 
    
     */
    def of(description: String) {
      if (atomic.get.registrationClosed)
        throw new TestRegistrationClosedException(Resources("describeCannotAppearInsideAnIt"), getStackDepth("FlatSpec.scala", "describe"))

      val oldBundle = atomic.get
      var (trunk, currentBranch, tagsMap, testsList, registrationClosed) = oldBundle.unpack

      val newBranch = DescriptionBranch(trunk, description)
      trunk.subNodes ::= newBranch
      currentBranch = newBranch

      updateAtomic(oldBundle, Bundle(trunk, currentBranch, tagsMap, testsList, registrationClosed))
    }
  }

  /**
   * Supports the registration of a “subject” being specified and tested.
   *
   * 
    
   * This field enables syntax such as the following subject registration:
   * 
    
   *
   * 
       * behavior of "A Stack"
   * ^
   * 
    
   *
   * 
    
   * For more information and examples of the use of the behavior field, see the main documentation 
   * for this trait.
   * 
    
   */
  protected val behavior = new BehaviorWord

  /**
   * Class that supports the registration of tagged tests via the ItWord instance
   * referenced from FlatSpec's it field.
   *
   * 
    
   * This class enables syntax such as the following tagged test registration:
   * 
    
   *
   * 
       * it should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
   *                                                                      ^
   * 
    
   *
   * 
    
   * It also enables syntax such as the following registration of an ignored, tagged test:
   * 
    
   *
   * 
       * it should "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { ... }
   *                                                                      ^
   * 
    
   *
   * 
    
   * In addition, it enables syntax such as the following registration of a pending, tagged test:
   * 
    
   *
   * 
       * it should "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending)
   *                                                                      ^
   * 
    
   *
   * 
    
   * For more information and examples of the use of the it field to register tagged tests, see
   * the Tagging tests section in the main documentation for trait FlatSpec.
   * For examples of tagged test registration, see
   * the Tagging tests section in the main documentation for trait FlatSpec.
   * 
    
   */
  protected final class ItVerbStringTaggedAs(verb: String, name: String, tags: List[Tag]) {

    /**
     * Supports the registration of tagged tests in a FlatSpec.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * it must "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
     *                                                                    ^
     * 
    
     *
     * 
    
     * For examples of tagged test registration, see
     * the Tagging tests section in the main documentation for trait FlatSpec.
     * 
    
     */
    def in(testFun: => Unit) {
      registerTestToRun(verb + " " + name, tags, testFun _)
    }

    /**
     * Supports the registration of pending, tagged tests in a FlatSpec.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * it must "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending)
     *                                                                    ^
     * 
    
     *
     * 
    
     * For examples of pending test registration, see the Pending tests section in the main documentation
     * for trait FlatSpec.  And for examples of tagged test registration, see
     * the Tagging tests section in the main documentation for trait FlatSpec.
     * 
    
     */
    def is(testFun: => PendingNothing) {
      registerTestToRun(verb + " " + name, tags, testFun _)
    }

    /**
     * Supports the registration of ignored, tagged tests in a FlatSpec.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * it must "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { ... }
     *                                                                    ^
     * 
    
     *
     * 
    
     * For examples of ignored test registration, see the Ignored tests section in the main documentation
     * for trait FlatSpec.  And for examples of tagged test registration, see
     * the Tagging tests section in the main documentation for trait FlatSpec.
     * 
    
     */
    def ignore(testFun: => Unit) {
      registerTestToIgnore(verb + " " + name, tags, testFun _)
    }
  }

  /**
   * Class that supports test registration via the ItWord instance referenced from FlatSpec's it field.
   *
   * 
    
   * This class enables syntax such as the following test registration:
   * 
    
   *
   * 
       * it should "pop values in last-in-first-out order" in { ... }
   *                                                   ^
   * 
    
   *
   * 
    
   * It also enables syntax such as the following registration of an ignored test:
   * 
    
   *
   * 
       * it should "pop values in last-in-first-out order" ignore { ... }
   *                                                   ^
   * 
    
   *
   * 
    
   * In addition, it enables syntax such as the following registration of a pending test:
   * 
    
   *
   * 
       * it should "pop values in last-in-first-out order" is (pending)
   *                                                   ^
   * 
    
   *
   * 
    
   * And finally, it also enables syntax such as the following tagged test registration:
   * 
    
   *
   * 
       * it should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
   *                                                   ^
   * 
    
   *
   * 
    
   * For more information and examples of the use of the it field, see the main documentation
   * for trait FlatSpec.
   * 
    
   */
  protected final class ItVerbString(verb: String, name: String) {

    /**
     * Supports the registration of tests in a FlatSpec.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * it must "pop values in last-in-first-out order" in { ... }
     *                                                 ^
     * 
    
     *
     * 
    
     * For examples of test registration, see the main documentation
     * for trait FlatSpec.
     * 
    
     */
    def in(testFun: => Unit) {
      registerTestToRun(verb + " " + name, List(), testFun _)
    }

    /**
     * Supports the registration of pending tests in a FlatSpec.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * it must "pop values in last-in-first-out order" is (pending)
     *                                                 ^
     * 
    
     *
     * 
    
     * For examples of pending test registration, see the Pending tests section in the main documentation
     * for trait FlatSpec.
     * 
    
     */
    def is(testFun: => PendingNothing) {
      registerTestToRun(verb + " " + name, List(), testFun _)
    }

    /**
     * Supports the registration of ignored tests in a FlatSpec.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * it must "pop values in last-in-first-out order" ignore { ... }
     *                                                 ^
     * 
    
     *
     * 
    
     * For examples of ignored test registration, see the Ignored tests section in the main documentation
     * for trait FlatSpec.
     * 
    
     */
    def ignore(testFun: => Unit) {
      registerTestToIgnore(verb + " " + name, List(), testFun _)
    }

    /**
     * Supports the registration of tagged tests in a FlatSpec.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * it must "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
     *                                                 ^
     * 
    
     *
     * 
    
     * For examples of tagged test registration, see the Tagging tests section in the main documentation
     * for trait FlatSpec.
     * 
    
     */
    def taggedAs(firstTestTag: Tag, otherTestTags: Tag*) = {
      val tagList = firstTestTag :: otherTestTags.toList
      new ItVerbStringTaggedAs(verb, name, tagList)
    }
  }

  /**
   * Class that supports test (and shared test) registration via the instance referenced from FlatSpec's it field.
   *
   * 
    
   * This class enables syntax such as the following test registration:
   * 
    
   *
   * 
       * it should "pop values in last-in-first-out order" in { ... }
   * ^
   * 
    
   *
   * 
    
   * It also enables syntax such as the following shared test registration:
   * 
    
   *
   * 
       * it should behave like nonEmptyStack(lastItemPushed)
   * ^
   * 
    
   *
   * 
    
   * For more information and examples of the use of the it field, see the main documentation 
   * for this trait.
   * 
    
   */
  protected final class ItWord {

    /**
     * Supports the registration of tests with should in a FlatSpec.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * it should "pop values in last-in-first-out order" in { ... }
     *    ^
     * 
    
     *
     * 
    
     * For examples of test registration, see the main documentation
     * for trait FlatSpec.
     * 
    
     */
    def should(string: String) = new ItVerbString("should", string)

    /**
     * Supports the registration of tests with must in a FlatSpec.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * it must "pop values in last-in-first-out order" in { ... }
     *    ^
     * 
    
     *
     * 
    
     * For examples of test registration, see the main documentation
     * for trait FlatSpec.
     * 
    
     */
    def must(string: String) = new ItVerbString("must", string)

    /**
     * Supports the registration of tests with can in a FlatSpec.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * it can "pop values in last-in-first-out order" in { ... }
     *    ^
     * 
    
     *
     * 
    
     * For examples of test registration, see the main documentation
     * for trait FlatSpec.
     * 
    
     */
    def can(string: String) = new ItVerbString("can", string)

    /**
     * Supports the registration of shared tests with should in a FlatSpec.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * it should behave like nonFullStack(stackWithOneItem)
     *    ^
     * 
    
     *
     * 
    
     * For examples of shared tests, see the Shared tests section
     * in the main documentation for trait FlatSpec.
     * 
    
     */
    def should(behaveWord: BehaveWord) = behaveWord

    /**
     * Supports the registration of shared tests with must in a FlatSpec.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * it must behave like nonFullStack(stackWithOneItem)
     *    ^
     * 
    
     *
     * 
    
     * For examples of shared tests, see the Shared tests section
     * in the main documentation for trait FlatSpec.
     * 
    
     */
    def must(behaveWord: BehaveWord) = behaveWord

    /**
     * Supports the registration of shared tests with can in a FlatSpec.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * it can behave like nonFullStack(stackWithOneItem)
     *    ^
     * 
    
     *
     * 
    
     * For examples of shared tests, see the Shared tests section
     * in the main documentation for trait FlatSpec.
     * 
    
     */
    def can(behaveWord: BehaveWord) = behaveWord
  }

  /**
   * Supports test (and shared test) registration in FlatSpecs.
   *
   * 
    
   * This field enables syntax such as the following test registration:
   * 
    
   *
   * 
       * it should "pop values in last-in-first-out order" in { ... }
   * ^
   * 
    
   *
   * 
    
   * It also enables syntax such as the following shared test registration:
   * 
    
   *
   * 
       * it should behave like nonEmptyStack(lastItemPushed)
   * ^
   * 
    
   *
   * 
    
   * For more information and examples of the use of the it field, see the main documentation 
   * for this trait.
   * 
    
   */
  protected val it = new ItWord

  /**
   * Class that supports registration of ignored, tagged tests via the IgnoreWord instance referenced
   * from FlatSpec's ignore field.
   *
   * 
    
   * This class enables syntax such as the following registration of an ignored, tagged test:
   * 
    
   *
   * 
       * ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
   *                                                                          ^
   * 
    
   *
   * 
    
   * In addition, it enables syntax such as the following registration of an ignored, tagged, pending test:
   * 
    
   *
   * 
       * ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending)
   *                                                                          ^
   * 
    
   *
   * 
    
   * Note: the is method is provided for completeness and design symmetry, given there's no way
   * to prevent changing is to ignore and marking a pending test as ignored that way.
   * Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.
   * 
    
   *
   * 
    
   * For more information and examples of the use of the ignore field, see the Ignored tests section
   * in the main documentation for trait FlatSpec. For examples of tagged test registration, see
   * the Tagging tests section in the main documentation for trait FlatSpec.
   * 
    
   */
  protected final class IgnoreVerbStringTaggedAs(verb: String, name: String, tags: List[Tag]) {

    /**
     * Supports the registration of ignored, tagged tests in a FlatSpec.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * ignore must "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
     *                                                                        ^
     * 
    
     *
     * 
    
     * For examples of the registration of ignored tests, see the Ignored tests section
     * in the main documentation for trait FlatSpec. For examples of tagged test registration, see
     * the Tagging tests section in the main documentation for trait FlatSpec.
     * 
    
     */
    def in(testFun: => Unit) {
      registerTestToIgnore(verb + " " + name, tags, testFun _)
    }

    /**
     * Supports the registration of ignored, tagged, pending tests in a FlatSpec.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * ignore must "pop values in last-in-first-out order" taggedAs(SlowTest) is (pending)
     *                                                                        ^
     * 
    
     *
     * 
    
     * Note: this is method is provided for completeness and design symmetry, given there's no way
     * to prevent changing is to ignore and marking a pending test as ignored that way.
     * Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.
     * 
    
     *
     * 
    
     * For examples of pending test registration, see the Pending tests section in the main documentation
     * for trait FlatSpec.  For examples of the registration of ignored tests,
     * see the Ignored tests section
     * in the main documentation for trait FlatSpec. For examples of tagged test registration, see
     * the Tagging tests section in the main documentation for trait FlatSpec.
     * 
    
     */
    def is(testFun: => PendingNothing) {
      registerTestToIgnore(verb + " " + name, tags, testFun _)
    }
    // Note: no def ignore here, so you can't put two ignores in the same line
  }

  /**
   * Class that supports registration of ignored tests via the IgnoreWord instance referenced
   * from FlatSpec's ignore field.
   *
   * 
    
   * This class enables syntax such as the following registration of an ignored test:
   * 
    
   *
   * 
       * ignore should "pop values in last-in-first-out order" in { ... }
   *                                                       ^
   * 
    
   *
   * 
    
   * In addition, it enables syntax such as the following registration of an ignored, pending test:
   * 
    
   *
   * 
       * ignore should "pop values in last-in-first-out order" is (pending)
   *                                                       ^
   * 
    
   *
   * 
    
   * Note: the is method is provided for completeness and design symmetry, given there's no way
   * to prevent changing is to ignore and marking a pending test as ignored that way.
   * Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.
   * 
    
   *
   * 
    
   * And finally, it also enables syntax such as the following ignored, tagged test registration:
   * 
    
   *
   * 
       * ignore should "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
   *                                                       ^
   * 
    
   *
   * 
    
   * For more information and examples of the use of the ignore field, see the Ignored tests section
   * in the main documentation for trait FlatSpec.
   * 
    
   */
  protected final class IgnoreVerbString(verb: String, name: String) {

    /**
     * Supports the registration of ignored tests in a FlatSpec.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * ignore must "pop values in last-in-first-out order" in { ... }
     *                                                     ^
     * 
    
     *
     * 
    
     * For examples of the registration of ignored tests, see the Ignored tests section
     * in the main documentation for trait FlatSpec.
     * 
    
     */
    def in(testFun: => Unit) {
      registerTestToIgnore(verb + " " + name, List(), testFun _)
    }

    /**
     * Supports the registration of ignored, pending tests in a FlatSpec.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * ignore must "pop values in last-in-first-out order" is (pending)
     *                                                     ^
     * 
    
     *
     * 
    
     * Note: this is method is provided for completeness and design symmetry, given there's no way
     * to prevent changing is to ignore and marking a pending test as ignored that way.
     * Although it isn't clear why someone would want to mark a pending test as ignored, it can be done.
     * 
    
     *
     * 
    
     * For examples of pending test registration, see the Pending tests section in the main documentation
     * for trait FlatSpec.  For examples of the registration of ignored tests,
     * see the Ignored tests section
     * in the main documentation for trait FlatSpec.
     * 
    
     */
    def is(testFun: => PendingNothing) {
      registerTestToIgnore(verb + " " + name, List(), testFun _)
    }

    /**
     * Supports the registration of ignored, tagged tests in a FlatSpec.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * ignore must "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
     *                                                     ^
     * 
    
     *
     * 
    
     * For examples of tagged test registration, see the Tagging tests section in the main documentation
     * for trait FlatSpec.  For examples of the registration of ignored tests,
     * see the Ignored tests section
     * in the main documentation for trait FlatSpec.
     * 
    
     */
    def taggedAs(firstTestTag: Tag, otherTestTags: Tag*) = {
      val tagList = firstTestTag :: otherTestTags.toList
      new IgnoreVerbStringTaggedAs(verb, name, tagList)
    }
  }

  /**
   * Class that supports registration of ignored tests via the ItWord instance
   * referenced from FlatSpec's ignore field.
   *
   * 
    
   * This class enables syntax such as the following registration of an ignored test:
   * 
    
   *
   * 
       * ignore should "pop values in last-in-first-out order" in { ... }
   * ^
   * 
    
   *
   * 
    
   * For more information and examples of the use of the ignore field, see Ignored tests section
   * in the main documentation for this trait.
   * 
    
   */
  protected final class IgnoreWord {

    /**
     * Supports the registration of ignored tests with should in a FlatSpec.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * ignore should "pop values in last-in-first-out order" in { ... }
     *        ^
     * 
    
     *
     * 
    
     * For more information and examples of the use of the ignore field, see Ignored tests section
     * in the main documentation for trait FlatSpec.
     * 
    
     */
    def should(string: String) = new IgnoreVerbString("should", string)

    /**
     * Supports the registration of ignored tests with must in a FlatSpec.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * ignore must "pop values in last-in-first-out order" in { ... }
     *        ^
     * 
    
     *
     * 
    
     * For more information and examples of the use of the ignore field, see Ignored tests section
     * in the main documentation for trait FlatSpec.
     * 
    
     */
    def must(string: String) = new IgnoreVerbString("must", string)

    /**
     * Supports the registration of ignored tests with can in a FlatSpec.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * ignore can "pop values in last-in-first-out order" in { ... }
     *        ^
     * 
    
     *
     * 
    
     * For more information and examples of the use of the ignore field, see Ignored tests section
     * in the main documentation for trait FlatSpec.
     * 
    
     */
    def can(string: String) = new IgnoreVerbString("can", string)
  }

  /**
   * Supports registration of ignored tests in FlatSpecs.
   *
   * 
    
   * This field enables syntax such as the following registration of an ignored test:
   * 
    
   *
   * 
       * ignore should "pop values in last-in-first-out order" in { ... }
   * ^
   * 
    
   *
   * 
    
   * For more information and examples of the use of the ignore field, see the Ignored tests section
   * in the main documentation for this trait.
   * 
    
   */
  protected val ignore = new IgnoreWord

  /**
   * Class that supports test registration in shorthand form.
   *
   * 
    
   * For example, this class enables syntax such as the following test registration
   * in shorthand form:
   * 
    
   *
   * 
       * "A Stack (when empty)" should "be empty" in { ... }
   *                                          ^
   * 
    
   *
   * 
    
   * This class also enables syntax such as the following ignored test registration
   * in shorthand form:
   * 
    
   *
   * 
       * "A Stack (when empty)" should "be empty" ignore { ... }
   *                                          ^
   * 
    
   *
   * 
    
   * This class is used via an implicit conversion (named convertToInAndIgnoreMethods)
   * from ResultOfStringPassedToVerb. The ResultOfStringPassedToVerb class
   * does not declare any methods named in, because the
   * type passed to in differs in a FlatSpec and a FixtureFlatSpec.
   * A FixtureFlatSpec needs two in methods, one that takes a no-arg
   * test function and another that takes a one-arg test function (a test that takes a
   * Fixture as its parameter). By constrast, a FlatSpec needs
   * only one in method that takes a by-name parameter. As a result,
   * FlatSpec and FixtureFlatSpec each provide an implicit conversion
   * from ResultOfStringPassedToVerb to a type that provides the appropriate
   * in methods.
   * 
    
   *
   * @author Bill Venners
   */
  protected final class InAndIgnoreMethods(resultOfStringPassedToVerb: ResultOfStringPassedToVerb) {

    import resultOfStringPassedToVerb.verb
    import resultOfStringPassedToVerb.rest

    /**
     * Supports the registration of tests in shorthand form.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * "A Stack" must "pop values in last-in-first-out order" in { ... }
     *                                                        ^
     * 
    
     *
     * 
    
     * For examples of test registration, see the main documentation
     * for trait FlatSpec.
     * 
    
     */
    def in(testFun: => Unit) {
      registerTestToRun(verb + " " + rest, List(), testFun _)
    }
    
    /**
     * Supports the registration of ignored tests in shorthand form.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * "A Stack" must "pop values in last-in-first-out order" ignore { ... }
     *                                                        ^
     * 
    
     *
     * 
    
     * For examples of ignored test registration, see the Ignored tests section
     * in the main documentation for trait FlatSpec.
     * 
    
     */
    def ignore(testFun: => Unit) {
      registerTestToIgnore(verb + " " + rest, List(), testFun _)
    }
  }

  /**
   * Implicitly converts an object of type ResultOfStringPassedToVerb to an
   * InAndIgnoreMethods, to enable in and ignore
   * methods to be invokable on that object.
   */
  protected implicit def convertToInAndIgnoreMethods(resultOfStringPassedToVerb: ResultOfStringPassedToVerb) =
    new InAndIgnoreMethods(resultOfStringPassedToVerb)
  
  /**
   * Class that supports tagged test registration in shorthand form.
   *
   * 
    
   * For example, this class enables syntax such as the following tagged test registration
   * in shorthand form:
   * 
    
   *
   * 
       * "A Stack (when empty)" should "be empty" taggedAs() in { ... }
   *                                                     ^
   * 
    
   *
   * 
    
   * This class also enables syntax such as the following tagged, ignored test registration
   * in shorthand form:
   * 
    
   *
   * 
       * "A Stack (when empty)" should "be empty" taggedAs(SlowTest) ignore { ... }
   *                                                             ^
   * 
    
   *
   * 
    
   * This class is used via an implicit conversion (named convertToInAndIgnoreMethodsAfterTaggedAs)
   * from ResultOfTaggedAsInvocation. The ResultOfTaggedAsInvocation class
   * does not declare any methods named in, because the
   * type passed to in differs in a FlatSpec and a FixtureFlatSpec.
   * A FixtureFlatSpec needs two in methods, one that takes a no-arg
   * test function and another that takes a one-arg test function (a test that takes a
   * Fixture as its parameter). By constrast, a FlatSpec needs
   * only one in method that takes a by-name parameter. As a result,
   * FlatSpec and FixtureFlatSpec each provide an implicit conversion
   * from ResultOfTaggedAsInvocation to a type that provides the appropriate
   * in methods.
   * 
    
   *
   * @author Bill Venners
   */
  protected final class InAndIgnoreMethodsAfterTaggedAs(resultOfTaggedAsInvocation: ResultOfTaggedAsInvocation) {

    import resultOfTaggedAsInvocation.verb
    import resultOfTaggedAsInvocation.rest
    import resultOfTaggedAsInvocation.{tags => tagsList}

    /**
     * Supports the registration of tagged tests in shorthand form.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * "A Stack" must "pop values in last-in-first-out order" taggedAs(SlowTest) in { ... }
     *                                                                           ^
     * 
    
     *
     * 
    
     * For examples of tagged test registration, see the Tagging tests section
     * in the main documentation for trait FlatSpec.
     * 
    
     */
    def in(testFun: => Unit) {
      registerTestToRun(verb + " " + rest, tagsList, testFun _)
    }

    /**
     * Supports the registration of tagged, ignored tests in shorthand form.
     *
     * 
    
     * This method supports syntax such as the following:
     * 
    
     *
     * 
         * "A Stack" must "pop values in last-in-first-out order" taggedAs(SlowTest) ignore { ... }
     *                                                                           ^
     * 
    
     *
     * 
    
     * For examples of ignored test registration, see the Ignored tests section
     * in the main documentation for trait FlatSpec.
     * For examples of tagged test registration, see the Tagging tests section
     * in the main documentation for trait FlatSpec.
     * 
    
     */
    def ignore(testFun: => Unit) {
      registerTestToIgnore(verb + " " + rest, tagsList, testFun _)
    }
  }

  /**
   * Implicitly converts an object of type ResultOfTaggedAsInvocation to an
   * InAndIgnoreMethodsAfterTaggedAs, to enable in and ignore
   * methods to be invokable on that object.
   */
  protected implicit def convertToInAndIgnoreMethodsAfterTaggedAs(resultOfTaggedAsInvocation: ResultOfTaggedAsInvocation) =
    new InAndIgnoreMethodsAfterTaggedAs(resultOfTaggedAsInvocation)

  /**
   * Supports the shorthand form of test registration.
   *
   * 
    
   * For example, this method enables syntax such as the following:
   * 
    
   *
   * 
       * "A Stack (when empty)" should "be empty" in { ... }
   *                        ^
   * 
    
   *
   * 
    
   * This function is passed as an implicit parameter to a should method
   * provided in ShouldVerb, a must method
   * provided in MustVerb, and a can method
   * provided in CanVerb. When invoked, this function registers the
   * subject description (the first parameter to the function) and returns a ResultOfStringPassedToVerb
   * initialized with the verb and rest parameters (the second and third parameters to
   * the function, respectively).
   * 
    
   */
  protected implicit val shorthandTestRegistrationFunction: (String, String, String) => ResultOfStringPassedToVerb = {
    (subject, verb, rest) => {
      behavior.of(subject)
      new ResultOfStringPassedToVerb(verb, rest) {

        def is(testFun: => PendingNothing) {
          registerTestToRun(verb + " " + rest, List(), testFun _)
        }
        // Note, won't have an is method that takes fixture => PendingNothing one, because don't want
        // to say is (fixture => pending), rather just say is (pending)
        def taggedAs(firstTestTag: Tag, otherTestTags: Tag*) = {
          val tagList = firstTestTag :: otherTestTags.toList
          new ResultOfTaggedAsInvocation(verb, rest, tagList) {
            // "A Stack" should "bla bla" taggedAs(SlowTest) is (pending)
            //                                               ^
            def is(testFun: => PendingNothing) {
              registerTestToRun(verb + " " + rest, tags, testFun _)
            }
          }
        }
      }
    }
  }

  /**
   * Supports the shorthand form of shared test registration.
   *
   * 
    
   * For example, this method enables syntax such as the following in:
   * 
    
   *
   * 
       * "A Stack (with one item)" should behave like nonEmptyStack(stackWithOneItem, lastValuePushed)
   *                           ^
   * 
    
   *
   * 
    
   * This function is passed as an implicit parameter to a should method
   * provided in ShouldVerb, a must method
   * provided in MustVerb, and a can method
   * provided in CanVerb. When invoked, this function registers the
   * subject description (the  parameter to the function) and returns a BehaveWord.
   * 
    
   */
  protected implicit val shorthandSharedTestRegistrationFunction: (String) => BehaveWord = {
    (left) => {
      behavior.of(left)
      new BehaveWord
    }
  }

  /**
   * Register a test with the given spec text and test function value that takes no arguments.
   *
   * This method will register the test for later execution via an invocation of one of the execute
   * methods. The name of the test will be a concatenation of the text of all surrounding describers,
   * from outside in, and the passed spec text, with one space placed between each item. (See the documenation
   * for testNames for an example.) The resulting test name must not have been registered previously on
   * this Spec instance.
   *
   * @param specText the specification text, which will be combined with the descText of any surrounding describers
   * to form the test name
   * @param testFun the test function
   * @throws DuplicateTestNameException if a test with the same name has been registered previously
   * @throws TestRegistrationClosedException if invoked after run has been invoked on this suite
   * @throws NullPointerException if specText or any passed test tag is null
   */
  /* private def oldIt(specText: String)(testFun: => Unit) {
    if (atomic.get.registrationClosed)
      throw new TestRegistrationClosedException(Resources("itCannotAppearInsideAnotherIt"), getStackDepth("FlatSpec.scala", "it"))
    oldIt(specText, Array[Tag](): _*)(testFun)
  } */

  /**
   * Register a test to ignore, which has the given spec text, optional tags, and test function value that takes no arguments.
   * This method will register the test for later ignoring via an invocation of one of the execute
   * methods. This method exists to make it easy to ignore an existing test by changing the call to it
   * to ignore without deleting or commenting out the actual test code. The test will not be executed, but a
   * report will be sent that indicates the test was ignored. The name of the test will be a concatenation of the text of all surrounding describers,
   * from outside in, and the passed spec text, with one space placed between each item. (See the documenation
   * for testNames for an example.) The resulting test name must not have been registered previously on
   * this Spec instance.
   *
   * @param specText the specification text, which will be combined with the descText of any surrounding describers
   * to form the test name
   * @param testTags the optional list of tags for this test
   * @param testFun the test function
   * @throws DuplicateTestNameException if a test with the same name has been registered previously
   * @throws TestRegistrationClosedException if invoked after run has been invoked on this suite
   * @throws NullPointerException if specText or any passed test tag is null
   */
  private def registerTestToIgnore(specText: String, testTags: List[Tag], testFun: () => Unit) {
    if (atomic.get.registrationClosed)
      throw new TestRegistrationClosedException(Resources("ignoreCannotAppearInsideAnIt"), getStackDepth("FlatSpec.scala", "ignore"))
    if (specText == null)
      throw new NullPointerException("specText was null")
    if (testTags.exists(_ == null))
      throw new NullPointerException("a test tag was null")
    val testName = registerTest(specText, testFun)
    val tagNames = Set[String]() ++ testTags.map(_.name)
    val oldBundle = atomic.get
    var (trunk, currentBranch, tagsMap, testsList, registrationClosed) = oldBundle.unpack
    tagsMap += (testName -> (tagNames + IgnoreTagName))
    updateAtomic(oldBundle, Bundle(trunk, currentBranch, tagsMap, testsList, registrationClosed))
  }

  /**
   * Register a test to ignore, which has the given spec text and test function value that takes no arguments.
   * This method will register the test for later ignoring via an invocation of one of the execute
   * methods. This method exists to make it easy to ignore an existing test by changing the call to it
   * to ignore without deleting or commenting out the actual test code. The test will not be executed, but a
   * report will be sent that indicates the test was ignored. The name of the test will be a concatenation of the text of all surrounding describers,
   * from outside in, and the passed spec text, with one space placed between each item. (See the documenation
   * for testNames for an example.) The resulting test name must not have been registered previously on
   * this Spec instance.
   *
   * @param specText the specification text, which will be combined with the descText of any surrounding describers
   * to form the test name
   * @param testFun the test function
   * @throws DuplicateTestNameException if a test with the same name has been registered previously
   * @throws TestRegistrationClosedException if invoked after run has been invoked on this suite
   * @throws NullPointerException if specText or any passed test tag is null
   */
  /* protected def oldIgnore(specText: String)(testFun: => Unit) {
    if (atomic.get.registrationClosed)
      throw new TestRegistrationClosedException(Resources("ignoreCannotAppearInsideAnIt"), getStackDepth("FlatSpec.scala", "ignore"))
    oldIgnore(specText, Array[Tag](): _*)(testFun)
  } */
  
  /**
   * A Map whose keys are String tag names to which tests in this Spec belong, and values
   * the Set of test names that belong to each tag. If this FlatSpec contains no tags, this method returns an empty Map.
   *
   * 
    
   * This trait's implementation returns tags that were passed as strings contained in Tag objects passed to 
   * methods test and ignore. 
   * 
    
   */
  override def tags: Map[String, Set[String]] = atomic.get.tagsMap

  private def runTestsInBranch(branch: Branch, reporter: Reporter, stopper: Stopper, filter: Filter, configMap: Map[String, Any], tracker: Tracker) {

    val stopRequested = stopper
    // Wrap any non-DispatchReporter, non-CatchReporter in a CatchReporter,
    // so that exceptions are caught and transformed
    // into error messages on the standard error stream.
    val report = wrapReporterIfNecessary(reporter)
    branch match {
      case desc @ DescriptionBranch(_, descriptionName) =>

        def sendInfoProvidedMessage() {
          // Need to use the full name of the description, which includes all the descriptions it is nested inside
          // Call getPrefix and pass in this Desc, to get the full name
          val descriptionFullName = getPrefix(desc).trim
         

          report(InfoProvided(tracker.nextOrdinal(), descriptionFullName, Some(NameInfo(thisSuite.suiteName, Some(thisSuite.getClass.getName), None)), None, None, Some(IndentedText(descriptionFullName, descriptionFullName, 0))))
        }
        
        // Only send an infoProvided message if the first thing in the subNodes is *not* sub-description, i.e.,
        // it is a test, because otherwise we get a lame description that doesn't have any tests under it.
        // But send it if the list is empty.
        if (desc.subNodes.isEmpty)
          sendInfoProvidedMessage() 
        else
          desc.subNodes.reverse.head match {
            case ex: TestLeaf => sendInfoProvidedMessage()
            case _ => // Do nothing in this case
          }

      case _ =>
    }
    branch.subNodes.reverse.foreach(
      _ match {
        case TestLeaf(_, tn, specText, _) =>
          if (!stopRequested()) { // TODO: Seems odd to me to check for stop here but still fire infos
            val (filterTest, ignoreTest) = filter(tn, tags)
            if (!filterTest)
              if (ignoreTest) {
                val testSucceededIcon = Resources("testSucceededIconChar")
                val formattedSpecText = Resources("iconPlusShortName", testSucceededIcon, specText)
                report(TestIgnored(tracker.nextOrdinal(), thisSuite.suiteName, Some(thisSuite.getClass.getName), tn, Some(IndentedText(formattedSpecText, specText, 1))))
              }
              else
                runTest(tn, report, stopRequested, configMap, tracker)
          }
        case InfoLeaf(_, message) =>
          val infoProvidedIcon = Resources("infoProvidedIconChar")
          val formattedText = Resources("iconPlusShortName", infoProvidedIcon, message)
          report(InfoProvided(tracker.nextOrdinal(), message,
            Some(NameInfo(thisSuite.suiteName, Some(thisSuite.getClass.getName), None)), None,
              None, Some(IndentedText(formattedText, message, 1))))
        case branch: Branch => runTestsInBranch(branch, reporter, stopRequested, filter, configMap, tracker)
      }
    )
  }

  /**
   * Run a test. This trait's implementation runs the test registered with the name specified by
   * testName. Each test's name is a concatenation of the text of all describers surrounding a test,
   * from outside in, and the test's  spec text, with one space placed between each item. (See the documenation
   * for testNames for an example.)
   *
   * @param testName the name of one test to execute.
   * @param reporter the Reporter to which results will be reported
   * @param stopper the Stopper that will be consulted to determine whether to stop execution early.
   * @param configMap a Map of properties that can be used by this Spec's executing tests.
   * @throws NullPointerException if any of testName, reporter, stopper, or configMap
   *     is null.
   */
  protected override def runTest(testName: String, reporter: Reporter, stopper: Stopper, configMap: Map[String, Any], tracker: Tracker) {

    if (testName == null || reporter == null || stopper == null || configMap == null)
      throw new NullPointerException

    atomic.get.testsList.find(_.testName == testName) match {
      case None => throw new IllegalArgumentException("Requested test doesn't exist: " + testName)
      case Some(test) => {
        val report = wrapReporterIfNecessary(reporter)

        val testSucceededIcon = Resources("testSucceededIconChar")
        val formattedSpecText = Resources("iconPlusShortName", testSucceededIcon, test.specText)

        // Create a Rerunner if the Spec has a no-arg constructor
        val hasPublicNoArgConstructor = Suite.checkForPublicNoArgConstructor(getClass)

        val rerunnable =
          if (hasPublicNoArgConstructor)
            Some(new TestRerunner(getClass.getName, testName))
          else
            None

        val testStartTime = System.currentTimeMillis

        // A TestStarting event won't normally show up in a specification-style output, but
        // will show up in a test-style output.
        report(TestStarting(tracker.nextOrdinal(), thisSuite.suiteName, Some(thisSuite.getClass.getName), test.testName, Some(MotionToSuppress), rerunnable))

        val formatter = IndentedText(formattedSpecText, test.specText, 1)
        val informerForThisTest =
          new MessageRecordingInformer(NameInfo(thisSuite.suiteName, Some(thisSuite.getClass.getName), Some(testName))) {
            def apply(message: String) {
              if (message == null)
                throw new NullPointerException
              if (shouldRecord)
                record(message)
              else {
                val infoProvidedIcon = Resources("infoProvidedIconChar")
                val formattedText = "  " + Resources("iconPlusShortName", infoProvidedIcon, message)
                report(InfoProvided(tracker.nextOrdinal(), message, nameInfoForCurrentThread, None, None, Some(IndentedText(formattedText, message, 2))))
              }
            }
          }

        val oldInformer = atomicInformer.getAndSet(informerForThisTest)
        var testWasPending = false
        var swapAndCompareSucceeded = false
        try {
          val theConfigMap = configMap
          withFixture(
            new NoArgTest {
              def name = testName
              def apply() { test.f() }
              def configMap = theConfigMap
            }
          )

          val duration = System.currentTimeMillis - testStartTime
          report(TestSucceeded(tracker.nextOrdinal(), thisSuite.suiteName, Some(thisSuite.getClass.getName), test.testName, Some(duration), Some(formatter), rerunnable))
        }
        catch {
          case _: TestPendingException =>
            report(TestPending(tracker.nextOrdinal(), thisSuite.suiteName, Some(thisSuite.getClass.getName), test.testName, Some(formatter)))
            testWasPending = true
          case e if !anErrorThatShouldCauseAnAbort(e) =>
            val duration = System.currentTimeMillis - testStartTime
            handleFailedTest(e, false, test.testName, test.specText, formattedSpecText, rerunnable, report, tracker, duration)
          case e => throw e
        }
        finally {
          // send out any recorded messages
          for (message <- informerForThisTest.recordedMessages) {
            val infoProvidedIcon = Resources("infoProvidedIconChar")
            val formattedText = "  " + Resources("iconPlusShortName", infoProvidedIcon, message)
            report(InfoProvided(tracker.nextOrdinal(), message, informerForThisTest.nameInfoForCurrentThread, Some(testWasPending), None, Some(IndentedText(formattedText, message, 2))))
          }

          val shouldBeInformerForThisTest = atomicInformer.getAndSet(oldInformer)
          swapAndCompareSucceeded = shouldBeInformerForThisTest eq informerForThisTest
        }
        if (!swapAndCompareSucceeded)  // Do outside finally to workaround Scala compiler bug
          throw new ConcurrentModificationException(Resources("concurrentInformerMod", thisSuite.getClass.getName))
      }
    }
  }

  private def handleFailedTest(throwable: Throwable, hasPublicNoArgConstructor: Boolean, testName: String,
      specText: String, formattedSpecText: String, rerunnable: Option[Rerunner], report: Reporter, tracker: Tracker, duration: Long) {

    val message =
      if (throwable.getMessage != null) // [bv: this could be factored out into a helper method]
        throwable.getMessage
      else
        throwable.toString

    val formatter = IndentedText(formattedSpecText, specText, 1)
    report(TestFailed(tracker.nextOrdinal(), message, thisSuite.suiteName, Some(thisSuite.getClass.getName), testName, Some(throwable), Some(duration), Some(formatter), rerunnable))
  }

  /**
   * Run zero to many of this FlatSpec's tests.
   *
   * 
    
   * This method takes a testName parameter that optionally specifies a test to invoke.
   * If testName is Some, this trait's implementation of this method
   * invokes runTest on this object, passing in:
   * 
    
   *
   * 
      
   * 
    • testName - the String value of the testName Option passed
   *   to this method
      • 
   * 
    • reporter - the Reporter passed to this method, or one that wraps and delegates to it
      • 
   * 
    • stopper - the Stopper passed to this method, or one that wraps and delegates to it
      • 
   * 
    • configMap - the configMap passed to this method, or one that wraps and delegates to it
      • 
   * 
    
   *
   * 
    
   * This method takes a Set of tag names that should be included (tagsToInclude), and a Set
   * that should be excluded (tagsToExclude), when deciding which of this Suite's tests to execute.
   * If tagsToInclude is empty, all tests will be executed
   * except those those belonging to tags listed in the tagsToExclude Set. If tagsToInclude is non-empty, only tests
   * belonging to tags mentioned in tagsToInclude, and not mentioned in tagsToExclude
   * will be executed. However, if testName is Some, tagsToInclude and tagsToExclude are essentially ignored.
   * Only if testName is None will tagsToInclude and tagsToExclude be consulted to
   * determine which of the tests named in the testNames Set should be run. For more information on trait tags, see the main documentation for this trait.
   * 
    
   *
   * 
    
   * If testName is None, this trait's implementation of this method
   * invokes testNames on this Suite to get a Set of names of tests to potentially execute.
   * (A testNames value of None essentially acts as a wildcard that means all tests in
   * this Suite that are selected by tagsToInclude and tagsToExclude should be executed.)
   * For each test in the testName Set, in the order
   * they appear in the iterator obtained by invoking the elements method on the Set, this trait's implementation
   * of this method checks whether the test should be run based on the tagsToInclude and tagsToExclude Sets.
   * If so, this implementation invokes runTest, passing in:
   * 
    
   *
   * 
      
   * 
    • testName - the String name of the test to run (which will be one of the names in the testNames Set)
      • 
   * 
    • reporter - the Reporter passed to this method, or one that wraps and delegates to it
      • 
   * 
    • stopper - the Stopper passed to this method, or one that wraps and delegates to it
      • 
   * 
    • configMap - the configMap passed to this method, or one that wraps and delegates to it
      • 
   * 
    
   *
   * @param testName an optional name of one test to execute. If None, all relevant tests should be executed.
   *                 I.e., None acts like a wildcard that means execute all relevant tests in this Spec.
   * @param reporter the Reporter to which results will be reported
   * @param stopper the Stopper that will be consulted to determine whether to stop execution early.
   * @param tagsToInclude a Set of String tag names to include in the execution of this Spec
   * @param tagsToExclude a Set of String tag names to exclude in the execution of this Spec
   * @param configMap a Map of key-value pairs that can be used by this Spec's executing tests.
   * @throws NullPointerException if any of testName, reporter, stopper, tagsToInclude,
   *     tagsToExclude, or configMap is null.
   */
  protected override def runTests(testName: Option[String], reporter: Reporter, stopper: Stopper, filter: Filter,
      configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker) {
    
    if (testName == null)
      throw new NullPointerException("testName was null")
    if (reporter == null)
      throw new NullPointerException("reporter was null")
    if (stopper == null)
      throw new NullPointerException("stopper was null")
    if (filter == null)
      throw new NullPointerException("filter was null")
    if (configMap == null)
      throw new NullPointerException("configMap was null")
    if (distributor == null)
      throw new NullPointerException("distributor was null")
    if (tracker == null)
      throw new NullPointerException("tracker was null")

    val stopRequested = stopper

    testName match {
      case None => runTestsInBranch(atomic.get.trunk, reporter, stopRequested, filter, configMap, tracker)
      case Some(tn) => runTest(tn, reporter, stopRequested, configMap, tracker)
    }
  }

  /**
   * An immutable Set of test names. If this FlatSpec contains no tests, this method returns an
   * empty Set.
   *
   * 
    
   * This trait's implementation of this method will return a set that contains the names of all registered tests. The set's
   * iterator will return those names in the order in which the tests were registered. Each test's name is composed
   * of the concatenation of the text of each surrounding describer, in order from outside in, and the text of the
   * example itself, with all components separated by a space. For example, consider this FlatSpec:
   * 
    
   *
   * 
       * import org.scalatest.FlatSpec
   *
   * class StackSpec extends FlatSpec {
   *
   *   "A Stack (when not empty)" must "allow me to pop" in {}
   *   it must "not be empty" in {}
   *
   *   "A Stack (when not full)" must "allow me to push" in {}
   *   it must "not be full" in {}
   * }
   * 
    
   *
   * 
    
   * Invoking testNames on this Spec will yield a set that contains the following
   * two test name strings:
   * 
    
   *
   * 
       * "A Stack (when not empty) must allow me to pop"
   * "A Stack (when not empty) must not be empty"
   * "A Stack (when not full) must allow me to push"
   * "A Stack (when not full) must not be full"
   * 
    
   */
  override def testNames: Set[String] = ListSet(atomic.get.testsList.map(_.testName): _*)

  override def run(testName: Option[String], reporter: Reporter, stopper: Stopper, filter: Filter,
      configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker) {

    val stopRequested = stopper

    // Set the flag that indicates registration is closed (because run has now been invoked),
    // which will disallow any further invocations of "describe", it", or "ignore" with
    // an RegistrationClosedException.
    val oldBundle = atomic.get
    var (trunk, currentBranch, tagsMap, testsList, registrationClosed) = oldBundle.unpack
    if (!registrationClosed)
      updateAtomic(oldBundle, Bundle(trunk, currentBranch, tagsMap, testsList, true))

    val report = wrapReporterIfNecessary(reporter)

    val informerForThisSuite =
      new ConcurrentInformer(NameInfo(thisSuite.suiteName, Some(thisSuite.getClass.getName), None)) {
        def apply(message: String) {
          if (message == null)
            throw new NullPointerException
          report(InfoProvided(tracker.nextOrdinal(), message, nameInfoForCurrentThread))
        }
      }

    atomicInformer.set(informerForThisSuite)

    var swapAndCompareSucceeded = false
    try {
      super.run(testName, report, stopRequested, filter, configMap, distributor, tracker)
    }
    finally {
      val shouldBeInformerForThisSuite = atomicInformer.getAndSet(zombieInformer)
      swapAndCompareSucceeded = shouldBeInformerForThisSuite eq informerForThisSuite
    }
    if (!swapAndCompareSucceeded)  // Do outside finally to workaround Scala compiler bug
      throw new ConcurrentModificationException(Resources("concurrentInformerMod", thisSuite.getClass.getName))
  }

  /**
   * Supports shared test registration in FlatSpecs.
   *
   * 
    
   * This field supports syntax such as the following:
   * 
    
   *
   * 
       * it should behave like nonFullStack(stackWithOneItem)
   *           ^
   * 
    
   *
   * 
    
   * For more information and examples of the use of behave, see the Shared tests section
   * in the main documentation for this trait.
   * 
    
   */
  protected val behave = new BehaveWord
}




    © 2015 - 2025 Weber Informatics LLC | Privacy Policy