An implicit instance of Application.
An implicit instance of Application.
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.
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.
the Args for this run
a Status object that indicates when all tests and nested suites started by this method have completed, and whether or not a failure occurred.
Trait that provides a new
Applicationinstance per ScalaTestSuite.By default, this trait creates a new
Applicationfor theSuiteusing default parameter values, which is made available via theappfield defined in this trait. If yourSuiteneeds aApplicationwith non-default parameters, overrideappto create it the way you need it.This
TestSuiteMixintrait's overriddenrunmethod callsPlay.start, passing in theApplicationprovided byapp, before executing theSuitevia a call tosuper.run. In addition, it places a reference to theApplicationprovided byappinto theConfigMapunder the keyorg.scalatestplus.play.app. This allows any nestedSuites to access theSuite'sApplicationas well, most easily by having the nestedSuites mix in the ConfiguredApp trait. On the status returned bysuper.run, this trait's overriddenrunmethod registers a call toPlay.stopto be executed when theStatuscompletes, and returns the sameStatus. This ensure theApplicationwill continue to execute until all nested suites have completed, after which theApplicationwill 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.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) } } }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 differentSuiteclasses. These will be your nested suites. Create a master suite that extendsGuiceOneAppPerSuiteand declares the nestedSuites. Annotate the nested suites with@DoNotDiscoverand have them extendConfiguredApp. 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.getString("ehcacheplugin") mustBe Some("disabled") } "make the Application available implicitly" in { def getConfig(key: String)(implicit app: Application) = app.configuration.getString(key) getConfig("ehcacheplugin") mustBe Some("disabled") } "start the Application" in { Play.maybeApplication mustBe Some(app) } } }