package guice
Type Members
- trait GuiceFakeApplicationFactory extends FakeApplicationFactory
This trait is used to return an instance of Application that is used in tests.
This trait is used to return an instance of Application that is used in tests.
If you need to use a fake application for Play, but don't want to override the application method for each suite individually, you can create a trait that subclasses GuiceFakeApplicationFactory
- trait GuiceOneAppPerSuite extends BaseOneAppPerSuite with GuiceFakeApplicationFactory
Trait that provides a new
Application
instance per ScalaTestSuite
.Trait that provides a new
Application
instance per ScalaTestSuite
.By default, this trait creates a new
Application
for theSuite
using default parameter values, which is made available via theapp
field defined in this trait. If yourSuite
needs aApplication
with non-default parameters, overrideapp
to create it the way you need it.This
TestSuiteMixin
trait's overriddenrun
method callsPlay.start
, passing in theApplication
provided byapp
, before executing theSuite
via a call tosuper.run
. In addition, it places a reference to theApplication
provided byapp
into theConfigMap
under the keyorg.scalatestplus.play.app
. This allows any nestedSuite
s to access theSuite
'sApplication
as well, most easily by having the nestedSuite
s mix in the ConfiguredApp trait. On the status returned bysuper.run
, this trait's overriddenrun
method registers a call toPlay.stop
to be executed when theStatus
completes, and returns the sameStatus
. This ensure theApplication
will continue to execute until all nested suites have completed, after which theApplication
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") } } }
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 differentSuite
classes. These will be your nested suites. Create a master suite that extendsGuiceOneAppPerSuite
and declares the nestedSuite
s. Annotate the nested suites with@DoNotDiscover
and 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.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") } } }
- trait GuiceOneAppPerTest extends BaseOneAppPerTest with GuiceFakeApplicationFactory
Trait that provides a new
Application
instance for each test.Trait that provides a new
Application
instance for each test.This
TestSuiteMixin
trait's overriddenwithFixture
method creates a newApplication
before each test and ensures it is cleaned up after the test has completed. You can access theApplication
from your tests as methodapp
(which is marked implicit).By default, this trait creates a new
Application
for each test using default parameter values, which is returned by thenewAppForTest
method defined in this trait. If your tests need aApplication
with non-default parameters, overridenewAppForTest
to return it.Here's an example that demonstrates some of the services provided by this trait:
package org.scalatestplus.play.examples.oneapppertest import org.scalatest._ import org.scalatestplus.play._ import org.scalatestplus.play.guice.GuiceOneAppPerTest import play.api.{Play, Application} import play.api.inject.guice._ class ExampleSpec extends PlaySpec with GuiceOneAppPerTest { // Override newAppForTest if you need an Application with other than non-default parameters. implicit override def newAppForTest(testData: TestData): Application = new GuiceApplicationBuilder().configure(Map("ehcacheplugin" -> "disabled")).build() "The OneAppPerTest 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") } } }
- trait GuiceOneServerPerSuite extends BaseOneServerPerSuite with GuiceFakeApplicationFactory
- trait GuiceOneServerPerTest extends BaseOneServerPerTest with GuiceFakeApplicationFactory