org.scalatestplus.play.guice
Members list
Type members
Classlikes
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
Attributes
- Supertypes
- Known subtypes
-
trait GuiceOneAppPerSuitetrait OneAppPerSuitetrait GuiceOneAppPerTesttrait OneAppPerTesttrait GuiceOneServerPerSuitetrait OneServerPerSuitetrait GuiceOneServerPerTesttrait OneServerPerTestShow all
Trait that provides a new Application
instance per ScalaTest Suite
.
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 Suite
s to access the Suite
's Application
as well, most easily by having the nested Suite
s 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") } } }
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 Suite
s. 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") } } }
Attributes
- Supertypes
-
trait FakeApplicationFactorytrait BaseOneAppPerSuitetrait TestSuiteMixintrait SuiteMixinclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
trait OneAppPerSuite
- Self type
-
TestSuite
Trait that provides a new Application
instance for each test.
Trait that provides a new Application
instance for each test.
This TestSuiteMixin
trait's overridden withFixture
method creates a new Application
before each test and ensures it is cleaned up after the test has completed. You can access the Application
from your tests as method app
(which is marked implicit).
By default, this trait creates a new Application
for each test using default parameter values, which is returned by the newAppForTest
method defined in this trait. If your tests need a Application
with non-default parameters, override newAppForTest
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") } } }
Attributes
- Supertypes
-
trait FakeApplicationFactorytrait BaseOneAppPerTesttrait AppProvidertrait TestSuiteMixintrait SuiteMixinclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
trait OneAppPerTest
- Self type
-
TestSuite
Attributes
- Supertypes
-
trait FakeApplicationFactorytrait BaseOneServerPerSuitetrait ServerProvidertrait TestSuiteMixintrait SuiteMixinclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
trait OneServerPerSuite
- Self type
-
TestSuite
Attributes
- Supertypes
-
trait FakeApplicationFactorytrait BaseOneServerPerTesttrait ServerProvidertrait TestSuiteMixintrait SuiteMixinclass Objecttrait Matchableclass AnyShow all
- Known subtypes
-
trait OneServerPerTest
- Self type
-
TestSuite