org.scalatest.fixture.FreeSpecLike.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of scalatest_2.9.1 Show documentation
ScalaTest is a free, open-source testing toolkit for Scala and Java programmers.
The newest version!
/*
 * Copyright 2001-2009 Artima, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.scalatest.fixture

import org.scalatest._
import words.{CanVerb, ResultOfAfterWordApplication, ShouldVerb, BehaveWord, MustVerb,
  StringVerbBlockRegistration}
import scala.collection.immutable.ListSet
import org.scalatest.exceptions.StackDepthExceptionHelper.getStackDepth
import java.util.concurrent.atomic.AtomicReference
import java.util.ConcurrentModificationException
import org.scalatest.events._
import org.scalatest.Suite.anExceptionThatShouldCauseAnAbort
import org.scalatest.Suite.autoTagClassAnnotations

/**
 * Implementation trait for class fixture.FreeSpec, which is
 * a sister class to org.scalatest.FreeSpec that can pass a
 * fixture object into its tests.
 * 
 * 
 * fixture.FreeSpec 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 fixture.FreeSpec into some other
 * class, you can use this trait instead, because class
 * fixture.FreeSpec does nothing more than extend this trait and add a nice toString implementation.
 * 
 *
 * 
 * See the documentation of the class for a detailed
 * overview of fixture.FreeSpec.
 * 
 *
 * @author Bill Venners
 */
@Finders(Array("org.scalatest.finders.FreeSpecFinder"))
trait FreeSpecLike extends Suite with Informing with Documenting { thisSuite =>

  private final val engine = new FixtureEngine[FixtureParam]("concurrentFixtureFreeSpecMod", "FixtureFreeSpec")
  import engine._
  
  private[scalatest] val sourceFileName = "FreeSpecLike.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
   * fixture.FreeSpec 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
  
  /**
   * 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
   * FreeSpec 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

  /**
   * 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 FreeSpec 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 methodName caller's method name
   * @param testFun the test function
   * @throws DuplicateTestNameException if a test with the same name has been registered previously
   * @throws TestRegistrationClosedException if invoked after run has been invoked on this suite
   * @throws NullPointerException if specText or any passed test tag is null
   */
  private def registerTestToRun(specText: String, testTags: List[Tag], methodName: String, testFun: FixtureParam => Any) {
    registerTest(specText, Transformer(testFun), "itCannotAppearInsideAnotherIt", sourceFileName, methodName, 4, -3, None, None, None, testTags: _*)
  }

  /**
   * 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 FreeSpec 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 methodName caller's method name
   * @param testFun the test function
   * @throws DuplicateTestNameException if a test with the same name has been registered previously
   * @throws TestRegistrationClosedException if invoked after run has been invoked on this suite
   * @throws NullPointerException if specText or any passed test tag is null
   */
  private def registerTestToIgnore(specText: String, testTags: List[Tag], methodName: String, testFun: FixtureParam => Any) {
    registerIgnoredTest(specText, Transformer(testFun), "ignoreCannotAppearInsideAnIt", sourceFileName, methodName, 4, -3, None, testTags: _*)
  }
   /*
  private def registerBranch(description: String, childPrefix: Option[String], fun: () => Unit) {

    // TODO: Fix the resource name and method name
    registerNestedBranch(description, childPrefix, fun(), "describeCannotAppearInsideAnIt", sourceFileName, "describe")
  }  */

  /**
   * Class that supports the registration of tagged tests.
   *
   * 
   * Instances of this class are returned by the taggedAs method of 
   * class FreeSpecStringWrapper.
   * 
   *
   * @author Bill Venners
   */
  protected final class ResultOfTaggedAsInvocationOnString(specText: String, tags: List[Tag]) {

    /**
     * Supports tagged test registration.
     *
     * 
     * For example, this method supports syntax such as the following:
     * 
     *
     *      * "complain on peek" taggedAs(SlowTest) in { fixture => ... }
     *                                       ^
     * 
     *
     * 
     * For more information and examples of this method's use, see the main documentation for trait FreeSpec.
     * 
     */
    def in(testFun: FixtureParam => Any) {
      registerTestToRun(specText, tags, "in", testFun)
    }

    /**
     * Supports tagged test registration, for tests that don't take a fixture.
     *
     * 
     * For example, this method supports syntax such as the following:
     * 
     *
     *      * "complain on peek" taggedAs(SlowTest) in { () => ... }
     *                                       ^
     * 
     *
     * 
     * For more information and examples of this method's use, see the main documentation for trait FreeSpec.
     * 
     */
    def in(testFun: () => Any) {
      registerTestToRun(specText, tags, "in", new NoArgTestWrapper(testFun))
    }

    /**
     * Supports registration of tagged, pending tests.
     *
     * 
     * For example, this method supports syntax such as the following:
     * 
     *
     *      * "complain on peek" taggedAs(SlowTest) is (pending)
     *                                       ^
     * 
     *
     * 
     * For more information and examples of this method's use, see the main documentation for trait FreeSpec.
     * 
     */
    def is(testFun: => PendingNothing) {
      registerTestToRun(specText, tags, "is", unusedFixtureParam => testFun)
    }

    /**
     * Supports registration of tagged, ignored tests.
     *
     * 
     * For example, this method supports syntax such as the following:
     * 
     *
     *      * "complain on peek" taggedAs(SlowTest) ignore { fixture => ... }
     *                                       ^
     * 
     *
     * 
     * For more information and examples of this method's use, see the main documentation for trait FreeSpec.
     * 
     */
    def ignore(testFun: FixtureParam => Any) {
      registerTestToIgnore(specText, tags, "ignore", testFun)
    }

    /**
     * Supports registration of tagged, ignored tests that take no fixture parameter.
     *
     * 
     * For example, this method supports syntax such as the following:
     * 
     *
     *      * "complain on peek" taggedAs(SlowTest) ignore { () => ... }
     *                                       ^
     * 
     *
     * 
     * For more information and examples of this method's use, see the main documentation for trait FreeSpec.
     * 
     */
    def ignore(testFun: () => Any) {
      registerTestToIgnore(specText, tags, "ignore", new NoArgTestWrapper(testFun))
    }
  }

  /**
   * A class that via an implicit conversion (named convertToFreeSpecStringWrapper) enables
   * methods when, that, in, is, taggedAs
   * and ignore to be invoked on Strings.
   *
   * 
   * This class provides much of the syntax for fixture.FreeSpec, however, it does not add
   * the verb methods (should, must, and can) to String.
   * Instead, these are added via the ShouldVerb, MustVerb, and CanVerb
   * traits, which fixture.FreeSpec mixes in, to avoid a conflict with implicit conversions provided
   * in ShouldMatchers and MustMatchers. 
   * 
   *
   * @author Bill Venners
   */
  protected final class FreeSpecStringWrapper(string: String) {

    // TODO: Fill in Scaladoc
    def - (fun: => Unit) {
      registerNestedBranch(string, None, fun, "describeCannotAppearInsideAnIt", sourceFileName, "-", 3, -2, None)
    }

    /**
     * Supports test registration.
     *
     * 
     * For example, this method supports syntax such as the following:
     * 
     *
     *      * "complain on peek" in { fixture => ... }
     *                    ^
     * 
     *
     * 
     * For more information and examples of this method's use, see the main documentation for trait FreeSpec.
     * 
     */
    def in(testFun: FixtureParam => Any) {
      registerTestToRun(string, List(), "in", testFun)
    }

    /**
     * Supports registration of tests that take no fixture.
     *
     * 
     * For example, this method supports syntax such as the following:
     * 
     *
     *      * "complain on peek" in { () => ... }
     *                    ^
     * 
     *
     * 
     * For more information and examples of this method's use, see the main documentation for trait FreeSpec.
     * 
     */
    def in(testFun: () => Any) {
      registerTestToRun(string, List(), "in", new NoArgTestWrapper(testFun))
    }

    /**
     * Supports pending test registration.
     *
     * 
     * For example, this method supports syntax such as the following:
     * 
     *
     *      * "complain on peek" is (pending)
     *                    ^
     * 
     *
     * 
     * For more information and examples of this method's use, see the main documentation for trait FreeSpec.
     * 
     */
    def is(testFun: => PendingNothing) {
      registerTestToRun(string, List(), "is", unusedFixtureParam => testFun)
    }

    /**
     * Supports ignored test registration.
     *
     * 
     * For example, this method supports syntax such as the following:
     * 
     *
     *      * "complain on peek" ignore { fixture => ... }
     *                    ^
     * 
     *
     * 
     * For more information and examples of this method's use, see the main documentation for trait FreeSpec.
     * 
     */
    def ignore(testFun: FixtureParam => Any) {
      registerTestToIgnore(string, List(), "ignore", testFun)
    }

    /**
     * Supports registration of ignored tests that take no fixture.
     *
     * 
     * For example, this method supports syntax such as the following:
     * 
     *
     *      * "complain on peek" ignore { () => ... }
     *                    ^
     * 
     *
     * 
     * For more information and examples of this method's use, see the main documentation for trait FreeSpec.
     * 
     */
    def ignore(testFun: () => Any) {
      registerTestToIgnore(string, List(), "ignore", new NoArgTestWrapper(testFun))
    }

    /**
     * Supports tagged test registration.
     *
     * 
     * For example, this method supports syntax such as the following:
     * 
     *
     *      * "complain on peek" taggedAs(SlowTest) in { fixture => ... }
     *                    ^
     * 
     *
     * 
     * For more information and examples of this method's use, see the main documentation for trait FreeSpec.
     * 
     */
    def taggedAs(firstTestTag: Tag, otherTestTags: Tag*) = {
      val tagList = firstTestTag :: otherTestTags.toList
      new ResultOfTaggedAsInvocationOnString(string, tagList)
    }
  }

  /**
   * Implicitly converts Strings to FreeSpecStringWrapper, which enables
   * methods when, that, in, is, taggedAs
   * and ignore to be invoked on Strings.
   */
  protected implicit def convertToFreeSpecStringWrapper(s: String) = new FreeSpecStringWrapper(s)

  /**
   * A Map whose keys are String tag names to which tests in this FreeSpec belong, and values
   * the Set of test names that belong to each tag. If this FreeSpec 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 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
   *
   * @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 = {
      theTest.testFun match {
        case transformer: org.scalatest.fixture.Transformer[_] => 
          transformer.exceptionalTestFun match {
            case wrapper: NoArgTestWrapper[_] =>
              withFixture(new FixturelessTestFunAndConfigMap(testName, wrapper.test, args.configMap))
            case fun => withFixture(new TestFunAndConfigMap(testName, fun, args.configMap))
          }
        case other => 
          other match {
            case wrapper: NoArgTestWrapper[_] =>
              withFixture(new FixturelessTestFunAndConfigMap(testName, wrapper.test, args.configMap))
            case fun => withFixture(new TestFunAndConfigMap(testName, fun, args.configMap))
          }
      }
    }

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

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

  /**
   * An immutable Set of test names. If this fixture.FreeSpec 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.
   * 
   */
  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: _*)
  }

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

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