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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scalatest_2.11.0-M5 Show documentation
ScalaTest is a free, open-source testing toolkit for Scala and Java programmers.
The newest version!
/*
 * Copyright 2001-2013 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 scala.collection.immutable.ListSet
import words.BehaveWord
import Suite.autoTagClassAnnotations

/**
 * Implementation trait for class FunSpec, which 
 * facilitates a “behavior-driven” style of development (BDD),
 * in which tests are combined with text that specifies the behavior the tests
 * verify.
 * 
 * 
 * FunSpec is a class, not a trait,
 * to minimize compile time given there is a slight compiler overhead to
 * mixing in traits compared to extending classes. If you need to mix the
 * behavior of FunSpec into some other class, you can use this
 * trait instead, because class FunSpec does nothing more than
 * extend this trait and add a nice toString implementation.
 * 
 *
 * 
 * See the documentation of the class for a detailed
 * overview of FunSpec.
 * 
 *
 * @author Bill Venners
 */
@Finders(Array("org.scalatest.finders.FunSpecFinder"))
trait FunSpecLike extends Suite with Informing with Updating with Alerting with Documenting { thisSuite =>

  private final val engine = new Engine("concurrentSpecMod", "FunSpec")
  import engine._

  // TODO: Probably make this private final val sourceFileName in a singleton object so it gets compiled in rather than carried around in each instance
  private[scalatest] val sourceFileName = "FunSpecLike.scala"

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

  protected def update: Updater = atomicUpdater.get
  protected def alert: Alerter = atomicAlerter.get
  
  /**
   * Returns a Documenter that during test execution will forward strings passed to its
   * apply method to the current reporter. If invoked in a constructor, it
   * will register the passed string for forwarding later during test execution. If invoked while this
   * Spec is being executed, such as from inside a test function, it will forward the information to
   * the current reporter immediately. If invoked at any other time, it will
   * throw an exception. This method can be called safely by any thread.
   */
  protected def markup: Documenter = atomicDocumenter.get

  /**
   * Class that, via an instance referenced from the it field,
   * supports test (and shared test) registration in FunSpecs.
   *
   * 
   * This class supports syntax such as the following test registration:
   * 
   *
   *    * it("should be empty")
   * ^
   * 
   *
   * 
   * and the following shared test registration:
   * 
   *
   *    * it should behave like nonFullStack(stackWithOneItem)
   * ^
   * 
   *
   * 
   * For more information and examples, see the main documentation for FunSpec.
   * 
   */
  protected class ItWord {

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

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

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

  /**
   * Supports test (and shared test) registration in FunSpecs.
   *
   * 
   * This field supports syntax such as the following:
   * 
   *
   *    * it("should be empty")
   * ^
   * 
   *
   *  class="stExamples"
   * it should behave like nonFullStack(stackWithOneItem)
   * ^
   * 
   *
   * 
   * For more information and examples of the use of the it field, see the main documentation for this trait.
   * 
   */
  protected val it = new ItWord
  
  /**
   * Class that, via an instance referenced from the they field,
   * supports test (and shared test) registration in FunSpecs.
   *
   * 
   * This class supports syntax such as the following test registration:
   * 
   *
   *    * they("should be empty")
   * ^
   * 
   *
   * 
   * and the following shared test registration:
   * 
   *
   *    * they should behave like nonFullStack(stackWithOneItem)
   * ^
   * 
   *
   * 
   * For more information and examples, see the main documentation for FunSpec.
   * 
   */
  protected class TheyWord {

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

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

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

  /**
   * Supports test (and shared test) registration in FunSpecs.
   *
   * 
   * This field supports syntax such as the following:
   * 
   *
   *    * they("should be empty")
   * ^
   * 
   *
   *  class="stExamples"
   * it should behave like nonFullStack(stackWithOneItem)
   * ^
   * 
   *
   * 
   * For more information and examples of the use of the it field, see the main documentation for this trait.
   * 
   */
  protected val they = new TheyWord

  /**
   * Register a test to ignore, which has the given spec text, optional tags, and test function value that takes no arguments.
   * This method will register the test for later ignoring via an invocation of one of the execute
   * methods. This method exists to make it easy to ignore an existing test by changing the call to it
   * to ignore without deleting or commenting out the actual test code. The test will not be executed, but a
   * report will be sent that indicates the test was ignored. The name of the test will be a concatenation of the text of all surrounding describers,
   * from outside in, and the passed spec text, with one space placed between each item. (See the documenation
   * for testNames for an example.) The resulting test name must not have been registered previously on
   * this FunSpec instance.
   *
   * @param testText the specification text, which will be combined with the descText of any surrounding describers
   * to form the test name
   * @param testTags the optional list of tags for this test
   * @param testFun the test function
   * @throws DuplicateTestNameException if a test with the same name has been registered previously
   * @throws TestRegistrationClosedException if invoked after run has been invoked on this suite
   * @throws NullPointerException if specText or any passed test tag is null
   */
  protected def ignore(testText: String, testTags: Tag*)(testFun: => Unit) {
    registerIgnoredTest(testText, Transformer(testFun _), "ignoreCannotAppearInsideAnIt", sourceFileName, "ignore", 4, -2, None, testTags: _*)
  }

  /**
   * Describe a “subject” being specified and tested by the passed function value. The
   * passed function value may contain more describers (defined with describe) and/or tests
   * (defined with it). This trait's implementation of this method will register the
   * description string and immediately invoke the passed function.
   */
  protected def describe(description: String)(fun: => Unit) {
    registerNestedBranch(description, None, fun, "describeCannotAppearInsideAnIt", sourceFileName, "describe", 4, -2, None)
  }

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

  /**
   * Run a test. This trait's implementation runs the test registered with the name specified by
   * testName. Each test's name is a concatenation of the text of all describers surrounding a test,
   * from outside in, and the test's  spec text, with one space placed between each item. (See the documenation
   * for testNames for an example.)
   *
   * @param testName the name of one test to execute.
   * @param args the Args for this run
   * @return a Status object that indicates when the test started by this method has completed, and whether or not it failed .
   *
   * @throws NullPointerException if any of testName, reporter, stopper, or configMap
   *     is null.
   */
  protected override def runTest(testName: String, args: Args): Status = {

    def invokeWithFixture(theTest: TestLeaf): Outcome = {
      val theConfigMap = args.configMap
      val testData = testDataFor(testName, theConfigMap)
      withFixture(
        new NoArgTest {
          val name = testData.name
          def apply(): Outcome = { theTest.testFun() }
          val configMap = testData.configMap
          val scopes = testData.scopes
          val text = testData.text
          val tags = testData.tags
        }
      )
    }

    runTestImpl(thisSuite, testName, args, true, invokeWithFixture)
  }

  /**
   * A Map whose keys are String tag names to which tests in this FunSpec belong, and values
   * the Set of test names that belong to each tag. If this FunSpec contains no tags, this method returns an empty Map.
   *
   * 
   * This trait's implementation returns tags that were passed as strings contained in Tag objects passed to 
   * methods test and ignore. 
   * 
   * 
   * 
   * In addition, this trait's implementation will also auto-tag tests with class level annotations.  
   * For example, if you annotate @Ignore at the class level, all test methods in the class will be auto-annotated with @Ignore.
   * 
   */
  override def tags: Map[String, Set[String]] = autoTagClassAnnotations(atomic.get.tagsMap, this)

  /**
   * Run zero to many of this FunSpec's tests.
   *
   * @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 args the Args for this run
   * @return a Status object that indicates when all tests started by this method have completed, and whether or not a failure occurred.
   *
   * @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 override def runTests(testName: Option[String], args: Args): Status = {
    runTestsImpl(thisSuite, testName, args, info, true, runTest)
  }

  override def run(testName: Option[String], args: Args): Status = {
    runImpl(thisSuite, testName, args, super.run)
  }

  /**
   * Supports shared test registration in FunSpecs.
   *
   * 
   * This field supports syntax such as the following:
   * 
   *
   *    * it should behave like nonFullStack(stackWithOneItem)
   *           ^
   * 
   *
   * 
   * For more information and examples of the use of behave, see the Shared tests section
   * in the main documentation for this trait.
   * 
   */
  protected val behave = new BehaveWord
  
  /**
   * Suite style name.
   */
  final override val styleName: String = "org.scalatest.FunSpec"
    
  override def testDataFor(testName: String, theConfigMap: ConfigMap = ConfigMap.empty): TestData = createTestDataFor(testName, theConfigMap, this)
}