trait ConfiguredServer extends TestSuiteMixin with ServerProvider
Trait that provides a configured Application
and server port number to the suite into which it is mixed.
The purpose of this trait is to allow nested suites of an enclosing suite that extends GuiceOneServerPerSuite
to make use of the Application
and port number provided by OneServerPerSuite
. Trait OneServerPerSuite
will ensure
the Application
is placed in the ConfigMap
under the key org.scalatestplus.play.app
and the port number
under the key org.scalatestplus.play.port
before nested suites are invoked. This information represents the "configured server" that
is passed from the enclosing suite to the nested suites. Trait ConfiguredServer
extracts this information from
from the ConfigMap
and makes the Application
available via the app
method, the port number available as an Int
from
the port
method, and also the port number wrapped in a PortNumber available as implicit method portNumber
(for use
with trait WsScalaTestClient).
To prevent discovery of nested suites you can annotate them with @DoNotDiscover
. Here's an example,
taken from GuiceOneAppPerSuite
's documentation:
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 GuiceOneServerPerSuite { // 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.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") } "provide an http endpoint" in { runningServer.endpoints.httpEndpoint must not be empty } "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() } } }
- Self Type
- ConfiguredServer with TestSuite
- Source
- ConfiguredServer.scala
- Alphabetic
- By Inheritance
- ConfiguredServer
- ServerProvider
- TestSuiteMixin
- SuiteMixin
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def expectedTestCount(filter: Filter): Int
- Definition Classes
- SuiteMixin
- abstract def nestedSuites: IndexedSeq[Suite]
- Definition Classes
- SuiteMixin
- abstract def rerunner: Option[String]
- Definition Classes
- SuiteMixin
- abstract def suiteId: String
- Definition Classes
- SuiteMixin
- abstract def suiteName: String
- Definition Classes
- SuiteMixin
- abstract def tags: Map[String, Set[String]]
- Definition Classes
- SuiteMixin
- abstract def testDataFor(testName: String, theConfigMap: ConfigMap): TestData
- Definition Classes
- SuiteMixin
- abstract def testNames: Set[String]
- Definition Classes
- SuiteMixin
- abstract val styleName: String
- Definition Classes
- SuiteMixin
- Annotations
- @deprecated
- Deprecated
(Since version 3.1.0) The styleName lifecycle method has been deprecated and will be removed in a future version of ScalaTest with no replacement.
Concrete Value Members
- implicit final def app: Application
The "configured"
Application
instance that was passed intorun
via theConfigMap
.The "configured"
Application
instance that was passed intorun
via theConfigMap
.- returns
the configured
Application
- Definition Classes
- ConfiguredServer → ServerProvider
- final def port: Int
The port used by the
TestServer
.The port used by the
TestServer
.- Definition Classes
- ServerProvider
- implicit def portNumber: PortNumber
Implicit
PortNumber
instance that wrapsport
.Implicit
PortNumber
instance that wrapsport
. The value returned fromportNumber.value
will be same as the value ofport
.- returns
the configured port number, wrapped in a
PortNumber
- Definition Classes
- ServerProvider
- def run(testName: Option[String], args: Args): Status
Looks in
args.configMap
for a key named "org.scalatestplus.play.app" whose value is aApplication
, and a key named "org.scalatestplus.play.port" whose value is anInt
, and if they exist, sets theApplication
as the value that will be returned from theapp
method and theInt
as the value that will be returned from theport
method, then callssuper.run
.Looks in
args.configMap
for a key named "org.scalatestplus.play.app" whose value is aApplication
, and a key named "org.scalatestplus.play.port" whose value is anInt
, and if they exist, sets theApplication
as the value that will be returned from theapp
method and theInt
as the value that will be returned from theport
method, then callssuper.run
.If no key matches "org.scalatestplus.play.app" in
args.configMap
, or the associated value is not aApplication
, or if no key matches "org.scalatestplus.play.port" inargs.configMap
, or the associated value is not anInt
, throwsIllegalArgumentException
.- 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 thisSuite
.- 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
- ConfiguredServer → SuiteMixin
- Exceptions thrown
java.lang.IllegalArgumentException
if theApplication
and/or port number does not appear inargs.configMap
under the expected keys