org.scalatest.Distributor.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 Show documentation

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

There is a newer version: 2.0.M6-SNAP4

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

/**
 * Trait whose instances facilitate parallel execution of Suites.
 * An optional Distributor is passed to the run method of Suite. If a
 * Distributor is indeed passed, trait Suite's implementation of run will
 * populate that Distributor with its nested Suites (by passing them to the Distributor's
 * apply method) rather than executing the nested Suites directly. It is then up to another thread or process
 * to execute those Suites.
 *
 * 
 * If you have a set of nested Suites that must be executed sequentially, you can mix in trait
 * SequentialNestedSuiteExecution, which overrides runNestedSuites and
 * calls super's runNestedSuites implementation, passing in None for the
 * Distributor.
 * 
 * 
 * 
 * Implementations of this trait must be thread safe.
 * 
 *
 * @author Bill Venners
 */
trait Distributor {
  
  /**
   * Puts a Suite into the Distributor.
   *
   * @param suite the Suite to put into the Distributor.
   * @param tracker a Tracker to pass to the Suite's run method.
   *
   * @throws NullPointerException if either suite or tracker is null.
   */
  @deprecated("Please use the apply method that takes a Args instead, the one with this signature: def apply(Suite, Args)")
  def apply(suite: Suite, tracker: Tracker)

  /**
   * Puts a Suite into the Distributor.
   *
   * 
   * The Distributor can decide which, if any, of the passed ArgsSuite's apply method. For example, a Distributor
   * may pass itself wrapped in a Some in the Args it passes to the Suite's run
   * method instead of the args.distributor value.
   * 
   *
   * @param suite the Suite to put into the Distributor.
   * @param args a Args containing objects that may be passed to the Suite's
   *             run method via a Args instance.
   *
   * @throws NullPointerException if either suite or tracker is null.
   */
  def apply(suite: Suite, args: Args): Status
}