org.specs.specification.ExampleContext.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of specs_2.9.3-RC1 Show documentation
specs
The newest version!
/**
 * Copyright (c) 2007-2011 Eric Torreborre 
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
 * documentation files (the "Software"), to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all copies or substantial portions of
 * the Software. Neither the name of specs nor the names of its contributors may be used to endorse or promote
 * products derived from this software without specific prior written permission.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
 * TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 * DEALINGS IN THE SOFTWARE.
 */
package org.specs.specification
import org.specs.execute.FailureException
import org.specs.util.ExtendedThrowable._
/**
 * This trait extends the ExampleLifeCycle with the capability to store actions 
 * to be executed before and after examples.
 */
trait ExampleContext extends ExampleLifeCycle {
  
  /** the before function will be invoked before each example */
  var before: Option[() => Any] = None
  /** the aroundExpectations function will be invoked around each expectations */
  var aroundExpectations: Option[(=>Any) => Any] = {
    def id(a: =>Any) = a
    Some(id(_))
  }
  /** the firstActions function will be invoked before all examples */
  var firstActions: Option[() => Any] = None
  /** the after function will be invoked after each example */
  var after: Option[() => Any] = None
  /** the lastActions function will be invoked after all examples */
  var lastActions: Option[() => Any] = None
  private lazy val executeOneExampleOnly = parent match {
    case Some(s: BaseSpecification) => s.executeOneExampleOnly
    case _ => false
  }
  /** calls the before method of the "parent" cycle, then the sus before method before an example if that method is defined. */
  override def beforeExample(ex: Examples): Unit = {
    beforeSystemFailure.map(throw _)
    parent.map(_.beforeExample(ex))
    if (!(ex eq this)) {
      if (!exampleList.isEmpty && ex == exampleList.head && !(executeOneExampleOnly && ex.hasSubExamples)) {
        executeActions(firstActions, "Before system:\n")
      }
      if (!ex.hasSubExamples) executeActions(before, "Before example:\n" )
    }
  }
  private def executeActions(actions: Option[() => Any], msg: String) = {
    val susListener = new Sus("", new org.specs.Specification {})
    actions.map { a =>
      withCurrent(susListener)(a.apply) 
    }
    actions.map { b => 
      val initErrors = susListener.failureAndErrors
      if (!initErrors.isEmpty) {
        val failure = new FailureException(msg+ 
                                         initErrors.map(_.getMessage).mkString("\n")).setAs(initErrors(0))
        beforeSystemFailure = Some(failure)
        beforeSystemFailure.map(throw _)
      }
    }
  }
  /** 
   * calls the executeExpectations method of the "parent" cycle.
   * 
   * If the example is not a sus then the "around expectations" function is used
   */
  override def executeExpectations(ex: Examples, t: =>Any): Any = {
    ex match {
      case sus: Sus => parent.map(_.executeExpectations(ex, t))
      case e: Example if (ex.hasSubExamples) => parent.map(_.executeExpectations(ex, t))
      case e: Example if (!ex.hasSubExamples) => aroundExpectations.map { (f: (=>Any) =>Any) => 
          f(parent.map(_.executeExpectations(ex, t)))
        }.orElse(parent.map(_.executeExpectations(ex, t)))
    }
    
  }
  /** calls the after method of the "parent" cycle, then the sus after method after an example if that method is defined. */
  override def afterExample(ex: Examples): Unit = { 
    if (!(ex eq this)) {
      if (!ex.hasSubExamples)
        executeActions(after, "After example:\n")
      this match {
        case composite: Examples if !topParent.map(_.isSequential).getOrElse(false) && !ex.hasSubExamples =>
          executeLastActions(ex)
        case other => ()
      }
    }
    parent.map(_.afterExample(ex))
  }

  protected def executeLastActions(ex: Examples) = {
    if (lastNested == Some(ex))
      executeActions(Some(() => { lastActions.map(_.apply) }), "After system:\n")
  }
  private def lastNested: Option[ExampleContext] = {
    exampleList.lastOption.flatMap(_.lastNested).orElse(Some(this))
  }
  /**
   * when an example has been executed in another specification to guarantee its isolation
   * copy all results, including the context variables.
   */
  override def copyExecutionResults(other: Examples) = {
    copyContextFrom(other)
    super.copyExecutionResults(other)
  }

  /**
   * copy the context variables from another example
   */
  def copyContextFrom(other: ExampleContext) = {
    before = other.before
    after = other.after
    aroundExpectations = other.aroundExpectations
    untilPredicate = other.untilPredicate
    firstActions = other.firstActions
    beforeSystemFailure = other.beforeSystemFailure
    lastActions = other.lastActions
  }
}