t

org.scalatestplus.play

ConfiguredApp

trait ConfiguredApp extends TestSuiteMixin

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

The purpose of this trait is to allow nested suites of an enclosing suite that extends GuiceOneAppPerSuite to make use of the Application provided by GuiceOneAppPerSuite. Trait GuiceOneAppPerSuite will ensure the Application 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 Application 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 GuiceOneAppPerSuite's documentation:

package org.scalatestplus.play.examples.oneapppersuite

import org.scalatestplus.play._
import play.api.{Play, Application}
import play.api.inject.guice._

class ExampleSpec extends PlaySpec with GuiceOneAppPerSuite {

  // Override app if you need an Application with other than non-default parameters.
  def fakeApplication(): Application =
    new GuiceApplicationBuilder().configure(Map("ehcacheplugin" -> "disabled")).build()

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

Self Type
ConfiguredApp with TestSuite
Source
ConfiguredApp.scala
Linear Supertypes
TestSuiteMixin, SuiteMixin, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConfiguredApp
  2. TestSuiteMixin
  3. SuiteMixin
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def expectedTestCount(filter: Filter): Int
    Definition Classes
    SuiteMixin
  2. abstract def nestedSuites: IndexedSeq[Suite]
    Definition Classes
    SuiteMixin
  3. abstract def rerunner: Option[String]
    Definition Classes
    SuiteMixin
  4. abstract def runNestedSuites(args: Args): Status
    Attributes
    protected
    Definition Classes
    SuiteMixin
  5. abstract def runTest(testName: String, args: Args): Status
    Attributes
    protected
    Definition Classes
    SuiteMixin
  6. abstract def runTests(testName: Option[String], args: Args): Status
    Attributes
    protected
    Definition Classes
    SuiteMixin
  7. abstract val styleName: String
    Definition Classes
    SuiteMixin
  8. abstract def suiteId: String
    Definition Classes
    SuiteMixin
  9. abstract def suiteName: String
    Definition Classes
    SuiteMixin
  10. abstract def tags: Map[String, Set[String]]
    Definition Classes
    SuiteMixin
  11. abstract def testDataFor(testName: String, theConfigMap: ConfigMap): TestData
    Definition Classes
    SuiteMixin
  12. abstract def testNames: Set[String]
    Definition Classes
    SuiteMixin
  13. abstract def withFixture(test: (ConfiguredApp.this)#NoArgTest): Outcome
    Attributes
    protected
    Definition Classes
    TestSuiteMixin

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. implicit final def app: Application

    The "configured" Application instance that was passed into run via the ConfigMap.

    The "configured" Application instance that was passed into run via the ConfigMap.

    returns

    the configured Application

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. def run(testName: Option[String], args: Args): Status

    Looks in args.configMap for a key named "org.scalatestplus.play.app" whose value is a Application, and if it exists, sets it as the Application that will be returned from the app method, then calls super.run.

    Looks in args.configMap for a key named "org.scalatestplus.play.app" whose value is a Application, and if it exists, sets it as the Application 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 Application, 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

    java.lang.IllegalArgumentException if the Application does not appear in args.configMap under the expected key

  17. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  20. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  21. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from TestSuiteMixin

Inherited from SuiteMixin

Inherited from AnyRef

Inherited from Any

Ungrouped