OneServerPerTestWithComponents

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

Linear Supertypes

FakeApplicationFactory, WithApplicationComponents, BaseOneServerPerTest, ServerProvider, TestSuiteMixin, SuiteMixin, AnyRef, Any

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( ... )
lazy val 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: Any): 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[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
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 an Application 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
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
lazy val port: Int

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.

Definition Classes
BaseOneServerPerTest → ServerProvider
implicit final lazy val portNumber: PortNumber

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.
returns
the configured port number, wrapped in a PortNumber

Definition Classes
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( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
def withFixture(test: (OneServerPerTestWithComponents.this)#NoArgTest): Outcome

Creates new Application and running TestServer instances before executing each test, and ensures they are cleaned up after the test completes.
Creates new Application and running TestServer instances before executing each test, and ensures they are cleaned up after the test completes. You can access the Application from your tests as app and the TestServer's port number as port.
test
the no-arg test function to run with a fixture
returns
the Outcome of the test execution

Definition Classes
BaseOneServerPerTest → TestSuiteMixin

Related Doc: package components

trait OneServerPerTestWithComponents extends BaseOneServerPerTest with WithApplicationComponents with FakeApplicationFactory

Abstract Value Members

abstract def components: BuiltInComponents

abstract def expectedTestCount(filter: Filter): Int

abstract def nestedSuites: IndexedSeq[Suite]

abstract def rerunner: Option[String]

abstract def run(testName: Option[String], args: Args): Status

abstract def runNestedSuites(args: Args): Status

abstract def runTest(testName: String, args: Args): Status

abstract def runTests(testName: Option[String], args: Args): Status

abstract val styleName: String

abstract def suiteId: String

abstract def suiteName: String

abstract def tags: Map[String, Set[String]]

abstract def testDataFor(testName: String, theConfigMap: ConfigMap): TestData

abstract def testNames: Set[String]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

implicit final def app: Application

final def asInstanceOf[T0]: T0

def clone(): AnyRef

lazy val context: Context

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def fakeApplication(): Application

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

def newAppForTest(testData: TestData): Application

final def newApplication: Application

final def notify(): Unit

final def notifyAll(): Unit

lazy val port: Int

implicit final lazy val portNumber: PortNumber

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

def withFixture(test: (OneServerPerTestWithComponents.this)#NoArgTest): Outcome

Inherited from FakeApplicationFactory

Inherited from WithApplicationComponents

Inherited from BaseOneServerPerTest

Inherited from ServerProvider

Inherited from TestSuiteMixin

Inherited from SuiteMixin

Inherited from AnyRef

Inherited from Any

Ungrouped