org.scalatest.fixture.AsyncSuite.scala Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2001-2014 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.fixture

import org.scalatest._
import org.scalatest.exceptions.StackDepthExceptionHelper._

import scala.concurrent.Future

trait AsyncSuite extends org.scalatest.fixture.Suite with org.scalatest.AsyncSuite {

  final override def withFixture(test: OneArgTest): Outcome = {
    throw new exceptions.NotAllowedException(FailureMessages.withFixtureNotAllowedInAsyncFixtures, getStackDepthFun("AsyncFixtures.scala", "withFixture"))
  }

  /**
   * A test function taking no arguments and returning an Future[Outcome].
   *
   * 
   * For more detail and examples, see the relevant section in the
   * documentation for trait fixture.FlatSpec.
   * 
   */
  trait OneArgAsyncTest extends (FixtureParam => Future[Outcome]) with TestData { thisOneArgAsyncTest =>
    /**
     * Runs the body of the test, returning an Future[Outcome].
     */
    def apply(fixture: FixtureParam): Future[Outcome]

    def toNoArgAsyncTest(fixture: FixtureParam): NoArgAsyncTest = 
      new NoArgAsyncTest {
        val name = thisOneArgAsyncTest.name
        val configMap = thisOneArgAsyncTest.configMap
        def apply(): Future[Outcome] = { thisOneArgAsyncTest(fixture) }
        val scopes = thisOneArgAsyncTest.scopes
        val text = thisOneArgAsyncTest.text
        val tags = thisOneArgAsyncTest.tags
      }
  }

  def withAsyncFixture(test: OneArgAsyncTest): Future[Outcome]

  import scala.language.implicitConversions

  implicit def convertToFuture(o: Any): Future[Any] = Future.successful(o)
}