org.scalatest.concurrent.ConductorMultiFixture.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.concurrent

import org.scalatest._
import fixture.ConfigMapFixture
import org.scalatest.fixture

/**
 * ConductorMultiFixture has been deprecated and will be removed in a future version of ScalaTest. Please
 * copy the withConductorFixture method into your own trait instead.
 *
 * 
 * This trait was originally intended for use with the "MultiFixture" traits in the org.scalatest.fixture
 * package. Those traits were deprecated in favor of using explicit method calls (rather than implicit ones). So this
 * trait is no longer relevant. You can still use the same approach if you want, of course, but since this will be
 * going away in a future version of ScalaTest, please just copy the source code of the withConductorFixture
 * method and place it into your own trait, then use that trait instead.
 * 
 *
 * @author Bill Venners
 */

@deprecated("Please copy the withConductorFixture method into your own trait instead.")
trait ConductorMultiFixture { this: fixture.Suite with ConfigMapFixture =>

  /**
   * 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.
   * 
   *
   */
  implicit def withConductorFixture(fun: Conductor => Unit): this.FixtureParam => Unit = { configMap =>
    val conductor = new Conductor
    fun(conductor)
    if (!conductor.conductingHasBegun)
      conductor.conduct()
  }
}