Trait

org.scalatestplus.play.guice

GuiceOneAppPerSuite

Related Doc: package guice

Permalink

trait GuiceOneAppPerSuite extends BaseOneAppPerSuite with GuiceFakeApplicationFactory

Trait that provides a new Application instance per ScalaTest Suite.

By default, this trait creates a new Application for the Suite using default parameter values, which is made available via the app field defined in this trait. If your Suite needs a Application with non-default parameters, override app to create it the way you need it.

This TestSuiteMixin trait's overridden run method calls Play.start, passing in the Application provided by app, before executing the Suite via a call to super.run. In addition, it places a reference to the Application provided by app into the ConfigMap under the key org.scalatestplus.play.app. This allows any nested Suites to access the Suite's Application as well, most easily by having the nested Suites mix in the ConfiguredApp trait. On the status returned by super.run, this trait's overridden run method registers a call to Play.stop to be executed when the Status completes, and returns the same Status. This ensure the Application will continue to execute until all nested suites have completed, after which the Application will be stopped.

Here's an example that demonstrates some of the services provided by this trait:

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)
    }
  }
}

If you have many tests that can share the same Application, and you don't want to put them all into one test class, you can place them into different Suite classes. These will be your nested suites. Create a master suite that extends GuiceOneAppPerSuite and declares the nested Suites. Annotate the nested suites with @DoNotDiscover and have them extend ConfiguredApp. Here's an example:

package org.scalatestplus.play.examples.oneapppersuite

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

// This is the "master" suite
class NestedExampleSpec extends Suites(
  new OneSpec,
  new TwoSpec,
  new RedSpec,
  new BlueSpec
) 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()
}

// 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 GuiceOneAppPerSuite trait" must {
    "provide an Application" in {
      app.configuration.getOptional[String]("ehcacheplugin") mustBe Some("disabled")
    }
    "make the Application available implicitly" in {
      def getConfig(key: String)(implicit app: Application) = app.configuration.getOptional[String](key)
      getConfig("ehcacheplugin") mustBe Some("disabled")
    }
    "start the Application" in {
      Play.maybeApplication mustBe Some(app)
    }
  }
}

Self Type
GuiceOneAppPerSuite with TestSuite
Source
GuiceOneAppPerSuite.scala
Linear Supertypes
GuiceFakeApplicationFactory, FakeApplicationFactory, BaseOneAppPerSuite, TestSuiteMixin, SuiteMixin, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GuiceOneAppPerSuite
  2. GuiceFakeApplicationFactory
  3. FakeApplicationFactory
  4. BaseOneAppPerSuite
  5. TestSuiteMixin
  6. SuiteMixin
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def expectedTestCount(filter: Filter): Int

    Permalink
    Definition Classes
    SuiteMixin
  2. abstract def nestedSuites: IndexedSeq[Suite]

    Permalink
    Definition Classes
    SuiteMixin
  3. abstract def rerunner: Option[String]

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

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

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

    Permalink
    Attributes
    protected
    Definition Classes
    SuiteMixin
  7. abstract val styleName: String

    Permalink
    Definition Classes
    SuiteMixin
  8. abstract def suiteId: String

    Permalink
    Definition Classes
    SuiteMixin
  9. abstract def suiteName: String

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

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

    Permalink
    Definition Classes
    SuiteMixin
  12. abstract def testNames: Set[String]

    Permalink
    Definition Classes
    SuiteMixin
  13. abstract def withFixture(test: (GuiceOneAppPerSuite.this)#NoArgTest): Outcome

    Permalink
    Attributes
    protected
    Definition Classes
    TestSuiteMixin

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. implicit lazy val app: Application

    Permalink

    An implicit instance of Application.

    An implicit instance of Application.

    Definition Classes
    BaseOneAppPerSuite
  5. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  6. def clone(): AnyRef

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

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def fakeApplication(): Application

    Permalink
  10. def finalize(): Unit

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

    Permalink
    Definition Classes
    AnyRef → Any
  12. def hashCode(): Int

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

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

    Permalink
    Definition Classes
    AnyRef
  15. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  16. final def notifyAll(): Unit

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

    Permalink

    Invokes Play.start, passing in the Application provided by app, and places that same Application into the ConfigMap under the key org.scalatestplus.play.app to make it available to nested suites; calls super.run; and lastly ensures Play.stop is invoked after all tests and nested suites have completed.

    Invokes Play.start, passing in the Application provided by app, and places that same Application into the ConfigMap under the key org.scalatestplus.play.app to make it available to nested suites; calls super.run; and lastly ensures Play.stop is invoked after all tests and nested suites have completed.

    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
    BaseOneAppPerSuite → SuiteMixin
  18. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  19. def toString(): String

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from FakeApplicationFactory

Inherited from BaseOneAppPerSuite

Inherited from TestSuiteMixin

Inherited from SuiteMixin

Inherited from AnyRef

Inherited from Any

Ungrouped