• Home
• org.scalatest
• scalatest_2.11.0-M3
• 1.9.1b
• source code
• Suite.scala

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.scalatest.Suite.scala Maven / Gradle / Ivy

/*
 * Copyright 2001-2012 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 java.lang.annotation._
import java.io.Serializable
import java.lang.reflect.Constructor
import java.lang.reflect.InvocationTargetException
import java.lang.reflect.Method
import java.lang.reflect.Modifier
import java.nio.charset.CoderMalfunctionError
import javax.xml.parsers.FactoryConfigurationError
import javax.xml.transform.TransformerFactoryConfigurationError
import Suite.simpleNameForTest
import Suite.parseSimpleName
import Suite.stripDollars
import Suite.formatterForSuiteStarting
import Suite.formatterForSuiteCompleted
import Suite.checkForPublicNoArgConstructor
import Suite.checkChosenStyles
import Suite.formatterForSuiteAborted
import Suite.anErrorThatShouldCauseAnAbort
import Suite.getSimpleNameOfAnObjectsClass
import Suite.takesInformer
import Suite.isTestMethodGoodies
import Suite.testMethodTakesAnInformer
import scala.collection.immutable.TreeSet
import Suite.getIndentedText
import org.scalatest.events._
import org.scalatest.tools.StandardOutReporter
import Suite.checkRunTestParamsForNull
import Suite.getIndentedTextForInfo
import Suite.getMessageForException
import Suite.reportTestStarting
import Suite.reportTestIgnored
import Suite.reportTestSucceeded
import Suite.reportTestPending
import Suite.reportInfoProvided
import exceptions.StackDepthExceptionHelper.getStackDepthFun
import exceptions._

/**
 * A suite of tests. A Suite instance encapsulates a conceptual
 * suite (i.e., a collection) of tests.
 *
 * 

 * This trait provides an interface that allows suites of tests to be run.
 * Its implementation enables a default way of writing and executing tests.  Subtraits and subclasses can
 * override Suite's methods to enable other ways of writing and executing tests.
 * This trait's default approach allows tests to be defined as methods whose name starts with "test."
 * This approach is easy to understand, and a good way for Scala beginners to start writing tests.
 * More advanced Scala programmers may prefer to mix together other Suite subtraits defined in ScalaTest, 
 * or create their own, to write tests in the way they feel makes them most productive. Here's a quick overview
 * of some of the options to help you get started:
 * 
 *
 * 

 * For JUnit 3 users
 * 
 *
 * 

 * If you are using JUnit 3 (version 3.8 or earlier releases) and you want to write JUnit 3 tests in Scala, look at
 * AssertionsForJUnit, 
 * ShouldMatchersForJUnit, and
 * JUnit3Suite. 
 * 
 *
 * 

 * For JUnit 4 users
 * 
 *
 * 

 * If you are using JUnit 4 and you want to write JUnit 4 tests in Scala, look at
 * JUnitSuite, and
 * JUnitRunner. With JUnitRunner,
 * you can use any of the traits described here and still run your tests with JUnit 4.
 * 
 *
 * 

 * For TestNG users
 * 
 *
 * 

 * If you are using TestNG and you want to write TestNG tests in Scala, look at
 * TestNGSuite.
 * 
 *
 * 

 * For high-level testing
 * 
 *
 * 

 * If you want to write tests at a higher level than unit tests, such as integration tests, acceptance tests,
 * or functional tests, check out FeatureSpec.
 * 
 *
 * 

 * For unit testing
 * 
 *
 * 

 * If you prefer a behavior-driven development (BDD) style, in which tests are combined with text that
 * specifies the behavior being tested, look at
 * FunSpec, 
 * FlatSpec,
 * FreeSpec, and
 * WordSpec. Otherwise, if you just want to write tests
 * and don't want to combine testing with specifying, look at 
 * FunSuite or read on to learn how to write
 * tests using this base trait, Suite. 
 * 
 *
 * 

 * To use this trait's approach to writing tests, simply create classes that
 * extend Suite and define test methods. Test methods have names of the form testX, 
 * where X is some unique, hopefully meaningful, string. A test method must be public and
 * can have any result type, but the most common result type is Unit. Here's an example:
 * 
 *
 * 
 * import org.scalatest.Suite
 *
 * class ExampleSuite extends Suite {
 *
 *   def testAddition {
 *     val sum = 1 + 1
 *     assert(sum === 2)
 *   }
 *
 *   def testSubtraction {
 *     val diff = 4 - 1
 *     assert(diff === 3)
 *   }
 * }
 * 
 *
 * 

 * You can run a Suite by invoking execute on it.
 * This method, which prints test results to the standard output, is intended to serve as a
 * convenient way to run tests from within the Scala interpreter. For example,
 * to run ExampleSuite from within the Scala interpreter, you could write:
 * 
 *
 * 
 * scala> (new ExampleSuite).execute()
 * 
 *
 * 

 * And you would see:
 * 
 *
 * 
 * ExampleSuite:
 * - testAddition
 * - testSubtraction
 * 
 *
 * 

 * Or, to run just the testAddition method, you could write:
 * 
 *
 * 
 * scala> (new ExampleSuite).execute("testAddition")
 * 
 *
 * 

 * And you would see:
 * 
 *
 * 
 * ExampleSuite:
 * - testAddition
 * 
 *
 * 

 * You can also pass to execute a config map of key-value
 * pairs, which will be passed down into suites and tests, as well as other parameters that configure the run itself.
 * For more information on running in the Scala interpreter, see the documentation for execute (below) and the
 * ScalaTest shell.
 * 
 *
 * 

 * The execute method invokes a run method takes seven
 * parameters. This run method, which actually executes the suite, will usually be invoked by a test runner, such
 * as org.scalatest.tools.Runner or an IDE. See the documentation
 * for Runner for more details.
 * 
 *
 * 
Assertions and ===
 *
 * 

 * Inside test methods in a Suite, you can write assertions by invoking assert and passing in a Boolean expression,
 * such as:
 * 
 *
 * 
 * val left = 2
 * val right = 1
 * assert(left == right)
 * 
 *
 * 

 * If the passed expression is true, assert will return normally. If false,
 * assert will complete abruptly with a TestFailedException. This exception is usually not caught
 * by the test method, which means the test method itself will complete abruptly by throwing the TestFailedException. Any
 * test method that completes abruptly with an exception is considered a failed
 * test. A test method that returns normally is considered a successful test.
 * 
 *
 * 

 * If you pass a Boolean expression to assert, a failed assertion will be reported, but without
 * reporting the left and right values. You can alternatively encode these values in a String passed as
 * a second argument to assert, as in:
 * 
 * 
 * 
 * val left = 2
 * val right = 1
 * assert(left == right, left + " did not equal " + right)
 * 
 *
 * 

 * Using this form of assert, the failure report will include the left and right values, 
 * helping you debug the problem. However, ScalaTest provides the === operator to make this easier.
 * (The === operator is defined in trait Assertions which trait Suite extends.)
 * You use it like this:
 * 
 *
 * 
 * val left = 2
 * val right = 1
 * assert(left === right)
 * 
 *
 * 

 * Because you use === here instead of ==, the failure report will include the left
 * and right values. For example, the detail message in the thrown TestFailedException from the assert
 * shown previously will include, "2 did not equal 1".
 * From this message you will know that the operand on the left had the value 2, and the operand on the right had the value 1.
 * 
 *
 * 

 * If you're familiar with JUnit, you would use ===
 * in a ScalaTest Suite where you'd use assertEquals in a JUnit TestCase.
 * The === operator is made possible by an implicit conversion from Any
 * to Equalizer. If you're curious to understand the mechanics, see the documentation for
 * Equalizer and the convertToEqualizer method.
 * 
 *
 * 
Expected results
 *
 * Although === provides a natural, readable extension to Scala's assert mechanism,
 * as the operands become lengthy, the code becomes less readable. In addition, the === comparison
 * doesn't distinguish between actual and expected values. The operands are just called left and right,
 * because if one were named expected and the other actual, it would be difficult for people to
 * remember which was which. To help with these limitations of assertions, Suite includes a method called expect that
 * can be used as an alternative to assert with ===. To use expect, you place
 * the expected value in parentheses after expect, followed by curly braces containing code 
 * that should result in the expected value. For example:
 *
 * 
 * val a = 5
 * val b = 2
 * expect(2) {
 *   a - b
 * }
 * 
 *
 * 

 * In this case, the expected value is 2, and the code being tested is a - b. This expectation will fail, and
 * the detail message in the TestFailedException will read, "Expected 2, but got 3."
 * 
 *
 * 
Intercepted exceptions
 *
 * 

 * Sometimes you need to test whether a method throws an expected exception under certain circumstances, such
 * as when invalid arguments are passed to the method. You can do this in the JUnit style, like this:
 * 
 *
 * 
 * val s = "hi"
 * try {
 *   s.charAt(-1)
 *   fail()
 * }
 * catch {
 *   case _: IndexOutOfBoundsException => // Expected, so continue
 * }
 * 
 *
 * 

 * If charAt throws IndexOutOfBoundsException as expected, control will transfer
 * to the catch case, which does nothing. If, however, charAt fails to throw an exception,
 * the next statement, fail(), will be executed. The fail method always completes abruptly with
 * a TestFailedException, thereby signaling a failed test.
 * 
 *
 * 

 * To make this common use case easier to express and read, ScalaTest provides an intercept
 * method. You use it like this:
 * 
 *
 * 
 * val s = "hi"
 * intercept[IndexOutOfBoundsException] {
 *   s.charAt(-1)
 * }
 * 
 *
 * 

 * This code behaves much like the previous example. If charAt throws an instance of IndexOutOfBoundsException,
 * intercept will return that exception. But if charAt completes normally, or throws a different
 * exception, intercept will complete abruptly with a TestFailedException. The intercept method returns the
 * caught exception so that you can inspect it further if you wish, for example, to ensure that data contained inside
 * the exception has the expected values. Here's an example:
 * 
 *
 * 
 * val s = "hi"
 * val caught =
 *   intercept[IndexOutOfBoundsException] {
 *     s.charAt(-1)
 *   }
 * assert(caught.getMessage === "String index out of range: -1")
 * 
 *
 * 
Using other assertions
 *
 * 

 * ScalaTest also supports another style of assertions via its matchers DSL. By mixing in
 * trait ShouldMatchers, you can 
 * write suites that look like:
 * 
 *
 * 
 * import org.scalatest.Suite
 * import org.scalatest.matchers.ShouldMatchers
 *
 * class ExampleSuite extends Suite with ShouldMatchers {
 *
 *   def testAddition {
 *     val sum = 1 + 1
 *     sum should equal (2)
 *   }
 *
 *   def testSubtraction {
 *     val diff = 4 - 1
 *     diff should equal (3)
 *   }
 * }
 * 
 * 
 * 
If you prefer the word "must" to the word "should," you can alternatively mix in
 * trait MustMatchers.
 * 
 *
 * 

 * If you are comfortable with assertion mechanisms from other test frameworks, chances
 * are you can use them with ScalaTest. Any assertion mechanism that indicates a failure with an exception
 * can be used as is with ScalaTest. For example, to use the assertEquals
 * methods provided by JUnit or TestNG, simply import them and use them. (You will of course need
 * to include the relevant JAR file for the framework whose assertions you want to use on either the
 * classpath or runpath when you run your tests.) Here's an example in which JUnit's assertions are
 * imported, then used within a ScalaTest suite:
 * 
 *
 * 
 * import org.scalatest.Suite
 * import org.junit.Assert._
 *
 * class ExampleSuite extends Suite {
 *
 *   def testAddition {
 *     val sum = 1 + 1
 *     assertEquals(2, sum)
 *   }
 *
 *   def testSubtraction {
 *     val diff = 4 - 1
 *     assertEquals(3, diff)
 *   }
 * }
 * 
 *
 * 
Nested suites
 *
 * 

 * A Suite can refer to a collection of other Suites,
 * which are called nested Suites. Those nested  Suites can in turn have
 * their own nested  Suites, and so on. Large test suites can be organized, therefore, as a tree of
 * nested Suites.
 * This trait's run method, in addition to invoking its
 * test methods, invokes run on each of its nested Suites.
 * 
 *
 * 

 * A List of a Suite's nested Suites can be obtained by invoking its
 * nestedSuites method. If you wish to create a Suite that serves as a
 * container for nested Suites, whether or not it has test methods of its own, simply override nestedSuites
 * to return a List of the nested Suites. Because this is a common use case, ScalaTest provides
 * a convenience Suites class, which takes a variable number of nested Suites as constructor
 * parameters. Here's an example:
 * 
 *
 * 
 * import org.scalatest.Suite
 * import org.scalatest.Suites
 *
 * class ASuite extends Suite {
 *   def testA {}
 * }
 * class BSuite extends Suite {
 *   def testB {}
 * }
 * class CSuite extends Suite {
 *   def testC {}
 * }
 *
 * class AlphabetSuite extends Suites(
 *   new ASuite,
 *   new BSuite,
 *   new CSuite
 * )
 * 
 *
 * 

 * If you now run AlphabetSuite:
 * 
 *
 * 
 * scala> (new AlphabetSuite).execute()
 * 
 *
 * 

 * You will see reports printed to the standard output that indicate the nested
 * suites—ASuite, BSuite, and
 * CSuite—were run:
 * 
 *
 * 
 * AlphabetSuite:
 * ASuite:
 * - testA
 * BSuite:
 * - testB
 * CSuite:
 * - testC
 * 
 *
 * 

 * Note that Runner can discover Suites automatically, so you need not
 * necessarily define nested Suites explicitly. See the documentation
 * for Runner for more information.
 * 
 *
 * 
The config map
 *
 * 

 * In some cases you may need to pass information to a suite of tests.
 * For example, perhaps a suite of tests needs to grab information from a file, and you want
 * to be able to specify a different filename during different runs.  You can accomplish this in ScalaTest by passing
 * the filename in a config map of key-value pairs, which is passed to run as a Map[String, Any].
 * The values in the config map are called "config objects," because they can be used to configure
 * suites, reporters, and tests.
 * 
 *
 * 

 * You can specify a string config object is via the ScalaTest Runner, either via the command line
 * or ScalaTest's ant task.
 * (See the documentation for Runner for information on how to specify 
 * config objects on the command line.)
 * The config map is passed to run, runNestedSuites, runTests, and runTest,
 * so one way to access it in your suite is to override one of those methods. If you need to use the config map inside your tests, you
 * can access it from the NoArgTest passed to withFixture, or the OneArgTest passed to
 * withFixture in the traits in the org.scalatest.fixture package. (See the
 * documentation for fixture.Suite
 * for instructions on how to access the config map in tests.)
 * 
 *
 * 
Ignored tests
 *
 * 

 * Another common use case is that tests must be “temporarily” disabled, with the
 * good intention of resurrecting the test at a later time. ScalaTest provides an Ignore
 * annotation for this purpose. You use it like this:
 * 
 *
 * 
 * import org.scalatest.Suite
 * import org.scalatest.Ignore
 *
 * class ExampleSuite extends Suite {
 *
 *   def testAddition {
 *     val sum = 1 + 1
 *     assert(sum === 2)
 *   }
 *
 *   @Ignore
 *   def testSubtraction {
 *     val diff = 4 - 1
 *     assert(diff === 3)
 *   }
 * }
 * 
 *
 * 

 * If you run this version of ExampleSuite with:
 * 
 *
 * 
 * scala> (new ExampleSuite).run()
 * 
 *
 * 

 * It will run only testAddition and report that testSubtraction was ignored. You'll see:
 * 
 *
 * 
 * ExampleSuite:
 * - testAddition
 * - testSubtraction !!! IGNORED !!!
 * 
 * 
 * 

 * Ignore is implemented as a tag. The Filter class effectively 
 * adds org.scalatest.Ignore to the tagsToExclude Set if it not already
 * in the tagsToExclude set passed to its primary constructor.  The only difference between
 * org.scalatest.Ignore and the tags you may define and exclude is that ScalaTest reports
 * ignored tests to the Reporter. The reason ScalaTest reports ignored tests is 
 * to encourage ignored tests to be eventually fixed and added back into the active suite of tests.
 * 
 *
 * 
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, 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.
 * 
 *
 * 

 * Although pending tests may be used more often in specification-style suites, such as
 * org.scalatest.FunSpec, you can also use it in Suite, like this:
 * 
 *
 * 
 * import org.scalatest.Suite
 *
 * class ExampleSuite extends Suite {
 *
 *   def testAddition {
 *     val sum = 1 + 1
 *     assert(sum === 2)
 *   }
 *
 *   def testSubtraction { pending }
 * }
 * 
 *
 * 

 * If you run this version of ExampleSuite with:
 * 
 *
 * 
 * scala> (new ExampleSuite).run()
 * 
 *
 * 

 * It will run both tests but report that testSubtraction is pending. You'll see:
 * 
 *
 * 
 * ExampleSuite:
 * - testAddition
 * - testSubtraction (pending)
 * 
 * 
 * 
Informers
 *
 * 

 * One of the parameters to run 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 Suite's methods will be sufficient, but
 * occasionally you may wish to provide custom information to the Reporter from a test method.
 * For this purpose, you can optionally include an Informer parameter in a test method, and then
 * pass the extra information to the Informer via its apply method. The Informer
 * will then pass the information to the Reporter by sending an InfoProvided event.
 * Here's an example:
 * 
 *
 * 
 * import org.scalatest._
 * 
 * class ExampleSuite extends Suite {
 *
 *   def testAddition(info: Informer) {
 *     assert(1 + 1 === 2)
 *     info("Addition seems to work")
 *   }
 * }
 * 
 *
 * If you run this Suite from the interpreter, you will see the message
 * included in the printed report:
 *
 * 
 * scala> (new ExampleSuite).run()
 * ExampleSuite:
 * - testAddition(Informer)
 *   + Addition seems to work 
 * 
 *
 * 
Executing suites in parallel
 *
 * 

 * The run method takes as one of its parameters an optional Distributor. If 
 * a Distributor is passed in, this trait's implementation of run puts its nested
 * Suites into the distributor rather than executing them directly. The caller of run
 * is responsible for ensuring that some entity runs the Suites placed into the 
 * distributor. The -c command line parameter to Runner, for example, will cause
 * Suites put into the Distributor to be run in parallel via a pool of threads.
 * 
 *
 * 
Tagging tests
 *
 * 

 * A Suite's tests may be classified into groups by tagging them with string names. When executing
 * a Suite, groups of tests can optionally be included and/or excluded. In this
 * trait's implementation, tags are indicated by annotations attached to the test method. To
 * create a new tag type to use in Suites, simply define a new Java annotation that itself is annotated with the org.scalatest.TagAnnotation annotation.
 * (Currently, for annotations to be
 * visible in Scala programs via Java reflection, the annotations themselves must be written in Java.) For example,
 * to create a tag named SlowAsMolasses, to use to mark slow tests, you would
 * write in Java:
 * 
 *
 * 
Because of a Scaladoc bug in Scala 2.8, I had to put a space after the at sign in one the target annotation example below. If you
 * want to copy and paste from this example, you'll need to remove the space by hand.  - Bill Venners
 *
 * 
 * import java.lang.annotation.*; 
 * import org.scalatest.TagAnnotation
 * 
 * @TagAnnotation
 * @Retention(RetentionPolicy.RUNTIME)
 * @ Target({ElementType.METHOD, ElementType.TYPE})
 * public @interface SlowAsMolasses {}
 * 
 *
 * 

 * Given this new annotation, you could place a Suite test method into the SlowAsMolasses group
 * (i.e., tag it as being SlowAsMolasses) like this:
 * 
 *
 * 
 * @SlowAsMolasses
 * def testSleeping { sleep(1000000) }
 * 
 *
 * 

 * The run method takes a Filter, whose constructor takes an optional
 * Set[String] 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.
 * 
 *
 * 
Shared fixtures
 *
 * 

 * A test fixture is objects or other artifacts (such as files, sockets, database
 * connections, etc.) used by tests to do their work.
 * If a fixture is used by only one test method, then the definitions of the fixture objects can
 * be local to the method, such as the objects assigned to sum and diff in the
 * previous ExampleSuite examples. If multiple methods need to share an immutable fixture, one approach
 * is to assign them to instance variables.
 * 
 *
 * 

 * In some cases, however, shared mutable fixture objects may be changed by test methods 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 3 offered 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 usually involves reassigning vars or mutating objects
 * between tests. Before going that route, you may wish to consider some more functional approaches that
 * avoid side effects.
 * 
 *
 * 
Calling create-fixture methods
 *
 * 

 * One approach is to write one or more create-fixture methods
 * that return a new instance of a needed fixture object (or an holder object containing multiple needed fixture objects) each time it
 * is called. You can then call a create-fixture method at the beginning of each
 * test method that needs the fixture, storing the returned object or objects in local variables. Here's an example:
 * 
 *
 * 
 * import org.scalatest.Suite
 * import collection.mutable.ListBuffer
 *
 * class ExampleSuite extends Suite {
 * 
 *   def fixture =
 *     new {
 *       val builder = new StringBuilder("ScalaTest is ")
 *       val buffer = new ListBuffer[String]
 *     }
 * 
 *   def testEasy {
 *     val f = fixture
 *     f.builder.append("easy!")
 *     assert(f.builder.toString === "ScalaTest is easy!")
 *     assert(f.buffer.isEmpty)
 *     f.buffer += "sweet"
 *   }
 * 
 *   def testFun {
 *     val f = fixture
 *     f.builder.append("fun!")
 *     assert(f.builder.toString === "ScalaTest is fun!")
 *     assert(f.buffer.isEmpty)
 *   }
 * }
 * 
 *
 * 

 * The “f.” in front of each use of a fixture object provides a visual indication of which objects 
 * are part of the fixture, but if you prefer, you can import the the members with “import f._” and use the names directly.
 * 
 *
 * 
Instantiating fixture traits
 *
 * 

 * A related technique is to place
 * the fixture objects in a fixture trait and run your test code in the context of a new anonymous class instance that mixes in
 * the fixture trait, like this:
 * 
 *
 * 
 * import org.scalatest.Suite
 * import collection.mutable.ListBuffer
 * 
 * class ExampleSuite extends Suite {
 * 
 *   trait Fixture {
 *     val builder = new StringBuilder("ScalaTest is ")
 *     val buffer = new ListBuffer[String]
 *   }
 * 
 *   def testEasy {
 *     new Fixture {
 *       builder.append("easy!")
 *       assert(builder.toString === "ScalaTest is easy!")
 *       assert(buffer.isEmpty)
 *       buffer += "sweet"
 *     }
 *   }
 * 
 *   def testFun {
 *     new Fixture {
 *       builder.append("fun!")
 *       assert(builder.toString === "ScalaTest is fun!")
 *       assert(buffer.isEmpty)
 *     }
 *   }
 * }
 * 
 *
 * 
Mixing in OneInstancePerTest
 *
 * 

 * If every test method 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 Suite, similar to the way JUnit tests are executed. Here's an example:
 * 
 *
 * 
 * import org.scalatest.Suite
 * import org.scalatest.OneInstancePerTest
 * import collection.mutable.ListBuffer
 * 
 * class ExampleSuite extends Suite with OneInstancePerTest {
 * 
 *   val builder = new StringBuilder("ScalaTest is ")
 *   val buffer = new ListBuffer[String]
 * 
 *   def testEasy {
 *     builder.append("easy!")
 *     assert(builder.toString === "ScalaTest is easy!")
 *     assert(buffer.isEmpty)
 *     buffer += "sweet"
 *   }
 * 
 *   def testFun {
 *     builder.append("fun!")
 *     assert(builder.toString === "ScalaTest is fun!")
 *     assert(buffer.isEmpty)
 *   }
 * }
 * 
 *
 * 

 * Although the create-fixture, fixture-trait, 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, you'll need to either
 * use side effects or the loan pattern.
 * 
 *
 * 
Mixing in BeforeAndAfter
 *
 * 

 * One way to use side effects is to mix in the BeforeAndAfter trait.
 * With this trait you can denote a bit of code to run before each test with before and/or after each test
 * each test with after, like this:
 * 
 * 
 * 
 * import org.scalatest.Suite
 * import org.scalatest.BeforeAndAfter
 * import collection.mutable.ListBuffer
 * 
 * class ExampleSuite extends Suite with BeforeAndAfter {
 * 
 *   val builder = new StringBuilder
 *   val buffer = new ListBuffer[String]
 * 
 *   before {
 *     builder.append("ScalaTest is ")
 *   }
 * 
 *   after {
 *     builder.clear()
 *     buffer.clear()
 *   }
 * 
 *   def testEasy {
 *     builder.append("easy!")
 *     assert(builder.toString === "ScalaTest is easy!")
 *     assert(buffer.isEmpty)
 *     buffer += "sweet"
 *   }
 * 
 *   def testFun {
 *     builder.append("fun!")
 *     assert(builder.toString === "ScalaTest is fun!")
 *     assert(buffer.isEmpty)
 *   }
 * }
 * 
 * 
 * 
Overriding withFixture(NoArgTest)
 *
 * 

 * An alternate way to take care of setup and cleanup via side effects
 * is to override withFixture. Trait Suite's implementation of
 * runTest passes a no-arg test function to withFixture. It is withFixture's
 * responsibility to invoke that test function.  Suite's implementation of withFixture simply
 * invokes the function, like this:
 * 
 *
 * 
 * // Default implementation
 * protected def withFixture(test: NoArgTest) {
 *   test()
 * }
 * 
 *
 * 

 * You can, therefore, override withFixture to perform setup before, and cleanup after, invoking the test function. If
 * you have cleanup to perform, you should invoke the test function
 * inside a try block and perform the cleanup in a finally clause.
 * Here's an example:
 * 
 *
 * 
 * import org.scalatest.Suite
 * import collection.mutable.ListBuffer
 *
 * class ExampleSuite extends Suite {
 *
 *   val builder = new StringBuilder
 *   val buffer = new ListBuffer[String]
 *
 *   override def withFixture(test: NoArgTest) {
 *     builder.append("ScalaTest is ") // perform setup
 *     try {
 *       test() // invoke the test function
 *     }
 *     finally {
 *       builder.clear() // perform cleanup
 *       buffer.clear()
 *     }
 *   }
 *
 *   def testEasy {
 *     builder.append("easy!")
 *     assert(builder.toString === "ScalaTest is easy!")
 *     assert(buffer.isEmpty)
 *     buffer += "sweet"
 *   }
 *
 *   def testFun {
 *     builder.append("fun!")
 *     assert(builder.toString === "ScalaTest is fun!")
 *     assert(buffer.isEmpty)
 *     buffer += "clear"
 *   }
 * }
 * 
 *
 * 

 * Note that the NoArgTest passed to withFixture, in addition to
 * an apply method that executes the test, also includes the test name as well as the config
 * map passed to runTest. Thus you can also use the test name and configuration objects in withFixture.
 * 
 *
 * 

 * The reason you should perform cleanup in a finally clause is that withFixture is called by
 * runTest, which expects an exception to be thrown to indicate a failed test. Thus when you invoke
 * the test function inside withFixture, it may complete abruptly with an exception. The finally
 * clause will ensure the fixture cleanup happens as that exception propagates back up the call stack to runTest.
 * 
 *
 * 
Overriding withFixture(OneArgTest)
 *
 * 

 * To use the loan pattern, you can extend fixture.Suite (from the org.scalatest.fixture package) instead of
 * Suite. Each test in a fixture.Suite takes a fixture as a parameter, allowing you to pass the fixture into
 * the test. You must indicate the type of the fixture parameter by specifying FixtureParam, and implement a
 * withFixture method that takes a OneArgTest. This withFixture method is responsible for
 * invoking the one-arg test function, so you can perform fixture set up before, and clean up after, invoking and passing
 * the fixture into the test function. Here's an example:
 * 
 *
 * 
 * import org.scalatest.fixture
 * import java.io.FileWriter
 * import java.io.File
 * 
 * class ExampleSuite extends fixture.Suite {
 * 
 *   final val tmpFile = "temp.txt"
 * 
 *   type FixtureParam = FileWriter
 * 
 *   def withFixture(test: OneArgTest) {
 * 
 *     val writer = new FileWriter(tmpFile) // set up the fixture
 *     try {
 *       test(writer) // "loan" the fixture to the test
 *     }
 *     finally {
 *       writer.close() // clean up the fixture
 *     }
 *   }
 * 
 *   def testEasy(writer: FileWriter) {
 *     writer.write("Hello, test!")
 *     writer.flush()
 *     assert(new File(tmpFile).length === 12)
 *   }
 * 
 *   def testFun(writer: FileWriter) {
 *     writer.write("Hi, test!")
 *     writer.flush()
 *     assert(new File(tmpFile).length === 9)
 *   }
 * }
 * 
 *
 * 

 * For more information, see the documentation for fixture.Suite.
 * 
 *
 * 
Providing different fixtures to different tests
 * 
 * 

 * If different tests in the same Suite require different fixtures, you can combine the previous techniques and
 * provide each test with just the fixture or fixtures it needs. Here's an example in which a StringBuilder and a
 * ListBuffer are provided via fixture traits, and file writer (that requires cleanup) is provided via the loan pattern:
 * 
 *
 * 
 * import java.io.FileWriter
 * import java.io.File
 * import collection.mutable.ListBuffer
 * import org.scalatest.Suite
 * 
 * class ExampleSuite extends Suite {
 * 
 *   final val tmpFile = "temp.txt"
 * 
 *   trait Builder {
 *     val builder = new StringBuilder("ScalaTest is ")
 *   }
 * 
 *   trait Buffer {
 *     val buffer = ListBuffer("ScalaTest", "is")
 *   }
 * 
 *   def withWriter(testCode: FileWriter => Any) {
 *     val writer = new FileWriter(tmpFile) // set up the fixture
 *     try {
 *       testCode(writer) // "loan" the fixture to the test
 *     }
 *     finally {
 *       writer.close() // clean up the fixture
 *     }
 *   }
 * 
 *   def testProductive { // This test needs the StringBuilder fixture
 *     new Builder {
 *       builder.append("productive!")
 *       assert(builder.toString === "ScalaTest is productive!")
 *     }
 *   }
 * 
 *   def testReadable { // This test needs the ListBuffer[String] fixture
 *     new Buffer {
 *       buffer += ("readable!")
 *       assert(buffer === List("ScalaTest", "is", "readable!"))
 *     }
 *   }
 * 
 *   def testFriendly { // This test needs the FileWriter fixture
 *     withWriter { writer =>
 *       writer.write("Hello, user!")
 *       writer.flush()
 *       assert(new File(tmpFile).length === 12)
 *     }
 *   }
 * 
 *   def testClearAndConcise { // This test needs the StringBuilder and ListBuffer
 *     new Builder with Buffer {
 *       builder.append("clear!")
 *       buffer += ("concise!")
 *       assert(builder.toString === "ScalaTest is clear!")
 *       assert(buffer === List("ScalaTest", "is", "concise!"))
 *     }
 *   }
 * 
 *   def testComposable { // This test needs all three fixtures
 *     new Builder with Buffer {
 *       builder.append("clear!")
 *       buffer += ("concise!")
 *       assert(builder.toString === "ScalaTest is clear!")
 *       assert(buffer === List("ScalaTest", "is", "concise!"))
 *       withWriter { writer =>
 *         writer.write(builder.toString)
 *         writer.flush()
 *         assert(new File(tmpFile).length === 19)
 *       }
 *     }
 *   }
 * }
 * 
 *
 * 

 * In the previous example, testProductive uses only the StringBuilder fixture, so it just instantiates
 * a new Builder, whereas testReadable uses only the ListBuffer fixture, so it just intantiates
 * a new Buffer. testFriendly needs just the FileWriter fixture, so it invokes
 * withWriter, which prepares and passes a FileWriter to the test (and takes care of closing it afterwords).
 * 
 *
 * 

 * Two tests need multiple fixtures: testClearAndConcise needs both the StringBuilder and the
 * ListBuffer, so it instantiates a class that mixes in both fixture traits with new Builder with Buffer.
 * testComposable needs all three fixtures, so in addition to new Builder with Buffer it also invokes
 * withWriter, wrapping just the of the test code that needs the fixture.
 * 
 *
 * 

 * Note that in this case, the loan pattern is being implemented via the withWriter method that takes a function, not
 * by overriding fixture.Suite's withFixture(OneArgTest) method. fixture.Suite makes the most sense
 * if all (or at least most) tests need the same fixture, whereas in this Suite only two tests need the
 * FileWriter.
 * 
 *
 * 

 * Note also that two test methods, testFriendly and testComposable, are declared as parameterless methods even
 * though they have a side effect. In production code you would normally declare these as empty-paren methods, and call them with
 * empty parentheses, to make it more obvious to readers of the code that they have a side effect. Whether or not a test method has
 * a side effect, however, is a less important distinction than it is for methods in production code. Moreover, test methods are not
 * normally invoked directly by client code, but rather through reflection by running the Suite that contains them, so a
 * lack of parentheses on an invocation of a side-effecting test method would not normally appear in any client code. Given the empty
 * parentheses do not add much value in the test methods case, the recommended style is to simply always leave them off.
 * 
 *
 * 

 * In the previous example, the withWriter method passed an object into
 * the tests. Passing fixture objects into tests is generally a good idea when possible, but sometimes a side affect is unavoidable.
 * For example, if you need to initialize a database running on a server across a network, your with-fixture 
 * method will likely have nothing to pass. In such cases, simply create a with-fixture method that takes a by-name parameter and
 * performs setup and cleanup via side effects, like this:
 * 
 *
 * 
 * def withDataInDatabase(test: => Any) {
 *   // initialize the database across the network
 *   try {
 *     test // "loan" the initialized database to the test
 *   }
 *   finally {
 *     // clean up the database
 *   }
 * }
 * 
 * 
 * 

 * You can then use it like:
 * 
 * 
 * 
 * def testUserLogsIn {
 *   withDataInDatabase {
 *     // test user logging in scenario
 *   }
 * }
 * 
 * 
 * 
Composing stackable fixture traits
 *
 * 

 * In larger projects, teams often end up with several different fixtures that test classes need in different combinations,
 * and possibly initialized (and cleaned up) in different orders. A good way to accomplish this in ScalaTest is to factor the individual
 * fixtures into traits that can be composed using the stackable trait pattern. This can be done, for example, by placing
 * withFixture methods in several traits, each of which call super.withFixture. Here's an example in
 * which the StringBuilder and ListBuffer[String] fixtures used in the previous examples have been
 * factored out into two stackable fixture traits named Builder and Buffer:
 * 
 *
 * 
 * import org.scalatest.Suite
 * import org.scalatest.AbstractSuite
 * import collection.mutable.ListBuffer
 * 
 * trait Builder extends AbstractSuite { this: Suite =>
 * 
 *   val builder = new StringBuilder
 * 
 *   abstract override def withFixture(test: NoArgTest) {
 *     builder.append("ScalaTest is ")
 *     try {
 *       super.withFixture(test) // To be stackable, must call super.withFixture
 *     }
 *     finally {
 *       builder.clear()
 *     }
 *   }
 * }
 * 
 * trait Buffer extends AbstractSuite { this: Suite =>
 * 
 *   val buffer = new ListBuffer[String]
 * 
 *   abstract override def withFixture(test: NoArgTest) {
 *     try {
 *       super.withFixture(test) // To be stackable, must call super.withFixture
 *     }
 *     finally {
 *       buffer.clear()
 *     }
 *   }
 * }
 * 
 * class ExampleSuite extends Suite with Builder with Buffer {
 * 
 *   def testEasy {
 *     builder.append("easy!")
 *     assert(builder.toString === "ScalaTest is easy!")
 *     assert(buffer.isEmpty)
 *     buffer += "sweet"
 *   }
 * 
 *   def testFun {
 *     builder.append("fun!")
 *     assert(builder.toString === "ScalaTest is fun!")
 *     assert(buffer.isEmpty)
 *     buffer += "clear"
 *   }
 * }
 * 
 *
 * 

 * By mixing in both the Builder and Buffer traits, ExampleSuite gets both fixtures, which will be
 * initialized before each test and cleaned up after. The order the traits are mixed together determines the order of execution.
 * In this case, Builder is "super" to Buffer. If you wanted Buffer to be "super"
 * to Builder, you need only switch the order you mix them together, like this: 
 * 
 *
 * 
 * class Example2Suite extends Suite with Buffer with Builder
 * 
 *
 * 

 * And if you only need one fixture you mix in only that trait:
 * 
 *
 * 
 * class Example3Suite extends Suite with Builder
 * 
 *
 * 

 * Another way to create stackable fixture traits is by extending the BeforeAndAfterEach
 * and/or BeforeAndAfterAll traits.
 * BeforeAndAfterEach has a beforeEach method that will be run before each test (like JUnit's setUp),
 * and an afterEach method that will be run after (like JUnit's tearDown).
 * Similarly, BeforeAndAfterAll has a beforeAll method that will be run before all tests,
 * and an afterAll method that will be run after all tests. Here's what the previously shown example would look like if it
 * were rewritten to use the BeforeAndAfterEach methods instead of withFixture:
 * 
 *
 * 
 * import org.scalatest.Suite
 * import org.scalatest.BeforeAndAfterEach
 * import collection.mutable.ListBuffer
 * 
 * trait Builder extends BeforeAndAfterEach { this: Suite =>
 * 
 *   val builder = new StringBuilder
 * 
 *   override def beforeEach() {
 *     builder.append("ScalaTest is ")
 *     super.beforeEach() // To be stackable, must call super.beforeEach
 *   }
 * 
 *   override def afterEach() {
 *     try {
 *       super.afterEach() // To be stackable, must call super.afterEach
 *     }
 *     finally {
 *       builder.clear()
 *     }
 *   }
 * }
 * 
 * trait Buffer extends BeforeAndAfterEach { this: Suite =>
 * 
 *   val buffer = new ListBuffer[String]
 * 
 *   override def afterEach() {
 *     try {
 *       super.afterEach() // To be stackable, must call super.afterEach
 *     }
 *     finally {
 *       buffer.clear()
 *     }
 *   }
 * }
 * 
 * class ExampleSuite extends Suite with Builder with Buffer {
 * 
 *   def testEasy {
 *     builder.append("easy!")
 *     assert(builder.toString === "ScalaTest is easy!")
 *     assert(buffer.isEmpty)
 *     buffer += "sweet"
 *   }
 * 
 *   def testFun {
 *     builder.append("fun!")
 *     assert(builder.toString === "ScalaTest is fun!")
 *     assert(buffer.isEmpty)
 *     buffer += "clear"
 *   }
 * }
 * 
 *
 * 

 * To get the same ordering as withFixture, place your super.beforeEach call at the end of each
 * beforeEach method, and the super.afterEach call at the beginning of each afterEach
 * method, as shown in the previous example. It is a good idea to invoke super.afterEach in a try
 * block and perform cleanup in a finally clause, as shown in the previous example, because this ensures the
 * cleanup code is performed even if super.afterAll throws an exception.
 * 
 *
 * 

 * One difference to bear in mind between the before-and-after traits and the withFixture methods, is that if
 * a withFixture method completes abruptly with an exception, it is considered a failed test. By contrast, if any of the
 * methods on the before-and-after traits (i.e., before  and after of BeforeAndAfter,
 * beforeEach and afterEach of BeforeAndAfterEach,
 * and beforeAll and afterAll of BeforeAndAfterAll) complete abruptly, it is considered a
 * failed suite, which will result in a SuiteAborted event.
 * 
 * 
 * 
 * 
Treatment of java.lang.Errors
 *
 * 

 * The Javadoc documentation for java.lang.Error states:
 * 
 *
 * 

 * An Error is a subclass of Throwable that indicates serious problems that a reasonable application should not try to catch. Most
 * such errors are abnormal conditions.
 * 
 *
 * 

 * Because Errors are used to denote serious errors, trait Suite and its subtypes in the ScalaTest API do not always treat a test
 * that completes abruptly with an Error as a test failure, but sometimes as an indication that serious problems
 * have arisen that should cause the run to abort. For example, if a test completes abruptly with an OutOfMemoryError, 
 * it will not be reported as a test failure, but will instead cause the run to abort. Because not everyone uses Errors only to represent serious
 * problems, however, ScalaTest only behaves this way for the following exception types (and their subclasses):
 * 
 *
 * 

 * 
java.lang.annotation.AnnotationFormatError
 * 
java.awt.AWTError
 * 
java.nio.charset.CoderMalfunctionError
 * 
javax.xml.parsers.FactoryConfigurationError
 * 
java.lang.LinkageError
 * 
java.lang.ThreadDeath
 * 
javax.xml.transform.TransformerFactoryConfigurationError
 * 
java.lang.VirtualMachineError
 * 
 *
 * 

 * The previous list includes all Errors that exist as part of Java 1.5 API, excluding java.lang.AssertionError. ScalaTest
 * does treat a thrown AssertionError as an indication of a test failure. In addition, any other Error that is not an instance of a
 * type mentioned in the previous list will be caught by the Suite traits in the ScalaTest API and reported as the cause of a test failure. 
 * 
 *
 * 

 * Although trait Suite and all its subtypes in the ScalaTest API consistently behave this way with regard to Errors,
 * this behavior is not required by the contract of Suite. Subclasses and subtraits that you define, for example, may treat all
 * Errors as test failures, or indicate errors in some other way that has nothing to do with exceptions.
 * 
 *
 * 
Extensibility
 *
 * 

 * Trait Suite provides default implementations of its methods that should
 * be sufficient for most applications, but many methods can be overridden when desired. Here's
 * a summary of the methods that are intended to be overridden:
 * 
 *
 * 

 * 
run - override this method to define custom ways to run suites of
 *   tests.
 * 
runNestedSuites - override this method to define custom ways to run nested suites.
 * 
runTests - override this method to define custom ways to run a suite's tests.
 * 
runTest - override this method to define custom ways to run a single named test.
 * 
testNames - override this method to specify the Suite's test names in a custom way.
 * 
tags - override this method to specify the Suite's test tags in a custom way.
 * 
nestedSuites - override this method to specify the Suite's nested Suites in a custom way.
 * 
suiteName - override this method to specify the Suite's name in a custom way.
 * 
expectedTestCount - override this method to count this Suite's expected tests in a custom way.
 * 
 *
 * 

 * For example, this trait's implementation of testNames performs reflection to discover methods starting with test,
 * and places these in a Set whose iterator returns the names in alphabetical order. If you wish to run tests in a different
 * order in a particular Suite, perhaps because a test named testAlpha can only succeed after a test named
 * testBeta has run, you can override testNames so that it returns a Set whose iterator returns
 * testBeta before testAlpha. (This trait's implementation of run will invoke tests
 * in the order they come out of the testNames Set iterator.)
 * 
 *
 * 

 * Alternatively, you may not like starting your test methods with test, and prefer using @Test annotations in
 * the style of Java's JUnit 4 or TestNG. If so, you can override testNames to discover tests using either of these two APIs
 * @Test annotations, or one of your own invention. (This is in fact
 * how org.scalatest.junit.JUnitSuite and org.scalatest.testng.TestNGSuite work.)
 * 
 *
 * 

 * Moreover, test in ScalaTest does not necessarily mean test method. A test can be anything that can be given a name,
 * that starts and either succeeds or fails, and can be ignored. In org.scalatest.FunSuite, for example, tests are represented
 * as function values. This
 * approach might look foreign to JUnit users, but may feel more natural to programmers with a functional programming background.
 * To facilitate this style of writing tests, FunSuite overrides testNames, runTest, and run such that you can 
 * define tests as function values.
 * 
 *
 * 

 * You can also model existing JUnit 3, JUnit 4, or TestNG tests as suites of tests, thereby incorporating tests written in Java into a ScalaTest suite.
 * The "wrapper" classes in packages org.scalatest.junit and org.scalatest.testng exist to make this easy.
 * No matter what legacy tests you may have, it is likely you can create or use an existing Suite subclass that allows you to model those tests
 * as ScalaTest suites and tests and incorporate them into a ScalaTest suite. You can then write new tests in Scala and continue supporting
 * older tests in Java.
 * 
 *
 * @author Bill Venners
 */
trait Suite extends Assertions with AbstractSuite with Serializable { thisSuite =>

  import Suite.TestMethodPrefix, Suite.InformerInParens, Suite.IgnoreAnnotation

  /**
   * A test function taking no arguments, which also provides a test name and config map.
   *
   * 

   * Suite's implementation of runTest passes instances of this trait
   * to withFixture for every test method it executes. It invokes withFixture
   * for every test, including test methods that take an Informer. For the latter case,
   * the Informer to pass to the test method is already contained inside the
   * NoArgTest instance passed to withFixture.
   * 
   */
  protected trait NoArgTest extends (() => Unit) {

    /**
     * The name of this test.
     */
    def name: String

    /**
     * Runs the code of the test.
     */
    def apply()

    /**
     * A Map[String, Any] containing objects that can be used
     * to configure the fixture and test.
     */
    def configMap: Map[String, Any]
  }

  /**
  * A List of this Suite object's nested Suites. If this Suite contains no nested Suites,
  * this method returns an empty List. This trait's implementation of this method returns an empty List.
  */
  def nestedSuites: List[Suite] = Nil
  
  /**
   * Executes this Suite, printing results to the standard output.
   *
   * 

   * This method implementation calls run on this Suite, passing in:
   * 
   *
   * 

   * 
testName - None
   * 
reporter - a reporter that prints to the standard output
   * 
stopper - a Stopper whose apply method always returns false
   * 
filter - a Filter constructed with None for tagsToInclude and Set()
   *   for tagsToExclude
   * 
configMap - an empty Map[String, Any]
   * 
distributor - None
   * 
tracker - a new Tracker
   * 
   *
   * 

   * This method serves as a convenient way to execute a Suite, especially from
   * within the Scala interpreter.
   * 
   *
   * 

   * Note:  In ScalaTest, the terms "execute" and "run" basically mean the same thing and
   * can be used interchangably. The reason this convenience method and its three overloaded forms
   * aren't named run
   * is because junit.framework.TestCase declares a run method
   * that takes no arguments but returns a junit.framework.TestResult. That
   * run method would not overload with this method if it were named run,
   * because it would have the same parameters but a different return type than the one
   * defined in TestCase. To facilitate integration with JUnit 3, therefore,
   * these convenience "run" methods are named execute. In particular, this allows trait
   * org.scalatest.junit.JUnit3Suite to extend both org.scalatest.Suite and
   * junit.framework.TestCase, which enables the creating of classes that
   * can be run with either ScalaTest or JUnit 3.
   * 
   *
  final def execute() {
    run(None, new StandardOutReporter, new Stopper {}, Filter(), Map(), None, new Tracker)
  }

   * Executes this Suite with the specified configMap, printing results to the standard output.
   *
   * 

   * This method implementation calls run on this Suite, passing in:
   * 
   *
   * 

   * 
testName - None
   * 
reporter - a reporter that prints to the standard output
   * 
stopper - a Stopper whose apply method always returns false
   * 
filter - a Filter constructed with None for tagsToInclude and Set()
   *   for tagsToExclude
   * 
configMap - the specified configMap Map[String, Any]
   * 
distributor - None
   * 
tracker - a new Tracker
   * 
   *
   * 

   * This method serves as a convenient way to execute a Suite, passing in some objects via the configMap, especially from within the Scala interpreter.
   * 
   *
   * 

   * Note:  In ScalaTest, the terms "execute" and "run" basically mean the same thing and
   * can be used interchangably. The reason this convenience method and its three overloaded forms
   * aren't named run is described the documentation of the overloaded form that
   * takes no parameters: execute().
   * 
   *
   * @param configMap a Map of key-value pairs that can be used by the executing Suite of tests.
   *
   * @throws NullPointerException if the passed configMap parameter is null.
   *
  final def execute(configMap: Map[String, Any]) {
    run(None, new StandardOutReporter, new Stopper {}, Filter(), configMap, None, new Tracker)
  }

   * Executes the test specified as testName in this Suite, printing results to the standard output.
   *
   * 

   * This method implementation calls run on this Suite, passing in:
   * 
   *
   * 

   * 
testName - Some(testName)
   * 
reporter - a reporter that prints to the standard output
   * 
stopper - a Stopper whose apply method always returns false
   * 
filter - a Filter constructed with None for tagsToInclude and Set()
   *   for tagsToExclude
   * 
configMap - an empty Map[String, Any]
   * 
distributor - None
   * 
tracker - a new Tracker
   * 
   *
   * 

   * This method serves as a convenient way to run a single test, especially from within the Scala interpreter.
   * 
   *
   * 

   * Note:  In ScalaTest, the terms "execute" and "run" basically mean the same thing and
   * can be used interchangably. The reason this convenience method and its three overloaded forms
   * aren't named run is described the documentation of the overloaded form that
   * takes no parameters: execute().
   * 
   *
   * @param testName the name of one test to run.
   *
   * @throws NullPointerException if the passed testName parameter is null.
   * @throws IllegalArgumentException if testName is defined, but no test with the specified test name
   *     exists in this Suite
   *
  final def execute(testName: String) {
    run(Some(testName), new StandardOutReporter, new Stopper {}, Filter(), Map(), None, new Tracker)
  }
*/

  /**
   * Executes one or more tests in this Suite, printing results to the standard output.
   *
   * 

   * This method invokes run on itself, passing in values that can be configured via the parameters to this
   * method, all of which have default values. This behavior is convenient when working with ScalaTest in the Scala interpreter.
   * Here's a summary of this method's parameters and how you can use them:
   * 
   *
   * 

   * The testName parameter
   * 
   *
   * 

   * If you leave testName at its default value (of null), this method will pass None to
   * the testName parameter of run, and as a result all the tests in this suite will be executed. If you
   * specify a testName, this method will pass Some(testName) to run, and only that test
   * will be run. Thus to run all tests in a suite from the Scala interpreter, you can write:
   * 
   *
   * 
   * scala> (new ExampleSuite).execute()
   * 
   *
   * 

   * To run just the test named "my favorite test" in a suite from the Scala interpreter, you would write:
   * 
   *
   * 
   * scala> (new ExampleSuite).execute("my favorite test")
   * 
   *
   * 

   * Or:
   * 
   *
   * 
   * scala> (new ExampleSuite).execute(testName = "my favorite test")
   * 
   *
   * 

   * The configMap parameter
   * 
   *
   * 

   * If you provide a value for the configMap parameter, this method will pass it to run. If not, the default value
   * of an empty Map will be passed. For more information on how to use a config map to configure your test suites, see
   * the config map section in the main documentation for this trait. Here's an example in which you configure
   * a run with the name of an input file:
   * 
   *
   * 
   * scala> (new ExampleSuite).execute(configMap = Map("inputFileName" -> "in.txt")
   * 
   *
   * 

   * The color parameter
   * 
   *
   * 

   * If you leave the color parameter unspecified, this method will configure the reporter it passes to run to print
   * to the standard output in color (via ansi escape characters). If you don't want color output, specify false for color, like this:
   * 
   *
   * 
   * scala> (new ExampleSuite).execute(color = false)
   * 
   *
   * 

   * The durations parameter
   * 
   *
   * 

   * If you leave the durations parameter unspecified, this method will configure the reporter it passes to run to
   * not print durations for tests and suites to the standard output. If you want durations printed, specify true for durations,
   * like this:
   * 
   *
   * 
   * scala> (new ExampleSuite).execute(durations = true)
   * 
   *
   * 

   * The shortstacks and fullstacks parameters
   * 
   *
   * 

   * If you leave both the shortstacks and fullstacks parameters unspecified, this method will configure the reporter
   * it passes to run to not print stack traces for failed tests if it has a stack depth that identifies the offending
   * line of test code. If you prefer a short stack trace (10 to 15 stack frames) to be printed with any test failure, specify true for
   * shortstacks:
   * 
   *
   * 
   * scala> (new ExampleSuite).execute(shortstacks = true)
   * 
   *
   * 

   * For full stack traces, set fullstacks to true:
   * 
   *
   * 
   * scala> (new ExampleSuite).execute(fullstacks = true)
   * 
   *
   * 

   * If you specify true for both shortstacks and fullstacks, you'll get full stack traces.
   * 
   *
   * 

   * The stats parameter
   * 
   *
   * 

   * If you leave the stats parameter unspecified, this method will not fire RunStarting and either RunCompleted
   * or RunAborted events to the reporter it passes to run.
   * If you specify true for stats, this method will fire the run events to the reporter, and the reporter will print the
   * expected test count before the run, and various statistics after, including the number of suites completed and number of tests that
   * succeeded, failed, were ignored or marked pending. Here's how you get the stats:
   * 
   *
   * 
   * scala> (new ExampleSuite).execute(stats = true)
   * 
   *
   *
   * 

   * To summarize, this method will pass to run:
   * 
   * 

   * 
testName - None if this method's testName parameter is left at its default value of null, else Some(testName).
   * 
reporter - a reporter that prints to the standard output
   * 
stopper - a Stopper whose apply method always returns false
   * 
filter - a Filter constructed with None for tagsToInclude and Set()
   *   for tagsToExclude
   * 
configMap - the configMap passed to this method
   * 
distributor - None
   * 
tracker - a new Tracker
   * 
   *
   * 

   * Note:  In ScalaTest, the terms "execute" and "run" basically mean the same thing and
   * can be used interchangably. The reason this method isn't named run is that it takes advantage of
   * default arguments, and you can't mix overloaded methods and default arguments in Scala. (If named run,
   * this method would have the same name but different arguments than the main run method that
   * takes seven arguments. Thus it would overload and couldn't be used with default argument values.)
   * 
   *
   * 

   * Design note: This method has two "features" that may seem unidiomatic. First, the default value of testName is null.
   * Normally in Scala the type of testName would be Option[String] and the default value would
   * be None, as it is in this trait's run method. The null value is used here for two reasons. First, in
   * ScalaTest 1.5, execute was changed from four overloaded methods to one method with default values, taking advantage of
   * the default and named parameters feature introduced in Scala 2.8.
   * To not break existing source code, testName needed to have type String, as it did in two of the overloaded
   * execute methods prior to 1.5. The other reason is that execute has always been designed to be called primarily
   * from an interpeter environment, such as the Scala REPL (Read-Evaluate-Print-Loop). In an interpreter environment, minimizing keystrokes is king.
   * A String type with a null default value lets users type suite.execute("my test name") rather than
   * suite.execute(Some("my test name")), saving several keystrokes.
   * 
   *
   * 

   * The second non-idiomatic feature is that shortstacks and fullstacks are all lower case rather than
   * camel case. This is done to be consistent with the Shell, which also uses those forms. The reason 
   * lower case is used in the Shell is to save keystrokes in an interpreter environment.  Most Unix commands, for
   * example, are all lower case, making them easier and quicker to type.  In the ScalaTest
   * Shell, methods like shortstacks, fullstacks, and nostats, etc., are 
   * designed to be all lower case so they feel more like shell commands than methods.
   * 
   *
   * @param testName the name of one test to run.
   * @param configMap a Map of key-value pairs that can be used by the executing Suite of tests.
   * @param color a boolean that configures whether output is printed in color
   * @param durations a boolean that configures whether test and suite durations are printed to the standard output
   * @param shortstacks a boolean that configures whether short stack traces should be printed for test failures
   * @param fullstacks a boolean that configures whether full stack traces should be printed for test failures
   * @param stats a boolean that configures whether test and suite statistics are printed to the standard output
   *
   * @throws NullPointerException if the passed configMap parameter is null.
   * @throws IllegalArgumentException if testName is defined, but no test with the specified test name
   *     exists in this Suite
   */
  final def execute(
    testName: String = null,
    configMap: Map[String, Any] = Map(),
    color: Boolean = true,
    durations: Boolean = false,
    shortstacks: Boolean = false,
    fullstacks: Boolean = false,
    stats: Boolean = false
  ) {
    if (configMap == null)
      throw new NullPointerException("configMap was null")
    if (testName != null && !testNames.contains(testName))
      throw new IllegalArgumentException(Resources("testNotFound", testName))

    val dispatch = new DispatchReporter(List(new StandardOutReporter(durations, color, shortstacks, fullstacks)))
    val tracker = new Tracker
    val filter = Filter()
    val runStartTime = System.currentTimeMillis
    if (stats)
      dispatch(RunStarting(tracker.nextOrdinal(), expectedTestCount(filter), configMap))

    val suiteStartTime = System.currentTimeMillis
    def dispatchSuiteAborted(e: Throwable) {
      val eMessage = e.getMessage
      val rawString = 
        if (eMessage != null && eMessage.length > 0)
          Resources("runOnSuiteException")
        else
          Resources("runOnSuiteExceptionWithMessage", eMessage)
      val formatter = formatterForSuiteAborted(thisSuite, rawString)
      val duration = System.currentTimeMillis - suiteStartTime
      dispatch(SuiteAborted(tracker.nextOrdinal(), rawString, thisSuite.suiteName, Some(thisSuite.getClass.getName), Some(e), Some(duration), formatter, None))
    }

    try {

      val formatter = formatterForSuiteStarting(thisSuite)
      dispatch(SuiteStarting(tracker.nextOrdinal(), thisSuite.suiteName, Some(thisSuite.getClass.getName), formatter))

      run(
        //if (testName != null) Some(testName) else None,
        Option(testName),
        dispatch,
        new Stopper {},
        filter,
        configMap,
        None,
        tracker
      )

      val suiteCompletedFormatter = formatterForSuiteCompleted(thisSuite)
      val duration = System.currentTimeMillis - suiteStartTime
      dispatch(SuiteCompleted(tracker.nextOrdinal(), thisSuite.suiteName, Some(thisSuite.getClass.getName), Some(duration), suiteCompletedFormatter))
      if (stats) {
        val duration = System.currentTimeMillis - runStartTime
        dispatch(RunCompleted(tracker.nextOrdinal(), Some(duration)))
      }
    }
    catch {
      case e: InstantiationException =>
        dispatchSuiteAborted(e)
        dispatch(RunAborted(tracker.nextOrdinal(), Resources("cannotInstantiateSuite", e.getMessage), Some(e), Some(System.currentTimeMillis - runStartTime)))
      case e: IllegalAccessException =>
        dispatchSuiteAborted(e)
        dispatch(RunAborted(tracker.nextOrdinal(), Resources("cannotInstantiateSuite", e.getMessage), Some(e), Some(System.currentTimeMillis - runStartTime)))
      case e: NoClassDefFoundError =>
        dispatchSuiteAborted(e)
        dispatch(RunAborted(tracker.nextOrdinal(), Resources("cannotLoadClass", e.getMessage), Some(e), Some(System.currentTimeMillis - runStartTime)))
      case e: Throwable =>
        dispatchSuiteAborted(e)
        dispatch(RunAborted(tracker.nextOrdinal(), Resources.bigProblems(e), Some(e), Some(System.currentTimeMillis - runStartTime)))
    }
    finally {
      dispatch.dispatchDisposeAndWaitUntilDone()
    }
  }

  /**
   * A Map whose keys are String tag names with which tests in this Suite are marked, and
   * whose values are the Set of test names marked with each tag.  If this Suite contains no tags, this
   * method returns an empty Map.
   *
   * 

   * This trait's implementation of this method uses Java reflection to discover any Java annotations attached to its test methods. The
   * fully qualified name of each unique annotation that extends TagAnnotation is considered a tag. This trait's
   * implementation of this method, therefore, places one key/value pair into to the
   * Map for each unique tag annotation name discovered through reflection. The mapped value for each tag name key will contain
   * the test method name, as provided via the testNames method. 
   * 
   *
   * 

   * Subclasses may override this method to define and/or discover tags in a custom manner, but overriding method implementations
   * should never return an empty Set as a value. If a tag has no tests, its name should not appear as a key in the
   * returned Map.
   * 
   */
  def tags: Map[String, Set[String]] = {

    def getTags(testName: String) =
      for {
        a <- getMethodForTestName(testName).getDeclaredAnnotations
        annotationClass = a.annotationType
        if annotationClass.isAnnotationPresent(classOf[TagAnnotation])
      } yield annotationClass.getName

    val elements =
      for (testName <- testNames; if !getTags(testName).isEmpty)
        yield testName -> (Set() ++ getTags(testName))

    Map() ++ elements
  }

  /**
  * A Set of test names. If this Suite contains no tests, this method returns an empty Set.
  *
  * 

  * This trait's implementation of this method uses Java reflection to discover all public methods whose name starts with "test",
  * which take either nothing or a single Informer as parameters. For each discovered test method, it assigns a test name
  * comprised of just the method name if the method takes no parameters, or the method name plus (Informer) if the
  * method takes a Informer. Here are a few method signatures and the names that this trait's implementation assigns them:
  * 
  *
  * 
  * def testCat() {}         // test name: "testCat"
  * def testCat(Informer) {} // test name: "testCat(Informer)"
  * def testDog() {}         // test name: "testDog"
  * def testDog(Informer) {} // test name: "testDog(Informer)"
  * def test() {}            // test name: "test"
  * def test(Informer) {}    // test name: "test(Informer)"
  * 
  *
  * 

  * This trait's implementation of this method returns an immutable Set of all such names, excluding the name
  * testNames. The iterator obtained by invoking elements on this
  * returned Set will produce the test names in their natural order, as determined by String's
  * compareTo method.
  * 
  *
  * 

  * This trait's implementation of runTests invokes this method
  * and calls runTest for each test name in the order they appear in the returned Set's iterator.
  * Although this trait's implementation of this method returns a Set whose iterator produces String
  * test names in a well-defined order, the contract of this method does not required a defined order. Subclasses are free to
  * override this method and return test names in an undefined order, or in a defined order that's different from String's
  * natural order.
  * 
  *
  * 

  * Subclasses may override this method to produce test names in a custom manner. One potential reason to override testNames is
  * to run tests in a different order, for example, to ensure that tests that depend on other tests are run after those other tests.
  * Another potential reason to override is allow tests to be defined in a different manner, such as methods annotated @Test annotations
  * (as is done in JUnitSuite and TestNGSuite) or test functions registered during construction (as is
  * done in FunSuite and FunSpec).
  * 
  */
  def testNames: Set[String] = {

    def isTestMethod(m: Method) = {

      // Factored out to share code with fixture.Suite.testNames
      val (isInstanceMethod, simpleName, firstFour, paramTypes, hasNoParams, isTestNames) = isTestMethodGoodies(m)

      isInstanceMethod && (firstFour == "test") && ((hasNoParams && !isTestNames) || takesInformer(m))
    }

    val testNameArray =
      for (m <- getClass.getMethods; if isTestMethod(m)) 
        yield if (takesInformer(m)) m.getName + InformerInParens else m.getName

    TreeSet[String]() ++ testNameArray
  }

  private[scalatest] def getMethodForTestName(testName: String) =
    try {
      getClass.getMethod(
        simpleNameForTest(testName),
        (if (testMethodTakesAnInformer(testName)) Array(classOf[Informer]) else new Array[Class[_]](0)): _*
      )
    }
    catch {
      case e: NoSuchMethodException =>
        throw new IllegalArgumentException(Resources("testNotFound", testName))
      case e: Throwable =>
        throw e
    }

  /**
   *  Run the passed test function in the context of a fixture established by this method.
   *
   * 

   * This method should set up the fixture needed by the tests of the
   * current suite, invoke the test function, and if needed, perform any clean
   * up needed after the test completes. Because the NoArgTest function
   * passed to this method takes no parameters, preparing the fixture will require
   * side effects, such as reassigning instance vars in this Suite or initializing
   * a globally accessible external database. If you want to avoid reassigning instance vars
   * you can use fixture.Suite.
   * 
   *
   * 

   * This trait's implementation of runTest invokes this method for each test, passing
   * in a NoArgTest whose apply method will execute the code of the test.
   * 
   *
   * 

   * This trait's implementation of this method simply invokes the passed NoArgTest function.
   * 
   *
   * @param test the no-arg test function to run with a fixture
   */
  protected def withFixture(test: NoArgTest) {
    test()
  }

  // Factored out to share this with fixture.Suite.runTest
  private[scalatest] def getSuiteRunTestGoodies(stopper: Stopper, reporter: Reporter, testName: String) = {
    val (stopRequested, report, hasPublicNoArgConstructor, rerunnable, testStartTime) = getRunTestGoodies(stopper, reporter, testName)
    val method = getMethodForTestName(testName)
    (stopRequested, report, method, hasPublicNoArgConstructor, rerunnable, testStartTime)
  }

  // Sharing this with FunSuite and fixture.FunSuite as well as Suite and fixture.Suite
  private[scalatest] def getRunTestGoodies(stopper: Stopper, reporter: Reporter, testName: String) = {

    val stopRequested = stopper
    val report = wrapReporterIfNecessary(reporter)

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

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

    val testStartTime = System.currentTimeMillis

    (stopRequested, report, hasPublicNoArgConstructor, rerunnable, testStartTime)
  }

  /**
   * Run a test.
   *
   * 

   * This trait's implementation uses Java reflection to invoke on this object the test method identified by the passed testName.
   * 
   *
   * 

   * Implementations of this method are responsible for ensuring a TestStarting event
   * is fired to the Reporter before executing any test, and either TestSucceeded,
   * TestFailed, or TestPending after executing any nested
   * Suite. (If a test is marked with the org.scalatest.Ignore tag, the
   * runTests method is responsible for ensuring a TestIgnored event is fired and that
   * this runTest method is not invoked for that ignored test.)
   * 
   *
   * @param testName the name of one test to run.
   * @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 key-value pairs that can be used by the executing Suite of tests.
   * @param tracker a Tracker tracking Ordinals being fired by the current thread.
   * @throws NullPointerException if any of testName, reporter, stopper, configMap
   *     or tracker is null.
   * @throws IllegalArgumentException if testName is defined, but no test with the specified test name
   *     exists in this Suite
   */
  protected def runTest(testName: String, reporter: Reporter, stopper: Stopper, configMap: Map[String, Any], tracker: Tracker) {

    checkRunTestParamsForNull(testName, reporter, stopper, configMap, tracker)

    val (stopRequested, report, method, hasPublicNoArgConstructor, rerunnable, testStartTime) =
      getSuiteRunTestGoodies(stopper, reporter, testName)

    reportTestStarting(this, report, tracker, testName, rerunnable)

    val formatter = getIndentedText(testName, 1, true)

    val informerForThisTest =
      MessageRecordingInformer2(
        (message, payload, isConstructingThread, testWasPending) => reportInfoProvided(thisSuite, report, tracker, Some(testName), message, payload, 2, isConstructingThread, true, Some(testWasPending))
      )

    val args: Array[Object] =
      if (testMethodTakesAnInformer(testName)) {
/*
        val informer =
          new Informer {
            def apply(message: String) {
              if (message == null)
                throw new NullPointerException
              reportInfoProvided(thisSuite, report, tracker, Some(testName), message, 2, true)
            }
          }
*/
        Array(informerForThisTest)  
      }
      else Array()

    var testWasPending = false
    try {
      val theConfigMap = configMap
      withFixture(
        new NoArgTest {
          def name = testName
          def apply() { method.invoke(thisSuite, args: _*) }
          def configMap = theConfigMap
        }
      )
      val duration = System.currentTimeMillis - testStartTime
      reportTestSucceeded(this, report, tracker, testName, duration, formatter, rerunnable)
    }
    catch { 
      case ite: InvocationTargetException =>
        val t = ite.getTargetException
        t match {
          case _: TestPendingException =>
            reportTestPending(this, report, tracker, testName, formatter)
            testWasPending = true // Set so info's printed out in the finally clause show up yellow
          case e if !anErrorThatShouldCauseAnAbort(e) =>
            val duration = System.currentTimeMillis - testStartTime
            handleFailedTest(t, hasPublicNoArgConstructor, testName, rerunnable, report, tracker, duration)
          case e: Throwable => throw e
        }
      case e if !anErrorThatShouldCauseAnAbort(e) =>
        val duration = System.currentTimeMillis - testStartTime
        handleFailedTest(e, hasPublicNoArgConstructor, testName, rerunnable, report, tracker, duration)
      case e: Throwable => throw e  
    }
    finally {
      informerForThisTest.fireRecordedMessages(testWasPending)
    }
  }
  
  /**
   * Run zero to many of this Suite's tests.
   *
   * 

   * This method takes a testName parameter that optionally specifies a test to invoke.
   * If testName is defined, 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 Map passed to this method, or one that wraps and delegates to it
   * 
   *
   * 

   * This method takes a Filter, which encapsulates an optional 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 run.
   * 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 the tagsToExcludeSet
   * will be run. However, if testName is defined, 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. This trait's implementation
   * behaves this way, and it is part of the general contract of this method, so all overridden forms of this method should behave
   * this way as well.  For more information on test tags, see the main documentation for this trait and for class Filter.
   * Note that this means that even if a test is marked as ignored, for example a test method in a Suite annotated with
   * org.scalatest.Ignore, if that test name is passed as testName to runTest, it will be invoked
   * despite the Ignore annotation.
   * 
   *
   * 

   * 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 run.
   * (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 run.)
   * 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 Filter.
   * 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
   * 
   *
   * 

   * If a test is marked with the org.scalatest.Ignore tag, implementations
   * of this method are responsible for ensuring a TestIgnored event is fired for that test
   * and that runTest is not called for that test.
   * 
   *
   * @param testName an optional name of one test to run. If None, all relevant tests should be run.
   *                 I.e., None acts like a wildcard that means run all relevant tests in this Suite.
   * @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 filter a Filter with which to filter tests based on their tags
   * @param configMap a Map of key-value pairs that can be used by the executing Suite of tests.
   * @param distributor an optional Distributor, into which to put nested Suites to be run
   *              by another entity, such as concurrently by a pool of threads. If None, nested Suites will be run sequentially.
   * @param tracker a Tracker tracking Ordinals being fired by the current thread.
   * @throws NullPointerException if any of the passed parameters is null.
   * @throws IllegalArgumentException if testName is defined, but no test with the specified test name
   *     exists in this Suite
   */
  protected 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 theTestNames = testNames
    if (theTestNames.size > 0)
      checkChosenStyles(configMap, styleName)

    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)

    // If a testName is passed to run, just run that, else run the tests returned
    // by testNames.
    testName match {

      case Some(tn) =>
        val (filterTest, ignoreTest) = filter(tn, tags)
        if (!filterTest) {
          if (ignoreTest)
            reportTestIgnored(thisSuite, report, tracker, tn, tn, 1)
          else
            runTest(tn, report, stopRequested, configMap, tracker)
        }

      case None =>
        for ((tn, ignoreTest) <- filter(theTestNames, tags)) {
          if (!stopRequested()) {
            if (ignoreTest)
              reportTestIgnored(thisSuite, report, tracker, tn, tn, 1)
            else
              runTest(tn, report, stopRequested, configMap, tracker)
          }
      }
    }
  }

  /**
   * Runs this suite of tests.
   *
   * 
If testName is None, this trait's implementation of this method
   * calls these two methods on this object in this order:
   *
   * 

   * 
runNestedSuites(report, stopper, tagsToInclude, tagsToExclude, configMap, distributor)
   * 
runTests(testName, report, stopper, tagsToInclude, tagsToExclude, configMap)
   * 
   *
   * 

   * If testName is defined, then this trait's implementation of this method
   * calls runTests, but does not call runNestedSuites. This behavior
   * is part of the contract of this method. Subclasses that override run must take
   * care not to call runNestedSuites if testName is defined. (The
   * OneInstancePerTest trait depends on this behavior, for example.)
   * 
   *
   * 

   * Subclasses and subtraits that override this run method can implement them without
   * invoking either the runTests or runNestedSuites methods, which
   * are invoked by this trait's implementation of this method. It is recommended, but not required,
   * that subclasses and subtraits that override run in a way that does not
   * invoke runNestedSuites also override runNestedSuites and make it
   * final. Similarly it is recommended, but not required,
   * that subclasses and subtraits that override run in a way that does not
   * invoke runTests also override runTests (and runTest,
   * which this trait's implementation of runTests calls) and make it
   * final. The implementation of these final methods can either invoke the superclass implementation
   * of the method, or throw an UnsupportedOperationException if appropriate. The
   * reason for this recommendation is that ScalaTest includes several traits that override
   * these methods to allow behavior to be mixed into a Suite. For example, trait
   * BeforeAndAfterEach overrides runTestss. In a Suite
   * subclass that no longer invokes runTests from run, the
   * BeforeAndAfterEach trait is not applicable. Mixing it in would have no effect.
   * By making runTests final in such a Suite subtrait, you make
   * the attempt to mix BeforeAndAfterEach into a subclass of your subtrait
   * a compiler error. (It would fail to compile with a complaint that BeforeAndAfterEach
   * is trying to override runTests, which is a final method in your trait.) 
   * 
   *
   * @param testName an optional name of one test to run. If None, all relevant tests should be run.
   *                 I.e., None acts like a wildcard that means run all relevant tests in this Suite.
   * @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 filter a Filter with which to filter tests based on their tags
   * @param configMap a Map of key-value pairs that can be used by the executing Suite of tests.
   * @param distributor an optional Distributor, into which to put nested Suites to be run
   *              by another entity, such as concurrently by a pool of threads. If None, nested Suites will be run sequentially.
   * @param tracker a Tracker tracking Ordinals being fired by the current thread.
   *         
   * @throws NullPointerException if any passed parameter is null.
   * @throws IllegalArgumentException if testName is defined, but no test with the specified test name
   *     exists in this Suite
   */
  def run(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
    val report = wrapReporterIfNecessary(reporter)

    testName match {
      case None => runNestedSuites(report, stopRequested, filter, configMap, distributor, tracker)
      case Some(_) =>
    }
    runTests(testName, report, stopRequested, filter, configMap, distributor, tracker)

    if (stopRequested()) {
      val rawString = Resources("executeStopping")
      report(InfoProvided(tracker.nextOrdinal(), rawString, Some(NameInfo(thisSuite.suiteName, Some(thisSuite.getClass.getName), testName))))
    }
  }

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

    val message = getMessageForException(throwable)
    val formatter = getIndentedText(testName, 1, true)
    val payload = 
      throwable match {
        case optPayload: PayloadField => 
          optPayload.payload
        case _ => 
          None
      }
    report(TestFailed(tracker.nextOrdinal(), message, thisSuite.suiteName, Some(thisSuite.getClass.getName), testName, Some(throwable), Some(duration), Some(formatter), rerunnable, payload))
  }

  /**
   *
   * Run zero to many of this Suite's nested Suites.
   *
   * 

   * If the passed distributor is None, this trait's
   * implementation of this method invokes run on each
   * nested Suite in the List obtained by invoking nestedSuites.
   * If a nested Suite's run
   * method completes abruptly with an exception, this trait's implementation of this
   * method reports that the Suite aborted and attempts to run the
   * next nested Suite.
   * If the passed distributor is defined, this trait's implementation
   * puts each nested Suite 
   * into the Distributor contained in the Some, in the order in which the
   * Suites appear in the List returned by nestedSuites, passing
   * in a new Tracker obtained by invoking nextTracker on the Tracker
   * passed to this method.
   * 
   *
   * 

   * Implementations of this method are responsible for ensuring SuiteStarting events
   * are fired to the Reporter before executing any nested Suite, and either SuiteCompleted
   * or SuiteAborted after executing any nested Suite.
   * 
   *
   * @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 filter a Filter with which to filter tests based on their tags
   * @param configMap a Map of key-value pairs that can be used by the executing Suite of tests.
   * @param distributor an optional Distributor, into which to put nested Suites to be run
   *              by another entity, such as concurrently by a pool of threads. If None, nested Suites will be run sequentially.
   * @param tracker a Tracker tracking Ordinals being fired by the current thread.
   *         
   * @throws NullPointerException if any passed parameter is null.
   */
  protected def runNestedSuites(reporter: Reporter, stopper: Stopper, filter: Filter,
                                configMap: Map[String, Any], distributor: Option[Distributor], tracker: Tracker) {

    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
    val report = wrapReporterIfNecessary(reporter)

    def callExecuteOnSuite(nestedSuite: Suite) {

      if (!stopRequested()) {

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

        val rerunnable =
          if (hasPublicNoArgConstructor)
            Some(new SuiteRerunner(nestedSuite.getClass.getName))
          else
            None

        val rawString = Resources("suiteExecutionStarting")
        val formatter = formatterForSuiteStarting(nestedSuite)

        val suiteStartTime = System.currentTimeMillis

        report(SuiteStarting(tracker.nextOrdinal(), nestedSuite.suiteName, Some(nestedSuite.getClass.getName), formatter, rerunnable))

        try {
          // Same thread, so OK to send same tracker
          nestedSuite.run(None, report, stopRequested, filter, configMap, distributor, tracker)

          val rawString = Resources("suiteCompletedNormally")
          val formatter = formatterForSuiteCompleted(nestedSuite)

          val duration = System.currentTimeMillis - suiteStartTime
          report(SuiteCompleted(tracker.nextOrdinal(), nestedSuite.suiteName, Some(nestedSuite.getClass.getName), Some(duration), formatter, rerunnable))
        }
        catch {       
          case e: RuntimeException => {
            val eMessage = e.getMessage
            val rawString = 
              if (eMessage != null && eMessage.length > 0)
                Resources("executeExceptionWithMessage", eMessage)
              else
                Resources("executeException")
            val formatter = formatterForSuiteAborted(nestedSuite, rawString)

            val duration = System.currentTimeMillis - suiteStartTime
            report(SuiteAborted(tracker.nextOrdinal(), rawString, nestedSuite.suiteName, Some(nestedSuite.getClass.getName), Some(e), Some(duration), formatter, rerunnable))
          }
        }
      }
    }

    distributor match {
      case None =>
        val nestedSuitesArray = nestedSuites.toArray
        for (i <- 0 until nestedSuitesArray.length) {
          if (!stopRequested()) {
            callExecuteOnSuite(nestedSuitesArray(i))
          }
        }
      case Some(distribute) =>
        for (nestedSuite <- nestedSuites)
          distribute(nestedSuite, tracker.nextTracker())
    }
  }

  /**
   * A user-friendly suite name for this Suite.
   *
   * 

   * This trait's
   * implementation of this method returns the simple name of this object's class. This
   * trait's implementation of runNestedSuites calls this method to obtain a
   * name for Reports to pass to the suiteStarting, suiteCompleted,
   * and suiteAborted methods of the Reporter.
   * 
   *
   * @return this Suite object's suite name.
   */
  def suiteName = getSimpleNameOfAnObjectsClass(thisSuite)

  /**
   * Throws TestPendingException to indicate a test is pending.
   *
   * 

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

   * Note: This method always completes abruptly with a TestPendingException. Thus it always has a side
   * effect. Methods with side effects are usually invoked with parentheses, as in pending(). This
   * method is defined as a parameterless method, in flagrant contradiction to recommended Scala style, because it 
   * forms a kind of DSL for pending tests. It enables tests in suites such as FunSuite or FunSpec
   * to be denoted by placing "(pending)" after the test name, as in:
   * 
   *
   * 
   * test("that style rules are not laws") (pending)
   * 
   *
   * 

   * Readers of the code see "pending" in parentheses, which looks like a little note attached to the test name to indicate
   * it is pending. Whereas "(pending()) looks more like a method call, "(pending)" lets readers
   * stay at a higher level, forgetting how it is implemented and just focusing on the intent of the programmer who wrote the code.
   * 
   */
  def pending: PendingNothing = { throw new TestPendingException }

  /**
   * Execute the passed block of code, and if it completes abruptly, throw TestPendingException, else
   * throw TestFailedException.
   *
   * 

   * This method can be used to temporarily change a failing test into a pending test in such a way that it will
   * automatically turn back into a failing test once the problem originally causing the test to fail has been fixed.
   * At that point, you need only remove the pendingUntilFixed call. In other words, a
   * pendingUntilFixed surrounding a block of code that isn't broken is treated as a test failure.
   * The motivation for this behavior is to encourage people to remove pendingUntilFixed calls when
   * there are no longer needed.
   * 
   *
   * 

   * This method facilitates a style of testing in which tests are written before the code they test. Sometimes you may
   * encounter a test failure that requires more functionality than you want to tackle without writing more tests. In this
   * case you can mark the bit of test code causing the failure with pendingUntilFixed. You can then write more
   * tests and functionality that eventually will get your production code to a point where the original test won't fail anymore.
   * At this point the code block marked with pendingUntilFixed will no longer throw an exception (because the
   * problem has been fixed). This will in turn cause pendingUntilFixed to throw TestFailedException
   * with a detail message explaining you need to go back and remove the pendingUntilFixed call as the problem orginally
   * causing your test code to fail has been fixed.
   * 
   *
   * @param f a block of code, which if it completes abruptly, should trigger a TestPendingException 
   * @throws TestPendingException if the passed block of code completes abruptly with an Exception or AssertionError
   */
  def pendingUntilFixed(f: => Unit) {
    val isPending =
      try {
        f
        false
      }
      catch {
        case _: Exception => true
        case _: AssertionError => true
      }
      if (isPending)
        throw new TestPendingException
      else
        throw new TestFailedException(Resources("pendingUntilFixed"), 2)
  }

  /**
   * The total number of tests that are expected to run when this Suite's run method is invoked.
   *
   * 

   * This trait's implementation of this method returns the sum of:
   * 
   *
   * 

   * 
the size of the testNames List, minus the number of tests marked as ignored and
   * any tests that are exluded by the passed Filter
   * 
the sum of the values obtained by invoking
   *     expectedTestCount on every nested Suite contained in
   *     nestedSuites
   * 
   *
   * @param filter a Filter with which to filter tests to count based on their tags
   */
  def expectedTestCount(filter: Filter): Int = {

    // [bv: here was another tricky refactor. How to increment a counter in a loop]
    def countNestedSuiteTests(nestedSuites: List[Suite], filter: Filter): Int =
      nestedSuites match {
        case List() => 0
        case nestedSuite :: nestedSuites => nestedSuite.expectedTestCount(filter) +
            countNestedSuiteTests(nestedSuites, filter)
    }

    filter.runnableTestCount(testNames, tags) + countNestedSuiteTests(nestedSuites, filter)
  }

  // Wrap any non-DispatchReporter, non-CatchReporter in a CatchReporter,
  // so that exceptions are caught and transformed
  // into error messages on the standard error stream.
  private[scalatest] def wrapReporterIfNecessary(reporter: Reporter) = reporter match {
    case dr: DispatchReporter => dr
    case cr: CatchReporter => cr
    case _ => new CatchReporter(reporter)
  }
  
  /**
   * Suite style name.
   */
  val styleName: String = "org.scalatest.Suite"
}

private[scalatest] object Suite {

  private[scalatest] val TestMethodPrefix = "test"
  private[scalatest] val InformerInParens = "(Informer)"
  private[scalatest] val IgnoreAnnotation = "org.scalatest.Ignore"

  private[scalatest] def getSimpleNameOfAnObjectsClass(o: AnyRef) = stripDollars(parseSimpleName(o.getClass().getName()))

  // [bv: this is a good example of the expression type refactor. I moved this from SuiteClassNameListCellRenderer]
  // this will be needed by the GUI classes, etc.
  private[scalatest] def parseSimpleName(fullyQualifiedName: String) = {

    val dotPos = fullyQualifiedName.lastIndexOf('.')

    // [bv: need to check the dotPos != fullyQualifiedName.length]
    if (dotPos != -1 && dotPos != fullyQualifiedName.length)
      fullyQualifiedName.substring(dotPos + 1)
    else
      fullyQualifiedName
  }
  
  private[scalatest] def checkForPublicNoArgConstructor(clazz: java.lang.Class[_]) = {
    
    try {
      val constructor = clazz.getConstructor(new Array[java.lang.Class[T] forSome { type T }](0): _*)

      Modifier.isPublic(constructor.getModifiers)
    }
    catch {
      case nsme: NoSuchMethodException => false
    }
  }

  // This attempts to strip dollar signs that happen when using the interpretter. It is quite fragile
  // and already broke once. In the early days, all funky dollar sign encrusted names coming out of
  // the interpreter started with "line". Now they don't, but in both cases they seemed to have at
  // least one "$iw$" in them. So now I leave the string alone unless I see a "$iw$" in it. Worst case
  // is sometimes people will get ugly strings coming out of the interpreter. -bv April 3, 2012
  private[scalatest] def stripDollars(s: String): String = {
    val lastDollarIndex = s.lastIndexOf('$')
    if (lastDollarIndex < s.length - 1)
      if (lastDollarIndex == -1 || !s.contains("$iw$")) s else s.substring(lastDollarIndex + 1)
    else {
      // The last char is a dollar sign
      val lastNonDollarChar = s.reverse.find(_ != '$')
      lastNonDollarChar match {
        case None => s
        case Some(c) => {
          val lastNonDollarIndex = s.lastIndexOf(c)
          if (lastNonDollarIndex == -1) s
          else stripDollars(s.substring(0, lastNonDollarIndex + 1))
        }
      }
    }
  }
  
  private[scalatest] def diffStrings(s: String, t: String): Tuple2[String, String] = {
    def findCommonPrefixLength(s: String, t: String): Int = {
      val max = s.length.min(t.length) // the maximum potential size of the prefix
      var i = 0
      var found = false
      while (i < max & !found) {
        found = (s.charAt(i) != t.charAt(i))
        if (!found)
          i = i + 1
      }
      i
    }
    def findCommonSuffixLength(s: String, t: String): Int = {
      val max = s.length.min(t.length) // the maximum potential size of the suffix
      var i = 0
      var found = false
      while (i < max & !found) {
        found = (s.charAt(s.length - 1 - i) != t.charAt(t.length - 1 - i))
        if (!found)
          i = i + 1
      }
      i
    }
    val commonPrefixLength = findCommonPrefixLength(s, t)
    val commonSuffixLength = findCommonSuffixLength(s.substring(commonPrefixLength), t.substring(commonPrefixLength))
    val prefix = s.substring(0, commonPrefixLength)
    val suffix = if (s.length - commonSuffixLength < 0) "" else s.substring(s.length - commonSuffixLength)
    val sMiddleEnd = s.length - commonSuffixLength
    val tMiddleEnd = t.length - commonSuffixLength
    val sMiddle = s.substring(commonPrefixLength, sMiddleEnd)
    val tMiddle = t.substring(commonPrefixLength, tMiddleEnd)
    val MaxContext = 20
    val shortPrefix = if (commonPrefixLength > MaxContext) "..." + prefix.substring(prefix.length - MaxContext) else prefix
    val shortSuffix = if (commonSuffixLength > MaxContext) suffix.substring(0, MaxContext) + "..." else suffix
    (shortPrefix + "[" + sMiddle + "]" + shortSuffix, shortPrefix + "[" + tMiddle + "]" + shortSuffix)
  }
  
  // If the objects are two strings, replace them with whatever is returned by diffStrings.
  // Otherwise, use the same objects.
  private[scalatest] def getObjectsForFailureMessage(a: Any, b: Any) = 
    a match {
      case aStr: String => {
        b match {
          case bStr: String => {
            Suite.diffStrings(aStr, bStr)    
          }
          case _ => (a, b)
        }
      } 
      case _ => (a, b)
    }

  private[scalatest] def formatterForSuiteStarting(suite: Suite): Option[Formatter] =
      Some(IndentedText(suite.suiteName + ":", suite.suiteName, 0))

  private[scalatest] def formatterForSuiteCompleted(suite: Suite): Option[Formatter] =
      Some(MotionToSuppress)

  private[scalatest] def formatterForSuiteAborted(suite: Suite, message: String): Option[Formatter] =
      Some(IndentedText(message, message, 0))

  private def simpleNameForTest(testName: String) =
    if (testName.endsWith(InformerInParens))
      testName.substring(0, testName.length - InformerInParens.length)
    else
      testName

  private[scalatest] def anErrorThatShouldCauseAnAbort(throwable: Throwable) =
    throwable match {
      case _: AnnotationFormatError | 
           _: CoderMalfunctionError |
           _: FactoryConfigurationError | 
           _: LinkageError | 
           _: ThreadDeath | 
           _: TransformerFactoryConfigurationError | 
           _: VirtualMachineError => true
      // Don't use AWTError directly because it doesn't exist on Android, and a user
      // got ScalaTest to compile under Android.
      case e if e.getClass.getName == "java.awt.AWTError" => true
      case _ => false
    }

  def takesInformer(m: Method) = {
    val paramTypes = m.getParameterTypes
    paramTypes.length == 1 && classOf[Informer].isAssignableFrom(paramTypes(0))
  }

  def isTestMethodGoodies(m: Method) = {

    val isInstanceMethod = !Modifier.isStatic(m.getModifiers())

    // name must have at least 4 chars (minimum is "test")
    val simpleName = m.getName
    val firstFour = if (simpleName.length >= 4) simpleName.substring(0, 4) else "" 

    val paramTypes = m.getParameterTypes
    val hasNoParams = paramTypes.length == 0

    // Discover testNames(Informer) because if we didn't it might be confusing when someone
    // actually wrote a testNames(Informer) method and it was silently ignored.
    val isTestNames = simpleName == "testNames"

    (isInstanceMethod, simpleName, firstFour, paramTypes, hasNoParams, isTestNames)
  }

  def testMethodTakesAnInformer(testName: String) = testName.endsWith(InformerInParens)

  def checkRunTestParamsForNull(testName: String, reporter: Reporter, stopper: Stopper, configMap: Map[String, Any], 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 (configMap == null)
      throw new NullPointerException("configMap was null")
    if (tracker == null)
      throw new NullPointerException("tracker was null")
  }
 
  /*
   For info and test names, the formatted text should have one level shaved off so that the text will
   line up correctly, and the icon is over to the left of that even with the enclosing level.

   If a test is at the top level (not nested inside a describe, it's level is 0. So no need to subtract 1
   to make room for the icon in that case. An info inside such a test will have level 1. And agin, in that
   case no need to subtract 1. Such a test is "outermost test" and the info inside is "in outermost test" in:

class ArghSpec extends Spec with GivenWhenThen {
  info("in ArghSpec")
  it("outermost test") {
    info("in outermost test")
  }
  describe("Apple") {
    info("in Apple")
    describe("Boat") {
      info("in Boat")
      describe("Cat") {
        info("in Cat")
        describe("Dog") {
          info("in Dog")
          describe("Elephant") {
            info("in Elephant")
            it("Factory") {
              info("in Factory (test)")
              given("an empty Stack")
              when("push is invoked")
              then("it should have size 1")
              and("pop should return the pushed value")
            }
          }
        }
      }
    }
  }
}

It should (and at this point does) output this:

[scalatest] ArghSpec:
[scalatest] + in ArghSpec 
[scalatest] - outermost test (5 milliseconds)
[scalatest]   + in outermost test 
[scalatest] Apple 
[scalatest] + in Apple 
[scalatest]   Boat 
[scalatest]   + in Boat 
[scalatest]     Cat 
[scalatest]     + in Cat 
[scalatest]       Dog 
[scalatest]       + in Dog 
[scalatest]         Elephant 
[scalatest]         + in Elephant 
[scalatest]         - Factory (1 millisecond)
[scalatest]           + in Factory (test) 
[scalatest]           + Given an empty Stack 
[scalatest]           + When push is invoked 
[scalatest]           + Then it should have size 1 
[scalatest]           + And pop should return the pushed value 

FeatureSpec doesn't want any icons printed out. So adding includeIcon here. It
was already in getIndentedTextForInfo because of descriptions being printed out
without icons.

This should really be named getIndentedTextForTest maybe, because I think it is just
used for test events like succeeded/failed, etc.
  */
  def getIndentedText(testText: String, level: Int, includeIcon: Boolean) = {
    val formattedText =
      if (includeIcon) {
        val testSucceededIcon = Resources("testSucceededIconChar")
        ("  " * (if (level == 0) 0 else (level - 1))) + Resources("iconPlusShortName", testSucceededIcon, testText)
      }
      else {
        ("  " * level) + testText
      }
    IndentedText(formattedText, testText, level)
  }

  // The icon is not included for branch description text, but is included for things sent via info(), given(),
  // when(), then(), etc. When it is included, reduce the level by 1, unless it is already 1 or 0.
  def getIndentedTextForInfo(message: String, level: Int, includeIcon: Boolean, infoIsInsideATest: Boolean) = {
    val formattedText =
      if (includeIcon) {
        val infoProvidedIcon = Resources("infoProvidedIconChar")
        //
        // Inside a test, you want level 1 to stay 1
        // [scalatest] - outermost test (5 milliseconds)
        // [scalatest]   + in outermost test
        //
        // But outside a test, level 1 should be transformed to 0
        // [scalatest] Apple
        // [scalatest] + in Apple
        //
        val indentationLevel =
          level match {
            case 0 => 0
            case 1 if infoIsInsideATest => 1
            case _ => level - 1
          }
        ("  " * indentationLevel) + Resources("iconPlusShortName", infoProvidedIcon, message)
        // ("  " * (if (level <= 1) level else (level - 1))) + Resources("iconPlusShortName", infoProvidedIcon, message)
      }
      else {
        ("  " * level) + message
      }
    IndentedText(formattedText, message, level)
  }

  def getMessageForException(e: Throwable): String =
    if (e.getMessage != null)
      e.getMessage
    else
      Resources("exceptionThrown", e.getClass.getName) // Say something like, "java.lang.Exception was thrown."

  def indentation(level: Int) = "  " * level

  def reportTestFailed(theSuite: Suite, report: Reporter, throwable: Throwable, testName: String, testText: String,
      rerunnable: Option[Rerunner], tracker: Tracker, duration: Long, level: Int, includeIcon: Boolean) {

    val message = getMessageForException(throwable)
    val formatter = getIndentedText(testText, level, includeIcon)
    val payload = 
      throwable match {
        case optPayload: PayloadField => 
          optPayload.payload
        case _ => 
          None
      }
    report(TestFailed(tracker.nextOrdinal(), message, theSuite.suiteName, Some(theSuite.getClass.getName), testName, Some(throwable), Some(duration), Some(formatter), rerunnable, payload))
  }

  def reportTestStarting(theSuite: Suite, report: Reporter, tracker: Tracker, testName: String, rerunnable: Option[Rerunner]) {
    report(TestStarting(tracker.nextOrdinal(), theSuite.suiteName, Some(theSuite.getClass.getName), testName, Some(MotionToSuppress), rerunnable))
  }

  def reportTestPending(theSuite: Suite, report: Reporter, tracker: Tracker, testName: String, formatter: Formatter) {
    report(TestPending(tracker.nextOrdinal(), theSuite.suiteName, Some(theSuite.getClass.getName), testName, Some(formatter)))
  }

  def reportTestSucceeded(theSuite: Suite, report: Reporter, tracker: Tracker, testName: String, duration: Long, formatter: Formatter, rerunnable: Option[Rerunner]) {
    report(TestSucceeded(tracker.nextOrdinal(), theSuite.suiteName, Some(theSuite.getClass.getName), testName, Some(duration), Some(formatter), rerunnable))
  }

  def reportTestIgnored(theSuite: Suite, report: Reporter, tracker: Tracker, testName: String, testText: String, level: Int) {
    val testSucceededIcon = Resources("testSucceededIconChar")
    val formattedText = indentation(level - 1) + Resources("iconPlusShortName", testSucceededIcon, testText)
    report(TestIgnored(tracker.nextOrdinal(), theSuite.suiteName, Some(theSuite.getClass.getName), testName, Some(IndentedText(formattedText, testText, level))))
  }

  // If not fired in the context of a test, then testName will be None
  def reportInfoProvided(
    theSuite: Suite,
    report: Reporter,
    tracker: Tracker,
    testName: Option[String],
    message: String,
    payload: Option[Any], 
    level: Int,
    includeNameInfo: Boolean,
    includeIcon: Boolean = true,
    aboutAPendingTest: Option[Boolean] = None
  ) {
    report(
      InfoProvided(
        tracker.nextOrdinal(),
        message,
        if (includeNameInfo)
          Some(NameInfo(theSuite.suiteName, Some(theSuite.getClass.getName), testName))
        else
          None,
        aboutAPendingTest,
        None,
        Some(getIndentedTextForInfo(message, level, includeIcon, testName.isDefined)), 
        payload
      )
    )
  }

  def checkChosenStyles(configMap: Map[String, Any], styleName: String) {
    val chosenStyleSet = 
        if (configMap.isDefinedAt("org.scalatest.ChosenStyles"))
          configMap("org.scalatest.ChosenStyles").asInstanceOf[Set[String]]
        else
          Set.empty[String]
    
    if (chosenStyleSet.size > 0 && !chosenStyleSet.contains(styleName)) {
      val e =
        if (chosenStyleSet.size == 1)
          new NotAllowedException(Resources("notTheChosenStyle", styleName, chosenStyleSet.head), getStackDepthFun("Scala.scala", "checkChosenStyles"))
        else
          new NotAllowedException(Resources("notOneOfTheChosenStyles", styleName, Suite.makeListForHumans(Vector.empty ++ chosenStyleSet.iterator)), getStackDepthFun("Scala.scala", "checkChosenStyles"))
      throw e
    }
  }

  // If it contains a space, or is an empty string, put quotes around it. OTherwise people might
  // get confused by the chosenStyles error message.
  def makeListForHumans(words: Vector[String]): String = {
    val quotedWords = words map { w =>
      if (w.length == 0 || w.indexOf(' ') >= 0) "\"" + w + "\""
      else w
    }
    quotedWords.length match {
      case 0 => ""
      //case 1 if quotedWords(0).isEmpty => "\"\""
      case 1 => quotedWords(0)
      case 2 => Resources("leftAndRight", quotedWords(0), quotedWords(1))
      case _ =>
        val (leading, trailing) = quotedWords.splitAt(quotedWords.length - 2)
        leading.mkString(", ") + ", " + Resources("leftCommaAndRight", trailing(0), trailing(1))
    }
  }
}