All Downloads are FREE. Search and download functionalities are using the official Maven repository.

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

Go to download

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

There is a newer version: 2.0.M6-SNAP4
Show 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 FixtureNodeFamily._
import verb.{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.anErrorThatShouldCauseAnAbort
import org.scalatest.Suite.autoTagClassAnnotations

/**
 * A sister trait to org.scalatest.WordSpec that can pass a fixture object into its tests.
 *
 * 

 * Recommended Usage:
 * Use trait fixture.WordSpec in situations for which WordSpec
 * would be a good choice, when all or most tests need the same fixture objects
 * that must be cleaned up afterwords. Note: fixture.WordSpec is intended for use in special situations, with trait WordSpec used for general needs. For
 * more insight into where fixture.WordSpec fits in the big picture, see the withFixture(OneArgTest) subsection of the Shared fixtures section in the documentation for trait WordSpec.
 * 

 * 
 * 

 * Trait fixture.WordSpec behaves similarly to trait org.scalatest.WordSpec, except that tests may have a
 * fixture parameter. The type of the
 * fixture parameter is defined by the abstract FixtureParam type, which is declared as a member of this trait.
 * This trait also declares an abstract withFixture method. This withFixture method
 * takes a OneArgTest, which is a nested trait defined as a member of this trait.
 * OneArgTest has an apply method that takes a FixtureParam.
 * This apply method is responsible for running a test.
 * This trait's runTest method delegates the actual running of each test to withFixture(OneArgTest), passing
 * in the test code to run via the OneArgTest argument. The withFixture(OneArgTest) method (abstract in this trait) is responsible
 * for creating the fixture argument and passing it to the test function.
 * 

 * 
 * 

 * Subclasses of this trait must, therefore, do three things differently from a plain old org.scalatest.WordSpec:
 * 

 * 
 * 
    
 * 
  1. define the type of the fixture parameter by specifying type FixtureParam
    2. 
 * 
  2. define the withFixture(OneArgTest) method
    3. 
 * 
  3. write tests that take a fixture parameter
    4. 
 * 
  4. (You can also define tests that don't take a fixture parameter.)
    5. 
 * 

 *
 * 

 * If the fixture you want to pass into your tests consists of multiple objects, you will need to combine
 * them into one object to use this trait. One good approach to passing multiple fixture objects is
 * to encapsulate them in a case class. Here's an example:
 * 

 *
 * 
 * case class F(file: File, writer: FileWriter)
 * type FixtureParam = F
 * 

 *
 * 

 * To enable the stacking of traits that define withFixture(NoArgTest), it is a good idea to let
 * withFixture(NoArgTest) invoke the test function instead of invoking the test
 * function directly. To do so, you'll need to convert the OneArgTest to a NoArgTest. You can do that by passing
 * the fixture object to the toNoArgTest method of OneArgTest. In other words, instead of
 * writing “test(theFixture)”, you'd delegate responsibility for
 * invoking the test function to the withFixture(NoArgTest) method of the same instance by writing:
 * 

 *
 * 
 * withFixture(test.toNoArgTest(theFixture))
 * 

 *
 * 

 * Here's a complete example:
 * 

 *
 * 
 * package org.scalatest.examples.wordspec.oneargtest
 * 
 * import org.scalatest.fixture
 * import java.io._
 * 
 * class ExampleSpec extends fixture.WordSpec {
 * 
 *   case class F(file: File, writer: FileWriter)
 *   type FixtureParam = F
 * 
 *   def withFixture(test: OneArgTest) {
 * 
 *     // create the fixture
 *     val file = File.createTempFile("hello", "world")
 *     val writer = new FileWriter(file)
 *     val theFixture = F(file, writer)
 * 
 *     try {
 *       writer.write("ScalaTest is ") // set up the fixture
 *       withFixture(test.toNoArgTest(theFixture)) // "loan" the fixture to the test
 *     }
 *     finally writer.close() // clean up the fixture
 *   }
 * 
 *   "Testing" should {
 *     "be easy" in { f =>
 *       f.writer.write("easy!")
 *       f.writer.flush()
 *       assert(f.file.length === 18)
 *     }
 * 
 *     "be fun" in { f =>
 *       f.writer.write("fun!")
 *       f.writer.flush()
 *       assert(f.file.length === 17)
 *     }
 *   } 
 * }
 * 

 *
 * 

 * If a test fails, the OneArgTest function will complete abruptly with an exception describing the failure.
 * To ensure clean up happens even if a test fails, you should invoke the test function from inside a try block and do the cleanup in a
 * finally clause, as shown in the previous example.
 * 

 *
 * 
Sharing fixtures across classes

 *
 * 

 * If multiple test classes need the same fixture, you can define the FixtureParam and withFixture(OneArgTest) implementations
 * in a trait, then mix that trait into the test classes that need it. For example, if your application requires a database and your integration tests
 * use that database, you will likely have many test classes that need a database fixture. You can create a "database fixture" trait that creates a
 * database with a unique name, passes the connector into the test, then removes the database once the test completes. This is shown in the following example:
 * 

 * 
 * 
 * package org.scalatest.examples.fixture.wordspec.sharing
 * 
 * import java.util.concurrent.ConcurrentHashMap
 * import org.scalatest.fixture
 * import DbServer._
 * import java.util.UUID.randomUUID
 * 
 * object DbServer { // Simulating a database server
 *   type Db = StringBuffer
 *   private val databases = new ConcurrentHashMap[String, Db]
 *   def createDb(name: String): Db = {
 *     val db = new StringBuffer
 *     databases.put(name, db)
 *     db
 *   }
 *   def removeDb(name: String) {
 *     databases.remove(name)
 *   }
 * }
 * 
 * trait DbFixture { this: fixture.Suite =>
 * 
 *   type FixtureParam = Db
 * 
 *   // Allow clients to populate the database after
 *   // it is created
 *   def populateDb(db: Db) {}
 * 
 *   def withFixture(test: OneArgTest) {
 *     val dbName = randomUUID.toString
 *     val db = createDb(dbName) // create the fixture
 *     try {
 *       populateDb(db) // setup the fixture
 *       withFixture(test.toNoArgTest(db)) // "loan" the fixture to the test
 *     }
 *     finally removeDb(dbName) // clean up the fixture
 *   }
 * }
 * 
 * class ExampleSpec extends fixture.WordSpec with DbFixture {
 * 
 *   override def populateDb(db: Db) { // setup the fixture
 *     db.append("ScalaTest is ")
 *   }
 * 
 *   "Testing" should {
 *     "should be easy" in { db =>
 *       db.append("easy!")
 *       assert(db.toString === "ScalaTest is easy!")
 *     }
 *     
 *     "should be fun" in { db =>
 *       db.append("fun!")
 *       assert(db.toString === "ScalaTest is fun!")
 *     }
 *   }
 *   
 *   // This test doesn't need a Db
 *   "Test code" should {
 *     "should be clear" in { () =>
 *       val buf = new StringBuffer
 *       buf.append("ScalaTest code is ")
 *       buf.append("clear!")
 *       assert(buf.toString === "ScalaTest code is clear!")
 *     }
 *   }
 * }
 * 

 *
 * 

 * Often when you create fixtures in a trait like DbFixture, you'll still need to enable individual test classes
 * to "setup" a newly created fixture before it gets passed into the tests. A good way to accomplish this is to pass the newly
 * created fixture into a setup method, like populateDb in the previous example, before passing it to the test
 * function. Classes that need to perform such setup can override the method, as does ExampleSpec.
 * 

 *
 * 

 * If a test doesn't need the fixture, you can indicate that by providing a no-arg instead of a one-arg function, as is done in the
 * third test in the previous example, “Test code should be clear”. In other words, instead of starting your function literal
 * with something like “db =>”, you'd start it with “() =>”. For such tests, runTest
 * will not invoke withFixture(OneArgTest). It will instead directly invoke withFixture(NoArgTest).
 * 

 *
 * 

 * Both examples shown above demonstrate the technique of giving each test its own "fixture sandbox" to play in. When your fixtures
 * involve external side-effects, like creating files or databases, it is a good idea to give each file or database a unique name as is
 * done in these examples. This keeps tests completely isolated, allowing you to run them in parallel if desired. You could mix
 * ParallelTestExecution into either of these ExampleSpec classes, and the tests would run in parallel just fine.
 * 

 *
 * @author Bill Venners
 */
@Finders(Array("org.scalatest.finders.WordSpecFinder"))
trait WordSpec extends Suite with ShouldVerb with MustVerb with CanVerb { thisSuite =>

  private final val engine = new FixtureEngine[FixtureParam]("concurrentFixtureWordSpecMod", "FixtureWordSpec")
  import engine._
  
  private[scalatest] val sourceFileName = "WordSpec.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.WordSpec is being executed, such as from inside a test function, it will forward the information to
   * the current reporter immediately. If invoked at any other time, it will
   * throw an exception. This method can be called safely by any thread.
   */
  implicit protected def info: Informer = atomicInformer.get

  /**
   * 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 WordSpec 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, 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 WordSpec 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, testFun, "ignoreCannotAppearInsideAnIt", sourceFileName, methodName, 4, -3, None, testTags: _*)
  }

  private def registerBranch(description: String, childPrefix: Option[String], methodName: String, stackDepth: Int, adjustment: Int, fun: () => Unit) {
    registerNestedBranch(description, childPrefix, fun(), "describeCannotAppearInsideAnIt", sourceFileName, methodName, stackDepth, adjustment, None)
  }

  /**
   * Class that supports the registration of tagged tests.
   *
   * 

   * Instances of this class are returned by the taggedAs method of 
   * class WordSpecStringWrapper.
   * 

   *
   * @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 fixture.WordSpec.
     * 

     */
    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 fixture.WordSpec.
     * 

     */
    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 fixture.WordSpec.
     * 

     */
    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 fixture.WordSpec.
     * 

     */
    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 fixture.WordSpec.
     * 

     */
    def ignore(testFun: () => Any) {
      registerTestToIgnore(specText, tags, "ignore", new NoArgTestWrapper(testFun))
    }
  }

  /**
   * A class that via an implicit conversion (named convertToWordSpecStringWrapper) enables
   * methods when, which, in, is, taggedAs
   * and ignore to be invoked on Strings.
   *
   * 

   * This class provides much of the syntax for fixture.WordSpec, 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.WordSpec mixes in, to avoid a conflict with implicit conversions provided
   * in ShouldMatchers and MustMatchers. 
   * 

   *
   * @author Bill Venners
   */
  protected final class WordSpecStringWrapper(string: String) {

    /**
     * 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 fixture.WordSpec.
     * 

     */
    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 fixture.WordSpec.
     * 

     */
    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 fixture.WordSpec.
     * 

     */
    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 fixture.WordSpec.
     * 

     */
    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 fixture.WordSpec.
     * 

     */
    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 fixture.WordSpec.
     * 

     */
    def taggedAs(firstTestTag: Tag, otherTestTags: Tag*) = {
      val tagList = firstTestTag :: otherTestTags.toList
      new ResultOfTaggedAsInvocationOnString(string, tagList)
    }

    /**
     * Registers a when clause.
     *
     * 

     * For example, this method supports syntax such as the following:
     * 

     *
     * 
     * "A Stack" when { ... }
     *           ^
     * 

     *
     * 

     * For more information and examples of this method's use, see the main documentation for trait fixture.WordSpec.
     * 

     */
    def when(f: => Unit) {
      registerBranch(string, Some("when"), "when", 4, -2, f _)
    }

    /**
     * Registers a when clause that is followed by an after word.
     *
     * 

     * For example, this method supports syntax such as the following:
     * 

     *
     * 
     * val theUser = afterWord("the user")
     *
     * "A Stack" when theUser { ... }
     *           ^
     * 

     *
     * 

     * For more information and examples of this method's use, see the main documentation for trait fixture.WordSpec.
     * 

     */
    def when(resultOfAfterWordApplication: ResultOfAfterWordApplication) {
      registerBranch(string, Some("when " + resultOfAfterWordApplication.text), "when", 4, -2, resultOfAfterWordApplication.f)
    }

    /**
     * that has been deprecated and will be used for a different purpose in a future version of ScalaTest. Please
     * use which instead. (Warning: this change will likely have a shorter than usual deprecation cycle: less than a year.)
     */
    @deprecated("Please use \"which\" instead of \"that\".")
    def that(f: => Unit) {
      registerBranch(string.trim + " that", None, "that", 4, -2, f _)
    }
    
    /**
     * Registers a which clause.
     *
     * 

     * For example, this method supports syntax such as the following:
     * 

     *
     * 
     * "a rerun button" which {
     *                  ^
     * 

     *
     * 

     * For more information and examples of this method's use, see the main documentation for trait fixture.WordSpec.
     * 

     */
    def which(f: => Unit) {
      registerBranch(string.trim + " which", None, "which", 4, -2, f _)
    }

    /**
     * that has been deprecated and will be used for a different purpose in a future version of ScalaTest. Please
     * use which instead. (Warning: this change will likely have a shorter than usual deprecation cycle: less than a year.)
     */
    @deprecated("Please use \"which\" instead of \"that\".")
    def that(resultOfAfterWordApplication: ResultOfAfterWordApplication) {
      registerBranch(string.trim + " that " + resultOfAfterWordApplication.text.trim, None, "that", 4, -2, resultOfAfterWordApplication.f)
    }
    
    /**
     * Registers a which clause.
     *
     * 

     * For example, this method supports syntax such as the following:
     * 

     *
     * 
     * "a rerun button" which {
     *                  ^
     * 

     *
     * 

     * For more information and examples of this method's use, see the main documentation for trait fixture.WordSpec.
     * 

     */
    def which(resultOfAfterWordApplication: ResultOfAfterWordApplication) {
      registerBranch(string.trim + " which " + resultOfAfterWordApplication.text.trim, None, "which", 4, -2, resultOfAfterWordApplication.f)
    }
  }

  /**
   * Class whose instances are after words, which can be used to reduce text duplication.
   *
   * 

   * If you are repeating a word or phrase at the beginning of each string inside
   * a block, you can "move the word or phrase" out of the block with an after word.
   * You create an after word by passing the repeated word or phrase to the afterWord method.
   * Once created, you can place the after word after when, a verb
   * (should, must, or can), or
   * which. (You can't place one after in or is, the
   * words that introduce a test.) Here's an example that has after words used in all three
   * places:
   * 

   *
   * 
   * import org.scalatest.fixture
   * import ConfigMapFixture
   * 
   * class ScalaTestGUISpec extends fixture.WordSpec with ConfigMapFixture {
   * 
   *   def theUser = afterWord("the user")
   *   def display = afterWord("display")
   *   def is = afterWord("is")
   * 
   *   "The ScalaTest GUI" when theUser {
   *     "clicks on an event report in the list box" should display {
   *       "a blue background in the clicked-on row in the list box" in { cm => }
   *       "the details for the event in the details area" in { cm => }
   *       "a rerun button," which is {
   *         "enabled if the clicked-on event is rerunnable" in { cm => }
   *         "disabled if the clicked-on event is not rerunnable" in { cm => }
   *       }
   *     }
   *   }
   * }
   * 

   *
   * 

   * Running the previous fixture.WordSpec in the Scala interpreter would yield:
   * 

   *
   * 
   * scala> (new ScalaTestGUISpec).run()
   * The ScalaTest GUI (when the user clicks on an event report in the list box) 
   * - should display a blue background in the clicked-on row in the list box
   * - should display the details for the event in the details area
   * - should display a rerun button, which is enabled if the clicked-on event is rerunnable
   * - should display a rerun button, which is disabled if the clicked-on event is not rerunnable
   * 

   */
  protected final class AfterWord(text: String) {

    /**
     * Supports the use of after words.
     *
     * 

     * This method transforms a block of code into a ResultOfAfterWordApplication, which
     * is accepted by when, should, must, can, and which
     * methods.  For more information, see the main documentation for trait org.scalatest.WordSpec.
     * 

     */
    def apply(f: => Unit) = new ResultOfAfterWordApplication(text, f _)
  }

  /**
   * Creates an after word that an be used to reduce text duplication.
   *
   * 

   * If you are repeating a word or phrase at the beginning of each string inside
   * a block, you can "move the word or phrase" out of the block with an after word.
   * You create an after word by passing the repeated word or phrase to the afterWord method.
   * Once created, you can place the after word after when, a verb
   * (should, must, or can), or
   * which. (You can't place one after in or is, the
   * words that introduce a test.) Here's an example that has after words used in all three
   * places:
   * 

   *
   * 
   * import org.scalatest.fixture
   * import ConfigMapFixture
   * 
   * class ScalaTestGUISpec extends fixture.WordSpec with ConfigMapFixture {
   * 
   *   def theUser = afterWord("the user")
   *   def display = afterWord("display")
   *   def is = afterWord("is")
   * 
   *   "The ScalaTest GUI" when theUser {
   *     "clicks on an event report in the list box" should display {
   *       "a blue background in the clicked-on row in the list box" in { cm => }
   *       "the details for the event in the details area" in { cm => }
   *       "a rerun button," which is {
   *         "enabled if the clicked-on event is rerunnable" in { cm => }
   *         "disabled if the clicked-on event is not rerunnable" in { cm => }
   *       }
   *     }
   *   }
   * }
   * 

   *
   * 

   * Running the previous fixture.WordSpec in the Scala interpreter would yield:
   * 

   *
   * 
   * scala> (new ScalaTestGUISpec).run()
   * The ScalaTest GUI (when the user clicks on an event report in the list box) 
   * - should display a blue background in the clicked-on row in the list box
   * - should display the details for the event in the details area
   * - should display a rerun button, which is enabled if the clicked-on event is rerunnable
   * - should display a rerun button, which is disabled if the clicked-on event is not rerunnable
   * 

   */
  protected def afterWord(text: String) = new AfterWord(text)

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

  /**
   * Supports the registration of subjects.
   *
   * 

   * For example, this method enables syntax such as the following:
   * 

   *
   * 
   * "A Stack" should { ...
   *           ^
   * 

   *
   * 

   * This function is passed as an implicit parameter to a should method
   * provided in ShouldVerb, a must method
   * provided in MustVerb, and a can method
   * provided in CanVerb. When invoked, this function registers the
   * subject and executes the block.
   * 

   */
  protected implicit val subjectRegistrationFunction: StringVerbBlockRegistration =
    new StringVerbBlockRegistration {
      def apply(left: String, verb: String, f: () => Unit) = registerBranch(left, Some(verb), "apply", 5, -2, f)
    }

  /**
   * Supports the registration of subject descriptions with after words.
   *
   * 

   * For example, this method enables syntax such as the following:
   * 

   *
   * 
   * def provide = afterWord("provide")
   *
   * "The ScalaTest Matchers DSL" can provide { ... }
   *                              ^
   * 

   *
   * 

   * This function is passed as an implicit parameter to a should method
   * provided in ShouldVerb, a must method
   * provided in MustVerb, and a can method
   * provided in CanVerb. When invoked, this function registers the
   * subject and executes the block.
   * 

   */
  protected implicit val subjectWithAfterWordRegistrationFunction: (String, String, ResultOfAfterWordApplication) => Unit = {
    (left, verb, resultOfAfterWordApplication) => {
      val afterWordFunction =
        () => {
          registerBranch(resultOfAfterWordApplication.text, None, verb, 5, -2, resultOfAfterWordApplication.f)
        }
      registerBranch(left, Some(verb), verb, 5, -2, afterWordFunction)
    }
  }

  /**
   * A Map whose keys are String tag names to which tests in this WordSpec belong, and values
   * the Set of test names that belong to each tag. If this fixture.WordSpec 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) {
      theTest.testFun 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 WordSpec'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 WordSpec.
   * @param args the Args for this run
   *
   * @throws NullPointerException if any of testName or args 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.WordSpec 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.WordSpecs.
   *
   * 

   * 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 org.scalatest.WordSpec.
   * 

   */
  protected val behave = new BehaveWord
  
  /**
   * Suite style name.
   */
  final override val styleName: String = "org.scalatest.fixture.WordSpec"
    
  override def testDataFor(testName: String, theConfigMap: Map[String, Any] = Map.empty): TestData = createTestDataFor(testName, theConfigMap, this)
}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy