trait OneServerPerTestWithComponents extends BaseOneServerPerTest with WithApplicationComponents with FakeApplicationFactory
An extension of BaseOneServerPerTest providing Compile-time DI.
Trait that provides a new Application
and running TestServer
instance for each test executed in a ScalaTest Suite
This TestSuiteMixin
trait overrides ScalaTest's withFixture
method to create a new Application
and TestServer
before each test, and ensure they are cleaned up after the test has completed. The Application
is available (implicitly) from
method app
. The TestServer
's port number is available as port
(and implicitly available as portNumber
, wrapped
in a PortNumber).
By default, this trait creates a new Application
for each test according to the components defined in the test.
Here's an example that demonstrates some of the services provided by this trait:
import org.scalatestplus.play.PlaySpec import org.scalatestplus.play.components.OneServerPerTestWithComponents 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 OneServerPerTestWithComponents { 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 = context.initialConfiguration ++ Configuration("foo" -> "bar", "ehcacheplugin" -> "disabled") } "The OneServerPerTestWithComponents 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") } } }
- Self Type
- OneServerPerTestWithComponents with TestSuite
- Source
- OneServerPerTestWithComponents.scala
- Alphabetic
- By Inheritance
- OneServerPerTestWithComponents
- FakeApplicationFactory
- WithApplicationComponents
- BaseOneServerPerTest
- ServerProvider
- TestSuiteMixin
- SuiteMixin
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
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 run(testName: Option[String], args: Args): Status
- 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
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 final def app: Application
Implicit method that returns the
Application
instance for the current test.Implicit method that returns the
Application
instance for the current test.- Definition Classes
- BaseOneServerPerTest → ServerProvider
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[java.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
- OneServerPerTestWithComponents → FakeApplicationFactory
- def finalize(): Unit
- Attributes
- protected[java.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
- def newAppForTest(testData: TestData): Application
Creates new instance of
Application
with parameters set to their defaults.Creates new instance of
Application
with parameters set to their defaults. Override this method if you need anApplication
created with non-default parameter values.- Definition Classes
- BaseOneServerPerTest
- 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
- def newServerForTest(app: Application, testData: TestData): RunningServer
- Attributes
- protected
- Definition Classes
- BaseOneServerPerTest
- 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
- implicit final def runningServer: RunningServer
- Definition Classes
- BaseOneServerPerTest → 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()
- def withFixture(test: (OneServerPerTestWithComponents.this)#NoArgTest): Outcome
Creates new
Application
and runningTestServer
instances before executing each test, and ensures they are cleaned up after the test completes.Creates new
Application
and runningTestServer
instances before executing each test, and ensures they are cleaned up after the test completes. You can access theApplication
from your tests asapp
and theTestServer
's port number asport
.- test
the no-arg test function to run with a fixture
- returns
the
Outcome
of the test execution
- Definition Classes
- BaseOneServerPerTest → TestSuiteMixin