trait OneServerPerSuiteWithComponents extends BaseOneServerPerSuite with WithApplicationComponents with FakeApplicationFactory
An extension of BaseOneServerPerSuite providing Compile-time DI.
Trait that provides a new Application
and running TestServer
instance per ScalaTest Suite
.
By default, this trait creates a new Application
for the Suite
according to the components defined in the test, this
is made available via the app
field defined in this trait and a new TestServer
for the Suite
using the port number provided by
its port
field and the Application
provided by its app
field. If your Suite
needs a different port number,
override port
.
This TestSuiteMixin
trait's overridden run
method calls start
on the TestServer
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
and to the port number provided by port
under the key
org.scalatestplus.play.port
. This allows any nested Suite
s to access the Suite
's
Application
and port number as well, most easily by having the nested Suite
s mix in the
ConfiguredServer trait. On the status returned by super.run
, this
trait's overridden run
method registers a call to stop
on the TestServer
to be executed when the Status
completes, and returns the same Status
. This ensure the TestServer
will continue to execute until
all nested suites have completed, after which the TestServer
will be stopped.
Here's an example that demonstrates some of the services provided by this trait:
import org.scalatestplus.play.PlaySpec import org.scalatestplus.play.components.OneServerPerSuiteWithComponents import play.api._ import play.api.mvc.Result import play.api.test.Helpers._ import play.api.test.{FakeRequest, Helpers} import scala.concurrent.Future class ExampleComponentsSpec extends PlaySpec with OneServerPerSuiteWithComponents { override def components: BuiltInComponents = new BuiltInComponentsFromContext(context) with NoHttpFiltersComponents { import play.api.mvc.Results import play.api.routing.Router import play.api.routing.sird._ lazy val router: Router = Router.from({ case GET(p"/") => defaultActionBuilder { Results.Ok("success!") } }) override lazy val configuration: Configuration = Configuration("foo" -> "bar", "ehcacheplugin" -> "disabled").withFallback(context.initialConfiguration) } "The OneServerPerSuiteWithComponents trait" must { "provide an Application" in { import play.api.test.Helpers.{GET, route} val Some(result: Future[Result]) = route(app, FakeRequest(GET, "/")) Helpers.contentAsString(result) must be("success!") } "override the configuration" in { app.configuration.getOptional[String]("foo") mustBe Some("bar") } } }
If you have many tests that can share the same Application
and TestServer
, 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 OneServerPerSuite
and declares the nested
Suite
s. Annotate the nested suites with @DoNotDiscover
and have them extend ConfiguredServer
. Here's an example:
import org.scalatest.{ DoNotDiscover, Suites, TestSuite } import org.scalatestplus.play.components._ import org.scalatestplus.play.{ ConfiguredServer, PlaySpec } import play.api._ import play.api.mvc.Result import play.api.test.Helpers._ import play.api.test.{ FakeRequest, Helpers } import scala.concurrent.Future class NestedExampleSpec extends Suites( new OneSpec, new TwoSpec, new RedSpec, new BlueSpec ) with OneServerPerSuiteWithComponents with TestSuite { // Override fakeApplication if you need an Application with other than non-default parameters. override def components: BuiltInComponents = new BuiltInComponentsFromContext(context) with NoHttpFiltersComponents { import play.api.mvc.Results import play.api.routing.Router import play.api.routing.sird._ lazy val router: Router = Router.from({ case GET(p"/") => defaultActionBuilder { Results.Ok("success!") } }) override lazy val configuration: Configuration = Configuration("ehcacheplugin" -> "disabled").withFallback(context.initialConfiguration) } } // These are the nested suites @DoNotDiscover class OneSpec extends PlaySpec with ConfiguredServer { "OneSpec" must { "make the Application available implicitly" in { def getConfig(key: String)(implicit app: Application) = app.configuration.getOptional[String](key) getConfig("ehcacheplugin") mustBe Some("disabled") } } } @DoNotDiscover class TwoSpec extends PlaySpec with ConfiguredServer @DoNotDiscover class RedSpec extends PlaySpec with ConfiguredServer @DoNotDiscover class BlueSpec extends PlaySpec with ConfiguredServer { "The NestedExampleSpeccc" must { "provide an Application" in { import play.api.test.Helpers.{ GET, route } val Some(result: Future[Result]) = route(app, FakeRequest(GET, "/")) Helpers.contentAsString(result) must be("success!") } "provide an actual running server" in { 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
- OneServerPerSuiteWithComponents with TestSuite
- Source
- OneServerPerSuiteWithComponents.scala
- Alphabetic
- By Inheritance
- OneServerPerSuiteWithComponents
- FakeApplicationFactory
- WithApplicationComponents
- BaseOneServerPerSuite
- ServerProvider
- TestSuiteMixin
- SuiteMixin
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def components: BuiltInComponents
Override this function to instantiate the components - a factory of sorts.
Override this function to instantiate the components - a factory of sorts.
- returns
the components to be used by the application
- Definition Classes
- WithApplicationComponents
- 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 runNestedSuites(args: Args): Status
- Attributes
- protected
- Definition Classes
- SuiteMixin
- abstract def runTest(testName: String, args: Args): Status
- Attributes
- protected
- Definition Classes
- SuiteMixin
- abstract def runTests(testName: Option[String], args: Args): Status
- Attributes
- protected
- Definition Classes
- SuiteMixin
- abstract val styleName: 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 def withFixture(test: (OneServerPerSuiteWithComponents.this)#NoArgTest): Outcome
- Attributes
- protected
- Definition Classes
- TestSuiteMixin
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- implicit lazy val app: Application
An implicit instance of
Application
.An implicit instance of
Application
.- Definition Classes
- BaseOneServerPerSuite → ServerProvider
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def context: Context
- returns
a context to use to create the application.
- Definition Classes
- WithApplicationComponents
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def fakeApplication(): Application
- Definition Classes
- OneServerPerSuiteWithComponents → FakeApplicationFactory
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def newApplication: Application
- returns
new application instance and set the components. This must be called for components to be properly set up.
- Definition Classes
- WithApplicationComponents
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- 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
Invokes
start
on a newTestServer
created with theApplication
provided byapp
and the port number defined byport
, places theApplication
and port number into theConfigMap
under the keysorg.scalatestplus.play.app
andorg.scalatestplus.play.port
, respectively, to make them available to nested suites; callssuper.run
; and lastly ensures theApplication
and test server are stopped after all tests and nested suites have completed.Invokes
start
on a newTestServer
created with theApplication
provided byapp
and the port number defined byport
, places theApplication
and port number into theConfigMap
under the keysorg.scalatestplus.play.app
andorg.scalatestplus.play.port
, respectively, to make them available to nested suites; callssuper.run
; and lastly ensures theApplication
and test server are stopped after all tests and nested suites have completed.- 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
- BaseOneServerPerSuite → SuiteMixin
- implicit lazy val runningServer: RunningServer
- Attributes
- protected
- Definition Classes
- BaseOneServerPerSuite → ServerProvider
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()