org.scalatest.concurrent

ConductorMultiFixture

trait ConductorMultiFixture extends AnyRef

Trait that can pass a new Conductor fixture into tests, for use in suites such as MultipleFixtureFunSuite or MultipleFixtureSpec, which facilitate writing tests that take different types of fixtures.

Here's an example of the use of this trait to test the ArrayBlockingQueue concurrency abstraction from java.util.concurrent:

import org.scalatest.fixture.MultipleFixtureFunSuite
import org.scalatest.concurrent.ConductorMultiFixture
import org.scalatest.matchers.ShouldMatchers
import java.util.concurrent.ArrayBlockingQueue

class ArrayBlockingQueueSuite extends MultipleFixtureFunSuite with ConductorMultiFixture with ShouldMatchers {

test("calling put on a full queue blocks the producer thread") { (conductor: Conductor) => import conductor._

val buf = new ArrayBlockingQueue[Int](1)

thread("producer") { buf put 42 buf put 17 beat should be (1) }

thread("consumer") { waitForBeat(1) buf.take should be (42) buf.take should be (17) }

whenFinished { buf should be ('empty) } }

test("calling take on an empty queue blocks the consumer thread") { (conductor: Conductor) => import conductor._

val buf = new ArrayBlockingQueue[Int](1)

thread("producer") { waitForBeat(1) buf put 42 buf put 17 }

thread("consumer") { buf.take should be (42) buf.take should be (17) beat should be (1) }

whenFinished { buf should be ('empty) } } }

For an explanation of how these tests work, see the documentation for Conductor.

Inherits

  1. AnyRef
  2. Any

Value Members

  1. def equals(arg0: Any): Boolean

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence

    This method is used to compare the receiver object (this) with the argument object (arg0) for equivalence.

    The default implementations of this method is an equivalence relation:

    • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
    • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
    • It is transitive: for any instances x, y, and z of type AnyRef if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

    If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is often necessary to override hashCode to ensure that objects that are "equal" (o1.equals(o2) returns true) hash to the same Int (o1.hashCode.equals(o2.hashCode)).

    arg0

    the object to compare against this object for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    definition classes: AnyRef ⇐ Any
  2. def hashCode(): Int

    Returns a hash code value for the object

    Returns a hash code value for the object.

    The default hashing algorithm is platform dependent.

    Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

    definition classes: AnyRef ⇐ Any
  3. def toString(): String

    Returns a string representation of the object

    Returns a string representation of the object.

    The default representation is platform dependent.

    definition classes: AnyRef ⇐ Any
  4. def withConductorFixture(fun: (Conductor) ⇒ Unit): (Map[String, Any]) ⇒ Unit

    Creates a new Conductor, passes the Conductor to the specified test function, and ensures that conduct gets invoked on the Conductor

    Creates a new Conductor, passes the Conductor to the specified test function, and ensures that conduct gets invoked on the Conductor.

    After the test function returns (so long as it returns normally and doesn't complete abruptly with an exception), this method will determine whether the conduct method has already been called (by invoking conductingHasBegun on the Conductor). If not, this method will invoke conduct to ensure that the multi-threaded test is actually conducted.

    attributes: implicit