An implicit instance of Application.
An implicit instance of Application.
The port used by the TestServer.
The port used by the TestServer. By default this will be set to the result returned from
Helpers.testServerPort. You can override this to provide a different port number.
Implicit PortNumber instance that wraps port.
Implicit PortNumber instance that wraps port. The value returned from portNumber.value
will be same as the value of port.
the configured port number, wrapped in a PortNumber
Invokes start on a new TestServer created with the Application provided by app and the
port number defined by port, places the Application and port number into the ConfigMap under the keys
org.scalatestplus.play.app and org.scalatestplus.play.port, respectively, to make
them available to nested suites; calls super.run; and lastly ensures the Application and test server are stopped after
all tests and nested suites have completed.
Invokes start on a new TestServer created with the Application provided by app and the
port number defined by port, places the Application and port number into the ConfigMap under the keys
org.scalatestplus.play.app and org.scalatestplus.play.port, respectively, to make
them available to nested suites; calls super.run; and lastly ensures the Application and test server are stopped 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
Applicationand runningTestServerinstance per ScalaTestSuite.By default, this trait creates a new
Applicationfor theSuiteusing default parameter values, which is made available via theappfield defined in this trait and a newTestServerfor theSuiteusing the port number provided by itsportfield and theApplicationprovided by itsappfield. If yourSuiteneeds aApplicationwith non-default parameters, overrideapp. If it needs a different port number, overrideport.This
TestSuiteMixintrait's overriddenrunmethod callsstarton theTestServerbefore executing theSuitevia a call tosuper.run. In addition, it places a reference to theApplicationprovided byappinto theConfigMapunder the keyorg.scalatestplus.play.appand to the port number provided byportunder the keyorg.scalatestplus.play.port. This allows any nestedSuites to access theSuite'sApplicationand port number as well, most easily by having the nestedSuites mix in the ConfiguredServer trait. On the status returned bysuper.run, this trait's overriddenrunmethod registers a call tostopon theTestServerto be executed when theStatuscompletes, and returns the sameStatus. This ensure theTestServerwill continue to execute until all nested suites have completed, after which theTestServerwill be stopped.Here's an example that demonstrates some of the services provided by this trait:
package org.scalatestplus.play.examples.oneserverpersuite import play.api.test._ import org.scalatestplus.play._ import play.api.{Play, Application} import play.api.inject.guice._ class ExampleSpec extends PlaySpec with OneServerPerSuite { // Override fakeApplication() if you need a Application with other than non-default parameters. def fakeApplication(): Application = new GuiceApplicationBuilder().configure("ehcacheplugin" -> "disabled").build() "The OneServerPerSuite 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) } "provide the port number" in { port mustBe Helpers.testServerPort } "provide an actual running server" in { import Helpers._ import java.net._ val url = new URL("http://localhost:" + port + "/boum") val con = url.openConnection().asInstanceOf[HttpURLConnection] try con.getResponseCode mustBe 404 finally con.disconnect() } } }If you have many tests that can share the same
ApplicationandTestServer, 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 extendsOneServerPerSuiteand declares the nestedSuites. Annotate the nested suites with@DoNotDiscoverand have them extendConfiguredServer. Here's an example:package org.scalatestplus.play.examples.oneserverpersuite 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 GuiceOneServerPerSuite { // Override app if you need an Application with other than non-default parameters. override def fakeApplication(): Application = new GuiceApplicationBuilder().configure(Map("ehcacheplugin" -> "disabled")).build() } // These are the nested suites @DoNotDiscover class OneSpec extends PlaySpec with ConfiguredServer @DoNotDiscover class TwoSpec extends PlaySpec with ConfiguredServer @DoNotDiscover class RedSpec extends PlaySpec with ConfiguredServer @DoNotDiscover class BlueSpec extends PlaySpec with ConfiguredServer { "The OneServerPerSuite 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) } "provide the port number" in { port mustBe Helpers.testServerPort } "provide an actual running server" in { import Helpers._ import java.net._ val url = new URL("http://localhost:" + port + "/boum") val con = url.openConnection().asInstanceOf[HttpURLConnection] try con.getResponseCode mustBe 404 finally con.disconnect() } } }