org.scalatest.Specs.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.0-1 Show documentation

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

There is a newer version: 2.0.M6-SNAP3

/*
 * Copyright 2001-2011 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

/**
 * A Suite class that takes zero to many (likely specification-style) Suites,
 *  which will be returned from its nestedSuites method.
 *
 * 
 * For example, you can define a suite that always executes a list of
 * nested, specification-style suites like this:
 * 
 *
 *  * class StepsSpec extends Specs(
 *   new Step1Spec,
 *   new Step2Spec,
 *   new Step3Spec,
 *   new Step4Spec,
 *   new Step5Spec
 * )
 * 
 *
 * 
 * When StepsSpec is executed, it will execute its
 * nested suites in the passed order: Step1Spec, Step2Spec,
 * Step3Spec, Step4Spec, and Step5Spec.
 * 
 *
 * @param specsToNest a sequence of Suites to nest.
 *
 * @throws NullPointerException if suitesToNest, or any suite
 * it contains, is null.
 *
 * @author Bill Venners
 */
class Specs(specsToNest: Suite*) extends Suite {

  for (s <- specsToNest) {
    if (s == null)
      throw new NullPointerException("A passed suite was null")
  }

  /**
   * Returns an immutable IndexedSeq containing the suites passed to the constructor in
   * the order they were passed.
   */
  override val nestedSuites: collection.immutable.IndexedSeq[Suite] = Vector.empty ++ specsToNest
}

/**
 * Companion object to class Specs that offers an apply factory method
 * for creating a Specs instance.
 *
 * 
 * One use case for this object is to run multiple specification-style suites in the Scala interpreter, like this:
 * 
 *
 *  * scala> Specs(new MyFirstSpec, new MyNextSpec).execute()
 * 
 */
object Specs {

  /**
   * Factory method for creating a Suites instance.
   */
  def apply(specsToNest: Suite*): Specs = new Specs(specsToNest: _*)
}