ConfiguredApp

Trait that provides a configured FakeApplication to the suite into which it is mixed.

The purpose of this trait is to allow nested suites of an enclosing suite that extends OneAppPerSuite to make use of the FakeApplication provided by OneAppPerSuite. Trait OneAppPerSuite will ensure the FakeApplication is placed in the ConfigMap under the key org.scalatestplus.play.app before nested suites are invoked. This represents the "configured application" that is passed from the enclosing suite to the nested suites. Trait ConfiguredApp extracts the FakeApplication from the ConfigMap and makes it available via the app method it provides.

To prevent discovery of nested suites you can annotate them with @DoNotDiscover. Here's an example, taken from OneAppPerSuite's documentation:

package org.scalatestplus.play.examples.oneapppersuite

import play.api.test._
import org.scalatest._
import org.scalatestplus.play._
import play.api.{Play, Application}

// This is the "master" suite
class NestedExampleSpec extends Suites(
  new OneSpec,
  new TwoSpec,
  new RedSpec,
  new BlueSpec
) with OneAppPerSuite {
  // Override app if you need a FakeApplication with other than non-default parameters.
  implicit override lazy val app: FakeApplication =
    FakeApplication(additionalConfiguration = Map("ehcacheplugin" -> "disabled"))
}

// These are the nested suites
@DoNotDiscover class OneSpec extends PlaySpec with ConfiguredApp
@DoNotDiscover class TwoSpec extends PlaySpec with ConfiguredApp
@DoNotDiscover class RedSpec extends PlaySpec with ConfiguredApp

@DoNotDiscover
class BlueSpec extends PlaySpec with ConfiguredApp {

  "The OneAppPerSuite trait" must {
    "provide a FakeApplication" in {
      app.configuration.getString("ehcacheplugin") mustBe Some("disabled")
    }
    "make the FakeApplication available implicitly" in {
      def getConfig(key: String)(implicit app: Application) = app.configuration.getString(key)
      getConfig("ehcacheplugin") mustBe Some("disabled")
    }
    "start the FakeApplication" in {
      Play.maybeApplication mustBe Some(app)
    }
  }
}

Self Type: ConfiguredApp with Suite

Linear Supertypes

SuiteMixin, AnyRef, Any

Abstract Value Members

abstract def expectedTestCount(filter: Filter): Int

Definition Classes
SuiteMixin
abstract def nestedSuites: IndexedSeq[Suite]

Definition Classes
SuiteMixin
abstract def rerunner: Option[String]

Definition Classes
SuiteMixin
abstract def runNestedSuites(args: Args): Status

Attributes
protected
Definition Classes
SuiteMixin
abstract def runTest(testName: String, args: Args): Status

Attributes
protected
Definition Classes
SuiteMixin
abstract def runTests(testName: Option[String], args: Args): Status

Attributes
protected
Definition Classes
SuiteMixin
abstract val styleName: String

Definition Classes
SuiteMixin
abstract def suiteId: String

Definition Classes
SuiteMixin
abstract def suiteName: String

Definition Classes
SuiteMixin
abstract def tags: Map[String, Set[String]]

Definition Classes
SuiteMixin
abstract def testDataFor(testName: String, theConfigMap: ConfigMap): TestData

Definition Classes
SuiteMixin
abstract def testNames: Set[String]

Definition Classes
SuiteMixin
abstract def withFixture(test: (ConfiguredApp.this)#NoArgTest): Outcome

Attributes
protected
Definition Classes
SuiteMixin

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def ==(arg0: Any): Boolean

Definition Classes
Any
implicit final def app: FakeApplication

The "configured" FakeApplication instance that was passed into run via the ConfigMap.
The "configured" FakeApplication instance that was passed into run via the ConfigMap.
returns
the configured FakeApplication
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def run(testName: Option[String], args: Args): Status

Looks in args.configMap for a key named "org.
Looks in args.configMap for a key named "org.scalatestplus.play.app" whose value is a FakeApplication, and if it exists, sets it as the FakeApplication that will be returned from the app method, then calls super.run.
If no key matches "org.scalatestplus.play.app" in args.configMap, or the associated value is not a FakeApplication, throws IllegalArgumentException.
To prevent discovery of nested suites you can annotate them with @DoNotDiscover.
testName
an optional name of one test to run. If None, all relevant tests should be run. I.e., None acts like a wildcard that means run all relevant tests in this Suite.
args
the Args for this run
returns
a Status object that indicates when all tests and nested suites started by this method have completed, and whether or not a failure occurred.

Definition Classes
ConfiguredApp → SuiteMixin
Exceptions thrown
IllegalArgumentException
if the FakeApplication does not appear in args.configMap under the expected key
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

trait ConfiguredApp extends SuiteMixin

Abstract Value Members

abstract def expectedTestCount(filter: Filter): Int

abstract def nestedSuites: IndexedSeq[Suite]

abstract def rerunner: Option[String]

abstract def runNestedSuites(args: Args): Status

abstract def runTest(testName: String, args: Args): Status

abstract def runTests(testName: Option[String], args: Args): Status

abstract val styleName: String

abstract def suiteId: String

abstract def suiteName: String

abstract def tags: Map[String, Set[String]]

abstract def testDataFor(testName: String, theConfigMap: ConfigMap): TestData

abstract def testNames: Set[String]

abstract def withFixture(test: (ConfiguredApp.this)#NoArgTest): Outcome

Concrete Value Members

final def !=(arg0: AnyRef): Boolean

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: AnyRef): Boolean

final def ==(arg0: Any): Boolean

implicit final def app: FakeApplication

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def run(testName: Option[String], args: Args): Status

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from SuiteMixin

Inherited from AnyRef

Inherited from Any

Ungrouped